blob: e77e7202820764d568b9674557e7bb71a6e23931 [file] [log] [blame]
vishwabmcba0bd5f2015-09-30 16:50:23 +05301#ifndef __HOST_IPMID_IPMI_COMMON_H__
2#define __HOST_IPMID_IPMI_COMMON_H__
Jason M. Bills13e67c82018-09-10 14:12:16 -07003#include <stdbool.h>
vishwabmcba0bd5f2015-09-30 16:50:23 +05304#include <stdlib.h>
Chris Austen30195fa2015-11-13 14:39:19 -06005#include <systemd/sd-bus.h>
vishwabmcba0bd5f2015-09-30 16:50:23 +05306
Joel Stanleyc99350c2015-11-25 17:27:25 +10307#ifdef __cplusplus
8extern "C" {
9#endif
10
Tom05732372016-09-06 17:21:23 +053011/*
12 * Specifies the minimum privilege level required to execute the command
13 * This means the command can be executed at a given privilege level or higher
14 * privilege level. Those commands which can be executed via system interface
15 * only should use SYSTEM_INTERFACE
16 */
Patrick Venture0b02be92018-08-31 11:55:55 -070017enum CommandPrivilege
18{
19 PRIVILEGE_CALLBACK = 0x01,
20 PRIVILEGE_USER,
21 PRIVILEGE_OPERATOR,
22 PRIVILEGE_ADMIN,
23 PRIVILEGE_OEM,
24 SYSTEM_INTERFACE = 0xFF,
Tom05732372016-09-06 17:21:23 +053025};
26
vishwabmcba0bd5f2015-09-30 16:50:23 +053027// length of Completion Code and its ALWAYS _1_
28#define IPMI_CC_LEN 1
29
30// IPMI Net Function number as specified by IPMI V2.0 spec.
Gunnar Millsd8249ee2018-04-12 16:33:53 -050031// Example :
vishwabmcba0bd5f2015-09-30 16:50:23 +053032// NETFUN_APP = (0x06 << 2),
Patrick Venture0b02be92018-08-31 11:55:55 -070033typedef unsigned char ipmi_netfn_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053034
35// IPMI Command for a Net Function number as specified by IPMI V2.0 spec.
Patrick Venture0b02be92018-08-31 11:55:55 -070036typedef unsigned char ipmi_cmd_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053037
38// Buffer containing data from sender of netfn and command as part of request
Patrick Venture0b02be92018-08-31 11:55:55 -070039typedef void* ipmi_request_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053040
41// This is the response buffer that the provider of [netfn,cmd] will send back
42// to the caller. Provider will allocate the memory inside the handler and then
43// will do a memcpy to this response buffer and also will set the data size
44// parameter to the size of the buffer.
45// EXAMPLE :
46// unsigned char str[] = {0x00, 0x01, 0xFE, 0xFF, 0x0A, 0x01};
47// *data_len = 6;
48// memcpy(response, &str, *data_len);
Patrick Venture0b02be92018-08-31 11:55:55 -070049typedef void* ipmi_response_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053050
51// This buffer contains any *user specific* data that is of interest only to the
52// plugin. For a ipmi function router, this data is opaque. At the time of
53// registering the plugin handlers, plugin may optionally allocate a memory and
54// fill in whatever needed that will be of help during the actual handling of
55// command. IPMID will just pass the netfn, cmd and also this data to plugins
56// during the command handler invocation.
Patrick Venture0b02be92018-08-31 11:55:55 -070057typedef void* ipmi_context_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053058
59// Length of request / response buffer depending on whether the data is a
60// request or a response from a plugin handler.
Patrick Venture0b02be92018-08-31 11:55:55 -070061typedef size_t* ipmi_data_len_t;
vishwabmcba0bd5f2015-09-30 16:50:23 +053062
63// Plugin function return the status code
64typedef unsigned char ipmi_ret_t;
65
Tom05732372016-09-06 17:21:23 +053066typedef enum CommandPrivilege ipmi_cmd_privilege_t;
67
vishwabmcba0bd5f2015-09-30 16:50:23 +053068// This is the callback handler that the plugin registers with IPMID. IPMI
69// function router will then make a call to this callback handler with the
70// necessary arguments of netfn, cmd, request, response, size and context.
71typedef ipmi_ret_t (*ipmid_callback_t)(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t,
Patrick Venture0b02be92018-08-31 11:55:55 -070072 ipmi_response_t, ipmi_data_len_t,
73 ipmi_context_t);
vishwabmcba0bd5f2015-09-30 16:50:23 +053074
75// This is the constructor function that is called into by each plugin handlers.
76// When ipmi sets up the callback handlers, a call is made to this with
77// information of netfn, cmd, callback handler pointer and context data.
Patrick Venture0b02be92018-08-31 11:55:55 -070078void ipmi_register_callback(ipmi_netfn_t, ipmi_cmd_t, ipmi_context_t,
79 ipmid_callback_t, ipmi_cmd_privilege_t);
vishwabmcba0bd5f2015-09-30 16:50:23 +053080
Jason M. Bills13e67c82018-09-10 14:12:16 -070081unsigned short reserveSel(void);
82bool checkSELReservation(unsigned short id);
83void cancelSELReservation(void);
Nan Li36c0cb62016-03-31 11:16:08 +080084
vishwabmcba0bd5f2015-09-30 16:50:23 +053085// These are the command network functions, the response
86// network functions are the function + 1. So to determine
87// the proper network function which issued the command
88// associated with a response, subtract 1.
89// Note: these are also shifted left to make room for the LUN.
90enum ipmi_net_fns
91{
Patrick Venture0b02be92018-08-31 11:55:55 -070092 NETFUN_CHASSIS = 0x00,
93 NETFUN_BRIDGE = 0x02,
94 NETFUN_SENSOR = 0x04,
95 NETFUN_APP = 0x06,
96 NETFUN_FIRMWARE = 0x08,
97 NETFUN_STORAGE = 0x0a,
98 NETFUN_TRANSPORT = 0x0c,
99 NETFUN_GRPEXT = 0x2c,
100 NETFUN_OEM_GROUP = 0x2e,
101 NETFUN_NONE = 0x30,
102 NETFUN_OEM = 0x32,
103 NETFUN_IBM_OEM = 0x3A
vishwabmcba0bd5f2015-09-30 16:50:23 +0530104};
105
106// IPMI commands for net functions. Since this is to be used both by the ipmi
107// function router and also the callback handler registration function, its put
108// in this .H file.
109enum ipmi_netfn_wild_card_cmd
110{
Patrick Venture0b02be92018-08-31 11:55:55 -0700111 IPMI_CMD_WILDCARD = 0xFF,
vishwabmcba0bd5f2015-09-30 16:50:23 +0530112};
113
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500114// Return (completion) codes from a IPMI operation as needed by IPMI V2.0 spec.
vishwabmcba0bd5f2015-09-30 16:50:23 +0530115enum ipmi_return_codes
116{
117 IPMI_CC_OK = 0x00,
Chris Austen1810bec2015-10-13 12:12:39 -0500118 IPMI_DCMI_CC_NO_ACTIVE_POWER_LIMIT = 0x80,
William A. Kennington III5325f2c2018-01-08 15:17:09 -0800119 IPMI_WDOG_CC_NOT_INIT = 0x80,
Xo Wangf542e8b2017-08-09 15:34:16 -0700120 IPMI_CC_SYSTEM_INFO_PARAMETER_NOT_SUPPORTED = 0x80,
121 IPMI_CC_SYSTEM_INFO_PARAMETER_SET_READ_ONLY = 0x82,
William A. Kennington III6ae3df32018-01-18 11:19:30 -0800122 IPMI_CC_BUSY = 0xC0,
Chris Austen8339f9d2015-10-21 20:07:31 -0500123 IPMI_CC_INVALID = 0xC1,
Nan Li36c0cb62016-03-31 11:16:08 +0800124 IPMI_CC_INVALID_RESERVATION_ID = 0xC5,
Tom63a3db72016-09-23 18:20:52 +0530125 IPMI_CC_REQ_DATA_LEN_INVALID = 0xC7,
Chris Austenc2cd29d2016-02-05 20:02:29 -0600126 IPMI_CC_PARM_OUT_OF_RANGE = 0xC9,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500127 IPMI_CC_SENSOR_INVALID = 0xCB,
Tom Joseph50234ad2017-03-20 18:51:38 +0530128 IPMI_CC_INVALID_FIELD_REQUEST = 0xCC,
Jayanth Othayoth0922bde2018-04-02 07:59:34 -0500129 IPMI_CC_ILLEGAL_COMMAND = 0xCD,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500130 IPMI_CC_RESPONSE_ERROR = 0xCE,
Tom Joseph9a61b4f2016-07-11 06:56:11 -0500131 IPMI_CC_INSUFFICIENT_PRIVILEGE = 0xD4,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500132 IPMI_CC_UNSPECIFIED_ERROR = 0xFF,
vishwabmcba0bd5f2015-09-30 16:50:23 +0530133};
134
Patrick Venture0b02be92018-08-31 11:55:55 -0700135sd_bus* ipmid_get_sd_bus_connection(void);
136sd_event* ipmid_get_sd_event_connection(void);
137sd_bus_slot* ipmid_get_sd_bus_slot(void);
Joel Stanleyc99350c2015-11-25 17:27:25 +1030138
139#ifdef __cplusplus
140}
141#endif
142
vishwabmcba0bd5f2015-09-30 16:50:23 +0530143#endif