Skip to content

Commit

Permalink
Merge pull request #924 from Dasharo/link-fixes
Browse files Browse the repository at this point in the history
docs/unified/protectli/overview.md: fix broken links
  • Loading branch information
macpijan authored Nov 6, 2024
2 parents 1174b58 + 98b2d6f commit 53211bf
Show file tree
Hide file tree
Showing 79 changed files with 357 additions and 681 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ localhost:12345` (the number is random).
It is crucial at this point to verify that the pages you have changed
render correctly as HTML in local preview.

It is also important to read through the console output after running `mkdocs
serve`. You should definitely eliminate any `WARNING`s related to your
contribution before submitting it for review, and you should consider applying
suggestions marked as `INFO`.

If you want to use a browser for a live preview while you keep making changes,
consider adding `--dirty` flag to `mkdocs serve` command. It limits automatic
regeneration to only changed files and makes browser updates much faster.
Expand Down
20 changes: 10 additions & 10 deletions docs/dasharo-menu-docs/boot-maintenance-mgr.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Boot Maintenance Manager is mainly used to manage boot options, boot timeout,
next boot variable, console inputs and outputs. It also provides a way to add
driver options, but it is rather rarely used.

![](/images/menus/boot_maint_mgr.jpeg){ class="center" }
![](../images/menus/boot_maint_mgr.jpeg){ class="center" }

* `Boot Next Value` is used to set which boot options should be booted after a
reboot. This setting is not permanent and works only after the first reboot,
Expand All @@ -18,24 +18,24 @@ driver options, but it is rather rarely used.

This submenu allows to manipulate the boot order and boot options in general:

![](/images/menus/boot_opts.jpeg){ class="center" }
![](../images/menus/boot_opts.jpeg){ class="center" }

## Add Boot Option

When selecting to add a boot option, file explorer appears where one has to
navigate to the desired disk, partition and file which shall be executed if the
boot options is selected:

![](/images/menus/add_boot_opt.jpeg){ class="center" }
![](../images/menus/add_boot_opt.jpeg){ class="center" }

NOTE: only EFI files may be used. If the file is already selected a window to
set the boot option name appears:

![](/images/menus/add_boot_opt2.jpeg){ class="center" }
![](../images/menus/add_boot_opt2.jpeg){ class="center" }

To set the name press `ENTER` to activate the prompt:

![](/images/menus/add_boot_opt3.jpeg){ class="center" }
![](../images/menus/add_boot_opt3.jpeg){ class="center" }

Confirm the name (it must not be too short) with `ENTER` and then
`Commit Changes and Exit`. From now on the boot options should appear on the
Expand All @@ -46,7 +46,7 @@ and [One Time Boot](overview.md#one-time-boot) menu.

To delete boot options, enter `Delete Boot Option` submenu.

![](/images/menus/del_boot_opt.jpeg){ class="center" }
![](../images/menus/del_boot_opt.jpeg){ class="center" }

Select the checkboxes which options should be removed and then
`Commit Changes and Exit`. From now on the deleted boot options should not
Expand All @@ -64,13 +64,13 @@ PLease note that the boot order may be changed only for currently detected and
registered boot options and devices. Dasharo does not yet provide fixed boot
order options per interface, e.g. prioritize USB over NVMe or SATA, etc.

![](/images/menus/boot_order.jpeg){ class="center" }
![](../images/menus/boot_order.jpeg){ class="center" }

To move the boot options priority, press `ENTER` when selecting the boot
options list. A popup windows with the entries should show up. Use `+` and `-`
on the hovered item to move it up and down, use arrows to change hovered item.

![](/images/menus/boot_order2.jpeg){ class="center" }
![](../images/menus/boot_order2.jpeg){ class="center" }

If you are satisfied with the order you set, press `ENTER` to confirm it and
then `Commit Changes and Exit`. The boot order should be immediately applied,
Expand All @@ -82,14 +82,14 @@ and [One Time Boot](overview.md#one-time-boot) menu.
This menu is used to load additional drivers. It is used very rarely so it is
not described in detail.

![](/images/menus/driver_opts.jpeg){ class="center" }
![](../images/menus/driver_opts.jpeg){ class="center" }

## Console Options

This menu is used to manipulate EFI console variable. Typically there is no need
to use it.

![](/images/menus/console_opts.jpeg){ class="center" }
![](../images/menus/console_opts.jpeg){ class="center" }

Here one may enable/disable input and output devices. Please note that most
output and input devices devices are registered automatically during boot.
Expand Down
2 changes: 1 addition & 1 deletion docs/dasharo-menu-docs/dasharo-apu-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ capabilities as [PC Engines sortbootorder](https://github.com/pcengines/sortboot
When entering the `Dasharo APU Configuration` menu, one may see the
following options to appear:

![](/images/menus/apu_config.jpeg){ class="center" }
![](../images/menus/apu_config.jpeg){ class="center" }

### Core Performance Boost

Expand Down
44 changes: 22 additions & 22 deletions docs/dasharo-menu-docs/dasharo-system-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
When entering the `Dasharo System Features` menu, one may see the following
submenus to appear:

![](/images/menus/dasharo_features.jpeg){ class="center" }
![](../images/menus/dasharo_features.jpeg){ class="center" }

## Dasharo Security Options

![](/images/menus/dasharo_sec_opts.jpeg){ class="center" }
![](../images/menus/dasharo_sec_opts.jpeg){ class="center" }

This menu offers security-sensitive options like:

Expand Down Expand Up @@ -46,7 +46,7 @@ This menu offers security-sensitive options like:

## Networking Options

![](/images/menus/dasharo_net_opts.jpeg){ class="center" }
![](../images/menus/dasharo_net_opts.jpeg){ class="center" }

- `Enable network boot` - the option controls if the network boot should be
enabled or not. This option is disabled by default on most Dasharo supported
Expand All @@ -57,7 +57,7 @@ This menu offers security-sensitive options like:

## USB Configuration

![](/images/menus/dasharo_usb_opts.jpeg){ class="center" }
![](../images/menus/dasharo_usb_opts.jpeg){ class="center" }

- `Enable USB stack` - controls loading of UEFI USB drivers, when enabled all
USB drivers are loaded making USB keyboards and mass storage drives
Expand All @@ -75,7 +75,7 @@ This submenu is used to access Intel Management Engine related options.
Currently the only option available is `Intel ME mode` which allows to enable
or disable Management Engine:

![](/images/menus/me_menu.jpeg){ class="center" }
![](../images/menus/me_menu.jpeg){ class="center" }

On the right side of the window there is a help section describing the option
meaning. If the window is too small, the help section may be divided and not
Expand All @@ -92,7 +92,7 @@ Intel ME can be disabled in two ways:
disabled. HAP method is much more efficient as it halts the ME firmware
execution even earlier than Soft Disable described above

![](/images/menus/me_menu2.jpeg){ class="center" }
![](../images/menus/me_menu2.jpeg){ class="center" }

When the mode is set to `Enabled`, Dasharo enables the Intel Management engine
by either sending `ME_ENABLE` command via MEI/HECI or clearing the HAP bit in
Expand All @@ -112,7 +112,7 @@ clean the ME region with `me_cleaner` script permanently.

## Chipset Configuration

![](/images/menus/dasharo_chipset_opts.jpeg){ class="center" }
![](../images/menus/dasharo_chipset_opts.jpeg){ class="center" }

The submenu contains general chipset options. Currently available options:

Expand All @@ -138,7 +138,7 @@ The submenu contains general chipset options. Currently available options:

The submenu contains general power management options.

![](/images/menus/dasharo_power_opts.jpeg){ class="center" }
![](../images/menus/dasharo_power_opts.jpeg){ class="center" }

Currently available options:

Expand Down Expand Up @@ -166,46 +166,46 @@ stop charging.

Flow chart for the two settings mentioned above:

![](/images/battery_threshold_flowchart.png){class="center"}
![](../images/battery_threshold_flowchart.png){class="center"}

- `Power state after power/AC loss` - controls
what power state the platform
should switch to when the main AC power is restored. Default value is
platform-dependent.

![](/images/menus/pwr_fail_opt.png){ class="center" }
![](../images/menus/pwr_fail_opt.png){ class="center" }

## PCI/PCIe Configuration

The submenu contains options related to the PCI and PCI Express devices and
subsystem.

![](/images/menus/dasharo_pci_opts.jpeg){ class="center" }
![](../images/menus/dasharo_pci_opts.jpeg){ class="center" }

- `Enable PCIe Resizable BARs` - enables/disables the PCIe Resizable BARs
during PCI enumeration process. If enabled, the PCI Express devices
advertising more suitable memory resources, will be configured to use those
resources (that typically means bigger memory resources assigned to the
device). By default this option is disabled for compatibility reasons.

![](/images/menus/rebar_default_flow.png){ class="center" }
![](../images/menus/rebar_default_flow.png){ class="center" }

![](/images/menus/rebar_flow.png){ class="center" }
![](../images/menus/rebar_flow.png){ class="center" }

- `OptionROM Execution Policy` - controls which OptionROMs are allowed to be
loaded and run. Default value may depend on platform (either `Disable all`
or `Enable All`)

![](/images/menus/optionrom_default_flow.png){ class="center" }
![](../images/menus/optionrom_default_flow.png){ class="center" }

![](/images/menus/optionrom_flow.png){ class="center" }
![](../images/menus/optionrom_flow.png){ class="center" }

## Memory Configuration

The submenu contains options related to the RAM memory configuration.

![](/images/menus/dasharo_mem_opts1.jpeg){ class="center" }
![](/images/menus/dasharo_mem_opts2.jpeg){ class="center" }
![](../images/menus/dasharo_mem_opts1.jpeg){ class="center" }
![](../images/menus/dasharo_mem_opts2.jpeg){ class="center" }

- `Memory SPD profile` - chooses the memory overclocking profile to use when
training the memory. Custom profiles are not yet supported. Currently, there
Expand All @@ -215,13 +215,13 @@ The submenu contains options related to the RAM memory configuration.
**WARNING**: Changing this value may brick your system. Be sure to have a
recovery method before modifying this setting. You have been warned.

![](/images/menus/spd_profile_flow.png){ class="center" }
![](../images/menus/spd_profile_flow.png){ class="center" }

## Serial Port Configuration

The submenu contains options related to the serial port configuration.

![](/images/menus/serial_opts.jpeg){ class="center" }
![](../images/menus/serial_opts.jpeg){ class="center" }

- `Enable Serial Port Console Redirection` - when enabled, the firmware will
output also on the serial port specific to the platform. Default value is
Expand All @@ -236,7 +236,7 @@ splitter must choose the highest resolution supported by all consoles.

The submenu contains options related to the CPU.

![](/images/menus/cpu_config1.jpg){ class="center" }
![](../images/menus/cpu_config1.jpg){ class="center" }

- `Number of active P-cores` - sets the number of active Performance cores on
a hybrid CPU architecture system, such as 12th generation Intel Core or
Expand All @@ -253,9 +253,9 @@ The submenu contains options related to the CPU.
secondary threads on hyper-threading supported cores to be disabled. On
hybrid CPU architecture, only P-cores support Hyper-Threading.

![](/images/menus/cpu_config2.jpg){ class="center" }
![](../images/menus/cpu_config2.jpg){ class="center" }

![](/images/menus/cpu_config3.jpg){ class="center" }
![](../images/menus/cpu_config3.jpg){ class="center" }

## Additional information

Expand Down
Loading

0 comments on commit 53211bf

Please sign in to comment.