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