1 /*
2 // Copyright (c) 2017 2018 Intel Corporation
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //      http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 */
16 
17 #pragma once
18 #include <phosphor-ipmi-host/sensorhandler.hpp>
19 
20 #include <cstdint>
21 
22 static constexpr uint8_t ipmiSdrVersion = 0x51;
23 
24 namespace intel_oem::ipmi::sel
25 {
26 static constexpr uint8_t selOperationSupport = 0x02;
27 static constexpr uint8_t systemEvent = 0x02;
28 static constexpr size_t systemEventSize = 3;
29 static constexpr uint8_t oemTsEventFirst = 0xC0;
30 static constexpr uint8_t oemTsEventLast = 0xDF;
31 static constexpr size_t oemTsEventSize = 9;
32 static constexpr uint8_t oemEventFirst = 0xE0;
33 static constexpr uint8_t oemEventLast = 0xFF;
34 static constexpr size_t oemEventSize = 13;
35 static constexpr uint8_t eventMsgRev = 0x04;
36 } // namespace intel_oem::ipmi::sel
37 
38 #pragma pack(push, 1)
39 struct GetSDRReq
40 {
41     uint16_t reservationID;
42     uint16_t recordID;
43     uint8_t offset;
44     uint8_t bytesToRead;
45 };
46 #pragma pack(pop)
47 
48 enum class SdrRepositoryInfoOps : uint8_t
49 {
50     allocCommandSupported = 0x1,
51     reserveSDRRepositoryCommandSupported = 0x2,
52     partialAddSDRSupported = 0x4,
53     deleteSDRSupported = 0x8,
54     reserved = 0x10,
55     modalLSB = 0x20,
56     modalMSB = 0x40,
57     overflow = 0x80
58 };
59 
60 enum class GetFRUAreaAccessType : uint8_t
61 {
62     byte = 0x0,
63     words = 0x1
64 };
65 
66 enum class SensorUnits : uint8_t
67 {
68     unspecified = 0x0,
69     degreesC = 0x1,
70     volts = 0x4,
71     amps = 0x5,
72     watts = 0x6,
73     rpm = 0x12,
74 };
75 
76 #pragma pack(push, 1)
77 struct FRUHeader
78 {
79     uint8_t commonHeaderFormat;
80     uint8_t internalOffset;
81     uint8_t chassisOffset;
82     uint8_t boardOffset;
83     uint8_t productOffset;
84     uint8_t multiRecordOffset;
85     uint8_t pad;
86     uint8_t checksum;
87 };
88 #pragma pack(pop)
89 
90 #pragma pack(push, 1)
91 struct Type12Record
92 {
93     get_sdr::SensorDataRecordHeader header;
94     uint8_t targetAddress;
95     uint8_t channelNumber;
96     uint8_t powerStateNotification;
97     uint8_t deviceCapabilities;
98     // define reserved bytes explicitly. The uint24_t is silently expanded to
99     // uint32_t, which ruins the byte alignment required by this structure.
100     uint8_t reserved[3];
101     uint8_t entityID;
102     uint8_t entityInstance;
103     uint8_t oem;
104     uint8_t typeLengthCode;
105     char name[16];
106 
107     Type12Record(uint16_t recordID, uint8_t address, uint8_t chNumber,
108                  uint8_t pwrStateNotification, uint8_t capabilities,
109                  uint8_t eid, uint8_t entityInst, uint8_t mfrDefined,
110                  const std::string& sensorname) :
111         targetAddress(address),
112         channelNumber(chNumber), powerStateNotification(pwrStateNotification),
113         deviceCapabilities(capabilities), reserved{}, entityID(eid),
114         entityInstance(entityInst), oem(mfrDefined)
115     {
116         get_sdr::header::set_record_id(recordID, &header);
117         header.sdr_version = ipmiSdrVersion;
118         header.record_type = 0x12;
119         size_t nameLen = std::min(sensorname.size(), sizeof(name));
120         header.record_length = sizeof(Type12Record) -
121                                sizeof(get_sdr::SensorDataRecordHeader) -
122                                sizeof(name) + nameLen;
123         typeLengthCode = 0xc0 | nameLen;
124         std::copy(sensorname.begin(), sensorname.begin() + nameLen, name);
125     }
126 };
127 #pragma pack(pop)
128 
129 #pragma pack(push, 1)
130 struct NMDiscoveryRecord
131 {
132     get_sdr::SensorDataRecordHeader header;
133     uint8_t oemID0;
134     uint8_t oemID1;
135     uint8_t oemID2;
136     uint8_t subType;
137     uint8_t version;
138     uint8_t targetAddress;
139     uint8_t channelNumber;
140     uint8_t healthEventSensor;
141     uint8_t exceptionEventSensor;
142     uint8_t operationalCapSensor;
143     uint8_t thresholdExceededSensor;
144 };
145 #pragma pack(pop)
146 
147 namespace ipmi
148 {
149 namespace storage
150 {
151 
152 constexpr const size_t nmDiscoverySDRCount = 1;
153 constexpr const size_t type12Count = 2;
154 ipmi::Cc getFruSdrs(ipmi::Context::ptr& ctx, size_t index,
155                     get_sdr::SensorDataFruRecord& resp);
156 
157 ipmi::Cc getFruSdrCount(ipmi::Context::ptr& ctx, size_t& count);
158 
159 std::vector<uint8_t> getType12SDRs(uint16_t index, uint16_t recordId);
160 std::vector<uint8_t> getNMDiscoverySDR(uint16_t index, uint16_t recordId);
161 } // namespace storage
162 } // namespace ipmi
163