xref: /openbmc/bmcweb/features/redfish/include/registries/platform_message_registry.hpp (revision 56b81992ba8a8e644f2e75251a94df4f4d0d0880)
1 #pragma once
2 /****************************************************************
3  *                 READ THIS WARNING FIRST
4  * This is an auto-generated header which contains definitions
5  * for Redfish DMTF defined messages.
6  * DO NOT modify this registry outside of running the
7  * parse_registries.py script.  The definitions contained within
8  * this file are owned by DMTF.  Any modifications to these files
9  * should be first pushed to the relevant registry in the DMTF
10  * github organization.
11  ***************************************************************/
12 #include "registries.hpp"
13 
14 #include <array>
15 
16 // clang-format off
17 
18 namespace redfish::registries::platform
19 {
20 const Header header = {
21     "Copyright 2023 DMTF. All rights reserved.",
22     "#MessageRegistry.v1_6_2.MessageRegistry",
23     1,
24     0,
25     1,
26     "Compute Platform Message Registry",
27     "en",
28     "This registry defines messages for compute platforms, covering topics related to processor, memory, and I/O device connectivity.",
29     "Platform",
30     "DMTF",
31 };
32 constexpr const char* url =
33     "https://redfish.dmtf.org/registries/Platform.1.0.1.json";
34 
35 constexpr std::array registry =
36 {
37     MessageEntry{
38         "OperatingSystemCrash",
39         {
40             "Indicates the operating system was halted due to a catastrophic error.",
41             "An operating system crash occurred.",
42             "Critical",
43             0,
44             {},
45             "Check additional diagnostic data if available.",
46         }},
47     MessageEntry{
48         "PlatformError",
49         {
50             "Indicates that a platform error occurred.",
51             "A platform error occurred.",
52             "Warning",
53             0,
54             {},
55             "Check additional diagnostic data if available.",
56         }},
57     MessageEntry{
58         "PlatformErrorAtLocation",
59         {
60             "Indicates that a platform error occurred and device or other location information is available.",
61             "A platform error occurred at location '%1'.",
62             "Warning",
63             1,
64             {
65                 "string",
66             },
67             "Check additional diagnostic data if available.",
68         }},
69     MessageEntry{
70         "UnhandledExceptionDetectedAfterReset",
71         {
72             "Indicates that an unhandled exception caused the platform to reset.",
73             "An unhandled exception caused a platform reset.",
74             "Critical",
75             0,
76             {},
77             "Check additional diagnostic data if available.",
78         }},
79 
80 };
81 
82 enum class Index
83 {
84     operatingSystemCrash = 0,
85     platformError = 1,
86     platformErrorAtLocation = 2,
87     unhandledExceptionDetectedAfterReset = 3,
88 };
89 } // namespace redfish::registries::platform
90