blob: 66c9bbb1edc24bdb62509662affa6e7d32475d7e [file] [log] [blame]
Patrick Venture46470a32018-09-07 19:26:25 -07001#pragma once
Chris Austenac4604a2015-10-13 12:43:27 -05002
Patrick Venture0b02be92018-08-31 11:55:55 -07003#include <stdint.h>
4
Brandon Kim9cf85622019-06-19 12:05:08 -07005#include <exception>
Vernon Mauerye08fbff2019-04-03 09:19:34 -07006#include <ipmid/api.hpp>
Vernon Mauery33250242019-03-12 16:49:26 -07007#include <ipmid/types.hpp>
8
Chris Austenac4604a2015-10-13 12:43:27 -05009// IPMI commands for net functions.
10enum ipmi_netfn_sen_cmds
11{
Jia, Chunhui3342a8e2018-12-29 13:32:26 +080012 IPMI_CMD_PLATFORM_EVENT = 0x2,
Tom Joseph5ca50952018-02-22 00:33:38 +053013 IPMI_CMD_GET_DEVICE_SDR_INFO = 0x20,
Patrick Venture0b02be92018-08-31 11:55:55 -070014 IPMI_CMD_GET_DEVICE_SDR = 0x21,
15 IPMI_CMD_RESERVE_DEVICE_SDR_REPO = 0x22,
Chris Austen10ccc0f2015-12-10 18:27:04 -060016 IPMI_CMD_GET_SENSOR_READING = 0x2D,
Patrick Venture0b02be92018-08-31 11:55:55 -070017 IPMI_CMD_GET_SENSOR_TYPE = 0x2F,
18 IPMI_CMD_SET_SENSOR = 0x30,
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -060019 IPMI_CMD_GET_SENSOR_THRESHOLDS = 0x27,
Chris Austenac4604a2015-10-13 12:43:27 -050020};
21
Ratan Guptae0cc8552018-01-22 14:23:04 +053022/**
23 * @enum device_type
24 * IPMI FRU device types
25 */
26enum device_type
27{
28 IPMI_PHYSICAL_FRU = 0x00,
29 IPMI_LOGICAL_FRU = 0x80,
30};
31
Emily Shaffer1fabf222017-04-05 08:53:21 -070032// Discrete sensor types.
33enum ipmi_sensor_types
34{
Patrick Venture0b02be92018-08-31 11:55:55 -070035 IPMI_SENSOR_TEMP = 0x01,
Emily Shaffer1fabf222017-04-05 08:53:21 -070036 IPMI_SENSOR_VOLTAGE = 0x02,
37 IPMI_SENSOR_CURRENT = 0x03,
Patrick Venture0b02be92018-08-31 11:55:55 -070038 IPMI_SENSOR_FAN = 0x04,
39 IPMI_SENSOR_TPM = 0xCC,
Emily Shaffer1fabf222017-04-05 08:53:21 -070040};
41
Brandon Kim9cf85622019-06-19 12:05:08 -070042/** @brief Custom exception for reading sensors that are not funcitonal.
43 */
44struct SensorFunctionalError : public std::exception
45{
46 const char* what() const noexcept
47 {
48 return "Sensor not functional";
49 }
50};
51
Chris Austen0012e9b2015-10-22 01:37:46 -050052#define MAX_DBUS_PATH 128
Patrick Venture0b02be92018-08-31 11:55:55 -070053struct dbus_interface_t
54{
55 uint8_t sensornumber;
56 uint8_t sensortype;
Chris Austen0012e9b2015-10-22 01:37:46 -050057
Patrick Venture0b02be92018-08-31 11:55:55 -070058 char bus[MAX_DBUS_PATH];
59 char path[MAX_DBUS_PATH];
60 char interface[MAX_DBUS_PATH];
Chris Austen0012e9b2015-10-22 01:37:46 -050061};
Tomd700e762016-09-20 18:24:13 +053062
Jia, Chunhui3342a8e2018-12-29 13:32:26 +080063struct PlatformEventRequest
64{
65 uint8_t eventMessageRevision;
66 uint8_t sensorType;
67 uint8_t sensorNumber;
68 uint8_t eventDirectionType;
69 uint8_t data[3];
70};
71
72static constexpr char const* ipmiSELPath = "/xyz/openbmc_project/Logging/IPMI";
73static constexpr char const* ipmiSELAddInterface =
74 "xyz.openbmc_project.Logging.IPMI";
75static const std::string ipmiSELAddMessage = "SEL Entry";
76
77static constexpr int selSystemEventSizeWith3Bytes = 8;
78static constexpr int selSystemEventSizeWith2Bytes = 7;
79static constexpr int selSystemEventSizeWith1Bytes = 6;
80static constexpr int selIPMBEventSize = 7;
81static constexpr uint8_t directionMask = 0x80;
82static constexpr uint8_t byte3EnableMask = 0x30;
83static constexpr uint8_t byte2EnableMask = 0xC0;
84
Patrick Venture0b02be92018-08-31 11:55:55 -070085int set_sensor_dbus_state_s(uint8_t, const char*, const char*);
86int set_sensor_dbus_state_y(uint8_t, const char*, const uint8_t);
87int find_openbmc_path(uint8_t, dbus_interface_t*);
Tom05732372016-09-06 17:21:23 +053088
Tom Joseph5ca50952018-02-22 00:33:38 +053089ipmi_ret_t ipmi_sen_get_sdr(ipmi_netfn_t netfn, ipmi_cmd_t cmd,
90 ipmi_request_t request, ipmi_response_t response,
91 ipmi_data_len_t data_len, ipmi_context_t context);
92
jayaprakash Mutyalad9578232019-05-13 20:22:50 +000093ipmi::RspType<uint16_t> ipmiSensorReserveSdr();
Tom Joseph5ca50952018-02-22 00:33:38 +053094
Ratan Guptae0cc8552018-01-22 14:23:04 +053095static const uint16_t FRU_RECORD_ID_START = 256;
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -080096static const uint16_t ENTITY_RECORD_ID_START = 512;
Ratan Guptae0cc8552018-01-22 14:23:04 +053097static const uint8_t SDR_VERSION = 0x51;
98static const uint16_t END_OF_RECORD = 0xFFFF;
99static const uint8_t LENGTH_MASK = 0x1F;
100
Tom Josephbe703f72017-03-09 12:34:35 +0530101/**
Emily Shafferd06e0e72017-04-05 09:08:57 -0700102 * Get SDR Info
103 */
104
105namespace get_sdr_info
106{
107namespace request
108{
109// Note: for some reason the ipmi_request_t appears to be the
110// raw value for this call.
111inline bool get_count(void* req)
112{
Patrick Venture0b02be92018-08-31 11:55:55 -0700113 return (bool)((uint64_t)(req)&1);
Emily Shafferd06e0e72017-04-05 09:08:57 -0700114}
115} // namespace request
Emily Shafferd06e0e72017-04-05 09:08:57 -0700116} // namespace get_sdr_info
Emily Shafferbbef71c2017-05-08 16:36:17 -0700117
118/**
119 * Get SDR
120 */
121namespace get_sdr
122{
123
124struct GetSdrReq
125{
126 uint8_t reservation_id_lsb;
127 uint8_t reservation_id_msb;
128 uint8_t record_id_lsb;
129 uint8_t record_id_msb;
130 uint8_t offset;
131 uint8_t bytes_to_read;
132} __attribute__((packed));
133
134namespace request
135{
136
Emily Shaffere5c9d2f2019-06-25 14:26:45 -0700137inline uint16_t get_reservation_id(GetSdrReq* req)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700138{
139 return (req->reservation_id_lsb + (req->reservation_id_msb << 8));
140};
141
Ratan Guptae0cc8552018-01-22 14:23:04 +0530142inline uint16_t get_record_id(GetSdrReq* req)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700143{
144 return (req->record_id_lsb + (req->record_id_msb << 8));
145};
146
147} // namespace request
148
149// Response
150struct GetSdrResp
151{
152 uint8_t next_record_id_lsb;
153 uint8_t next_record_id_msb;
154 uint8_t record_data[64];
155} __attribute__((packed));
156
157namespace response
158{
159
Ratan Guptae0cc8552018-01-22 14:23:04 +0530160inline void set_next_record_id(uint16_t next, GetSdrResp* resp)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700161{
162 resp->next_record_id_lsb = next & 0xff;
163 resp->next_record_id_msb = (next >> 8) & 0xff;
164};
165
166} // namespace response
167
168// Record header
169struct SensorDataRecordHeader
170{
171 uint8_t record_id_lsb;
172 uint8_t record_id_msb;
173 uint8_t sdr_version;
174 uint8_t record_type;
175 uint8_t record_length; // Length not counting the header
176} __attribute__((packed));
177
178namespace header
179{
180
181inline void set_record_id(int id, SensorDataRecordHeader* hdr)
182{
183 hdr->record_id_lsb = (id & 0xFF);
184 hdr->record_id_msb = (id >> 8) & 0xFF;
185};
186
187} // namespace header
188
189enum SensorDataRecordType
190{
Ratan Guptae0cc8552018-01-22 14:23:04 +0530191 SENSOR_DATA_FULL_RECORD = 0x1,
Hao Jiangda06d152021-01-19 15:27:43 -0800192 SENSOR_DATA_EVENT_RECORD = 0x3,
Ratan Guptae0cc8552018-01-22 14:23:04 +0530193 SENSOR_DATA_FRU_RECORD = 0x11,
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800194 SENSOR_DATA_ENTITY_RECORD = 0x8,
Emily Shafferbbef71c2017-05-08 16:36:17 -0700195};
196
197// Record key
198struct SensorDataRecordKey
199{
200 uint8_t owner_id;
201 uint8_t owner_lun;
202 uint8_t sensor_number;
203} __attribute__((packed));
204
Ratan Guptae0cc8552018-01-22 14:23:04 +0530205/** @struct SensorDataFruRecordKey
206 *
207 * FRU Device Locator Record(key) - SDR Type 11
208 */
209struct SensorDataFruRecordKey
210{
211 uint8_t deviceAddress;
212 uint8_t fruID;
213 uint8_t accessLun;
214 uint8_t channelNumber;
215} __attribute__((packed));
216
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800217/** @struct SensorDataEntityRecordKey
218 *
219 * Entity Association Record(key) - SDR Type 8
220 */
221struct SensorDataEntityRecordKey
222{
223 uint8_t containerEntityId;
224 uint8_t containerEntityInstance;
225 uint8_t flags;
226 uint8_t entityId1;
227 uint8_t entityInstance1;
228} __attribute__((packed));
229
Emily Shafferbbef71c2017-05-08 16:36:17 -0700230namespace key
231{
232
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800233static constexpr uint8_t listOrRangeBit = 7;
234static constexpr uint8_t linkedBit = 6;
235
Emily Shafferbbef71c2017-05-08 16:36:17 -0700236inline void set_owner_id_ipmb(SensorDataRecordKey* key)
237{
238 key->owner_id &= ~0x01;
239};
240
241inline void set_owner_id_system_sw(SensorDataRecordKey* key)
242{
243 key->owner_id |= 0x01;
244};
245
Tom Joseph96423912018-01-25 00:14:34 +0530246inline void set_owner_id_bmc(SensorDataRecordKey* key)
247{
248 key->owner_id |= 0x20;
249};
250
Emily Shafferbbef71c2017-05-08 16:36:17 -0700251inline void set_owner_id_address(uint8_t addr, SensorDataRecordKey* key)
252{
253 key->owner_id &= 0x01;
Patrick Venture0b02be92018-08-31 11:55:55 -0700254 key->owner_id |= addr << 1;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700255};
256
257inline void set_owner_lun(uint8_t lun, SensorDataRecordKey* key)
258{
259 key->owner_lun &= ~0x03;
Patrick Venture0b02be92018-08-31 11:55:55 -0700260 key->owner_lun |= (lun & 0x03);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700261};
262
263inline void set_owner_lun_channel(uint8_t channel, SensorDataRecordKey* key)
264{
265 key->owner_lun &= 0x0f;
Patrick Venture0b02be92018-08-31 11:55:55 -0700266 key->owner_lun |= ((channel & 0xf) << 4);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700267};
268
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800269inline void set_flags(bool isList, bool isLinked,
270 SensorDataEntityRecordKey* key)
271{
272 key->flags = 0x00;
273 if (!isList)
274 key->flags |= 1 << listOrRangeBit;
275
276 if (isLinked)
277 key->flags |= 1 << linkedBit;
278};
279
Emily Shafferbbef71c2017-05-08 16:36:17 -0700280} // namespace key
281
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600282/** @struct GetSensorThresholdsResponse
283 *
284 * Response structure for Get Sensor Thresholds command
285 */
286struct GetSensorThresholdsResponse
287{
Patrick Venture0b02be92018-08-31 11:55:55 -0700288 uint8_t validMask; //!< valid mask
289 uint8_t lowerNonCritical; //!< lower non-critical threshold
290 uint8_t lowerCritical; //!< lower critical threshold
291 uint8_t lowerNonRecoverable; //!< lower non-recoverable threshold
292 uint8_t upperNonCritical; //!< upper non-critical threshold
293 uint8_t upperCritical; //!< upper critical threshold
294 uint8_t upperNonRecoverable; //!< upper non-recoverable threshold
Dhruvaraj Subhashchandran5c0beec2018-01-23 04:47:06 -0600295} __attribute__((packed));
296
Emily Shafferbbef71c2017-05-08 16:36:17 -0700297// Body - full record
298#define FULL_RECORD_ID_STR_MAX_LENGTH 16
Ratan Guptae0cc8552018-01-22 14:23:04 +0530299
300static const int FRU_RECORD_DEVICE_ID_MAX_LENGTH = 16;
301
Emily Shafferbbef71c2017-05-08 16:36:17 -0700302struct SensorDataFullRecordBody
303{
304 uint8_t entity_id;
305 uint8_t entity_instance;
306 uint8_t sensor_initialization;
307 uint8_t sensor_capabilities; // no macro support
308 uint8_t sensor_type;
309 uint8_t event_reading_type;
Patrick Venture0b02be92018-08-31 11:55:55 -0700310 uint8_t supported_assertions[2]; // no macro support
311 uint8_t supported_deassertions[2]; // no macro support
Emily Shafferbbef71c2017-05-08 16:36:17 -0700312 uint8_t discrete_reading_setting_mask[2]; // no macro support
313 uint8_t sensor_units_1;
314 uint8_t sensor_units_2_base;
315 uint8_t sensor_units_3_modifier;
316 uint8_t linearization;
317 uint8_t m_lsb;
318 uint8_t m_msb_and_tolerance;
319 uint8_t b_lsb;
320 uint8_t b_msb_and_accuracy_lsb;
321 uint8_t accuracy_and_sensor_direction;
322 uint8_t r_b_exponents;
Patrick Venture0b02be92018-08-31 11:55:55 -0700323 uint8_t analog_characteristic_flags; // no macro support
Emily Shafferbbef71c2017-05-08 16:36:17 -0700324 uint8_t nominal_reading;
325 uint8_t normal_max;
326 uint8_t normal_min;
327 uint8_t sensor_max;
328 uint8_t sensor_min;
329 uint8_t upper_nonrecoverable_threshold;
330 uint8_t upper_critical_threshold;
331 uint8_t upper_noncritical_threshold;
332 uint8_t lower_nonrecoverable_threshold;
333 uint8_t lower_critical_threshold;
334 uint8_t lower_noncritical_threshold;
335 uint8_t positive_threshold_hysteresis;
336 uint8_t negative_threshold_hysteresis;
337 uint16_t reserved;
338 uint8_t oem_reserved;
339 uint8_t id_string_info;
Emily Shaffer10f49592017-05-10 12:01:10 -0700340 char id_string[FULL_RECORD_ID_STR_MAX_LENGTH];
Emily Shafferbbef71c2017-05-08 16:36:17 -0700341} __attribute__((packed));
342
Hao Jiangda06d152021-01-19 15:27:43 -0800343/** @struct SensorDataEventRecord
344 *
345 * Event Only Sensor Record(body) - SDR Type 3
346 */
347struct SensorDataEventRecordBody
348{
349 uint8_t entity_id;
350 uint8_t entity_instance;
351 uint8_t sensor_type;
352 uint8_t event_reading_type;
353 uint8_t sensor_record_sharing_1;
354 uint8_t sensor_record_sharing_2;
355 uint8_t reserved;
356 uint8_t oem_reserved;
357 uint8_t id_string_info;
358 char id_string[FULL_RECORD_ID_STR_MAX_LENGTH];
359} __attribute__((packed));
360
Ratan Guptae0cc8552018-01-22 14:23:04 +0530361/** @struct SensorDataFruRecordBody
362 *
363 * FRU Device Locator Record(body) - SDR Type 11
364 */
365struct SensorDataFruRecordBody
366{
367 uint8_t reserved;
368 uint8_t deviceType;
369 uint8_t deviceTypeModifier;
370 uint8_t entityID;
371 uint8_t entityInstance;
372 uint8_t oem;
373 uint8_t deviceIDLen;
374 char deviceID[FRU_RECORD_DEVICE_ID_MAX_LENGTH];
375} __attribute__((packed));
376
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800377/** @struct SensorDataEntityRecordBody
378 *
379 * Entity Association Record(body) - SDR Type 8
380 */
381struct SensorDataEntityRecordBody
382{
383 uint8_t entityId2;
384 uint8_t entityInstance2;
385 uint8_t entityId3;
386 uint8_t entityInstance3;
387 uint8_t entityId4;
388 uint8_t entityInstance4;
389} __attribute__((packed));
390
Emily Shafferbbef71c2017-05-08 16:36:17 -0700391namespace body
392{
393
394inline void set_entity_instance_number(uint8_t n,
395 SensorDataFullRecordBody* body)
396{
Patrick Venture0b02be92018-08-31 11:55:55 -0700397 body->entity_instance &= 1 << 7;
398 body->entity_instance |= (n & ~(1 << 7));
Emily Shafferbbef71c2017-05-08 16:36:17 -0700399};
400inline void set_entity_physical_entity(SensorDataFullRecordBody* body)
401{
Patrick Venture0b02be92018-08-31 11:55:55 -0700402 body->entity_instance &= ~(1 << 7);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700403};
404inline void set_entity_logical_container(SensorDataFullRecordBody* body)
405{
Patrick Venture0b02be92018-08-31 11:55:55 -0700406 body->entity_instance |= 1 << 7;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700407};
408
Patrick Venture0b02be92018-08-31 11:55:55 -0700409inline void sensor_scanning_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700410{
411 if (enabled)
412 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700413 body->sensor_initialization |= 1 << 0;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700414 }
415 else
416 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700417 body->sensor_initialization &= ~(1 << 0);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700418 };
419};
Patrick Venture0b02be92018-08-31 11:55:55 -0700420inline void event_generation_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700421{
422 if (enabled)
423 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700424 body->sensor_initialization |= 1 << 1;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700425 }
426 else
427 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700428 body->sensor_initialization &= ~(1 << 1);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700429 }
430};
Patrick Venture0b02be92018-08-31 11:55:55 -0700431inline void init_types_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700432{
433 if (enabled)
434 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700435 body->sensor_initialization |= 1 << 2;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700436 }
437 else
438 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700439 body->sensor_initialization &= ~(1 << 2);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700440 }
441};
Patrick Venture0b02be92018-08-31 11:55:55 -0700442inline void init_hyst_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700443{
444 if (enabled)
445 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700446 body->sensor_initialization |= 1 << 3;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700447 }
448 else
449 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700450 body->sensor_initialization &= ~(1 << 3);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700451 }
452};
Patrick Venture0b02be92018-08-31 11:55:55 -0700453inline void init_thresh_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700454{
455 if (enabled)
456 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700457 body->sensor_initialization |= 1 << 4;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700458 }
459 else
460 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700461 body->sensor_initialization &= ~(1 << 4);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700462 }
463};
Patrick Venture0b02be92018-08-31 11:55:55 -0700464inline void init_events_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700465{
466 if (enabled)
467 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700468 body->sensor_initialization |= 1 << 5;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700469 }
470 else
471 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700472 body->sensor_initialization &= ~(1 << 5);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700473 }
474};
Patrick Venture0b02be92018-08-31 11:55:55 -0700475inline void init_scanning_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700476{
477 if (enabled)
478 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700479 body->sensor_initialization |= 1 << 6;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700480 }
481 else
482 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700483 body->sensor_initialization &= ~(1 << 6);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700484 }
485};
Patrick Venture0b02be92018-08-31 11:55:55 -0700486inline void init_settable_state(bool enabled, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700487{
488 if (enabled)
489 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700490 body->sensor_initialization |= 1 << 7;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700491 }
492 else
493 {
Patrick Venture0b02be92018-08-31 11:55:55 -0700494 body->sensor_initialization &= ~(1 << 7);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700495 }
496};
497
498inline void set_percentage(SensorDataFullRecordBody* body)
499{
Patrick Venture0b02be92018-08-31 11:55:55 -0700500 body->sensor_units_1 |= 1 << 0;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700501};
502inline void unset_percentage(SensorDataFullRecordBody* body)
503{
Patrick Venture0b02be92018-08-31 11:55:55 -0700504 body->sensor_units_1 &= ~(1 << 0);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700505};
506inline void set_modifier_operation(uint8_t op, SensorDataFullRecordBody* body)
507{
Patrick Venture0b02be92018-08-31 11:55:55 -0700508 body->sensor_units_1 &= ~(3 << 1);
509 body->sensor_units_1 |= (op & 0x3) << 1;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700510};
511inline void set_rate_unit(uint8_t unit, SensorDataFullRecordBody* body)
512{
Patrick Venture0b02be92018-08-31 11:55:55 -0700513 body->sensor_units_1 &= ~(7 << 3);
514 body->sensor_units_1 |= (unit & 0x7) << 3;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700515};
516inline void set_analog_data_format(uint8_t format,
517 SensorDataFullRecordBody* body)
518{
Patrick Venture0b02be92018-08-31 11:55:55 -0700519 body->sensor_units_1 &= ~(3 << 6);
520 body->sensor_units_1 |= (format & 0x3) << 6;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700521};
522
Emily Shaffer7cad3fc2017-08-30 17:50:37 -0700523inline void set_m(uint16_t m, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700524{
525 body->m_lsb = m & 0xff;
Patrick Venture0b02be92018-08-31 11:55:55 -0700526 body->m_msb_and_tolerance &= ~(3 << 6);
527 body->m_msb_and_tolerance |= ((m & (3 << 8)) >> 2);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700528};
529inline void set_tolerance(uint8_t tol, SensorDataFullRecordBody* body)
530{
531 body->m_msb_and_tolerance &= ~0x3f;
532 body->m_msb_and_tolerance |= tol & 0x3f;
533};
534
Emily Shaffer7cad3fc2017-08-30 17:50:37 -0700535inline void set_b(uint16_t b, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700536{
537 body->b_lsb = b & 0xff;
Patrick Venture0b02be92018-08-31 11:55:55 -0700538 body->b_msb_and_accuracy_lsb &= ~(3 << 6);
539 body->b_msb_and_accuracy_lsb |= ((b & (3 << 8)) >> 2);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700540};
Emily Shaffer7cad3fc2017-08-30 17:50:37 -0700541inline void set_accuracy(uint16_t acc, SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700542{
Emily Shaffer7cad3fc2017-08-30 17:50:37 -0700543 // bottom 6 bits
Emily Shafferbbef71c2017-05-08 16:36:17 -0700544 body->b_msb_and_accuracy_lsb &= ~0x3f;
545 body->b_msb_and_accuracy_lsb |= acc & 0x3f;
Emily Shaffer7cad3fc2017-08-30 17:50:37 -0700546 // top 4 bits
Emily Shafferbbef71c2017-05-08 16:36:17 -0700547 body->accuracy_and_sensor_direction &= 0x0f;
Emily Shaffer7cad3fc2017-08-30 17:50:37 -0700548 body->accuracy_and_sensor_direction |= ((acc >> 6) & 0xf) << 4;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700549};
550inline void set_accuracy_exp(uint8_t exp, SensorDataFullRecordBody* body)
551{
Patrick Venture0b02be92018-08-31 11:55:55 -0700552 body->accuracy_and_sensor_direction &= ~(3 << 2);
553 body->accuracy_and_sensor_direction |= (exp & 3) << 2;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700554};
555inline void set_sensor_dir(uint8_t dir, SensorDataFullRecordBody* body)
556{
Patrick Venture0b02be92018-08-31 11:55:55 -0700557 body->accuracy_and_sensor_direction &= ~(3 << 0);
Emily Shafferbbef71c2017-05-08 16:36:17 -0700558 body->accuracy_and_sensor_direction |= (dir & 3);
559};
560
561inline void set_b_exp(uint8_t exp, SensorDataFullRecordBody* body)
562{
563 body->r_b_exponents &= 0xf0;
564 body->r_b_exponents |= exp & 0x0f;
565};
566inline void set_r_exp(uint8_t exp, SensorDataFullRecordBody* body)
567{
568 body->r_b_exponents &= 0x0f;
Patrick Venture0b02be92018-08-31 11:55:55 -0700569 body->r_b_exponents |= (exp & 0x0f) << 4;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700570};
571
572inline void set_id_strlen(uint8_t len, SensorDataFullRecordBody* body)
573{
574 body->id_string_info &= ~(0x1f);
575 body->id_string_info |= len & 0x1f;
576};
Willy Tueae88592022-12-13 14:28:02 -0800577inline void set_id_strlen(uint8_t len, SensorDataEventRecordBody* body)
578{
579 body->id_string_info &= ~(0x1f);
580 body->id_string_info |= len & 0x1f;
581};
Patrick Venture0b02be92018-08-31 11:55:55 -0700582inline uint8_t get_id_strlen(SensorDataFullRecordBody* body)
Emily Shafferbbef71c2017-05-08 16:36:17 -0700583{
584 return body->id_string_info & 0x1f;
585};
586inline void set_id_type(uint8_t type, SensorDataFullRecordBody* body)
587{
Patrick Venture0b02be92018-08-31 11:55:55 -0700588 body->id_string_info &= ~(3 << 6);
589 body->id_string_info |= (type & 0x3) << 6;
Emily Shafferbbef71c2017-05-08 16:36:17 -0700590};
Willy Tueae88592022-12-13 14:28:02 -0800591inline void set_id_type(uint8_t type, SensorDataEventRecordBody* body)
592{
593 body->id_string_info &= ~(3 << 6);
594 body->id_string_info |= (type & 0x3) << 6;
595};
Emily Shafferbbef71c2017-05-08 16:36:17 -0700596
Ratan Guptae0cc8552018-01-22 14:23:04 +0530597inline void set_device_id_strlen(uint8_t len, SensorDataFruRecordBody* body)
598{
599 body->deviceIDLen &= ~(LENGTH_MASK);
600 body->deviceIDLen |= len & LENGTH_MASK;
601};
602
603inline uint8_t get_device_id_strlen(SensorDataFruRecordBody* body)
604{
605 return body->deviceIDLen & LENGTH_MASK;
606};
607
Tom Josephdc212b22018-02-16 09:59:57 +0530608inline void set_readable_mask(uint8_t mask, SensorDataFullRecordBody* body)
609{
610 body->discrete_reading_setting_mask[1] = mask & 0x3F;
611}
612
Emily Shafferbbef71c2017-05-08 16:36:17 -0700613} // namespace body
614
615// More types contained in section 43.17 Sensor Unit Type Codes,
616// IPMI spec v2 rev 1.1
617enum SensorUnitTypeCodes
618{
619 SENSOR_UNIT_UNSPECIFIED = 0,
620 SENSOR_UNIT_DEGREES_C = 1,
621 SENSOR_UNIT_VOLTS = 4,
622 SENSOR_UNIT_AMPERES = 5,
Tom Josephdc212b22018-02-16 09:59:57 +0530623 SENSOR_UNIT_WATTS = 6,
Emily Shafferbbef71c2017-05-08 16:36:17 -0700624 SENSOR_UNIT_JOULES = 7,
Kirill Pakhomov812e44c2018-10-22 16:25:35 +0300625 SENSOR_UNIT_RPM = 18,
Emily Shafferbbef71c2017-05-08 16:36:17 -0700626 SENSOR_UNIT_METERS = 34,
627 SENSOR_UNIT_REVOLUTIONS = 41,
628};
629
630struct SensorDataFullRecord
631{
632 SensorDataRecordHeader header;
633 SensorDataRecordKey key;
634 SensorDataFullRecordBody body;
635} __attribute__((packed));
636
Hao Jiangda06d152021-01-19 15:27:43 -0800637/** @struct SensorDataEventRecord
638 *
639 * Event Only Sensor Record - SDR Type 3
640 */
641struct SensorDataEventRecord
642{
643 SensorDataRecordHeader header;
644 SensorDataRecordKey key;
645 SensorDataEventRecordBody body;
646} __attribute__((packed));
647
Ratan Guptae0cc8552018-01-22 14:23:04 +0530648/** @struct SensorDataFruRecord
649 *
650 * FRU Device Locator Record - SDR Type 11
651 */
652struct SensorDataFruRecord
653{
654 SensorDataRecordHeader header;
655 SensorDataFruRecordKey key;
656 SensorDataFruRecordBody body;
657} __attribute__((packed));
658
Jaghathiswari Rankappagounder Natarajan9c118942019-02-12 13:22:55 -0800659/** @struct SensorDataEntityRecord
660 *
661 * Entity Association Record - SDR Type 8
662 */
663struct SensorDataEntityRecord
664{
665 SensorDataRecordHeader header;
666 SensorDataEntityRecordKey key;
667 SensorDataEntityRecordBody body;
668} __attribute__((packed));
669
Patrick Venture0b02be92018-08-31 11:55:55 -0700670} // namespace get_sdr
Tom Joseph816e92b2017-09-06 19:23:00 +0530671
672namespace ipmi
673{
674
675namespace sensor
676{
677
678/**
679 * @brief Map offset to the corresponding bit in the assertion byte.
680 *
Gunnar Mills8991dd62017-10-25 17:11:29 -0500681 * The discrete sensors support up to 14 states. 0-7 offsets are stored in one
Tom Joseph816e92b2017-09-06 19:23:00 +0530682 * byte and offsets 8-14 in the second byte.
683 *
684 * @param[in] offset - offset number.
685 * @param[in/out] resp - get sensor reading response.
686 */
Sui Chen4cc42552019-09-11 10:28:35 -0700687inline void setOffset(uint8_t offset, ipmi::sensor::GetSensorResponse* resp)
Tom Joseph816e92b2017-09-06 19:23:00 +0530688{
689 if (offset > 7)
690 {
Sui Chen4cc42552019-09-11 10:28:35 -0700691 resp->discreteReadingSensorStates |= 1 << (offset - 8);
Tom Joseph816e92b2017-09-06 19:23:00 +0530692 }
693 else
694 {
Sui Chen4cc42552019-09-11 10:28:35 -0700695 resp->thresholdLevelsStates |= 1 << offset;
Tom Joseph816e92b2017-09-06 19:23:00 +0530696 }
697}
698
Tom Josephe4014fc2017-09-06 23:57:36 +0530699/**
700 * @brief Set the reading field in the response.
701 *
702 * @param[in] offset - offset number.
703 * @param[in/out] resp - get sensor reading response.
704 */
Sui Chen4cc42552019-09-11 10:28:35 -0700705inline void setReading(uint8_t value, ipmi::sensor::GetSensorResponse* resp)
Tom Josephe4014fc2017-09-06 23:57:36 +0530706{
707 resp->reading = value;
708}
709
Tom Joseph295f17e2017-09-07 00:09:46 +0530710/**
711 * @brief Map the value to the assertion bytes. The assertion states are stored
712 * in 2 bytes.
713 *
714 * @param[in] value - value to mapped to the assertion byte.
715 * @param[in/out] resp - get sensor reading response.
716 */
717inline void setAssertionBytes(uint16_t value,
Sui Chen4cc42552019-09-11 10:28:35 -0700718 ipmi::sensor::GetSensorResponse* resp)
Tom Joseph295f17e2017-09-07 00:09:46 +0530719{
Sui Chen4cc42552019-09-11 10:28:35 -0700720 resp->thresholdLevelsStates = static_cast<uint8_t>(value & 0x00FF);
721 resp->discreteReadingSensorStates = static_cast<uint8_t>(value >> 8);
Tom Joseph295f17e2017-09-07 00:09:46 +0530722}
723
Tom Josephe05b2922017-09-07 00:43:16 +0530724/**
725 * @brief Set the scanning enabled bit in the response.
726 *
727 * @param[in/out] resp - get sensor reading response.
728 */
Sui Chen4cc42552019-09-11 10:28:35 -0700729inline void enableScanning(ipmi::sensor::GetSensorResponse* resp)
Tom Josephe05b2922017-09-07 00:43:16 +0530730{
Sui Chen4cc42552019-09-11 10:28:35 -0700731 resp->readingOrStateUnavailable = false;
732 resp->scanningEnabled = true;
733 resp->allEventMessagesEnabled = false;
Tom Josephe05b2922017-09-07 00:43:16 +0530734}
735
Tom Joseph816e92b2017-09-06 19:23:00 +0530736} // namespace sensor
737
738} // namespace ipmi