blob: 23fd91c383e21ffa31edebf18329678abd27bb14 [file] [log] [blame]
Patrick Williams70a47ba2021-09-02 09:53:31 -05001#ifndef STATE_SET_H
2#define STATE_SET_H
3
4#ifdef __cplusplus
5extern "C" {
6#endif
7
8/** @brief PLDM State Set IDs in DSP0249_1.1.0 specification
9 */
10enum pldm_state_set_ids {
11
12 /* Table 1 - General State Sets */
13 PLDM_STATE_SET_HEALTH_STATE = 1,
14 PLDM_STATE_SET_AVAILABILITY = 2,
15 PLDM_STATE_SET_PREDICTIVE_CONDITION = 3,
16 PLDM_STATE_SET_REDUNDANCY_STATUS = 4,
17 PLDM_STATE_SET_HEALTH_REDUNDANCY_TREND = 5,
18 PLDM_STATE_SET_GROUP_RESOURCE_LEVEL = 6,
19 PLDM_STATE_SET_REDUNDANCY_ENTITY_ROLE = 7,
20 PLDM_STATE_SET_OPERATIONAL_STATUS = 8,
21 PLDM_STATE_SET_OPERATIONAL_STRESS_STATUS = 9,
22 PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS = 10,
23 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS = 11,
24 PLDM_STATE_SET_OPERATIONAL_CONNECTION_STATUS = 12,
25 PLDM_STATE_SET_PRESENCE = 13,
26 PLDM_STATE_SET_PERFORMANCE = 14,
27 PLDM_STATE_SET_CONFIGURATION_STATE = 15,
28 PLDM_STATE_SET_CHANGED_CONFIGURATION = 16,
29 PLDM_STATE_SET_IDENTIFY_STATE = 17,
30 PLDM_STATE_SET_VERSION = 18,
31 PLDM_STATE_SET_ALARM_STATE = 19,
32 PLDM_STATE_SET_DEVICE_INITIALIZATION = 20,
33 PLDM_STATE_SET_THERMAL_TRIP = 21,
34
35 /* Table 2 - Communication State Sets */
36 PLDM_STATE_SET_HEARTBEAT = 32,
37 PLDM_STATE_SET_LINK_STATE = 33,
38
39 /* Table 3 - General Sensor State Sets */
40 PLDM_STATE_SET_SMOKE_STATE = 64,
41 PLDM_STATE_SET_HUMIDITY_STATE = 65,
42 PLDM_STATE_SET_DOOR_STATE = 66,
43 PLDM_STATE_SET_SWITCH_STATE = 67,
44
45 /* Table 4 - Security-Related State Sets */
46 PLDM_STATE_SET_LOCK_STATE = 96,
47 PLDM_STATE_SET_PHYSICAL_SECURITY = 97,
48 PLDM_STATE_SET_DOCK_AUTHORIZATION = 98,
49 PLDM_STATE_SET_HW_SECURITY = 99,
50 PLDM_STATE_SET_PHYSICAL_COMM_CONNECTION = 100,
51 PLDM_STATE_SET_COMM_LEASH_STATUS = 101,
52 PLDM_STATE_SET_FOREIGN_NW_DETECTION_STATUS = 102,
53 PLDM_STATE_SET_PASSWORD_PROTECTED_ACCESS_SECURITY = 103,
54 PLDM_STATE_SET_SECURITY_ACCESS_PRIVILEGE_LEVEL = 104,
55 PLDM_STATE_SET_SESSION_AUDIT = 105,
56
57 /* Table 5 - Software-Related State Sets */
58 PLDM_STATE_SET_SW_TERMINATION_STATUS = 129,
59
60 /* Table 6 - Redundant Storage Media (RAID) State Sets */
61 PLDM_STATE_SET_STORAGE_MEDIA_ACTIVITY = 160,
62
63 /* Table 7 - Boot-Related State Sets */
64 PLDM_STATE_SET_BOOT_RESTART_CAUSE = 192,
65 PLDM_STATE_SET_BOOT_RESTART_REQUEST = 193,
66 PLDM_STATE_SET_ENTITY_BOOT_STATUS = 194,
67 PLDM_STATE_SET_BOOT_ERROR_STATUS = 195,
68 PLDM_STATE_SET_BOOT_PROGRESS = 196,
69 PLDM_STATE_SET_SYS_FIRMWARE_HANG = 197,
70 PLDM_STATE_SET_POST_ERRORS = 198,
71
72 /* Table 8 - Monitored System-Related State Sets */
73 PLDM_STATE_SET_LOG_FILL_STATUS = 225,
74 PLDM_STATE_SET_LOG_FILTER_STATUS = 226,
75 PLDM_STATE_SET_LOG_TIMESTAMP_CHANGE = 227,
76 PLDM_STATE_SET_INTERRUPT_REQUESTED = 228,
77 PLDM_STATE_SET_INTERRUPT_RECEIVED = 229,
78 PLDM_STATE_SET_DIAGNOSTIC_INTERRUPT_REQUESTED = 230,
79 PLDM_STATE_SET_DIAGNOSTIC_INTERRUPT_RECEIVED = 231,
80 PLDM_STATE_SET_IO_CHANNEL_CHECK_NMI_REQUESTED = 232,
81 PLDM_STATE_SET_IO_CHANNEL_CHECK_NMI_RECEIVED = 233,
82 PLDM_STATE_SET_FATAL_NMI_REQUESTED = 234,
83 PLDM_STATE_SET_FATAL_NMI_RECEIVED = 235,
84 PLDM_STATE_SET_SOFTWARE_NMI_REQUESTED = 236,
85 PLDM_STATE_SET_SOFTWARE_NMI_RECEIVED = 237,
86 PLDM_STATE_SET_SMI_REQUESTED = 238,
87 PLDM_STATE_SET_SMI_RECEIVED = 238,
88 PLDM_STATE_SET_PCI_PERR_REQUESTED = 239,
89 PLDM_STATE_SET_PCI_PERR_RECEIVED = 240,
90 PLDM_STATE_SET_PCI_SERR_REQUESTED = 241,
91 PLDM_STATE_SET_PCI_SERR_RECEIVED = 242,
92 PLDM_STATE_SET_BUS_ERROR_STATUS = 243,
93 PLDM_STATE_SET_WATCHDOG_STATUS = 244,
94
95 /* Table 9 - Power-Related State Sets */
96 PLDM_STATE_SET_POWER_SUPPLY_STATE = 256,
97 PLDM_STATE_SET_DEVICE_POWER_STATE = 257,
98 PLDM_STATE_SET_ACPI_POWER_STATE = 258,
99 PLDM_STATE_SET_BACKUP_POWER_SOURCE = 259,
100 PLDM_STATE_SET_SYSTEM_POWER_STATE = 260,
101 PLDM_STATE_SET_BATTERY_ACTIVITY = 261,
102 PLDM_STATE_SET_BATTERY_STATE = 262,
103
104 /* Table 10 - Processor-Related State Sets */
105 PLDM_STATE_SET_PROC_POWER_STATE = 288,
106 PLDM_STATE_SET_POWER_PERFORMANCE_STATE = 289,
107 PLDM_STATE_SET_PROC_ERROR_STATUS = 290,
108 PLDM_STATE_SET_BIST_FAILURE_STATUS = 291,
109 PLDM_STATE_SET_IBIST_FAILURE_STATUS = 292,
110 PLDM_STATE_SET_PROC_HANG_IN_POST = 293,
111 PLDM_STATE_SET_PROC_STARTUP_FAILURE = 294,
112 PLDM_STATE_SET_UNCORRECTABLE_CPU_ERROR = 295,
113 PLDM_STATE_SET_MACHINE_CHECK_ERROR = 296,
114 PLDM_STATE_SET_CORRECTED_MACHINE_CHECK = 297,
115
116 /* Table 11 - Memory-Related State Sets */
117 PLDM_STATE_SET_CACHE_STATUS = 320,
118 PLDM_STATE_SET_MEMORY_ERROR_STATUS = 321,
119 PLDM_STATE_SET_REDUNDANT_MEMORY_ACTIVITY_STATUS = 322,
120
121 /* Table 12 - Storage Device State Sets */
122 PLDM_STATE_SET_ERROR_DETECTION_STATUS = 330,
123 PLDM_STATE_SET_STUCK_BIT_STATUS = 331,
124 PLDM_STATE_SET_SCRUB_STATUS = 332,
125
126 /* Table 13 - Slot/Module State Sets */
127 PLDM_STATE_SET_SLOT_OCCUPANCY = 352,
128 PLDM_STATE_SET_SLOT_STATE = 353,
129};
130
131/* @brief List of states for the Health State state set (ID 1).
132 */
133enum pldm_state_set_health_state_values {
134 PLDM_STATE_SET_HEALTH_STATE_NORMAL = 1,
135 PLDM_STATE_SET_HEALTH_STATE_NON_CRITICAL = 2,
136 PLDM_STATE_SET_HEALTH_STATE_CRITICAL = 3,
137 PLDM_STATE_SET_HEALTH_STATE_FATAL = 4,
138 PLDM_STATE_SET_HEALTH_STATE_UPPER_NON_CRITICAL = 5,
139 PLDM_STATE_SET_HEALTH_STATE_LOWER_NON_CRITICAL = 6,
140 PLDM_STATE_SET_HEALTH_STATE_UPPER_CRITICAL = 7,
141 PLDM_STATE_SET_HEALTH_STATE_LOWER_CRITICAL = 8,
142 PLDM_STATE_SET_HEALTH_STATE_UPPER_FATAL = 9,
143 PLDM_STATE_SET_HEALTH_STATE_LOWER_FATAL = 10,
144};
145
146/* @brief List of states for the State Set Availability (ID 2),
147 */
148enum pldm_state_set_availability_values {
149 PLDM_STATE_SET_AVAILABILITY_REBOOTING = 8
150};
151
152/* @brief List of states for the Operational Fault status (ID 10).
153 */
154enum pldm_state_set_operational_fault_status_values {
155 PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS_NORMAL = 1,
156 PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS_STRESSED = 2,
157};
158
159/* @brief List of states for the Operational Running Status state set (ID 11).
160 */
161enum pldm_state_set_operational_running_status_values {
162 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STARTING = 1,
163 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPING = 2,
164 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPED = 3,
165 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_IN_SERVICE = 4,
166 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_ABORTED = 5,
167 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_DORMANT = 6
168};
169
170/* @brief List of states for the Set Identify state (ID 17).
171 */
172enum pldm_state_set_identify_state_values {
173 PLDM_STATE_SET_IDENTIFY_STATE_UNASSERTED = 1,
174 PLDM_STATE_SET_IDENTIFY_STATE_ASSERTED = 2,
175};
176
177/* @brief List of states for the Set Thermal Trip state set (ID 21).
178 */
179enum pldm_state_set_thermal_trip_values {
180 PLDM_STATE_SET_THERMAL_TRIP_STATUS_NORMAL = 1,
181 PLDM_STATE_SET_THERMAL_TRIP_STATUS_THERMAL_TRIP = 2,
182};
183
184/* @brief List of states for the Software-related state set (ID 129).
185 */
186enum pldm_software_termination_status_values {
187 PLDM_SW_TERM_NORMAL = 1,
188 PLDM_SW_TERM_SOFTWARE_TERMINATION_DETECTED = 2,
189 PLDM_SW_TERM_CRITICAL_STOP_DURING_LOAD_INITIALIZATION = 3,
190 PLDM_SW_TERM_RUN_TIME_CRITICAL_STOP = 4,
191 PLDM_SW_TERM_GRACEFUL_SHUTDOWN_REQUESTED = 5,
192 PLDM_SW_TERM_GRACEFUL_RESTART_REQUESTED = 6,
193 PLDM_SW_TERM_GRACEFUL_SHUTDOWN = 7,
194 PLDM_SW_TERM_TERMINATION_REQUEST_FAILED = 8,
195};
196
197/* @brief List of states for the Boot Restart Cause state set (ID 192).
198 */
199enum pldm_state_set_boot_restart_cause_values {
200 PLDM_STATE_SET_BOOT_RESTART_CAUSE_POWERED_UP = 1,
201 PLDM_STATE_SET_BOOT_RESTART_CAUSE_HARD_RESET = 2,
202 PLDM_STATE_SET_BOOT_RESTART_CAUSE_WARM_RESET = 3,
203 PLDM_STATE_SET_BOOT_RESTART_CAUSE_MANUAL_HARD_RESET = 4,
204 PLDM_STATE_SET_BOOT_RESTART_CAUSE_MANUAL_WARM_RESET = 5,
205 PLDM_STATE_SET_BOOT_RESTART_CAUSE_SYSTEM_RESTART = 6,
206 PLDM_STATE_SET_BOOT_RESTART_CAUSE_WATCHDOG_TIMEOUT = 7
207};
208
209/* @brief List of states for the Boot Progress state set (ID 196).
210 */
211enum pldm_state_set_boot_progress_state_values {
212 PLDM_STATE_SET_BOOT_PROG_STATE_NOT_ACTIVE = 1,
213 PLDM_STATE_SET_BOOT_PROG_STATE_COMPLETED = 2,
214 PLDM_STATE_SET_BOOT_PROG_STATE_MEM_INITIALIZATION = 3,
215 PLDM_STATE_SET_BOOT_PROG_STATE_SEC_PROC_INITIALIZATION = 5,
216 PLDM_STATE_SET_BOOT_PROG_STATE_PCI_RESORUCE_CONFIG = 9,
217 PLDM_STATE_SET_BOOT_PROG_STATE_STARTING_OP_SYS = 21,
218 PLDM_STATE_SET_BOOT_PROG_STATE_BASE_BOARD_INITIALIZATION = 22,
219 PLDM_STATE_SET_BOOT_PROG_STATE_PRIMARY_PROC_INITIALIZATION = 26,
220};
221
222/* @brief List of states for the System Power State set (ID 260).
223 */
224enum pldm_state_set_system_power_state_values {
225 PLDM_STATE_SET_SYS_POWER_STATE_OFF_SOFT_GRACEFUL = 9
226};
227
228/* OEM ranges */
229#define PLDM_OEM_STATE_SET_ID_START 32768
230#define PLDM_OEM_STATE_SET_ID_END 65535
231
232#ifdef __cplusplus
233}
234#endif
235
236#endif /* STATE_SET_H */