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 enum class IPMINetfnStorageCmds : ipmi_cmd_t
77 {
78     ipmiCmdGetRepositoryInfo = 0x20,
79     ipmiCmdGetSDRAllocationInfo = 0x21,
80     ipmiCmdReserveSDR = 0x22,
81     ipmiCmdGetSDR = 0x23,
82 };
83 
84 #pragma pack(push, 1)
85 struct FRUHeader
86 {
87     uint8_t commonHeaderFormat;
88     uint8_t internalOffset;
89     uint8_t chassisOffset;
90     uint8_t boardOffset;
91     uint8_t productOffset;
92     uint8_t multiRecordOffset;
93     uint8_t pad;
94     uint8_t checksum;
95 };
96 #pragma pack(pop)
97 
98 #pragma pack(push, 1)
99 struct Type12Record
100 {
101     get_sdr::SensorDataRecordHeader header;
102     uint8_t slaveAddress;
103     uint8_t channelNumber;
104     uint8_t powerStateNotification;
105     uint8_t deviceCapabilities;
106     uint24_t reserved;
107     uint8_t entityID;
108     uint8_t entityInstance;
109     uint8_t oem;
110     uint8_t typeLengthCode;
111     char name[16];
112 };
113 #pragma pack(pop)
114 
115 #pragma pack(push, 1)
116 struct NMDiscoveryRecord
117 {
118     get_sdr::SensorDataRecordHeader header;
119     uint8_t oemID0;
120     uint8_t oemID1;
121     uint8_t oemID2;
122     uint8_t subType;
123     uint8_t version;
124     uint8_t slaveAddress;
125     uint8_t channelNumber;
126     uint8_t healthEventSensor;
127     uint8_t exceptionEventSensor;
128     uint8_t operationalCapSensor;
129     uint8_t thresholdExceededSensor;
130 };
131 #pragma pack(pop)
132 
133 namespace ipmi
134 {
135 namespace storage
136 {
137 
138 constexpr const size_t nmDiscoverySDRCount = 1;
139 constexpr const size_t type12Count = 2;
140 ipmi_ret_t getFruSdrs(ipmi::Context::ptr ctx, size_t index,
141                       get_sdr::SensorDataFruRecord& resp);
142 
143 ipmi_ret_t getFruSdrCount(ipmi::Context::ptr ctx, size_t& count);
144 
145 std::vector<uint8_t> getType12SDRs(uint16_t index, uint16_t recordId);
146 std::vector<uint8_t> getNMDiscoverySDR(uint16_t index, uint16_t recordId);
147 } // namespace storage
148 } // namespace ipmi
149