xref: /freebsd/sys/sys/ipmi.h (revision 9768746b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef __SYS_IPMI_H__
32 #define	__SYS_IPMI_H__
33 
34 #define IPMI_MAX_ADDR_SIZE		0x20
35 #define IPMI_MAX_RX			1024
36 
37 #define IPMI_BMC_CHANNEL		0x0f /* Linux BMC channel */
38 #define IPMI_IPMB_CHANNEL		0x00
39 
40 #define IPMI_BMC_SLAVE_ADDR		0x20 /* Linux Default slave address */
41 #define IPMI_BMC_SMS_LUN		0x02
42 
43 #define IPMI_SYSTEM_INTERFACE_ADDR_TYPE	0x0c
44 #define IPMI_IPMB_ADDR_TYPE		0x01
45 #define IPMI_IPMB_BROADCAST_ADDR_TYPE	0x41
46 
47 #define IPMI_IOC_MAGIC			'i'
48 #define IPMICTL_RECEIVE_MSG_TRUNC	_IOWR(IPMI_IOC_MAGIC, 11, struct ipmi_recv)
49 #define IPMICTL_RECEIVE_MSG		_IOWR(IPMI_IOC_MAGIC, 12, struct ipmi_recv)
50 #define IPMICTL_SEND_COMMAND		_IOW(IPMI_IOC_MAGIC, 13, struct ipmi_req)
51 #define IPMICTL_REGISTER_FOR_CMD	_IOW(IPMI_IOC_MAGIC, 14, struct ipmi_cmdspec)
52 #define IPMICTL_UNREGISTER_FOR_CMD	_IOW(IPMI_IOC_MAGIC, 15, struct ipmi_cmdspec)
53 #define IPMICTL_SET_GETS_EVENTS_CMD	_IOW(IPMI_IOC_MAGIC, 16, int)
54 #define IPMICTL_SET_MY_ADDRESS_CMD	_IOW(IPMI_IOC_MAGIC, 17, unsigned int)
55 #define IPMICTL_GET_MY_ADDRESS_CMD	_IOR(IPMI_IOC_MAGIC, 18, unsigned int)
56 #define IPMICTL_SET_MY_LUN_CMD		_IOW(IPMI_IOC_MAGIC, 19, unsigned int)
57 #define IPMICTL_GET_MY_LUN_CMD		_IOR(IPMI_IOC_MAGIC, 20, unsigned int)
58 
59 #define IPMI_RESPONSE_RECV_TYPE         1
60 #define IPMI_ASYNC_EVENT_RECV_TYPE      2
61 #define IPMI_CMD_RECV_TYPE              3
62 
63 #define	IPMI_CHASSIS_REQUEST		0x00
64 # define IPMI_CHASSIS_CONTROL		0x02
65 #  define IPMI_CC_POWER_DOWN		0x0
66 #  define IPMI_CC_POWER_UP		0x1
67 #  define IPMI_CC_POWER_CYCLE		0x2
68 #  define IPMI_CC_HARD_RESET		0x3
69 #  define IPMI_CC_PULSE_DI		0x4
70 #  define IPMI_CC_SOFT_OVERTEMP		0x5
71 
72 #define IPMI_APP_REQUEST		0x06
73 #define IPMI_GET_DEVICE_ID		0x01
74 # define IPMI_ADS_CHASSIS		0x80
75 # define IPMI_ADS_BRIDGE		0x40
76 # define IPMI_ADS_EVENT_GEN		0x20
77 # define IPMI_ADS_EVENT_RCV		0x10
78 # define IPMI_ADS_FRU_INV		0x08
79 # define IPMI_ADS_SEL			0x04
80 # define IPMI_ADS_SDR			0x02
81 # define IPMI_ADS_SENSOR		0x01
82 #define IPMI_CLEAR_FLAGS		0x30
83 #define IPMI_GET_MSG_FLAGS		0x31
84 # define IPMI_MSG_AVAILABLE		0x01
85 # define IPMI_MSG_BUFFER_FULL		0x02
86 # define IPMI_WDT_PRE_TIMEOUT		0x08
87 #define IPMI_GET_MSG			0x33
88 #define IPMI_SEND_MSG			0x34
89 #define IPMI_GET_CHANNEL_INFO		0x42
90 #define IPMI_RESET_WDOG			0x22
91 #define IPMI_SET_WDOG			0x24
92 #define IPMI_GET_WDOG			0x25
93 
94 #define IPMI_SET_WD_TIMER_SMS_OS	0x04
95 #define IPMI_SET_WD_TIMER_DONT_STOP	0x40
96 #define IPMI_SET_WD_ACTION_NONE		0x00
97 #define IPMI_SET_WD_ACTION_RESET	0x01
98 #define IPMI_SET_WD_ACTION_POWER_DOWN	0x02
99 #define IPMI_SET_WD_ACTION_POWER_CYCLE	0x03
100 #define IPMI_SET_WD_PREACTION_NONE	(0x00 << 4)
101 #define IPMI_SET_WD_PREACTION_SMI	(0x01 << 4)
102 #define IPMI_SET_WD_PREACTION_NMI	(0x02 << 4)
103 #define IPMI_SET_WD_PREACTION_MI	(0x03 << 4)
104 
105 struct ipmi_msg {
106 	unsigned char	netfn;
107         unsigned char	cmd;
108         unsigned short	data_len;
109         unsigned char	*data;
110 };
111 
112 struct ipmi_req {
113 	unsigned char	*addr;
114 	unsigned int	addr_len;
115 	long		msgid;
116 	struct ipmi_msg	msg;
117 };
118 
119 struct ipmi_recv {
120 	int		recv_type;
121 	unsigned char	*addr;
122 	unsigned int	addr_len;
123 	long		msgid;
124 	struct ipmi_msg	msg;
125 };
126 
127 struct ipmi_cmdspec {
128 	unsigned char	netfn;
129 	unsigned char	cmd;
130 };
131 
132 struct ipmi_addr {
133 	int		addr_type;
134 	short		channel;
135 	unsigned char	data[IPMI_MAX_ADDR_SIZE];
136 };
137 
138 struct ipmi_system_interface_addr {
139 	int		addr_type;
140 	short		channel;
141 	unsigned char	lun;
142 };
143 
144 struct ipmi_ipmb_addr {
145 	int		addr_type;
146 	short		channel;
147 	unsigned char	slave_addr;
148 	unsigned char	lun;
149 };
150 
151 #if defined(__amd64__)
152 /* Compatibility with 32-bit binaries. */
153 
154 #define IPMICTL_RECEIVE_MSG_TRUNC_32	_IOWR(IPMI_IOC_MAGIC, 11, struct ipmi_recv32)
155 #define IPMICTL_RECEIVE_MSG_32		_IOWR(IPMI_IOC_MAGIC, 12, struct ipmi_recv32)
156 #define IPMICTL_SEND_COMMAND_32		_IOW(IPMI_IOC_MAGIC, 13, struct ipmi_req32)
157 
158 struct ipmi_msg32 {
159 	unsigned char	netfn;
160         unsigned char	cmd;
161         unsigned short	data_len;
162 	uint32_t	data;
163 };
164 
165 struct ipmi_req32 {
166 	uint32_t	addr;
167 	unsigned int	addr_len;
168 	int32_t		msgid;
169 	struct ipmi_msg32 msg;
170 };
171 
172 struct ipmi_recv32 {
173 	int		recv_type;
174 	uint32_t	addr;
175 	unsigned int	addr_len;
176 	int32_t		msgid;
177 	struct ipmi_msg32 msg;
178 };
179 
180 #endif
181 
182 #endif	/* !__SYS_IPMI_H__ */
183