blob: e7c4a0871677162de85342bc806674b6db336915 [file] [log] [blame]
Jason M. Billse79a2882018-09-04 15:50:47 -07001description: >
2 Implement to provide an IPMI System Event Log (SEL) logging interface
3 under the path /xyz/openbmc_project/Logging/IPMI.
4
5 SEL records store system event information and will contain a record ID
6 and type followed by type-specific information. The type-specific
7 information includes a timestamp, generator ID (used to identify the
8 component that is adding the SEL record), sensor number, event
9 direction and event-specific data for system type events; or timestamp
10 and OEM data for OEM type events.
11
12 The interface allows adding system or OEM type events. For system type
13 events it requires a generator ID (0x20 for BMC), sensor D-Bus path,
14 event direction (assertion or de-assertion), and event specific data.
15 For OEM type events, it requires the record type and OEM data.
16
17 It will assign a record ID and timestamp automatically and return the
18 assigned record ID.
19methods:
20 - name: IpmiSelAdd
21 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050022 Log a system event record type SEL entry.
Jason M. Billse79a2882018-09-04 15:50:47 -070023 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050024 - name: Message
25 type: string
26 description: >
27 The text to log for the event.
28 - name: Path
Patrick Williamsb78a0702022-10-24 12:32:56 -050029 type: object_path
Patrick Williams8da396c2022-03-14 14:21:02 -050030 description: >
31 The object path that is generating the SEL entry.
32 - name: SELData
33 type: array[byte]
34 description: >
35 An array of up to 3 bytes of SEL event data.
36 - name: Assert
37 type: boolean
38 description: >
39 An indicator if the SEL event is asserting or de-asserting.
40 - name: GeneratorID
41 type: uint16
42 description: >
43 The Generator ID of the component requesting the new SEL entry.
44 In most cases this will be 0x20 (the BMC Generator ID).
Jason M. Billse79a2882018-09-04 15:50:47 -070045 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050046 - name: RecordID
47 type: uint16
48 description: >
49 The Record ID of the new SEL entry.
Jason M. Billse79a2882018-09-04 15:50:47 -070050 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050051 - xyz.openbmc_project.Common.Error.InternalFailure
52 - xyz.openbmc_project.Common.Error.InvalidArgument
Jason M. Billse79a2882018-09-04 15:50:47 -070053
Andrei Kartashev964c4c72021-08-11 11:52:54 +030054 - name: AddExtended
55 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050056 Log a system event record SEL entry with custom SensorType/EventType.
Andrei Kartashev964c4c72021-08-11 11:52:54 +030057 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -050058 - name: Message
59 type: string
60 description: >
61 The text to log for the event.
62 - name: Path
Patrick Williamsb78a0702022-10-24 12:32:56 -050063 type: object_path
Patrick Williams8da396c2022-03-14 14:21:02 -050064 description: >
65 The object path that is generating the SEL entry.
66 - name: SELData
67 type: array[byte]
68 description: >
69 An array of up to 3 bytes of SEL event data.
70 - name: GeneratorID
71 type: uint16
72 description: >
73 The Generator ID of the component requesting the new SEL entry.
74 In most cases this will be 0x20 (the BMC Generator ID).
75 - name: eventType
76 type: byte
77 description: >
78 Type of trigger for the event and event direction.
79 - name: sensorType
80 type: byte
81 description: >
82 Sensor Type Code for sensor that generated the event.
83 - name: sensorNum
84 type: byte
85 description: >
86 Number of sensor that generated the event.
Andrei Kartashev964c4c72021-08-11 11:52:54 +030087 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -050088 - name: RecordID
89 type: uint16
90 description: >
91 The Record ID of the new SEL entry.
Andrei Kartashev964c4c72021-08-11 11:52:54 +030092 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -050093 - xyz.openbmc_project.Common.Error.InternalFailure
94 - xyz.openbmc_project.Common.Error.InvalidArgument
Andrei Kartashev964c4c72021-08-11 11:52:54 +030095
Jason M. Billse79a2882018-09-04 15:50:47 -070096 - name: IpmiSelAddOem
97 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -050098 Log an OEM record type SEL entry requested from external to the BMC.
Jason M. Billse79a2882018-09-04 15:50:47 -070099 parameters:
Patrick Williams8da396c2022-03-14 14:21:02 -0500100 - name: Message
101 type: string
102 description: >
103 The text to log for the event.
104 - name: SELData
105 type: array[byte]
106 description: >
107 An array of up to 13 bytes of SEL event data.
108 - name: RecordType
109 type: byte
110 description: >
111 The OEM record type for the SEL entry.
Jason M. Billse79a2882018-09-04 15:50:47 -0700112 returns:
Patrick Williams8da396c2022-03-14 14:21:02 -0500113 - name: RecordID
114 type: uint16
115 description: >
116 The Record ID of the new SEL entry.
Jason M. Billse79a2882018-09-04 15:50:47 -0700117 errors:
Patrick Williams8da396c2022-03-14 14:21:02 -0500118 - xyz.openbmc_project.Common.Error.InternalFailure
119 - xyz.openbmc_project.Common.Error.InvalidArgument
Charles Boyerce8e3892021-07-29 16:13:11 -0500120
121 - name: Clear
122 description: >
Patrick Williams8da396c2022-03-14 14:21:02 -0500123 Clear the SEL entries from their storage location.