Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-host-ipmid / 0a1301c141809fc8441abee5415c791ce894f068 / . / scripts / sensor-example.yaml
blob: 06c8836be7918011f7c521b6f5725d216fe31e09 [file] [log] [blame]
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]1# Sensor id is the key
20x60:
3 sensorType: 0x07
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]4 sensorReadingType: 0x6F
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]5 # A "set" operation on this sensor should update this d-bus path.
6 # If the path is not specified, an MRW parser will try to determine the path
7 # based on the sensor id, on MRW based systems. This typically happens for
8 # inventory items.
9 path: /org/open_power/control/occ0
10 # The interface that exposes method(s) to update the path above.
11 serviceInterface: org.freedesktop.DBus.Properties
12 # Where the sensor value is represented - assertion bits/reading/event data
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame]13 readingType: assertion
Tom Joseph31ff6e62018-01-24 16:10:09 +0530[diff] [blame]14 # Sensor name would be occ0
15 sensorNamePattern: nameLeaf
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]16 eventType: 0x6F
17 # All the d-bus interfaces : properties that must be updated for this path
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]18 interfaces:
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]19 # One or more interface dict entries
20 org.open_power.OCC.Status:
21 OccActive:
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]22 Offsets:
23 # Sensor type specific offset
24 0x06:
25 # OccActive is a boolean
26 type: "bool"
27 # If offset 0x06 is asserted, set OccActive as false.
28 assert: "false"
29 deassert: "true"
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]30
310x61:
32 sensorType: 0x04
33 sensorReadingType: 0x6F
34 # Inventory paths intentionally leave out the inventory root,
35 # /xyz/openbmc_project/inventory, because phosphor-inventory-manager
36 # adds that.
37 path: /system/chassis/motherboard/dimm1
38 serviceInterface: xyz.openbmc_project.Inventory.Manager
39 readingType: assertion
Tom Joseph31ff6e62018-01-24 16:10:09 +0530[diff] [blame]40 sensorNamePattern: nameLeaf
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]41 interfaces:
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]42 xyz.openbmc_project.State.Decorator.OperationalStatus:
43 Functional:
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]44 #Offsets contain the offsets in the sensor data.
45 Offsets:
46 0x06:
47 assert: true
48 deassert: false
49 type: bool
50 #Prereqs are pre-requisites for this property value to be true.
51 Prereqs:
52 0x04:
53 assert: false
54 deassert: true
55 type: bool
56 xyz.openbmc_project.Inventory.Item:
57 Present:
58 Offsets:
Dhruvaraj Subhashchandrane84841c2017-08-22 07:40:27 -0500[diff] [blame]59 0x04:
60 assert: false
61 deassert: true
62 type: bool
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]63
640x63:
Dhruvaraj Subhashchandrane0af7202017-07-12 06:35:20 -0500[diff] [blame]65 interfaces:
66 xyz.openbmc_project.Control.Boot.RebootAttempts:
67 AttemptsLeft:
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]68 Offsets:
69 0xFF:
70 type: uint32_t
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]71 path: /xyz/openbmc_project/state/host0
72 # A special case of assertion, where the entire assert bitfield
73 # serves as the value, or reading. Hence, the offset above is intentionally
74 # 0xFF, to indicate not to check any specific bits in the assertion.
75 readingType: readingAssertion
Tom Joseph31ff6e62018-01-24 16:10:09 +0530[diff] [blame]76 # Sensor name would be AttemptsLeft
77 sensorNamePattern: nameProperty
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]78 sensorReadingType: 0x6F
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]79 sensorType: 0xC3
80 serviceInterface: org.freedesktop.DBus.Properties
81
820x62:
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]83 interfaces:
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]84 xyz.openbmc_project.Control.Boot.RebootAttempts:
85 AttemptsLeft:
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]86 Offsets:
87 0xFF:
88 type: uint32_t
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]89 path: /xyz/openbmc_project/state/host1
90 readingType: readingAssertion
Tom Joseph31ff6e62018-01-24 16:10:09 +0530[diff] [blame]91 sensorNamePattern: nameProperty
Ratan Gupta47bf3ed2017-03-04 08:33:57 +0530[diff] [blame]92 sensorReadingType: 0x6F
Deepak Kodihalli1bb0d382017-08-12 02:01:27 -0500[diff] [blame]93 sensorType: 0xC3
94 serviceInterface: org.freedesktop.DBus.Properties
Emily Shaffercc941e12017-06-14 13:06:26 -0700[diff] [blame]95
960xD0:
97 sensorType: 0x01
98 path: /xyz/openbmc_project/sensors/temperature/fleeting0
99 sensorReadingType: 0x01
100 multiplierM: 511
101 offsetB: 0
102 bExp: 0
Tom Joseph0a1301c2018-02-16 08:27:00 +0530[diff] [blame^]103 # Result exponent field in Type 1 SDR(2's complement, signed)
104 rExp: 0
105 # Applies for analog sensors, the actual reading value for the sensor is
106 # Value * 10^N
107 scale: -3
Emily Shaffercc941e12017-06-14 13:06:26 -0700[diff] [blame]108 mutability: Mutability::Write|Mutability::Read
109 serviceInterface: org.freedesktop.DBus.Properties
110 readingType: readingData
Tom Joseph31ff6e62018-01-24 16:10:09 +0530[diff] [blame]111 sensorNamePattern: nameLeaf
Emily Shaffercc941e12017-06-14 13:06:26 -0700[diff] [blame]112 interfaces:
113 xyz.openbmc_project.Sensor.Value:
114 Value:
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]115 Offsets:
116 0xFF:
117 type: int64_t
Emily Shaffercc941e12017-06-14 13:06:26 -0700[diff] [blame]118
Dhruvaraj Subhashchandrane84841c2017-08-22 07:40:27 -0500[diff] [blame]1190x54:
120 sensorType: 0x07
121 path: /system/chassis/motherboard/cpu0/core22
122 sensorReadingType: 0x6F
123 serviceInterface: xyz.openbmc_project.Inventory.Manager
124 readingType: assertion
Tom Joseph31ff6e62018-01-24 16:10:09 +0530[diff] [blame]125 # Sensor name would be cpu0_core22
126 sensorNamePattern: nameParentLeaf
Dhruvaraj Subhashchandrane84841c2017-08-22 07:40:27 -0500[diff] [blame]127 interfaces:
128 xyz.openbmc_project.State.Decorator.OperationalStatus:
129 Functional:
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]130 Offsets:
Dhruvaraj Subhashchandrane84841c2017-08-22 07:40:27 -0500[diff] [blame]131 0x08:
132 assert: false
133 deassert: true
134 type: bool
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]135 Prereqs:
136 0x07:
137 assert: true
138 deassert: false
Dhruvaraj Subhashchandrane84841c2017-08-22 07:40:27 -0500[diff] [blame]139 xyz.openbmc_project.Inventory.Item:
140 Present:
Dhruvaraj Subhashchandrane245e4e2017-10-03 03:58:05 -0500[diff] [blame]141 Offsets:
Dhruvaraj Subhashchandrane84841c2017-08-22 07:40:27 -0500[diff] [blame]142 0x07:
143 assert: true
144 deassert: false
145 #The update will be skipped based on the value of skipOn
146 #in this case if offset 0x07 is deasserted
147 #the update will be skipped.
148 skipOn: deassert
149 type: bool