1 #include "sensorhandler.hpp"
2 
3 #include <malloc.h>
4 
5 extern uint8_t find_type_for_sensor_number(uint8_t);
6 
7 struct sensorRES_t
8 {
9     uint8_t sensor_number;
10     uint8_t operation;
11     uint8_t sensor_reading;
12     uint8_t assert_state7_0;
13     uint8_t assert_state14_8;
14     uint8_t deassert_state7_0;
15     uint8_t deassert_state14_8;
16     uint8_t event_data1;
17     uint8_t event_data2;
18     uint8_t event_data3;
19 } __attribute__((packed));
20 
21 #define ISBITSET(x, y) (((x) >> (y)) & 0x01)
22 #define ASSERTINDEX 0
23 #define DEASSERTINDEX 1
24 
25 // Sensor Type,  Offset, function handler, Dbus Method, Assert value, Deassert
26 // value
27 struct lookup_t
28 {
29     uint8_t sensor_type;
30     uint8_t offset;
31     int (*func)(const sensorRES_t*, const lookup_t*, const char*);
32     char member[16];
33     char assertion[64];
34     char deassertion[64];
35 };
36 
37 extern int updateDbusInterface(uint8_t, const char*, const char*);
38 
39 int set_sensor_dbus_state_simple(const sensorRES_t* pRec,
40                                  const lookup_t* pTable, const char* value)
41 {
42 
43     return set_sensor_dbus_state_s(pRec->sensor_number, pTable->member, value);
44 }
45 
46 struct event_data_t
47 {
48     uint8_t data;
49     char text[64];
50 };
51 
52 event_data_t g_fwprogress02h[] = {{0x00, "Unspecified"},
53                                   {0x01, "Memory Init"},
54                                   {0x02, "HD Init"},
55                                   {0x03, "Secondary Proc Init"},
56                                   {0x04, "User Authentication"},
57                                   {0x05, "User init system setup"},
58                                   {0x06, "USB configuration"},
59                                   {0x07, "PCI configuration"},
60                                   {0x08, "Option ROM Init"},
61                                   {0x09, "Video Init"},
62                                   {0x0A, "Cache Init"},
63                                   {0x0B, "SM Bus init"},
64                                   {0x0C, "Keyboard Init"},
65                                   {0x0D, "Embedded ctrl init"},
66                                   {0x0E, "Docking station attachment"},
67                                   {0x0F, "Enable docking station"},
68                                   {0x10, "Docking station ejection"},
69                                   {0x11, "Disabling docking station"},
70                                   {0x12, "Calling OS Wakeup"},
71                                   {0x13, "Starting OS"},
72                                   {0x14, "Baseboard Init"},
73                                   {0x15, ""},
74                                   {0x16, "Floppy Init"},
75                                   {0x17, "Keyboard Test"},
76                                   {0x18, "Pointing Device Test"},
77                                   {0x19, "Primary Proc Init"},
78                                   {0xFF, "Unknown"}};
79 
80 event_data_t g_fwprogress00h[] = {
81     {0x00, "Unspecified."},
82     {0x01, "No system memory detected"},
83     {0x02, "No usable system memory"},
84     {0x03, "Unrecoverable hard-disk/ATAPI/IDE"},
85     {0x04, "Unrecoverable system-board"},
86     {0x05, "Unrecoverable diskette"},
87     {0x06, "Unrecoverable hard-disk controller"},
88     {0x07, "Unrecoverable PS/2 or USB keyboard"},
89     {0x08, "Removable boot media not found"},
90     {0x09, "Unrecoverable video controller"},
91     {0x0A, "No video device detected"},
92     {0x0B, "Firmware ROM corruption detected"},
93     {0x0C, "CPU voltage mismatch"},
94     {0x0D, "CPU speed matching"},
95     {0xFF, "unknown"},
96 };
97 
98 char* event_data_lookup(event_data_t* p, uint8_t b)
99 {
100 
101     while (p->data != 0xFF)
102     {
103         if (p->data == b)
104         {
105             break;
106         }
107         p++;
108     }
109 
110     return p->text;
111 }
112 
113 //  The fw progress sensor contains some additional information that needs to be
114 //  processed prior to calling the dbus code.
115 int set_sensor_dbus_state_fwprogress(const sensorRES_t* pRec,
116                                      const lookup_t* pTable, const char*)
117 {
118 
119     char valuestring[128];
120     char* p = valuestring;
121 
122     switch (pTable->offset)
123     {
124 
125         case 0x00:
126             std::snprintf(
127                 p, sizeof(valuestring), "POST Error, %s",
128                 event_data_lookup(g_fwprogress00h, pRec->event_data2));
129             break;
130         case 0x01: /* Using g_fwprogress02h for 0x01 because that's what the
131                       ipmi spec says to do */
132             std::snprintf(
133                 p, sizeof(valuestring), "FW Hang, %s",
134                 event_data_lookup(g_fwprogress02h, pRec->event_data2));
135             break;
136         case 0x02:
137             std::snprintf(
138                 p, sizeof(valuestring), "FW Progress, %s",
139                 event_data_lookup(g_fwprogress02h, pRec->event_data2));
140             break;
141         default:
142             std::snprintf(
143                 p, sizeof(valuestring),
144                 "Internal warning, fw_progres offset unknown (0x%02x)",
145                 pTable->offset);
146             break;
147     }
148 
149     return set_sensor_dbus_state_s(pRec->sensor_number, pTable->member, p);
150 }
151 
152 // Handling this special OEM sensor by coping what is in byte 4.  I also think
153 // that is odd considering byte 3 is for sensor reading.  This seems like a
154 // misuse of the IPMI spec
155 int set_sensor_dbus_state_osbootcount(const sensorRES_t* pRec, const lookup_t*,
156                                       const char*)
157 {
158     return set_sensor_dbus_state_y(pRec->sensor_number, "setValue",
159                                    pRec->assert_state7_0);
160 }
161 
162 int set_sensor_dbus_state_system_event(const sensorRES_t* pRec,
163                                        const lookup_t* pTable, const char*)
164 {
165     char valuestring[128];
166     char* p = valuestring;
167 
168     switch (pTable->offset)
169     {
170 
171         case 0x00:
172             std::snprintf(p, sizeof(valuestring), "System Reconfigured");
173             break;
174         case 0x01:
175             std::snprintf(p, sizeof(valuestring), "OEM Boot Event");
176             break;
177         case 0x02:
178             std::snprintf(p, sizeof(valuestring),
179                           "Undetermined System Hardware Failure");
180             break;
181         case 0x03:
182             std::snprintf(
183                 p, sizeof(valuestring),
184                 "System Failure see error log for more details (0x%02x)",
185                 pRec->event_data2);
186             break;
187         case 0x04:
188             std::snprintf(
189                 p, sizeof(valuestring),
190                 "System Failure see PEF error log for more details (0x%02x)",
191                 pRec->event_data2);
192             break;
193         default:
194             std::snprintf(
195                 p, sizeof(valuestring),
196                 "Internal warning, system_event offset unknown (0x%02x)",
197                 pTable->offset);
198             break;
199     }
200 
201     return set_sensor_dbus_state_s(pRec->sensor_number, pTable->member, p);
202 }
203 
204 //  This table lists only senors we care about telling dbus about.
205 //  Offset definition cab be found in section 42.2 of the IPMI 2.0
206 //  spec.  Add more if/when there are more items of interest.
207 lookup_t g_ipmidbuslookup[] = {
208 
209     {0xe9, 0x00, set_sensor_dbus_state_simple, "setValue", "Disabled",
210      ""}, // OCC Inactive 0
211     {0xe9, 0x01, set_sensor_dbus_state_simple, "setValue", "Enabled",
212      ""}, // OCC Active 1
213     // Turbo Allowed
214     {0xda, 0x00, set_sensor_dbus_state_simple, "setValue", "True", "False"},
215     // Power Supply Derating
216     {0xb4, 0x00, set_sensor_dbus_state_simple, "setValue", "", ""},
217     // Power Cap
218     {0xC2, 0x00, set_sensor_dbus_state_simple, "setValue", "", ""},
219     {0x07, 0x07, set_sensor_dbus_state_simple, "setPresent", "True", "False"},
220     {0x07, 0x08, set_sensor_dbus_state_simple, "setFault", "True", "False"},
221     {0x0C, 0x06, set_sensor_dbus_state_simple, "setPresent", "True", "False"},
222     {0x0C, 0x04, set_sensor_dbus_state_simple, "setFault", "True", "False"},
223     {0x0F, 0x02, set_sensor_dbus_state_fwprogress, "setValue", "True", "False"},
224     {0x0F, 0x01, set_sensor_dbus_state_fwprogress, "setValue", "True", "False"},
225     {0x0F, 0x00, set_sensor_dbus_state_fwprogress, "setValue", "True", "False"},
226     {0xC7, 0x01, set_sensor_dbus_state_simple, "setFault", "True", "False"},
227     {0xc3, 0x00, set_sensor_dbus_state_osbootcount, "setValue", "", ""},
228     {0x1F, 0x00, set_sensor_dbus_state_simple, "setValue",
229      "Boot completed (00)", ""},
230     {0x1F, 0x01, set_sensor_dbus_state_simple, "setValue",
231      "Boot completed (01)", ""},
232     {0x1F, 0x02, set_sensor_dbus_state_simple, "setValue", "PXE boot completed",
233      ""},
234     {0x1F, 0x03, set_sensor_dbus_state_simple, "setValue",
235      "Diagnostic boot completed", ""},
236     {0x1F, 0x04, set_sensor_dbus_state_simple, "setValue",
237      "CD-ROM boot completed", ""},
238     {0x1F, 0x05, set_sensor_dbus_state_simple, "setValue", "ROM boot completed",
239      ""},
240     {0x1F, 0x06, set_sensor_dbus_state_simple, "setValue",
241      "Boot completed (06)", ""},
242     {0x12, 0x00, set_sensor_dbus_state_system_event, "setValue", "", ""},
243     {0x12, 0x01, set_sensor_dbus_state_system_event, "setValue", "", ""},
244     {0x12, 0x02, set_sensor_dbus_state_system_event, "setValue", "", ""},
245     {0x12, 0x03, set_sensor_dbus_state_system_event, "setValue", "", ""},
246     {0x12, 0x04, set_sensor_dbus_state_system_event, "setValue", "", ""},
247     {0xCA, 0x00, set_sensor_dbus_state_simple, "setValue", "Disabled", ""},
248     {0xCA, 0x01, set_sensor_dbus_state_simple, "setValue", "Enabled", ""},
249     {0xFF, 0xFF, NULL, "", "", ""}};
250 
251 void reportSensorEventAssert(const sensorRES_t* pRec, int index)
252 {
253     lookup_t* pTable = &g_ipmidbuslookup[index];
254     (*pTable->func)(pRec, pTable, pTable->assertion);
255 }
256 void reportSensorEventDeassert(const sensorRES_t* pRec, int index)
257 {
258     lookup_t* pTable = &g_ipmidbuslookup[index];
259     (*pTable->func)(pRec, pTable, pTable->deassertion);
260 }
261 
262 int findindex(const uint8_t sensor_type, int offset, int* index)
263 {
264 
265     int i = 0, rc = 0;
266     lookup_t* pTable = g_ipmidbuslookup;
267 
268     do
269     {
270         if (((pTable + i)->sensor_type == sensor_type) &&
271             ((pTable + i)->offset == offset))
272         {
273             rc = 1;
274             *index = i;
275             break;
276         }
277         i++;
278     } while ((pTable + i)->sensor_type != 0xFF);
279 
280     return rc;
281 }
282 
283 bool shouldReport(uint8_t sensorType, int offset, int* index)
284 {
285     bool rc = false;
286 
287     if (findindex(sensorType, offset, index))
288     {
289         rc = true;
290     }
291     if (rc == false)
292     {
293 #ifdef __IPMI_DEBUG__
294         log<level::DEBUG>("LOOKATME: Sensor should not be reported",
295                           entry("SENSORTYPE=0x%02x", sensorType),
296                           entry("OFFSET=0x%02x", offset));
297 #endif
298     }
299 
300     return rc;
301 }
302 
303 int updateSensorRecordFromSSRAESC(const void* record)
304 {
305     auto pRec = static_cast<const sensorRES_t*>(record);
306     uint8_t stype;
307     int index;
308 
309     stype = find_type_for_sensor_number(pRec->sensor_number);
310 
311     // 0xC3 types use the assertion7_0 for the value to be set
312     // so skip the reseach and call the correct event reporting
313     // function
314     if (stype == 0xC3)
315     {
316         shouldReport(stype, 0x00, &index);
317         reportSensorEventAssert(pRec, index);
318     }
319     else
320     {
321         // Scroll through each bit position .  Determine
322         // if any bit is either asserted or Deasserted.
323         for (int i = 0; i < 8; i++)
324         {
325 
326             if ((ISBITSET(pRec->assert_state7_0, i)) &&
327                 (shouldReport(stype, i, &index)))
328             {
329                 reportSensorEventAssert(pRec, index);
330             }
331             if ((ISBITSET(pRec->assert_state14_8, i)) &&
332                 (shouldReport(stype, i + 8, &index)))
333             {
334                 reportSensorEventAssert(pRec, index);
335             }
336             if ((ISBITSET(pRec->deassert_state7_0, i)) &&
337                 (shouldReport(stype, i, &index)))
338             {
339                 reportSensorEventDeassert(pRec, index);
340             }
341             if ((ISBITSET(pRec->deassert_state14_8, i)) &&
342                 (shouldReport(stype, i + 8, &index)))
343             {
344                 reportSensorEventDeassert(pRec, index);
345             }
346         }
347     }
348 
349     return 0;
350 }
351