summaryrefslogtreecommitdiff
path: root/python/vyos/system/grub_util.py
blob: 4a3d8795e3afcd549d2d11640bc5cd38260e8470 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Copyright 2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library.  If not, see <http://www.gnu.org/licenses/>.

from vyos.system import disk, grub, image, compat

@compat.grub_cfg_update
def set_console_speed(console_speed: str, root_dir: str = '') -> None:
    """Write default console speed to GRUB configuration

    Args:
        console_speed (str): default console speed
        root_dir (str, optional): an optional path to the root directory.
        Defaults to empty.
    """
    if not root_dir:
        root_dir = disk.find_persistence()

    grub.set_console_speed(console_speed, root_dir)

@image.if_not_live_boot
def update_console_speed(console_speed: str, root_dir: str = '') -> None:
    """Update console_speed if different from current value"""

    if not root_dir:
        root_dir = disk.find_persistence()

    vars_file: str = f'{root_dir}/{grub.CFG_VYOS_VARS}'
    vars_current: dict[str, str] = grub.vars_read(vars_file)
    console_speed_current = vars_current.get('console_speed', None)
    if console_speed != console_speed_current:
        set_console_speed(console_speed, root_dir)

@compat.grub_cfg_update
def set_kernel_cmdline_options(cmdline_options: str, version: str = '',
                               root_dir: str = '') -> None:
    """Write Kernel CLI cmdline options to GRUB configuration"""
    if not root_dir:
        root_dir = disk.find_persistence()

    if not version:
        version = image.get_running_image()

    grub.set_kernel_cmdline_options(cmdline_options, version, root_dir)

@image.if_not_live_boot
def update_kernel_cmdline_options(cmdline_options: str,
                                  root_dir: str = '') -> None:
    """Update Kernel custom cmdline options"""
    if not root_dir:
        root_dir = disk.find_persistence()

    version = image.get_running_image()

    boot_opts_current = grub.get_boot_opts(version, root_dir)
    boot_opts_proposed = grub.BOOT_OPTS_STEM + f'{version} {cmdline_options}'

    if boot_opts_proposed != boot_opts_current:
        set_kernel_cmdline_options(cmdline_options, version, root_dir)