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