1 #ifndef __HOST_IPMID_IPMI_COMMON_H__ 2 #define __HOST_IPMID_IPMI_COMMON_H__ 3 4 #include <systemd/sd-bus.h> 5 6 #include <cstddef> 7 8 /* 9 * Specifies the minimum privilege level required to execute the command 10 * This means the command can be executed at a given privilege level or higher 11 * privilege level. Those commands which can be executed via system interface 12 * only should use SYSTEM_INTERFACE 13 */ 14 enum CommandPrivilege 15 { 16 PRIVILEGE_CALLBACK = 0x01, 17 PRIVILEGE_USER, 18 PRIVILEGE_OPERATOR, 19 PRIVILEGE_ADMIN, 20 PRIVILEGE_OEM, 21 SYSTEM_INTERFACE = 0xFF, 22 }; 23 24 // length of Completion Code and its ALWAYS _1_ 25 #define IPMI_CC_LEN 1 26 27 // IPMI Net Function number as specified by IPMI V2.0 spec. 28 // Example : 29 // NETFUN_APP = (0x06 << 2), 30 typedef unsigned char ipmi_netfn_t; 31 32 // IPMI Command for a Net Function number as specified by IPMI V2.0 spec. 33 typedef unsigned char ipmi_cmd_t; 34 35 // Buffer containing data from sender of netfn and command as part of request 36 typedef void* ipmi_request_t; 37 38 // This is the response buffer that the provider of [netfn,cmd] will send back 39 // to the caller. Provider will allocate the memory inside the handler and then 40 // will do a memcpy to this response buffer and also will set the data size 41 // parameter to the size of the buffer. 42 // EXAMPLE : 43 // unsigned char str[] = {0x00, 0x01, 0xFE, 0xFF, 0x0A, 0x01}; 44 // *data_len = 6; 45 // memcpy(response, &str, *data_len); 46 typedef void* ipmi_response_t; 47 48 // This buffer contains any *user specific* data that is of interest only to the 49 // plugin. For a ipmi function router, this data is opaque. At the time of 50 // registering the plugin handlers, plugin may optionally allocate a memory and 51 // fill in whatever needed that will be of help during the actual handling of 52 // command. IPMID will just pass the netfn, cmd and also this data to plugins 53 // during the command handler invocation. 54 typedef void* ipmi_context_t; 55 56 // Length of request / response buffer depending on whether the data is a 57 // request or a response from a plugin handler. 58 typedef std::size_t* ipmi_data_len_t; 59 60 // Plugin function return the status code 61 typedef unsigned char ipmi_ret_t; 62 63 typedef enum CommandPrivilege ipmi_cmd_privilege_t; 64 65 // This is the callback handler that the plugin registers with IPMID. IPMI 66 // function router will then make a call to this callback handler with the 67 // necessary arguments of netfn, cmd, request, response, size and context. 68 typedef ipmi_ret_t (*ipmid_callback_t)(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t, 69 ipmi_response_t, ipmi_data_len_t, 70 ipmi_context_t); 71 72 // This is the constructor function that is called into by each plugin handlers. 73 // When ipmi sets up the callback handlers, a call is made to this with 74 // information of netfn, cmd, callback handler pointer and context data. 75 void ipmi_register_callback(ipmi_netfn_t, ipmi_cmd_t, ipmi_context_t, 76 ipmid_callback_t, ipmi_cmd_privilege_t); 77 78 unsigned short reserveSel(void); 79 bool checkSELReservation(unsigned short id); 80 void cancelSELReservation(void); 81 82 // These are the command network functions, the response 83 // network functions are the function + 1. So to determine 84 // the proper network function which issued the command 85 // associated with a response, subtract 1. 86 // Note: these are also shifted left to make room for the LUN. 87 enum ipmi_net_fns 88 { 89 NETFUN_CHASSIS = 0x00, 90 NETFUN_BRIDGE = 0x02, 91 NETFUN_SENSOR = 0x04, 92 NETFUN_APP = 0x06, 93 NETFUN_FIRMWARE = 0x08, 94 NETFUN_STORAGE = 0x0a, 95 NETFUN_TRANSPORT = 0x0c, 96 NETFUN_GRPEXT = 0x2c, 97 NETFUN_OEM_GROUP = 0x2e, 98 NETFUN_NONE = 0x30, 99 NETFUN_OEM = 0x32, 100 NETFUN_IBM_OEM = 0x3A 101 }; 102 103 // IPMI commands for net functions. Since this is to be used both by the ipmi 104 // function router and also the callback handler registration function, its put 105 // in this .H file. 106 enum ipmi_netfn_wild_card_cmd 107 { 108 IPMI_CMD_WILDCARD = 0xFF, 109 }; 110 111 // Return (completion) codes from a IPMI operation as needed by IPMI V2.0 spec. 112 enum ipmi_return_codes 113 { 114 IPMI_CC_OK = 0x00, 115 IPMI_DCMI_CC_NO_ACTIVE_POWER_LIMIT = 0x80, 116 IPMI_WDOG_CC_NOT_INIT = 0x80, 117 IPMI_CC_SYSTEM_INFO_PARAMETER_NOT_SUPPORTED = 0x80, 118 IPMI_CC_SYSTEM_INFO_PARAMETER_SET_READ_ONLY = 0x82, 119 IPMI_CC_BUSY = 0xC0, 120 IPMI_CC_INVALID = 0xC1, 121 IPMI_CC_TIMEOUT = 0xC3, 122 IPMI_CC_OUT_OF_SPACE = 0xC4, 123 IPMI_CC_INVALID_RESERVATION_ID = 0xC5, 124 IPMI_CC_REQ_DATA_TRUNCATED = 0xC6, 125 IPMI_CC_REQ_DATA_LEN_INVALID = 0xC7, 126 IPMI_CC_PARM_OUT_OF_RANGE = 0xC9, 127 IPMI_CC_REQUESTED_TOO_MANY_BYTES = 0xCA, 128 IPMI_CC_SENSOR_INVALID = 0xCB, 129 IPMI_CC_INVALID_FIELD_REQUEST = 0xCC, 130 IPMI_CC_ILLEGAL_COMMAND = 0xCD, 131 IPMI_CC_RESPONSE_ERROR = 0xCE, 132 IPMI_CC_INSUFFICIENT_PRIVILEGE = 0xD4, 133 IPMI_CC_UNSPECIFIED_ERROR = 0xFF, 134 }; 135 136 // Temp solution: To detect the request source channel. 137 // There is no stright forward way to get the exact 138 // channel so we are hardcoding it to KCS in case host-ipmid 139 // and LAN1 for netipmid. 140 // we can't differentiate between LAN1 & LAN2 for netipmid in this logic. 141 // As our current design will not be able to support the same. This is done 142 // so that in all the places where ever we need to use the self channel can be 143 // be implemented properly and based on new architecture.this can be updated. 144 typedef enum 145 { 146 interfaceKCS = 0, 147 interfaceLAN1 = 1, 148 interfaceUnknown = 0xFF 149 } EInterfaceIndex; 150 151 EInterfaceIndex getInterfaceIndex(void); 152 153 sd_bus* ipmid_get_sd_bus_connection(void); 154 sd_event* ipmid_get_sd_event_connection(void); 155 sd_bus_slot* ipmid_get_sd_bus_slot(void); 156 157 // move this from ipmid.hpp, which is now gone 158 // this should not be used. Use the channel API to get the channel size 159 #define MAX_IPMI_BUFFER 64 160 161 #endif 162