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