blob: 67a1000ebf2b73d876acf15f69022c995aac434d [file] [log] [blame]
vishwabmcba0bd5f2015-09-30 16:50:23 +05301#ifndef __HOST_IPMID_IPMI_COMMON_H__
2#define __HOST_IPMID_IPMI_COMMON_H__
3#include <stdlib.h>
Chris Austen30195fa2015-11-13 14:39:19 -06004#include <systemd/sd-bus.h>
vishwabmcba0bd5f2015-09-30 16:50:23 +05305
Joel Stanleyc99350c2015-11-25 17:27:25 +10306#ifdef __cplusplus
7extern "C" {
8#endif
9
Tom05732372016-09-06 17:21:23 +053010/*
11 * Specifies the minimum privilege level required to execute the command
12 * This means the command can be executed at a given privilege level or higher
13 * privilege level. Those commands which can be executed via system interface
14 * only should use SYSTEM_INTERFACE
15 */
16enum CommandPrivilege {
17 PRIVILEGE_CALLBACK = 0x01,
18 PRIVILEGE_USER,
19 PRIVILEGE_OPERATOR,
20 PRIVILEGE_ADMIN,
21 PRIVILEGE_OEM,
22 SYSTEM_INTERFACE = 0xFF,
23};
24
vishwabmcba0bd5f2015-09-30 16:50:23 +053025// length of Completion Code and its ALWAYS _1_
26#define IPMI_CC_LEN 1
27
28// IPMI Net Function number as specified by IPMI V2.0 spec.
29// Example :
30// NETFUN_APP = (0x06 << 2),
31typedef unsigned char ipmi_netfn_t;
32
33// IPMI Command for a Net Function number as specified by IPMI V2.0 spec.
34typedef unsigned char ipmi_cmd_t;
35
36// Buffer containing data from sender of netfn and command as part of request
37typedef void* ipmi_request_t;
38
39// This is the response buffer that the provider of [netfn,cmd] will send back
40// to the caller. Provider will allocate the memory inside the handler and then
41// will do a memcpy to this response buffer and also will set the data size
42// parameter to the size of the buffer.
43// EXAMPLE :
44// unsigned char str[] = {0x00, 0x01, 0xFE, 0xFF, 0x0A, 0x01};
45// *data_len = 6;
46// memcpy(response, &str, *data_len);
47typedef void* ipmi_response_t;
48
49// This buffer contains any *user specific* data that is of interest only to the
50// plugin. For a ipmi function router, this data is opaque. At the time of
51// registering the plugin handlers, plugin may optionally allocate a memory and
52// fill in whatever needed that will be of help during the actual handling of
53// command. IPMID will just pass the netfn, cmd and also this data to plugins
54// during the command handler invocation.
55typedef void* ipmi_context_t;
56
57// Length of request / response buffer depending on whether the data is a
58// request or a response from a plugin handler.
59typedef size_t* ipmi_data_len_t;
60
61// Plugin function return the status code
62typedef unsigned char ipmi_ret_t;
63
Tom05732372016-09-06 17:21:23 +053064typedef enum CommandPrivilege ipmi_cmd_privilege_t;
65
vishwabmcba0bd5f2015-09-30 16:50:23 +053066// This is the callback handler that the plugin registers with IPMID. IPMI
67// function router will then make a call to this callback handler with the
68// necessary arguments of netfn, cmd, request, response, size and context.
69typedef ipmi_ret_t (*ipmid_callback_t)(ipmi_netfn_t, ipmi_cmd_t, ipmi_request_t,
70 ipmi_response_t, ipmi_data_len_t, 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.
Tom05732372016-09-06 17:21:23 +053075void ipmi_register_callback(ipmi_netfn_t, ipmi_cmd_t, ipmi_context_t, ipmid_callback_t,
76 ipmi_cmd_privilege_t);
77
vishwabmcba0bd5f2015-09-30 16:50:23 +053078
Nan Li36c0cb62016-03-31 11:16:08 +080079unsigned short get_sel_reserve_id(void);
80
vishwabmcba0bd5f2015-09-30 16:50:23 +053081// These are the command network functions, the response
82// network functions are the function + 1. So to determine
83// the proper network function which issued the command
84// associated with a response, subtract 1.
85// Note: these are also shifted left to make room for the LUN.
86enum ipmi_net_fns
87{
Adriana Kobylak5d6481f2015-10-29 21:44:55 -050088 NETFUN_CHASSIS = 0x00,
89 NETFUN_BRIDGE = 0x02,
90 NETFUN_SENSOR = 0x04,
91 NETFUN_APP = 0x06,
92 NETFUN_FIRMWARE = 0x08,
93 NETFUN_STORAGE = 0x0a,
94 NETFUN_TRANSPORT = 0x0c,
95 NETFUN_GRPEXT = 0x2c,
96 NETFUN_NONE = 0x30,
97 NETFUN_OEM = 0x32
vishwabmcba0bd5f2015-09-30 16:50:23 +053098};
99
100// IPMI commands for net functions. Since this is to be used both by the ipmi
101// function router and also the callback handler registration function, its put
102// in this .H file.
103enum ipmi_netfn_wild_card_cmd
104{
105 IPMI_CMD_WILDCARD = 0xFF,
106};
107
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500108// Return (completion) codes from a IPMI operation as needed by IPMI V2.0 spec.
vishwabmcba0bd5f2015-09-30 16:50:23 +0530109enum ipmi_return_codes
110{
111 IPMI_CC_OK = 0x00,
Chris Austen1810bec2015-10-13 12:12:39 -0500112 IPMI_DCMI_CC_NO_ACTIVE_POWER_LIMIT = 0x80,
Chris Austen8339f9d2015-10-21 20:07:31 -0500113 IPMI_CC_INVALID = 0xC1,
Nan Li36c0cb62016-03-31 11:16:08 +0800114 IPMI_CC_INVALID_RESERVATION_ID = 0xC5,
Tom63a3db72016-09-23 18:20:52 +0530115 IPMI_CC_REQ_DATA_LEN_INVALID = 0xC7,
Chris Austenc2cd29d2016-02-05 20:02:29 -0600116 IPMI_CC_PARM_OUT_OF_RANGE = 0xC9,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500117 IPMI_CC_SENSOR_INVALID = 0xCB,
Tom Joseph50234ad2017-03-20 18:51:38 +0530118 IPMI_CC_INVALID_FIELD_REQUEST = 0xCC,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500119 IPMI_CC_RESPONSE_ERROR = 0xCE,
Tom Joseph9a61b4f2016-07-11 06:56:11 -0500120 IPMI_CC_INSUFFICIENT_PRIVILEGE = 0xD4,
Adriana Kobylakd100ee52015-10-20 17:02:37 -0500121 IPMI_CC_UNSPECIFIED_ERROR = 0xFF,
vishwabmcba0bd5f2015-09-30 16:50:23 +0530122};
123
Joel Stanleyc99350c2015-11-25 17:27:25 +1030124sd_bus *ipmid_get_sd_bus_connection(void);
vishwab9f559a2016-01-13 01:53:08 -0600125sd_bus_slot *ipmid_get_sd_bus_slot(void);
Joel Stanleyc99350c2015-11-25 17:27:25 +1030126
127#ifdef __cplusplus
128}
129#endif
130
vishwabmcba0bd5f2015-09-30 16:50:23 +0530131#endif