blob: b1c078baa1647d2818214b4e6a7997b600dfb868 [file] [log] [blame]
vishwabmcba0bd5f2015-09-30 16:50:23 +05301#ifndef __HOST_IPMID_IPMI_COMMON_H__
2#define __HOST_IPMID_IPMI_COMMON_H__
vishwabmcba0bd5f2015-09-30 16:50:23 +05303
Patrick Venture2edd0e62018-10-25 16:10:10 -07004#include <systemd/sd-bus.h>
Joel Stanleyc99350c2015-11-25 17:27:25 +10305
Tom05732372016-09-06 17:21:23 +05306/*
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 */
Patrick Venture0b02be92018-08-31 11:55:55 -070012enum CommandPrivilege
13{
14 PRIVILEGE_CALLBACK = 0x01,
15 PRIVILEGE_USER,
16 PRIVILEGE_OPERATOR,
17 PRIVILEGE_ADMIN,
18 PRIVILEGE_OEM,
19 SYSTEM_INTERFACE = 0xFF,
Tom05732372016-09-06 17:21:23 +053020};
21
vishwabmcba0bd5f2015-09-30 16:50:23 +053022// 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.
Gunnar Millsd8249ee2018-04-12 16:33:53 -050026// Example :
vishwabmcba0bd5f2015-09-30 16:50:23 +053027// NETFUN_APP = (0x06 << 2),
Patrick Venture0b02be92018-08-31 11:55:55 -070028typedef unsigned char ipmi_netfn_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053029
30// IPMI Command for a Net Function number as specified by IPMI V2.0 spec.
Patrick Venture0b02be92018-08-31 11:55:55 -070031typedef unsigned char ipmi_cmd_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053032
33// Buffer containing data from sender of netfn and command as part of request
Patrick Venture0b02be92018-08-31 11:55:55 -070034typedef void* ipmi_request_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053035
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);
Patrick Venture0b02be92018-08-31 11:55:55 -070044typedef void* ipmi_response_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053045
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.
Patrick Venture0b02be92018-08-31 11:55:55 -070052typedef void* ipmi_context_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053053
54// Length of request / response buffer depending on whether the data is a
55// request or a response from a plugin handler.
Patrick Venture0b02be92018-08-31 11:55:55 -070056typedef size_t* ipmi_data_len_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053057
58// Plugin function return the status code
59typedef unsigned char ipmi_ret_t;
60
Tom05732372016-09-06 17:21:23 +053061typedef enum CommandPrivilege ipmi_cmd_privilege_t;
62
vishwabmcba0bd5f2015-09-30 16:50:23 +053063// 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.
66typedef ipmi_ret_t (*ipmid_callback_t)(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t,
Patrick Venture0b02be92018-08-31 11:55:55 -070067 ipmi_response_t, ipmi_data_len_t,
68 ipmi_context_t);
vishwabmcba0bd5f2015-09-30 16:50:23 +053069
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.
Patrick Venture0b02be92018-08-31 11:55:55 -070073void ipmi_register_callback(ipmi_netfn_t, ipmi_cmd_t, ipmi_context_t,
74 ipmid_callback_t, ipmi_cmd_privilege_t);
vishwabmcba0bd5f2015-09-30 16:50:23 +053075
Jason M. Bills13e67c82018-09-10 14:12:16 -070076unsigned short reserveSel(void);
77bool checkSELReservation(unsigned short id);
78void cancelSELReservation(void);
Nan Li36c0cb62016-03-31 11:16:08 +080079
vishwabmcba0bd5f2015-09-30 16:50:23 +053080// 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.
85enum ipmi_net_fns
86{
Patrick Venture0b02be92018-08-31 11:55:55 -070087 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
vishwabmcba0bd5f2015-09-30 16:50:23 +053099};
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.
104enum ipmi_netfn_wild_card_cmd
105{
Patrick Venture0b02be92018-08-31 11:55:55 -0700106 IPMI_CMD_WILDCARD = 0xFF,
vishwabmcba0bd5f2015-09-30 16:50:23 +0530107};
108
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500109// Return (completion) codes from a IPMI operation as needed by IPMI V2.0 spec.
vishwabmcba0bd5f2015-09-30 16:50:23 +0530110enum ipmi_return_codes
111{
112 IPMI_CC_OK = 0x00,
Chris Austen1810bec2015-10-13 12:12:39 -0500113 IPMI_DCMI_CC_NO_ACTIVE_POWER_LIMIT = 0x80,
William A. Kennington III5325f2c2018-01-08 15:17:09 -0800114 IPMI_WDOG_CC_NOT_INIT = 0x80,
Xo Wangf542e8b2017-08-09 15:34:16 -0700115 IPMI_CC_SYSTEM_INFO_PARAMETER_NOT_SUPPORTED = 0x80,
116 IPMI_CC_SYSTEM_INFO_PARAMETER_SET_READ_ONLY = 0x82,
William A. Kennington III6ae3df32018-01-18 11:19:30 -0800117 IPMI_CC_BUSY = 0xC0,
Chris Austen8339f9d2015-10-21 20:07:31 -0500118 IPMI_CC_INVALID = 0xC1,
Patrick Venturead359eb2018-11-12 15:03:54 -0800119 IPMI_CC_TIMEOUT = 0xC3,
120 IPMI_CC_OUT_OF_SPACE = 0xC4,
Nan Li36c0cb62016-03-31 11:16:08 +0800121 IPMI_CC_INVALID_RESERVATION_ID = 0xC5,
Patrick Venturead359eb2018-11-12 15:03:54 -0800122 IPMI_CC_REQ_DATA_TRUNCATED = 0xC6,
Tom63a3db72016-09-23 18:20:52 +0530123 IPMI_CC_REQ_DATA_LEN_INVALID = 0xC7,
Chris Austenc2cd29d2016-02-05 20:02:29 -0600124 IPMI_CC_PARM_OUT_OF_RANGE = 0xC9,
Patrick Venturead359eb2018-11-12 15:03:54 -0800125 IPMI_CC_REQUESTED_TOO_MANY_BYTES = 0xCA,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500126 IPMI_CC_SENSOR_INVALID = 0xCB,
Tom Joseph50234ad2017-03-20 18:51:38 +0530127 IPMI_CC_INVALID_FIELD_REQUEST = 0xCC,
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500128 IPMI_CC_ILLEGAL_COMMAND = 0xCD,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500129 IPMI_CC_RESPONSE_ERROR = 0xCE,
Tom Joseph9a61b4f2016-07-11 06:56:11 -0500130 IPMI_CC_INSUFFICIENT_PRIVILEGE = 0xD4,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500131 IPMI_CC_UNSPECIFIED_ERROR = 0xFF,
vishwabmcba0bd5f2015-09-30 16:50:23 +0530132};
133
ssekarb8491102018-08-16 17:31:43 +0530134// 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.
142typedef enum
143{
144 interfaceKCS = 0,
145 interfaceLAN1 = 1,
146 interfaceUnknown = 0xFF
147} EInterfaceIndex;
148
149EInterfaceIndex getInterfaceIndex(void);
150
Patrick Venture0b02be92018-08-31 11:55:55 -0700151sd_bus* ipmid_get_sd_bus_connection(void);
152sd_event* ipmid_get_sd_event_connection(void);
153sd_bus_slot* ipmid_get_sd_bus_slot(void);
Joel Stanleyc99350c2015-11-25 17:27:25 +1030154
vishwabmcba0bd5f2015-09-30 16:50:23 +0530155#endif