xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/BIOSConfig/SecureBoot.interface.yaml (revision b235159e0acc9943bc5f4e428ba6536f2e3cb621)
1 description: >
2     UEFI Secure Boot information and represents properties for managing the UEFI
3     Secure Boot functionality of a system.
4 
5 properties:
6     - name: CurrentBoot
7       type: enum[self.CurrentBootType]
8       description: >
9           The UEFI Secure Boot state during the current boot cycle.
10       default: Unknown
11 
12     - name: PendingEnable
13       type: boolean
14       description: >
15           An indication of whether the UEFI Secure Boot takes effect on next
16           boot.
17 
18     - name: Mode
19       type: enum[self.ModeType]
20       description: >
21           The current UEFI Secure Boot Mode.
22       default: Unknown
23 
24 enumerations:
25     - name: CurrentBootType
26       description: >
27           Secure Boot Current Boot Type.
28       values:
29           - name: Unknown
30             description: >
31                 UEFI Secure Boot is currently unknown.
32           - name: Enabled
33             description: >
34                 UEFI Secure Boot is currently enabled.
35           - name: Disabled
36             description: >
37                 UEFI Secure Boot is currently disabled.
38 
39     - name: ModeType
40       description: >
41           Secure Boot Mode Type. UEFI Secure Boot Modes are defined in UEFI
42           Specification -
43           https://uefi.org/specs/UEFI/2.10/32_Secure_Boot_and_Driver_Signing.html#secure-boot-modes
44       values:
45           - name: Unknown
46             description: >
47                 UEFI Secure Boot is currently unknown.
48           - name: Setup
49             description: >
50                 UEFI Secure Boot is currently in Setup Mode.
51           - name: User
52             description: >
53                 UEFI Secure Boot is currently in User Mode.
54           - name: Audit
55             description: >
56                 UEFI Secure Boot is currently in Audit Mode.
57           - name: Deployed
58             description: >
59                 UEFI Secure Boot is currently in Deployed Mode.
60