Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
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 | */ | |
33 | ||
34 | #ifndef __LINUX_IPMI_H | |
35 | #define __LINUX_IPMI_H | |
36 | ||
37 | #include <linux/ipmi_msgdefs.h> | |
07766f24 | 38 | #include <linux/compiler.h> |
1da177e4 LT |
39 | |
40 | /* | |
41 | * This file describes an interface to an IPMI driver. You have to | |
42 | * have a fairly good understanding of IPMI to use this, so go read | |
43 | * the specs first before actually trying to do anything. | |
44 | * | |
45 | * With that said, this driver provides a multi-user interface to the | |
46 | * IPMI driver, and it allows multiple IPMI physical interfaces below | |
47 | * the driver. The physical interfaces bind as a lower layer on the | |
48 | * driver. They appear as interfaces to the application using this | |
49 | * interface. | |
50 | * | |
51 | * Multi-user means that multiple applications may use the driver, | |
52 | * send commands, receive responses, etc. The driver keeps track of | |
53 | * commands the user sends and tracks the responses. The responses | |
54 | * will go back to the application that send the command. If the | |
55 | * response doesn't come back in time, the driver will return a | |
56 | * timeout error response to the application. Asynchronous events | |
57 | * from the BMC event queue will go to all users bound to the driver. | |
58 | * The incoming event queue in the BMC will automatically be flushed | |
59 | * if it becomes full and it is queried once a second to see if | |
60 | * anything is in it. Incoming commands to the driver will get | |
61 | * delivered as commands. | |
62 | * | |
63 | * This driver provides two main interfaces: one for in-kernel | |
64 | * applications and another for userland applications. The | |
65 | * capabilities are basically the same for both interface, although | |
66 | * the interfaces are somewhat different. The stuff in the | |
67 | * #ifdef KERNEL below is the in-kernel interface. The userland | |
68 | * interface is defined later in the file. */ | |
69 | ||
70 | ||
71 | ||
72 | /* | |
73 | * This is an overlay for all the address types, so it's easy to | |
74 | * determine the actual address type. This is kind of like addresses | |
75 | * work for sockets. | |
76 | */ | |
77 | #define IPMI_MAX_ADDR_SIZE 32 | |
78 | struct ipmi_addr | |
79 | { | |
80 | /* Try to take these from the "Channel Medium Type" table | |
81 | in section 6.5 of the IPMI 1.5 manual. */ | |
82 | int addr_type; | |
83 | short channel; | |
84 | char data[IPMI_MAX_ADDR_SIZE]; | |
85 | }; | |
86 | ||
87 | /* | |
88 | * When the address is not used, the type will be set to this value. | |
89 | * The channel is the BMC's channel number for the channel (usually | |
90 | * 0), or IPMC_BMC_CHANNEL if communicating directly with the BMC. | |
91 | */ | |
92 | #define IPMI_SYSTEM_INTERFACE_ADDR_TYPE 0x0c | |
93 | struct ipmi_system_interface_addr | |
94 | { | |
95 | int addr_type; | |
96 | short channel; | |
97 | unsigned char lun; | |
98 | }; | |
99 | ||
100 | /* An IPMB Address. */ | |
101 | #define IPMI_IPMB_ADDR_TYPE 0x01 | |
102 | /* Used for broadcast get device id as described in section 17.9 of the | |
103 | IPMI 1.5 manual. */ | |
104 | #define IPMI_IPMB_BROADCAST_ADDR_TYPE 0x41 | |
105 | struct ipmi_ipmb_addr | |
106 | { | |
107 | int addr_type; | |
108 | short channel; | |
109 | unsigned char slave_addr; | |
110 | unsigned char lun; | |
111 | }; | |
112 | ||
113 | /* | |
114 | * A LAN Address. This is an address to/from a LAN interface bridged | |
115 | * by the BMC, not an address actually out on the LAN. | |
116 | * | |
117 | * A concious decision was made here to deviate slightly from the IPMI | |
118 | * spec. We do not use rqSWID and rsSWID like it shows in the | |
119 | * message. Instead, we use remote_SWID and local_SWID. This means | |
120 | * that any message (a request or response) from another device will | |
121 | * always have exactly the same address. If you didn't do this, | |
122 | * requests and responses from the same device would have different | |
123 | * addresses, and that's not too cool. | |
124 | * | |
125 | * In this address, the remote_SWID is always the SWID the remote | |
126 | * message came from, or the SWID we are sending the message to. | |
127 | * local_SWID is always our SWID. Note that having our SWID in the | |
128 | * message is a little weird, but this is required. | |
129 | */ | |
130 | #define IPMI_LAN_ADDR_TYPE 0x04 | |
131 | struct ipmi_lan_addr | |
132 | { | |
133 | int addr_type; | |
134 | short channel; | |
135 | unsigned char privilege; | |
136 | unsigned char session_handle; | |
137 | unsigned char remote_SWID; | |
138 | unsigned char local_SWID; | |
139 | unsigned char lun; | |
140 | }; | |
141 | ||
142 | ||
143 | /* | |
144 | * Channel for talking directly with the BMC. When using this | |
145 | * channel, This is for the system interface address type only. FIXME | |
146 | * - is this right, or should we use -1? | |
147 | */ | |
148 | #define IPMI_BMC_CHANNEL 0xf | |
149 | #define IPMI_NUM_CHANNELS 0x10 | |
150 | ||
c69c3127 CM |
151 | /* |
152 | * Used to signify an "all channel" bitmask. This is more than the | |
153 | * actual number of channels because this is used in userland and | |
154 | * will cover us if the number of channels is extended. | |
155 | */ | |
156 | #define IPMI_CHAN_ALL (~0) | |
157 | ||
1da177e4 LT |
158 | |
159 | /* | |
160 | * A raw IPMI message without any addressing. This covers both | |
161 | * commands and responses. The completion code is always the first | |
162 | * byte of data in the response (as the spec shows the messages laid | |
163 | * out). | |
164 | */ | |
165 | struct ipmi_msg | |
166 | { | |
167 | unsigned char netfn; | |
168 | unsigned char cmd; | |
169 | unsigned short data_len; | |
170 | unsigned char __user *data; | |
171 | }; | |
172 | ||
173 | struct kernel_ipmi_msg | |
174 | { | |
175 | unsigned char netfn; | |
176 | unsigned char cmd; | |
177 | unsigned short data_len; | |
178 | unsigned char *data; | |
179 | }; | |
180 | ||
181 | /* | |
182 | * Various defines that are useful for IPMI applications. | |
183 | */ | |
184 | #define IPMI_INVALID_CMD_COMPLETION_CODE 0xC1 | |
185 | #define IPMI_TIMEOUT_COMPLETION_CODE 0xC3 | |
186 | #define IPMI_UNKNOWN_ERR_COMPLETION_CODE 0xff | |
187 | ||
188 | ||
189 | /* | |
190 | * Receive types for messages coming from the receive interface. This | |
191 | * is used for the receive in-kernel interface and in the receive | |
192 | * IOCTL. | |
193 | * | |
194 | * The "IPMI_RESPONSE_RESPNOSE_TYPE" is a little strange sounding, but | |
195 | * it allows you to get the message results when you send a response | |
196 | * message. | |
197 | */ | |
198 | #define IPMI_RESPONSE_RECV_TYPE 1 /* A response to a command */ | |
199 | #define IPMI_ASYNC_EVENT_RECV_TYPE 2 /* Something from the event queue */ | |
200 | #define IPMI_CMD_RECV_TYPE 3 /* A command from somewhere else */ | |
201 | #define IPMI_RESPONSE_RESPONSE_TYPE 4 /* The response for | |
202 | a sent response, giving any | |
203 | error status for sending the | |
204 | response. When you send a | |
205 | response message, this will | |
206 | be returned. */ | |
207 | /* Note that async events and received commands do not have a completion | |
208 | code as the first byte of the incoming data, unlike a response. */ | |
209 | ||
210 | ||
211 | ||
212 | #ifdef __KERNEL__ | |
213 | ||
214 | /* | |
215 | * The in-kernel interface. | |
216 | */ | |
217 | #include <linux/list.h> | |
218 | #include <linux/module.h> | |
2e0e1f9f | 219 | #include <linux/device.h> |
3b625943 | 220 | #include <linux/proc_fs.h> |
3b625943 | 221 | |
1da177e4 LT |
222 | /* Opaque type for a IPMI message user. One of these is needed to |
223 | send and receive messages. */ | |
224 | typedef struct ipmi_user *ipmi_user_t; | |
225 | ||
226 | /* | |
227 | * Stuff coming from the receive interface comes as one of these. | |
228 | * They are allocated, the receiver must free them with | |
229 | * ipmi_free_recv_msg() when done with the message. The link is not | |
230 | * used after the message is delivered, so the upper layer may use the | |
231 | * link to build a linked list, if it likes. | |
232 | */ | |
233 | struct ipmi_recv_msg | |
234 | { | |
235 | struct list_head link; | |
236 | ||
237 | /* The type of message as defined in the "Receive Types" | |
238 | defines above. */ | |
239 | int recv_type; | |
240 | ||
241 | ipmi_user_t user; | |
242 | struct ipmi_addr addr; | |
243 | long msgid; | |
244 | struct kernel_ipmi_msg msg; | |
245 | ||
246 | /* The user_msg_data is the data supplied when a message was | |
247 | sent, if this is a response to a sent message. If this is | |
248 | not a response to a sent message, then user_msg_data will | |
56a55ec6 CM |
249 | be NULL. If the user above is NULL, then this will be the |
250 | intf. */ | |
1da177e4 LT |
251 | void *user_msg_data; |
252 | ||
253 | /* Call this when done with the message. It will presumably free | |
254 | the message and do any other necessary cleanup. */ | |
255 | void (*done)(struct ipmi_recv_msg *msg); | |
256 | ||
257 | /* Place-holder for the data, don't make any assumptions about | |
258 | the size or existance of this, since it may change. */ | |
259 | unsigned char msg_data[IPMI_MAX_MSG_LENGTH]; | |
260 | }; | |
261 | ||
262 | /* Allocate and free the receive message. */ | |
393d2cc3 | 263 | void ipmi_free_recv_msg(struct ipmi_recv_msg *msg); |
1da177e4 LT |
264 | |
265 | struct ipmi_user_hndl | |
266 | { | |
267 | /* Routine type to call when a message needs to be routed to | |
268 | the upper layer. This will be called with some locks held, | |
269 | the only IPMI routines that can be called are ipmi_request | |
270 | and the alloc/free operations. The handler_data is the | |
271 | variable supplied when the receive handler was registered. */ | |
272 | void (*ipmi_recv_hndl)(struct ipmi_recv_msg *msg, | |
273 | void *user_msg_data); | |
274 | ||
275 | /* Called when the interface detects a watchdog pre-timeout. If | |
276 | this is NULL, it will be ignored for the user. */ | |
277 | void (*ipmi_watchdog_pretimeout)(void *handler_data); | |
278 | }; | |
279 | ||
280 | /* Create a new user of the IPMI layer on the given interface number. */ | |
281 | int ipmi_create_user(unsigned int if_num, | |
282 | struct ipmi_user_hndl *handler, | |
283 | void *handler_data, | |
284 | ipmi_user_t *user); | |
285 | ||
286 | /* Destroy the given user of the IPMI layer. Note that after this | |
287 | function returns, the system is guaranteed to not call any | |
288 | callbacks for the user. Thus as long as you destroy all the users | |
289 | before you unload a module, you will be safe. And if you destroy | |
290 | the users before you destroy the callback structures, it should be | |
291 | safe, too. */ | |
292 | int ipmi_destroy_user(ipmi_user_t user); | |
293 | ||
294 | /* Get the IPMI version of the BMC we are talking to. */ | |
295 | void ipmi_get_version(ipmi_user_t user, | |
296 | unsigned char *major, | |
297 | unsigned char *minor); | |
298 | ||
299 | /* Set and get the slave address and LUN that we will use for our | |
300 | source messages. Note that this affects the interface, not just | |
301 | this user, so it will affect all users of this interface. This is | |
302 | so some initialization code can come in and do the OEM-specific | |
303 | things it takes to determine your address (if not the BMC) and set | |
c14979b9 CM |
304 | it for everyone else. Note that each channel can have its own address. */ |
305 | int ipmi_set_my_address(ipmi_user_t user, | |
306 | unsigned int channel, | |
307 | unsigned char address); | |
308 | int ipmi_get_my_address(ipmi_user_t user, | |
309 | unsigned int channel, | |
310 | unsigned char *address); | |
311 | int ipmi_set_my_LUN(ipmi_user_t user, | |
312 | unsigned int channel, | |
313 | unsigned char LUN); | |
314 | int ipmi_get_my_LUN(ipmi_user_t user, | |
315 | unsigned int channel, | |
316 | unsigned char *LUN); | |
1da177e4 LT |
317 | |
318 | /* | |
319 | * Like ipmi_request, but lets you specify the number of retries and | |
320 | * the retry time. The retries is the number of times the message | |
321 | * will be resent if no reply is received. If set to -1, the default | |
322 | * value will be used. The retry time is the time in milliseconds | |
323 | * between retries. If set to zero, the default value will be | |
324 | * used. | |
325 | * | |
326 | * Don't use this unless you *really* have to. It's primarily for the | |
327 | * IPMI over LAN converter; since the LAN stuff does its own retries, | |
328 | * it makes no sense to do it here. However, this can be used if you | |
329 | * have unusual requirements. | |
330 | */ | |
331 | int ipmi_request_settime(ipmi_user_t user, | |
332 | struct ipmi_addr *addr, | |
333 | long msgid, | |
334 | struct kernel_ipmi_msg *msg, | |
335 | void *user_msg_data, | |
336 | int priority, | |
337 | int max_retries, | |
338 | unsigned int retry_time_ms); | |
339 | ||
340 | /* | |
341 | * Like ipmi_request, but with messages supplied. This will not | |
342 | * allocate any memory, and the messages may be statically allocated | |
343 | * (just make sure to do the "done" handling on them). Note that this | |
344 | * is primarily for the watchdog timer, since it should be able to | |
345 | * send messages even if no memory is available. This is subject to | |
346 | * change as the system changes, so don't use it unless you REALLY | |
347 | * have to. | |
348 | */ | |
349 | int ipmi_request_supply_msgs(ipmi_user_t user, | |
350 | struct ipmi_addr *addr, | |
351 | long msgid, | |
352 | struct kernel_ipmi_msg *msg, | |
353 | void *user_msg_data, | |
354 | void *supplied_smi, | |
355 | struct ipmi_recv_msg *supplied_recv, | |
356 | int priority); | |
357 | ||
358 | /* | |
359 | * When commands come in to the SMS, the user can register to receive | |
c69c3127 | 360 | * them. Only one user can be listening on a specific netfn/cmd/chan tuple |
1da177e4 LT |
361 | * at a time, you will get an EBUSY error if the command is already |
362 | * registered. If a command is received that does not have a user | |
363 | * registered, the driver will automatically return the proper | |
c69c3127 CM |
364 | * error. Channels are specified as a bitfield, use IPMI_CHAN_ALL to |
365 | * mean all channels. | |
1da177e4 LT |
366 | */ |
367 | int ipmi_register_for_cmd(ipmi_user_t user, | |
368 | unsigned char netfn, | |
c69c3127 CM |
369 | unsigned char cmd, |
370 | unsigned int chans); | |
1da177e4 LT |
371 | int ipmi_unregister_for_cmd(ipmi_user_t user, |
372 | unsigned char netfn, | |
c69c3127 CM |
373 | unsigned char cmd, |
374 | unsigned int chans); | |
1da177e4 LT |
375 | |
376 | /* | |
377 | * Allow run-to-completion mode to be set for the interface of | |
378 | * a specific user. | |
379 | */ | |
380 | void ipmi_user_set_run_to_completion(ipmi_user_t user, int val); | |
381 | ||
382 | /* | |
383 | * When the user is created, it will not receive IPMI events by | |
384 | * default. The user must set this to TRUE to get incoming events. | |
385 | * The first user that sets this to TRUE will receive all events that | |
386 | * have been queued while no one was waiting for events. | |
387 | */ | |
388 | int ipmi_set_gets_events(ipmi_user_t user, int val); | |
389 | ||
390 | /* | |
391 | * Called when a new SMI is registered. This will also be called on | |
392 | * every existing interface when a new watcher is registered with | |
393 | * ipmi_smi_watcher_register(). | |
394 | */ | |
395 | struct ipmi_smi_watcher | |
396 | { | |
397 | struct list_head link; | |
398 | ||
399 | /* You must set the owner to the current module, if you are in | |
400 | a module (generally just set it to "THIS_MODULE"). */ | |
401 | struct module *owner; | |
402 | ||
403 | /* These two are called with read locks held for the interface | |
404 | the watcher list. So you can add and remove users from the | |
405 | IPMI interface, send messages, etc., but you cannot add | |
406 | or remove SMI watchers or SMI interfaces. */ | |
50c812b2 | 407 | void (*new_smi)(int if_num, struct device *dev); |
1da177e4 LT |
408 | void (*smi_gone)(int if_num); |
409 | }; | |
410 | ||
411 | int ipmi_smi_watcher_register(struct ipmi_smi_watcher *watcher); | |
412 | int ipmi_smi_watcher_unregister(struct ipmi_smi_watcher *watcher); | |
413 | ||
414 | /* The following are various helper functions for dealing with IPMI | |
415 | addresses. */ | |
416 | ||
417 | /* Return the maximum length of an IPMI address given it's type. */ | |
418 | unsigned int ipmi_addr_length(int addr_type); | |
419 | ||
420 | /* Validate that the given IPMI address is valid. */ | |
421 | int ipmi_validate_addr(struct ipmi_addr *addr, int len); | |
422 | ||
423 | #endif /* __KERNEL__ */ | |
424 | ||
425 | ||
426 | /* | |
427 | * The userland interface | |
428 | */ | |
429 | ||
430 | /* | |
431 | * The userland interface for the IPMI driver is a standard character | |
432 | * device, with each instance of an interface registered as a minor | |
433 | * number under the major character device. | |
434 | * | |
435 | * The read and write calls do not work, to get messages in and out | |
436 | * requires ioctl calls because of the complexity of the data. select | |
437 | * and poll do work, so you can wait for input using the file | |
438 | * descriptor, you just can use read to get it. | |
439 | * | |
440 | * In general, you send a command down to the interface and receive | |
441 | * responses back. You can use the msgid value to correlate commands | |
442 | * and responses, the driver will take care of figuring out which | |
443 | * incoming messages are for which command and find the proper msgid | |
444 | * value to report. You will only receive reponses for commands you | |
445 | * send. Asynchronous events, however, go to all open users, so you | |
446 | * must be ready to handle these (or ignore them if you don't care). | |
447 | * | |
448 | * The address type depends upon the channel type. When talking | |
449 | * directly to the BMC (IPMC_BMC_CHANNEL), the address is ignored | |
450 | * (IPMI_UNUSED_ADDR_TYPE). When talking to an IPMB channel, you must | |
451 | * supply a valid IPMB address with the addr_type set properly. | |
452 | * | |
453 | * When talking to normal channels, the driver takes care of the | |
454 | * details of formatting and sending messages on that channel. You do | |
455 | * not, for instance, have to format a send command, you just send | |
456 | * whatever command you want to the channel, the driver will create | |
457 | * the send command, automatically issue receive command and get even | |
458 | * commands, and pass those up to the proper user. | |
459 | */ | |
460 | ||
461 | ||
462 | /* The magic IOCTL value for this interface. */ | |
463 | #define IPMI_IOC_MAGIC 'i' | |
464 | ||
465 | ||
466 | /* Messages sent to the interface are this format. */ | |
467 | struct ipmi_req | |
468 | { | |
469 | unsigned char __user *addr; /* Address to send the message to. */ | |
470 | unsigned int addr_len; | |
471 | ||
472 | long msgid; /* The sequence number for the message. This | |
473 | exact value will be reported back in the | |
474 | response to this request if it is a command. | |
475 | If it is a response, this will be used as | |
476 | the sequence value for the response. */ | |
477 | ||
478 | struct ipmi_msg msg; | |
479 | }; | |
480 | /* | |
481 | * Send a message to the interfaces. error values are: | |
482 | * - EFAULT - an address supplied was invalid. | |
483 | * - EINVAL - The address supplied was not valid, or the command | |
484 | * was not allowed. | |
485 | * - EMSGSIZE - The message to was too large. | |
486 | * - ENOMEM - Buffers could not be allocated for the command. | |
487 | */ | |
488 | #define IPMICTL_SEND_COMMAND _IOR(IPMI_IOC_MAGIC, 13, \ | |
489 | struct ipmi_req) | |
490 | ||
491 | /* Messages sent to the interface with timing parameters are this | |
492 | format. */ | |
493 | struct ipmi_req_settime | |
494 | { | |
495 | struct ipmi_req req; | |
496 | ||
497 | /* See ipmi_request_settime() above for details on these | |
498 | values. */ | |
499 | int retries; | |
500 | unsigned int retry_time_ms; | |
501 | }; | |
502 | /* | |
503 | * Send a message to the interfaces with timing parameters. error values | |
504 | * are: | |
505 | * - EFAULT - an address supplied was invalid. | |
506 | * - EINVAL - The address supplied was not valid, or the command | |
507 | * was not allowed. | |
508 | * - EMSGSIZE - The message to was too large. | |
509 | * - ENOMEM - Buffers could not be allocated for the command. | |
510 | */ | |
511 | #define IPMICTL_SEND_COMMAND_SETTIME _IOR(IPMI_IOC_MAGIC, 21, \ | |
512 | struct ipmi_req_settime) | |
513 | ||
514 | /* Messages received from the interface are this format. */ | |
515 | struct ipmi_recv | |
516 | { | |
517 | int recv_type; /* Is this a command, response or an | |
518 | asyncronous event. */ | |
519 | ||
520 | unsigned char __user *addr; /* Address the message was from is put | |
521 | here. The caller must supply the | |
522 | memory. */ | |
523 | unsigned int addr_len; /* The size of the address buffer. | |
524 | The caller supplies the full buffer | |
525 | length, this value is updated to | |
526 | the actual message length when the | |
527 | message is received. */ | |
528 | ||
529 | long msgid; /* The sequence number specified in the request | |
530 | if this is a response. If this is a command, | |
531 | this will be the sequence number from the | |
532 | command. */ | |
533 | ||
534 | struct ipmi_msg msg; /* The data field must point to a buffer. | |
535 | The data_size field must be set to the | |
536 | size of the message buffer. The | |
537 | caller supplies the full buffer | |
538 | length, this value is updated to the | |
539 | actual message length when the message | |
540 | is received. */ | |
541 | }; | |
542 | ||
543 | /* | |
544 | * Receive a message. error values: | |
545 | * - EAGAIN - no messages in the queue. | |
546 | * - EFAULT - an address supplied was invalid. | |
547 | * - EINVAL - The address supplied was not valid. | |
548 | * - EMSGSIZE - The message to was too large to fit into the message buffer, | |
549 | * the message will be left in the buffer. */ | |
550 | #define IPMICTL_RECEIVE_MSG _IOWR(IPMI_IOC_MAGIC, 12, \ | |
551 | struct ipmi_recv) | |
552 | ||
553 | /* | |
554 | * Like RECEIVE_MSG, but if the message won't fit in the buffer, it | |
555 | * will truncate the contents instead of leaving the data in the | |
556 | * buffer. | |
557 | */ | |
558 | #define IPMICTL_RECEIVE_MSG_TRUNC _IOWR(IPMI_IOC_MAGIC, 11, \ | |
559 | struct ipmi_recv) | |
560 | ||
561 | /* Register to get commands from other entities on this interface. */ | |
562 | struct ipmi_cmdspec | |
563 | { | |
564 | unsigned char netfn; | |
565 | unsigned char cmd; | |
566 | }; | |
567 | ||
568 | /* | |
569 | * Register to receive a specific command. error values: | |
570 | * - EFAULT - an address supplied was invalid. | |
571 | * - EBUSY - The netfn/cmd supplied was already in use. | |
572 | * - ENOMEM - could not allocate memory for the entry. | |
573 | */ | |
574 | #define IPMICTL_REGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 14, \ | |
575 | struct ipmi_cmdspec) | |
576 | /* | |
577 | * Unregister a regsitered command. error values: | |
578 | * - EFAULT - an address supplied was invalid. | |
579 | * - ENOENT - The netfn/cmd was not found registered for this user. | |
580 | */ | |
581 | #define IPMICTL_UNREGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 15, \ | |
582 | struct ipmi_cmdspec) | |
583 | ||
c69c3127 CM |
584 | /* |
585 | * Register to get commands from other entities on specific channels. | |
586 | * This way, you can only listen on specific channels, or have messages | |
587 | * from some channels go to one place and other channels to someplace | |
588 | * else. The chans field is a bitmask, (1 << channel) for each channel. | |
589 | * It may be IPMI_CHAN_ALL for all channels. | |
590 | */ | |
591 | struct ipmi_cmdspec_chans | |
592 | { | |
593 | unsigned int netfn; | |
594 | unsigned int cmd; | |
595 | unsigned int chans; | |
596 | }; | |
597 | ||
598 | /* | |
599 | * Register to receive a specific command on specific channels. error values: | |
600 | * - EFAULT - an address supplied was invalid. | |
601 | * - EBUSY - One of the netfn/cmd/chans supplied was already in use. | |
602 | * - ENOMEM - could not allocate memory for the entry. | |
603 | */ | |
604 | #define IPMICTL_REGISTER_FOR_CMD_CHANS _IOR(IPMI_IOC_MAGIC, 28, \ | |
605 | struct ipmi_cmdspec_chans) | |
606 | /* | |
607 | * Unregister some netfn/cmd/chans. error values: | |
608 | * - EFAULT - an address supplied was invalid. | |
609 | * - ENOENT - None of the netfn/cmd/chans were found registered for this user. | |
610 | */ | |
611 | #define IPMICTL_UNREGISTER_FOR_CMD_CHANS _IOR(IPMI_IOC_MAGIC, 29, \ | |
612 | struct ipmi_cmdspec_chans) | |
613 | ||
1da177e4 LT |
614 | /* |
615 | * Set whether this interface receives events. Note that the first | |
616 | * user registered for events will get all pending events for the | |
617 | * interface. error values: | |
618 | * - EFAULT - an address supplied was invalid. | |
619 | */ | |
620 | #define IPMICTL_SET_GETS_EVENTS_CMD _IOR(IPMI_IOC_MAGIC, 16, int) | |
621 | ||
622 | /* | |
623 | * Set and get the slave address and LUN that we will use for our | |
624 | * source messages. Note that this affects the interface, not just | |
625 | * this user, so it will affect all users of this interface. This is | |
626 | * so some initialization code can come in and do the OEM-specific | |
627 | * things it takes to determine your address (if not the BMC) and set | |
628 | * it for everyone else. You should probably leave the LUN alone. | |
629 | */ | |
c14979b9 CM |
630 | struct ipmi_channel_lun_address_set |
631 | { | |
632 | unsigned short channel; | |
633 | unsigned char value; | |
634 | }; | |
635 | #define IPMICTL_SET_MY_CHANNEL_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 24, struct ipmi_channel_lun_address_set) | |
636 | #define IPMICTL_GET_MY_CHANNEL_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 25, struct ipmi_channel_lun_address_set) | |
637 | #define IPMICTL_SET_MY_CHANNEL_LUN_CMD _IOR(IPMI_IOC_MAGIC, 26, struct ipmi_channel_lun_address_set) | |
638 | #define IPMICTL_GET_MY_CHANNEL_LUN_CMD _IOR(IPMI_IOC_MAGIC, 27, struct ipmi_channel_lun_address_set) | |
639 | /* Legacy interfaces, these only set IPMB 0. */ | |
1da177e4 LT |
640 | #define IPMICTL_SET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 17, unsigned int) |
641 | #define IPMICTL_GET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 18, unsigned int) | |
642 | #define IPMICTL_SET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 19, unsigned int) | |
643 | #define IPMICTL_GET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 20, unsigned int) | |
644 | ||
645 | /* | |
646 | * Get/set the default timing values for an interface. You shouldn't | |
647 | * generally mess with these. | |
648 | */ | |
649 | struct ipmi_timing_parms | |
650 | { | |
651 | int retries; | |
652 | unsigned int retry_time_ms; | |
653 | }; | |
654 | #define IPMICTL_SET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 22, \ | |
655 | struct ipmi_timing_parms) | |
656 | #define IPMICTL_GET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 23, \ | |
657 | struct ipmi_timing_parms) | |
658 | ||
659 | #endif /* __LINUX_IPMI_H */ |