Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / pldm / c50c6cd75d56ec8a8e17b99c16577586f7972b9c / . / libpldm / state_set.h
blob: dca5cda093441af84e1b53be60c0399316e89344 [file] [log] [blame]
Tom Josephc4bcc1f2020-06-23 15:48:25 +0530[diff] [blame]1#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 /* Table 1 - General State Sets */
12 PLDM_STATE_SET_HEALTH_STATE = 1,
13 PLDM_STATE_SET_AVAILABILITY = 2,
14 PLDM_STATE_SET_PREDICTIVE_CONDITION = 3,
15 PLDM_STATE_SET_REDUNDANCY_STATUS = 4,
16 PLDM_STATE_SET_HEALTH_REDUNDANCY_TREND = 5,
17 PLDM_STATE_SET_GROUP_RESOURCE_LEVEL = 6,
18 PLDM_STATE_SET_REDUNDANCY_ENTITY_ROLE = 7,
19 PLDM_STATE_SET_OPERATIONAL_STATUS = 8,
20 PLDM_STATE_SET_OPERATIONAL_STRESS_STATUS = 9,
21 PLDM_STATE_SET_OPERATIONAL_FAULT_STATUS = 10,
22 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS = 11,
23 PLDM_STATE_SET_OPERATIONAL_CONNECTION_STATUS = 12,
24 PLDM_STATE_SET_PRESENCE = 13,
25 PLDM_STATE_SET_PERFORMANCE = 14,
26 PLDM_STATE_SET_CONFIGURATION_STATE = 15,
27 PLDM_STATE_SET_CHANGED_CONFIGURATION = 16,
28 PLDM_STATE_SET_IDENTIFY_STATE = 17,
29 PLDM_STATE_SET_VERSION = 18,
30 PLDM_STATE_SET_ALARM_STATE = 19,
31 PLDM_STATE_SET_DEVICE_INITIALIZATION = 20,
32 PLDM_STATE_SET_THERMAL_TRIP = 21,
33
34 /* Table 2 - Communication State Sets */
35 PLDM_STATE_SET_HEARTBEAT = 32,
36 PLDM_STATE_SET_LINK_STATE = 33,
37
38 /* Table 3 - General Sensor State Sets */
39 PLDM_STATE_SET_SMOKE_STATE = 64,
40 PLDM_STATE_SET_HUMIDITY_STATE = 65,
41 PLDM_STATE_SET_DOOR_STATE = 66,
42 PLDM_STATE_SET_SWITCH_STATE = 67,
43
44 /* Table 4 - Security-Related State Sets */
45 PLDM_STATE_SET_LOCK_STATE = 96,
46 PLDM_STATE_SET_PHYSICAL_SECURITY = 97,
47 PLDM_STATE_SET_DOCK_AUTHORIZATION = 98,
48 PLDM_STATE_SET_HW_SECURITY = 99,
49 PLDM_STATE_SET_PHYSICAL_COMM_CONNECTION = 100,
50 PLDM_STATE_SET_COMM_LEASH_STATUS = 101,
51 PLDM_STATE_SET_FOREIGN_NW_DETECTION_STATUS = 102,
52 PLDM_STATE_SET_PASSWORD_PROTECTED_ACCESS_SECURITY = 103,
53 PLDM_STATE_SET_SECURITY_ACCESS_PRIVILEGE_LEVEL = 104,
54 PLDM_STATE_SET_SESSION_AUDIT = 105,
55
56 /* Table 5 - Software-Related State Sets */
57 PLDM_STATE_SET_SW_TERMINATION_STATUS = 129,
58
59 /* Table 6 - Redundant Storage Media (RAID) State Sets */
60 PLDM_STATE_SET_STORAGE_MEDIA_ACTIVITY = 160,
61
62 /* Table 7 - Boot-Related State Sets */
63 PLDM_STATE_SET_BOOT_RESTART_CAUSE = 192,
64 PLDM_STATE_SET_BOOT_RESTART_REQUEST = 193,
65 PLDM_STATE_SET_ENTITY_BOOT_STATUS = 194,
66 PLDM_STATE_SET_BOOT_ERROR_STATUS = 195,
67 PLDM_STATE_SET_BOOT_PROGRESS = 196,
68 PLDM_STATE_SET_SYS_FIRMWARE_HANG = 197,
69 PLDM_STATE_SET_POST_ERRORS = 198,
70
71 /* Table 8 - Monitored System-Related State Sets */
72 PLDM_STATE_SET_LOG_FILL_STATUS = 225,
73 PLDM_STATE_SET_LOG_FILTER_STATUS = 226,
74 PLDM_STATE_SET_LOG_TIMESTAMP_CHANGE = 227,
75 PLDM_STATE_SET_INTERRUPT_REQUESTED = 228,
76 PLDM_STATE_SET_INTERRUPT_RECEIVED = 229,
77 PLDM_STATE_SET_DIAGNOSTIC_INTERRUPT_REQUESTED = 230,
78 PLDM_STATE_SET_DIAGNOSTIC_INTERRUPT_RECEIVED = 231,
79 PLDM_STATE_SET_IO_CHANNEL_CHECK_NMI_REQUESTED = 232,
80 PLDM_STATE_SET_IO_CHANNEL_CHECK_NMI_RECEIVED = 233,
81 PLDM_STATE_SET_FATAL_NMI_REQUESTED = 234,
82 PLDM_STATE_SET_FATAL_NMI_RECEIVED = 235,
83 PLDM_STATE_SET_SOFTWARE_NMI_REQUESTED = 236,
84 PLDM_STATE_SET_SOFTWARE_NMI_RECEIVED = 237,
85 PLDM_STATE_SET_SMI_REQUESTED = 238,
86 PLDM_STATE_SET_SMI_RECEIVED = 238,
87 PLDM_STATE_SET_PCI_PERR_REQUESTED = 239,
88 PLDM_STATE_SET_PCI_PERR_RECEIVED = 240,
89 PLDM_STATE_SET_PCI_SERR_REQUESTED = 241,
90 PLDM_STATE_SET_PCI_SERR_RECEIVED = 242,
91 PLDM_STATE_SET_BUS_ERROR_STATUS = 243,
92 PLDM_STATE_SET_WATCHDOG_STATUS = 244,
93
94 /* Table 9 - Power-Related State Sets */
95 PLDM_STATE_SET_POWER_SUPPLY_STATE = 256,
96 PLDM_STATE_SET_DEVICE_POWER_STATE = 257,
97 PLDM_STATE_SET_ACPI_POWER_STATE = 258,
98 PLDM_STATE_SET_BACKUP_POWER_SOURCE = 259,
99 PLDM_STATE_SET_SYSTEM_POWER_STATE = 260,
100 PLDM_STATE_SET_BATTERY_ACTIVITY = 261,
101 PLDM_STATE_SET_BATTERY_STATE = 262,
102
103 /* Table 10 - Processor-Related State Sets */
104 PLDM_STATE_SET_PROC_POWER_STATE = 288,
105 PLDM_STATE_SET_POWER_PERFORMANCE_STATE = 289,
106 PLDM_STATE_SET_PROC_ERROR_STATUS = 290,
107 PLDM_STATE_SET_BIST_FAILURE_STATUS = 291,
108 PLDM_STATE_SET_IBIST_FAILURE_STATUS = 292,
109 PLDM_STATE_SET_PROC_HANG_IN_POST = 293,
110 PLDM_STATE_SET_PROC_STARTUP_FAILURE = 294,
111 PLDM_STATE_SET_UNCORRECTABLE_CPU_ERROR = 295,
112 PLDM_STATE_SET_MACHINE_CHECK_ERROR = 296,
113 PLDM_STATE_SET_CORRECTED_MACHINE_CHECK = 297,
114
115 /* Table 11 - Memory-Related State Sets */
116 PLDM_STATE_SET_CACHE_STATUS = 320,
117 PLDM_STATE_SET_MEMORY_ERROR_STATUS = 321,
118 PLDM_STATE_SET_REDUNDANT_MEMORY_ACTIVITY_STATUS = 322,
119
120 /* Table 12 - Storage Device State Sets */
121 PLDM_STATE_SET_ERROR_DETECTION_STATUS = 330,
122 PLDM_STATE_SET_STUCK_BIT_STATUS = 331,
123 PLDM_STATE_SET_SCRUB_STATUS = 332,
124
125 /* Table 13 - Slot/Module State Sets */
126 PLDM_STATE_SET_SLOT_OCCUPANCY = 352,
127 PLDM_STATE_SET_SLOT_STATE = 353,
128};
129
Zach Clarkc038bac2021-04-16 14:38:06 -0500[diff] [blame]130/* @brief List of states for the Health State state set (ID 1).
131 */
132enum pldm_state_set_health_state_values {
133 PLDM_STATE_SET_HEALTH_STATE_NORMAL = 1,
134 PLDM_STATE_SET_HEALTH_STATE_NON_CRITICAL = 2,
135 PLDM_STATE_SET_HEALTH_STATE_CRITICAL = 3,
136 PLDM_STATE_SET_HEALTH_STATE_FATAL = 4,
137 PLDM_STATE_SET_HEALTH_STATE_UPPER_NON_CRITICAL = 5,
138 PLDM_STATE_SET_HEALTH_STATE_LOWER_NON_CRITICAL = 6,
139 PLDM_STATE_SET_HEALTH_STATE_UPPER_CRITICAL = 7,
140 PLDM_STATE_SET_HEALTH_STATE_LOWER_CRITICAL = 8,
141 PLDM_STATE_SET_HEALTH_STATE_UPPER_FATAL = 9,
142 PLDM_STATE_SET_HEALTH_STATE_LOWER_FATAL = 10,
143};
144
Zach Clarkb728eee2020-06-18 10:01:31 -0500[diff] [blame]145/* @brief List of states for the Boot Restart Cause state set (ID 192).
146 */
147enum pldm_state_set_boot_restart_cause_values {
148 PLDM_STATE_SET_BOOT_RESTART_CAUSE_POWERED_UP = 1,
149 PLDM_STATE_SET_BOOT_RESTART_CAUSE_HARD_RESET = 2,
150 PLDM_STATE_SET_BOOT_RESTART_CAUSE_WARM_RESET = 3,
151 PLDM_STATE_SET_BOOT_RESTART_CAUSE_MANUAL_HARD_RESET = 4,
152 PLDM_STATE_SET_BOOT_RESTART_CAUSE_MANUAL_WARM_RESET = 5,
153 PLDM_STATE_SET_BOOT_RESTART_CAUSE_SYSTEM_RESTART = 6,
154 PLDM_STATE_SET_BOOT_RESTART_CAUSE_WATCHDOG_TIMEOUT = 7
155};
156
157/* @brief List of states for the Operational Running Status state set (ID 11).
158 */
159enum pldm_state_set_operational_running_status_values {
160 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STARTING = 1,
161 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPING = 2,
162 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPED = 3,
163 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_IN_SERVICE = 4,
164 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_ABORTED = 5,
165 PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_DORMANT = 6
166};
167
Chicago Duan184f6022020-04-17 11:30:49 +0800[diff] [blame]168/* @brief List of states for the Software-related state set (ID 129).
169 */
170enum pldm_software_termination_status_values {
171 PLDM_SW_TERM_NORMAL = 1,
172 PLDM_SW_TERM_SOFTWARE_TERMINATION_DETECTED = 2,
173 PLDM_SW_TERM_CRITICAL_STOP_DURING_LOAD_INITIALIZATION = 3,
174 PLDM_SW_TERM_RUN_TIME_CRITICAL_STOP = 4,
175 PLDM_SW_TERM_GRACEFUL_SHUTDOWN_REQUESTED = 5,
176 PLDM_SW_TERM_GRACEFUL_RESTART_REQUESTED = 6,
177 PLDM_SW_TERM_GRACEFUL_SHUTDOWN = 7,
178 PLDM_SW_TERM_TERMINATION_REQUEST_FAILED = 8,
179};
Sampa Misraaea5dde2020-08-31 08:33:47 -0500[diff] [blame]180
181/* OEM ranges */
182#define PLDM_OEM_STATE_SET_ID_START 32768
183#define PLDM_OEM_STATE_SET_ID_END 65535
184
Tom Josephc4bcc1f2020-06-23 15:48:25 +0530[diff] [blame]185#ifdef __cplusplus
186}
187#endif
188
Zach Clarkb728eee2020-06-18 10:01:31 -0500[diff] [blame]189#endif /* STATE_SET_H */