ipmi.h 25 KB

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