1 /*
2 // Copyright (c) 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 
19 #include <ipmid/api-types.hpp>
20 #include <user_channel/user_layer.hpp>
21 namespace ipmi
22 {
23 namespace intel
24 {
25 
26 static constexpr NetFn netFnGeneral = netFnOemOne;
27 static constexpr NetFn netFnPlatform = netFnOemTwo;
28 static constexpr NetFn netFnApp = netFnOemEight;
29 
30 namespace general
31 {
32 static constexpr Cmd cmdRestoreConfiguration = 0x02;
33 static constexpr Cmd cmdGetSmSignal = 0x14;
34 static constexpr Cmd cmdSetSmSignal = 0x15;
35 static constexpr Cmd cmdSetBIOSID = 0x26;
36 static constexpr Cmd cmdGetOEMDeviceInfo = 0x27;
37 static constexpr Cmd cmdSetColdRedundancyConfig = 0x2d;
38 static constexpr Cmd cmdGetColdRedundancyConfig = 0x2e;
39 static constexpr Cmd cmdGetAICSlotFRUIDSlotPosRecords = 0x31;
40 static constexpr Cmd cmdGetMultiNodeRole = 0x33;
41 static constexpr Cmd cmdGetMultiNodeId = 0x36;
42 static constexpr Cmd cmdSetSystemGUID = 0x41;
43 static constexpr Cmd cmdDisableBMCSystemReset = 0x42;
44 static constexpr Cmd cmdGetBMCResetDisables = 0x43;
45 static constexpr Cmd cmdSendEmbeddedFWUpdStatus = 0x44;
46 static constexpr Cmd cmdSlotI2CMasterWriteRead = 0x52;
47 static constexpr Cmd cmdSetPowerRestoreDelay = 0x54;
48 static constexpr Cmd cmdGetPowerRestoreDelay = 0x55;
49 static constexpr Cmd cmdSetFaultIndication = 0x57;
50 static constexpr Cmd cmdSetOEMUser2Activation = 0x5A;
51 static constexpr Cmd cmdSetSpecialUserPassword = 0x5F;
52 static constexpr Cmd cmdSetShutdownPolicy = 0x60;
53 static constexpr Cmd cmdGetShutdownPolicy = 0x62;
54 static constexpr Cmd cmdGetMultiNodePresence = 0x63;
55 static constexpr Cmd cmdGetBufferSize = 0x66;
56 static constexpr Cmd cmdSetFanConfig = 0x89;
57 static constexpr Cmd cmdGetFanConfig = 0x8a;
58 static constexpr Cmd cmdSetFanSpeedOffset = 0x8c;
59 static constexpr Cmd cmdGetFanSpeedOffset = 0x8d;
60 static constexpr Cmd cmdSetDimmOffset = 0x8e;
61 static constexpr Cmd cmdGetDimmOffset = 0x8f;
62 static constexpr Cmd cmdSetFscParameter = 0x90;
63 static constexpr Cmd cmdGetFscParameter = 0x91;
64 static constexpr Cmd cmdGetChassisIdentifier = 0x92;
65 static constexpr Cmd cmdReadBaseBoardProductId = 0x93;
66 static constexpr Cmd cmdGetProcessorErrConfig = 0x9A;
67 static constexpr Cmd cmdSetProcessorErrConfig = 0x9B;
68 static constexpr Cmd cmdSetManufacturingData = 0xA1;
69 static constexpr Cmd cmdGetManufacturingData = 0xA2;
70 static constexpr Cmd cmdGetLEDStatus = 0xB0;
71 static constexpr Cmd cmdControlBmcServices = 0xB1;
72 static constexpr Cmd cmdGetBmcServiceStatus = 0xB2;
73 static constexpr Cmd cmdGetSecurityMode = 0xB3;
74 static constexpr Cmd cmdSetSecurityMode = 0xB4;
75 static constexpr Cmd cmdMtmKeepAlive = 0xB5;
76 static constexpr Cmd cmdOEMGetReading = 0xE2;
77 static constexpr Cmd cmdGetNmiStatus = 0xE5;
78 static constexpr Cmd cmdSetEfiBootOptions = 0xEA;
79 static constexpr Cmd cmdGetEfiBootOptions = 0xEB;
80 static constexpr Cmd cmdSetNmiStatus = 0xED;
81 static constexpr Cmd cmdGetPSUVersion = 0xEF;
82 } // namespace general
83 
84 namespace platform
85 {
86 static constexpr Cmd cmdCfgHostSerialPortSpeed = 0x90;
87 static constexpr Cmd cmdClearCMOS = 0x91;
88 } // namespace platform
89 
90 namespace app
91 {
92 static constexpr Cmd cmdMdrStatus = 0x20;
93 static constexpr Cmd cmdMdrComplete = 0x21;
94 static constexpr Cmd cmdMdrEvent = 0x22;
95 static constexpr Cmd cmdMdrRead = 0x23;
96 static constexpr Cmd cmdMdrWrite = 0x24;
97 static constexpr Cmd cmdMdrLock = 0x25;
98 static constexpr Cmd cmdMdrIIAgentStatus = 0x30;
99 static constexpr Cmd cmdMdrIIGetDir = 0x31;
100 static constexpr Cmd cmdMdrIIGetDataInfo = 0x32;
101 static constexpr Cmd cmdMdrIILockData = 0x33;
102 static constexpr Cmd cmdMdrIIUnlockData = 0X34;
103 static constexpr Cmd cmdMdrIIGetDataBlock = 0x35;
104 static constexpr Cmd cmdMdrIISendDir = 0x38;
105 static constexpr Cmd cmdMdrIISendDataInfoOffer = 0x39;
106 static constexpr Cmd cmdMdrIISendDataInfo = 0x3a;
107 static constexpr Cmd cmdMdrIIDataStart = 0x3b;
108 static constexpr Cmd cmdMdrIIDataDone = 0x3c;
109 static constexpr Cmd cmdMdrIISendDataBlock = 0x3d;
110 static constexpr Cmd cmdSlotIpmb = 0x51;
111 } // namespace app
112 
113 } // namespace intel
114 
115 } // namespace ipmi
116 
117 // FIXME: put these in the cpp files that use them
118 enum class IPMIIntelOEMReturnCodes
119 {
120     ipmiCCPayloadActive = 0x80,
121     ipmiCCInvalidPCIESlotID = 0x80,
122     ipmiCCParameterNotSupported = 0x80,
123     ipmiCCPayloadAlreadyDeactivated = 0x80,
124     ipmiCCSetInProcess = 0x81,
125     ipmiCCPayloadDisable = 0x81,
126     ipmiCCLostArbitration = 0x81,
127     ipmiCCInvalidCablePortIndex = 0x81,
128     ipmiCCHealthStatusNotAvailable = 0x81,
129     ipmiCCBusError = 0x82,
130     ipmiCCReadOnly = 0x82,
131     ipmiCCWriteOnly = 0x82,
132     ipmiCCNoCablePresent = 0x82,
133     ipmiCCDataCollectionInProgress = 0x82,
134     ipmiCCPayloadActivationLimitReached = 0x82,
135     ipmiCCNACKOnWrite = 0x83,
136     ipmiCCDataCollectionFailed = 0x83,
137     ipmiCCCanNotActivateWithEncrption = 0x83,
138     ipmiCCCanNotActivateWithoutEncryption = 0x84,
139     ipmiCCInvalidChecksum = 0x85,
140     ipmiCCNoCabledPCIEPortsAvailable = 0xC2,
141 
142 };
143 
144 enum class IPMIReturnCodeExt
145 {
146     ipmiCCInvalidLUN = 0xC2,
147     ipmiCCTimeout = 0xC3,
148     ipmiCCStorageLeak = 0xC4,
149     ipmiCCRequestDataTruncated = 0xC6,
150     ipmiCCRequestDataFieldLengthLimitExceeded = 0xC8,
151     ipmiCCCanNotReturnNumberOfRequestedDataBytes = 0xCA,
152     ipmiCCRequestSensorDataRecordNotFound = 0xCB,
153     ipmiCCDestinationUnavailable = 0xD3,
154     ipmiCCParamterNotSupportInPresentState = 0xD5,
155 };
156 
157 static constexpr const uint8_t maxBIOSIDLength = 0xFF;
158 static constexpr const uint8_t maxCPUNum = 4;
159 static constexpr const char* biosActiveObjPath =
160     "/xyz/openbmc_project/software/bios_active";
161 static constexpr const char* biosVersionIntf =
162     "xyz.openbmc_project.Software.Version";
163 static constexpr const char* biosVersionProp = "Version";
164 
165 static constexpr const char* powerRestoreDelayObjPath =
166     "/xyz/openbmc_project/control/power_restore_delay";
167 static constexpr const char* powerRestoreDelayIntf =
168     "xyz.openbmc_project.Control.Power.RestoreDelay";
169 static constexpr const char* powerRestoreDelayProp = "PowerRestoreDelay";
170 static constexpr const char* processorErrConfigObjPath =
171     "/xyz/openbmc_project/control/processor_error_config";
172 static constexpr const char* processorErrConfigIntf =
173     "xyz.openbmc_project.Control.Processor.ErrConfig";
174 static constexpr const char* bmcResetDisablesPath =
175     "/xyz/openbmc_project/control/bmc_reset_disables";
176 static constexpr const char* bmcResetDisablesIntf =
177     "xyz.openbmc_project.Control.ResetDisables";
178 
179 static constexpr const char* postCodesObjPath =
180     "/xyz/openbmc_project/State/Boot/PostCode";
181 static constexpr const char* postCodesIntf =
182     "xyz.openbmc_project.State.Boot.PostCode";
183 
184 static constexpr const char* identifyLEDObjPath =
185     "/xyz/openbmc_project/led/physical/identify";
186 static constexpr const char* ledIntf = "xyz.openbmc_project.Led.Physical";
187 static constexpr const char* statusAmberObjPath =
188     "/xyz/openbmc_project/led/physical/status_amber";
189 static constexpr const char* statusGreenObjPath =
190     "/xyz/openbmc_project/led/physical/status_green";
191 
192 static constexpr const uint8_t noShutdownOnOCOT = 0;
193 static constexpr const uint8_t shutdownOnOCOT = 1;
194 static constexpr const uint8_t noShutdownPolicySupported = 0;
195 static constexpr const uint8_t shutdownPolicySupported = 1;
196 static constexpr const char* oemShutdownPolicyIntf =
197     "com.intel.Control.OCOTShutdownPolicy";
198 static constexpr const char* oemShutdownPolicyObjPath =
199     "/com/intel/control/ocotshutdown_policy_config";
200 static constexpr const char* oemShutdownPolicyObjPathProp = "OCOTPolicy";
201 
202 static constexpr const char* fwGetEnvCmd = "/sbin/fw_printenv";
203 static constexpr const char* fwSetEnvCmd = "/sbin/fw_setenv";
204 static constexpr const char* fwHostSerailCfgEnvName = "hostserialcfg";
205 
206 constexpr const char* settingsBusName = "xyz.openbmc_project.Settings";
207 
208 static constexpr const uint8_t getHostSerialCfgCmd = 0;
209 static constexpr const uint8_t setHostSerialCfgCmd = 1;
210 
211 // parameters:
212 // 0: host serial port 1 and 2 normal speed
213 // 1: host serial port 1 high spend, port 2 normal speed
214 // 2: host serial port 1 normal spend, port 2 high speed
215 // 3: host serial port 1 and 2 high speed
216 static constexpr const uint8_t HostSerialCfgParamMax = 3;
217 static constexpr uint8_t ipmiDefaultUserId = 2;
218 
219 static constexpr const uint8_t selEvtTargetMask = 0xF0;
220 static constexpr const uint8_t selEvtTargetShift = 4;
221 
222 static constexpr const uint8_t targetInstanceMask = 0x0E;
223 static constexpr const uint8_t targetInstanceShift = 1;
224 
225 enum class IPMINetfnIntelOEMAppCmd
226 {
227     mdrStatus = 0x20,
228     mdrComplete = 0x21,
229     mdrEvent = 0x22,
230     mdrRead = 0x23,
231     mdrWrite = 0x24,
232     mdrLock = 0x25,
233     mdr2AgentStatus = 0x30,
234     mdr2GetDir = 0x31,
235     mdr2GetDataInfo = 0x32,
236     mdr2LockData = 0x33,
237     mdr2UnlockData = 0x34,
238     mdr2GetDataBlock = 0x35,
239     mdr2SendDir = 0x38,
240     mdr2SendDataInfoOffer = 0x39,
241     mdr2SendDataInfo = 0x3a,
242     mdr2DataStart = 0x3b,
243     mdr2DataDone = 0x3c,
244     mdr2SendDataBlock = 0x3d,
245 };
246 
247 enum class OEMDevEntityType
248 {
249     biosId,
250     devVer,
251     sdrVer,
252 };
253 
254 enum class FWUpdateTarget : uint8_t
255 {
256     targetBMC = 0x0,
257     targetBIOS = 0x1,
258     targetME = 0x2,
259     targetOEMEWS = 0x4,
260 };
261 
262 enum class CPUStatus
263 {
264     disabled = 0x0,
265     enabled = 0x1,
266     notPresent = 0x3,
267 };
268 
269 #pragma pack(push, 1)
270 struct GUIDData
271 {
272     uint8_t node1;
273     uint8_t node2;
274     uint8_t node3;
275     uint8_t node4;
276     uint8_t node5;
277     uint8_t node6;
278     uint8_t clock1;
279     uint8_t clock2;
280     uint8_t timeHigh1;
281     uint8_t timeHigh2;
282     uint8_t timeMid1;
283     uint8_t timeMid2;
284     uint8_t timeLow1;
285     uint8_t timeLow2;
286     uint8_t timeLow3;
287     uint8_t timeLow4;
288 };
289 
290 struct DeviceInfo
291 {
292     uint8_t biosIDLength;
293     uint8_t biosId[maxBIOSIDLength];
294 };
295 
296 struct SetPowerRestoreDelayReq
297 {
298     uint8_t byteMSB;
299     uint8_t byteLSB;
300 };
301 
302 struct GetPowerRestoreDelayRes
303 {
304     uint8_t byteMSB;
305     uint8_t byteLSB;
306 };
307 
308 struct GetOemDeviceInfoRes
309 {
310     uint8_t resDatalen;
311     uint8_t data[maxBIOSIDLength];
312 };
313 
314 struct GetOEMShutdownPolicyRes
315 {
316     uint8_t policy;
317     uint8_t policySupport;
318 };
319 
320 struct CfgHostSerialReq
321 {
322     uint8_t command;
323     uint8_t parameter;
324 };
325 #pragma pack(pop)
326 
327 //
328 // Fault type enumeration
329 //
330 enum class RemoteFaultType
331 {
332     fan,         // 0
333     temperature, // 1
334     power,       // 2
335     driveslot,   // 3
336     software,    // 4
337     memory,      // 5
338     max = 6      // 6
339 };
340 
341 // Enumeration for remote fault states as required by the HSC
342 //
343 enum class RemoteFaultState
344 {
345     // fault indicators
346     fanLEDs,
347     cpu1DimmLeds,
348     cpu2DimmLeds,
349     cpu3DimmLeds,
350     cpu4DimmLeds,
351     maxFaultState,
352 };
353 
354 enum class DimmFaultType
355 {
356     cpu1cpu2Dimm,
357     cpu3cpu4Dimm,
358     maxFaultGroup,
359 };
360 
361 enum class setFscParamFlags : uint8_t
362 {
363     tcontrol = 0x1,
364     pwmOffset = 0x2,
365     maxPwm = 0x3,
366     cfm = 0x4
367 };
368 
369 enum class dimmOffsetTypes : uint8_t
370 {
371     staticCltt = 0x0,
372     dimmPower = 0x2
373 };
374 
375 // FIXME: this stuff needs to be rewritten
376 enum IPMI_INTEL_OEM_RETURN_CODES
377 {
378     IPMI_CC_OEM_PAYLOAD_ACTIVE = 0x80,
379     IPMI_CC_OEM_INVALID_PCIE_SLOTID = 0x80,
380     IPMI_CC_OEM_PARAMETER_NOT_SUPPORTED = 0x80,
381     IPMI_CC_OEM_PAYLOAD_ALREADY_DEACTIVATED = 0x80,
382     IPMI_CC_OEM_SET_IN_PROCESS = 0x81,
383     IPMI_CC_OEM_PAYLOAD_DISABLE = 0x81,
384     IPMI_CC_OEM_LOST_ARBITRATION = 0x81,
385     IPMI_CC_OEM_INVALID_CABLE_PORT_INDEX = 0x81,
386     IPMI_CC_OEM_HEALTH_STATUS_NOT_AVAILABLE = 0x81,
387     IPMI_CC_OEM_BUS_ERROR = 0x82,
388     IPMI_CC_OEM_READ_ONLY = 0x82,
389     IPMI_CC_OEM_WRITE_ONLY = 0x82,
390     IPMI_CC_OEM_NO_CABLE_PRESENT = 0x82,
391     IPMI_CC_OEM_DATA_COLLECTION_IN_PROGRESS = 0x82,
392     IPMI_CC_OEM_PAYLOAD_ACTIVATION_LIMIT_REACH = 0x82,
393     IPMI_CC_OEM_NACK_ON_WRITE = 0x83,
394     IPMI_CC_OEM_DATA_COLLECTION_FAILED = 0x83,
395     IPMI_CC_OEM_CAN_NOT_ACTIVATE_WITH_ENCRYPTION = 0x83,
396     IPMI_CC_OEM_CAN_NOT_ACTIVATE_WITHOUT_ENCRYPTION = 0x84,
397     IPMI_CC_OEM_INVALID_CHECKSUM = 0x85,
398     IPMI_CC_OEM_NO_CABLED_PCIE_PORTS_AVAILABLE = 0xC2,
399 };
400 
401 enum IPMI_RETURN_CODE_EXT
402 {
403     IPMI_CC_INVALID_LUN = 0xC2,
404     IPMI_CC_STORGE_LEAK = 0xC4,
405     IPMI_CC_REQUEST_DATA_TRUNCATED = 0xC6,
406     IPMI_CC_REQUEST_DATA_FIELD_LENGTH_LIMIT_EXCEEDED = 0xC8,
407     IPMI_CC_CANNOT_RETURN_NUMBER_OF_REQUESTED_DATA_BYTES = 0xCA,
408     IPMI_CC_REQUEST_SENSOR_DATA_RECORD_NOT_FOUND = 0xCB,
409     IPMI_CC_DESTINATION_UNAVAILABLE = 0xD3,
410     IPMI_CC_PARAMETER_NOT_SUPPORT_IN_PRESENT_STATE = 0xD5,
411 };
412