blob: f1045b2c6a00a0543da1892eebff3f120c32a679 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * ipmi.h
3 *
4 * MontaVista IPMI interface
5 *
6 * Author: MontaVista Software, Inc.
7 * Corey Minyard <minyard@mvista.com>
8 * source@mvista.com
9 *
10 * Copyright 2002 MontaVista Software Inc.
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version.
16 *
17 *
18 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
24 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
26 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
27 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * You should have received a copy of the GNU General Public License along
30 * with this program; if not, write to the Free Software Foundation, Inc.,
31 * 675 Mass Ave, Cambridge, MA 02139, USA.
32 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#ifndef __LINUX_IPMI_H
34#define __LINUX_IPMI_H
35
David Howells607ca462012-10-13 10:46:48 +010036#include <uapi/linux/ipmi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/list.h>
Corey Minyard3b625942005-06-23 22:01:42 -070039#include <linux/proc_fs.h>
Corey Minyarda11213f2014-10-10 17:47:04 -050040#include <linux/acpi.h> /* For acpi_handle */
Corey Minyard3b625942005-06-23 22:01:42 -070041
Paul Gortmakerde477252011-05-26 13:46:22 -040042struct module;
Paul Gortmaker313162d2012-01-30 11:46:54 -050043struct device;
Paul Gortmakerde477252011-05-26 13:46:22 -040044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045/* Opaque type for a IPMI message user. One of these is needed to
46 send and receive messages. */
47typedef struct ipmi_user *ipmi_user_t;
48
49/*
50 * Stuff coming from the receive interface comes as one of these.
51 * They are allocated, the receiver must free them with
52 * ipmi_free_recv_msg() when done with the message. The link is not
53 * used after the message is delivered, so the upper layer may use the
54 * link to build a linked list, if it likes.
55 */
Corey Minyardc70d7492008-04-29 01:01:09 -070056struct ipmi_recv_msg {
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 struct list_head link;
58
59 /* The type of message as defined in the "Receive Types"
Corey Minyardc70d7492008-04-29 01:01:09 -070060 defines above. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 int recv_type;
62
63 ipmi_user_t user;
64 struct ipmi_addr addr;
65 long msgid;
66 struct kernel_ipmi_msg msg;
67
68 /* The user_msg_data is the data supplied when a message was
69 sent, if this is a response to a sent message. If this is
70 not a response to a sent message, then user_msg_data will
Corey Minyard56a55ec2005-09-06 15:18:42 -070071 be NULL. If the user above is NULL, then this will be the
72 intf. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 void *user_msg_data;
74
75 /* Call this when done with the message. It will presumably free
76 the message and do any other necessary cleanup. */
77 void (*done)(struct ipmi_recv_msg *msg);
78
79 /* Place-holder for the data, don't make any assumptions about
Lucas De Marchi25985ed2011-03-30 22:57:33 -030080 the size or existence of this, since it may change. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 unsigned char msg_data[IPMI_MAX_MSG_LENGTH];
82};
83
84/* Allocate and free the receive message. */
Corey Minyard393d2cc2005-11-07 00:59:54 -080085void ipmi_free_recv_msg(struct ipmi_recv_msg *msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Corey Minyardc70d7492008-04-29 01:01:09 -070087struct ipmi_user_hndl {
88 /* Routine type to call when a message needs to be routed to
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 the upper layer. This will be called with some locks held,
90 the only IPMI routines that can be called are ipmi_request
91 and the alloc/free operations. The handler_data is the
92 variable supplied when the receive handler was registered. */
93 void (*ipmi_recv_hndl)(struct ipmi_recv_msg *msg,
94 void *user_msg_data);
95
96 /* Called when the interface detects a watchdog pre-timeout. If
97 this is NULL, it will be ignored for the user. */
98 void (*ipmi_watchdog_pretimeout)(void *handler_data);
99};
100
101/* Create a new user of the IPMI layer on the given interface number. */
102int ipmi_create_user(unsigned int if_num,
Corey Minyard210af2a2017-01-05 10:52:10 -0600103 const struct ipmi_user_hndl *handler,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 void *handler_data,
105 ipmi_user_t *user);
106
107/* Destroy the given user of the IPMI layer. Note that after this
108 function returns, the system is guaranteed to not call any
109 callbacks for the user. Thus as long as you destroy all the users
110 before you unload a module, you will be safe. And if you destroy
111 the users before you destroy the callback structures, it should be
112 safe, too. */
113int ipmi_destroy_user(ipmi_user_t user);
114
115/* Get the IPMI version of the BMC we are talking to. */
116void ipmi_get_version(ipmi_user_t user,
117 unsigned char *major,
118 unsigned char *minor);
119
120/* Set and get the slave address and LUN that we will use for our
121 source messages. Note that this affects the interface, not just
122 this user, so it will affect all users of this interface. This is
123 so some initialization code can come in and do the OEM-specific
124 things it takes to determine your address (if not the BMC) and set
Corey Minyardc14979b2005-09-06 15:18:38 -0700125 it for everyone else. Note that each channel can have its own address. */
126int ipmi_set_my_address(ipmi_user_t user,
127 unsigned int channel,
128 unsigned char address);
129int ipmi_get_my_address(ipmi_user_t user,
130 unsigned int channel,
131 unsigned char *address);
132int ipmi_set_my_LUN(ipmi_user_t user,
133 unsigned int channel,
134 unsigned char LUN);
135int ipmi_get_my_LUN(ipmi_user_t user,
136 unsigned int channel,
137 unsigned char *LUN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139/*
140 * Like ipmi_request, but lets you specify the number of retries and
141 * the retry time. The retries is the number of times the message
142 * will be resent if no reply is received. If set to -1, the default
143 * value will be used. The retry time is the time in milliseconds
144 * between retries. If set to zero, the default value will be
145 * used.
146 *
147 * Don't use this unless you *really* have to. It's primarily for the
148 * IPMI over LAN converter; since the LAN stuff does its own retries,
149 * it makes no sense to do it here. However, this can be used if you
150 * have unusual requirements.
151 */
152int ipmi_request_settime(ipmi_user_t user,
153 struct ipmi_addr *addr,
154 long msgid,
155 struct kernel_ipmi_msg *msg,
156 void *user_msg_data,
157 int priority,
158 int max_retries,
159 unsigned int retry_time_ms);
160
161/*
162 * Like ipmi_request, but with messages supplied. This will not
163 * allocate any memory, and the messages may be statically allocated
164 * (just make sure to do the "done" handling on them). Note that this
165 * is primarily for the watchdog timer, since it should be able to
166 * send messages even if no memory is available. This is subject to
167 * change as the system changes, so don't use it unless you REALLY
168 * have to.
169 */
170int ipmi_request_supply_msgs(ipmi_user_t user,
171 struct ipmi_addr *addr,
172 long msgid,
173 struct kernel_ipmi_msg *msg,
174 void *user_msg_data,
175 void *supplied_smi,
176 struct ipmi_recv_msg *supplied_recv,
177 int priority);
178
179/*
Corey Minyardfcfa4722007-10-18 03:07:09 -0700180 * Poll the IPMI interface for the user. This causes the IPMI code to
181 * do an immediate check for information from the driver and handle
182 * anything that is immediately pending. This will not block in any
Corey Minyardbda4c302008-04-29 01:01:02 -0700183 * way. This is useful if you need to spin waiting for something to
184 * happen in the IPMI driver.
Corey Minyardfcfa4722007-10-18 03:07:09 -0700185 */
186void ipmi_poll_interface(ipmi_user_t user);
187
188/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 * When commands come in to the SMS, the user can register to receive
Corey Minyardc69c31272006-09-30 23:27:56 -0700190 * them. Only one user can be listening on a specific netfn/cmd/chan tuple
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * at a time, you will get an EBUSY error if the command is already
192 * registered. If a command is received that does not have a user
193 * registered, the driver will automatically return the proper
Corey Minyardc69c31272006-09-30 23:27:56 -0700194 * error. Channels are specified as a bitfield, use IPMI_CHAN_ALL to
195 * mean all channels.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 */
197int ipmi_register_for_cmd(ipmi_user_t user,
198 unsigned char netfn,
Corey Minyardc69c31272006-09-30 23:27:56 -0700199 unsigned char cmd,
200 unsigned int chans);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201int ipmi_unregister_for_cmd(ipmi_user_t user,
202 unsigned char netfn,
Corey Minyardc69c31272006-09-30 23:27:56 -0700203 unsigned char cmd,
204 unsigned int chans);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206/*
Corey Minyardb9675132006-12-06 20:41:02 -0800207 * Go into a mode where the driver will not autonomously attempt to do
208 * things with the interface. It will still respond to attentions and
209 * interrupts, and it will expect that commands will complete. It
210 * will not automatcially check for flags, events, or things of that
211 * nature.
212 *
213 * This is primarily used for firmware upgrades. The idea is that
214 * when you go into firmware upgrade mode, you do this operation
215 * and the driver will not attempt to do anything but what you tell
216 * it or what the BMC asks for.
217 *
218 * Note that if you send a command that resets the BMC, the driver
219 * will still expect a response from that command. So the BMC should
220 * reset itself *after* the response is sent. Resetting before the
221 * response is just silly.
222 *
223 * If in auto maintenance mode, the driver will automatically go into
224 * maintenance mode for 30 seconds if it sees a cold reset, a warm
225 * reset, or a firmware NetFN. This means that code that uses only
226 * firmware NetFN commands to do upgrades will work automatically
227 * without change, assuming it sends a message every 30 seconds or
228 * less.
229 *
230 * See the IPMI_MAINTENANCE_MODE_xxx defines for what the mode means.
231 */
232int ipmi_get_maintenance_mode(ipmi_user_t user);
233int ipmi_set_maintenance_mode(ipmi_user_t user, int mode);
234
235/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 * When the user is created, it will not receive IPMI events by
237 * default. The user must set this to TRUE to get incoming events.
238 * The first user that sets this to TRUE will receive all events that
239 * have been queued while no one was waiting for events.
240 */
Corey Minyard89986492014-04-14 09:46:54 -0500241int ipmi_set_gets_events(ipmi_user_t user, bool val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243/*
244 * Called when a new SMI is registered. This will also be called on
245 * every existing interface when a new watcher is registered with
246 * ipmi_smi_watcher_register().
247 */
Corey Minyardc70d7492008-04-29 01:01:09 -0700248struct ipmi_smi_watcher {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 struct list_head link;
250
251 /* You must set the owner to the current module, if you are in
252 a module (generally just set it to "THIS_MODULE"). */
253 struct module *owner;
254
255 /* These two are called with read locks held for the interface
256 the watcher list. So you can add and remove users from the
257 IPMI interface, send messages, etc., but you cannot add
258 or remove SMI watchers or SMI interfaces. */
Corey Minyard50c812b2006-03-26 01:37:21 -0800259 void (*new_smi)(int if_num, struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 void (*smi_gone)(int if_num);
261};
262
263int ipmi_smi_watcher_register(struct ipmi_smi_watcher *watcher);
264int ipmi_smi_watcher_unregister(struct ipmi_smi_watcher *watcher);
265
266/* The following are various helper functions for dealing with IPMI
267 addresses. */
268
269/* Return the maximum length of an IPMI address given it's type. */
270unsigned int ipmi_addr_length(int addr_type);
271
272/* Validate that the given IPMI address is valid. */
273int ipmi_validate_addr(struct ipmi_addr *addr, int len);
274
Zhao Yakui16f42322010-12-08 10:10:16 +0800275/*
276 * How did the IPMI driver find out about the device?
277 */
278enum ipmi_addr_src {
279 SI_INVALID = 0, SI_HOTMOD, SI_HARDCODED, SI_SPMI, SI_ACPI, SI_SMBIOS,
Tony Camusob07b58a2016-06-22 14:22:28 -0400280 SI_PCI, SI_DEVICETREE, SI_LAST
Zhao Yakui16f42322010-12-08 10:10:16 +0800281};
Corey Minyard7e503872014-10-09 07:20:32 -0500282const char *ipmi_addr_src_to_str(enum ipmi_addr_src src);
Zhao Yakui16f42322010-12-08 10:10:16 +0800283
284union ipmi_smi_info_union {
Corey Minyarda11213f2014-10-10 17:47:04 -0500285#ifdef CONFIG_ACPI
Zhao Yakui16f42322010-12-08 10:10:16 +0800286 /*
287 * the acpi_info element is defined for the SI_ACPI
288 * address type
289 */
290 struct {
Corey Minyarda11213f2014-10-10 17:47:04 -0500291 acpi_handle acpi_handle;
Zhao Yakui16f42322010-12-08 10:10:16 +0800292 } acpi_info;
Corey Minyarda11213f2014-10-10 17:47:04 -0500293#endif
Zhao Yakui16f42322010-12-08 10:10:16 +0800294};
295
296struct ipmi_smi_info {
297 enum ipmi_addr_src addr_src;
298
299 /*
300 * Base device for the interface. Don't forget to put this when
301 * you are done.
302 */
303 struct device *dev;
304
305 /*
306 * The addr_info provides more detailed info for some IPMI
307 * devices, depending on the addr_src. Currently only SI_ACPI
308 * info is provided.
309 */
310 union ipmi_smi_info_union addr_info;
311};
312
313/* This is to get the private info of ipmi_smi_t */
314extern int ipmi_get_smi_info(int if_num, struct ipmi_smi_info *data);
315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316#endif /* __LINUX_IPMI_H */