blob: 62fa083f192aecd64fb3d8898e12f64158dfaf26 [file] [log] [blame]
Chicago Duan3ff4a702020-06-12 16:24:41 +08001description: >
2 Implement to emit D-Bus signal for PLDM Event Messages. PLDM Event
3 Messages are PLDM monitoring and control messages that are used by
4 a PLDM terminus to synchronously or asynchronously report PLDM events
5 to a central party called the PLDM Event Receiver.
6
7 When the PLDM daemon receives a sensorEvent of type stateSensorState,
8 it emits the StateSensorEvent signal.
9
10 This signal would be used by PLDM Requester apps on the BMC, which
11 will rely on this signal to determine state changes on a connected
12 PLDM entity.
13
14 More information about PLDM Event Messages can be found at DSP0248
15 version 1.2.0 section 13.
16
17signals:
18 - name: StateSensorEvent
19 description: >
20 Signal indicating that a state sensor change EventMessage is
21 received.
22 More information about properties can be found at DSP0248 version
23 1.2.0 table 19.
24 properties:
Patrick Williams8da396c2022-03-14 14:21:02 -050025 - name: TID
26 type: byte
27 description: >
28 A terminus id.
Chicago Duan3ff4a702020-06-12 16:24:41 +080029
Patrick Williams8da396c2022-03-14 14:21:02 -050030 - name: sensorID
31 type: uint16
32 description: >
33 The sensorID is the value that is used in PDRs and PLDM sensor
34 access commands to identify and access a particular sensor
35 within a terminus.
Chicago Duan3ff4a702020-06-12 16:24:41 +080036
Patrick Williams8da396c2022-03-14 14:21:02 -050037 - name: sensorOffset
38 type: byte
39 description: >
40 Identifies which state sensor within a composite state sensor
41 the event is being returned for.
Chicago Duan3ff4a702020-06-12 16:24:41 +080042
Patrick Williams8da396c2022-03-14 14:21:02 -050043 - name: eventState
44 type: byte
45 description: >
46 The event state value from the state change that triggered
47 the event message.
Chicago Duan3ff4a702020-06-12 16:24:41 +080048
Patrick Williams8da396c2022-03-14 14:21:02 -050049 - name: previousEventState
50 type: byte
51 description: >
52 The event state value for the state from which the present
53 event state was entered.