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> 38 39 /* 40 * This file describes an interface to an IPMI driver. You have to 41 * have a fairly good understanding of IPMI to use this, so go read 42 * the specs first before actually trying to do anything. 43 * 44 * With that said, this driver provides a multi-user interface to the 45 * IPMI driver, and it allows multiple IPMI physical interfaces below 46 * the driver. The physical interfaces bind as a lower layer on the 47 * driver. They appear as interfaces to the application using this 48 * interface. 49 * 50 * Multi-user means that multiple applications may use the driver, 51 * send commands, receive responses, etc. The driver keeps track of 52 * commands the user sends and tracks the responses. The responses 53 * will go back to the application that send the command. If the 54 * response doesn't come back in time, the driver will return a 55 * timeout error response to the application. Asynchronous events 56 * from the BMC event queue will go to all users bound to the driver. 57 * The incoming event queue in the BMC will automatically be flushed 58 * if it becomes full and it is queried once a second to see if 59 * anything is in it. Incoming commands to the driver will get 60 * delivered as commands. 61 * 62 * This driver provides two main interfaces: one for in-kernel 63 * applications and another for userland applications. The 64 * capabilities are basically the same for both interface, although 65 * the interfaces are somewhat different. The stuff in the 66 * #ifdef __KERNEL__ below is the in-kernel interface. The userland 67 * interface is defined later in the file. */ 68 69 70 71 /* 72 * This is an overlay for all the address types, so it's easy to 73 * determine the actual address type. This is kind of like addresses 74 * work for sockets. 75 */ 76 #define IPMI_MAX_ADDR_SIZE 32 77 struct ipmi_addr { 78 /* Try to take these from the "Channel Medium Type" table 79 in section 6.5 of the IPMI 1.5 manual. */ 80 int addr_type; 81 short channel; 82 char data[IPMI_MAX_ADDR_SIZE]; 83 }; 84 85 /* 86 * When the address is not used, the type will be set to this value. 87 * The channel is the BMC's channel number for the channel (usually 88 * 0), or IPMC_BMC_CHANNEL if communicating directly with the BMC. 89 */ 90 #define IPMI_SYSTEM_INTERFACE_ADDR_TYPE 0x0c 91 struct ipmi_system_interface_addr { 92 int addr_type; 93 short channel; 94 unsigned char lun; 95 }; 96 97 /* An IPMB Address. */ 98 #define IPMI_IPMB_ADDR_TYPE 0x01 99 /* Used for broadcast get device id as described in section 17.9 of the 100 IPMI 1.5 manual. */ 101 #define IPMI_IPMB_BROADCAST_ADDR_TYPE 0x41 102 struct ipmi_ipmb_addr { 103 int addr_type; 104 short channel; 105 unsigned char slave_addr; 106 unsigned char lun; 107 }; 108 109 /* 110 * A LAN Address. This is an address to/from a LAN interface bridged 111 * by the BMC, not an address actually out on the LAN. 112 * 113 * A concious decision was made here to deviate slightly from the IPMI 114 * spec. We do not use rqSWID and rsSWID like it shows in the 115 * message. Instead, we use remote_SWID and local_SWID. This means 116 * that any message (a request or response) from another device will 117 * always have exactly the same address. If you didn't do this, 118 * requests and responses from the same device would have different 119 * addresses, and that's not too cool. 120 * 121 * In this address, the remote_SWID is always the SWID the remote 122 * message came from, or the SWID we are sending the message to. 123 * local_SWID is always our SWID. Note that having our SWID in the 124 * message is a little weird, but this is required. 125 */ 126 #define IPMI_LAN_ADDR_TYPE 0x04 127 struct ipmi_lan_addr { 128 int addr_type; 129 short channel; 130 unsigned char privilege; 131 unsigned char session_handle; 132 unsigned char remote_SWID; 133 unsigned char local_SWID; 134 unsigned char lun; 135 }; 136 137 138 /* 139 * Channel for talking directly with the BMC. When using this 140 * channel, This is for the system interface address type only. FIXME 141 * - is this right, or should we use -1? 142 */ 143 #define IPMI_BMC_CHANNEL 0xf 144 #define IPMI_NUM_CHANNELS 0x10 145 146 /* 147 * Used to signify an "all channel" bitmask. This is more than the 148 * actual number of channels because this is used in userland and 149 * will cover us if the number of channels is extended. 150 */ 151 #define IPMI_CHAN_ALL (~0) 152 153 154 /* 155 * A raw IPMI message without any addressing. This covers both 156 * commands and responses. The completion code is always the first 157 * byte of data in the response (as the spec shows the messages laid 158 * out). 159 */ 160 struct ipmi_msg { 161 unsigned char netfn; 162 unsigned char cmd; 163 unsigned short data_len; 164 unsigned char *data; 165 }; 166 167 struct kernel_ipmi_msg { 168 unsigned char netfn; 169 unsigned char cmd; 170 unsigned short data_len; 171 unsigned char *data; 172 }; 173 174 /* 175 * Various defines that are useful for IPMI applications. 176 */ 177 #define IPMI_INVALID_CMD_COMPLETION_CODE 0xC1 178 #define IPMI_TIMEOUT_COMPLETION_CODE 0xC3 179 #define IPMI_UNKNOWN_ERR_COMPLETION_CODE 0xff 180 181 182 /* 183 * Receive types for messages coming from the receive interface. This 184 * is used for the receive in-kernel interface and in the receive 185 * IOCTL. 186 * 187 * The "IPMI_RESPONSE_RESPNOSE_TYPE" is a little strange sounding, but 188 * it allows you to get the message results when you send a response 189 * message. 190 */ 191 #define IPMI_RESPONSE_RECV_TYPE 1 /* A response to a command */ 192 #define IPMI_ASYNC_EVENT_RECV_TYPE 2 /* Something from the event queue */ 193 #define IPMI_CMD_RECV_TYPE 3 /* A command from somewhere else */ 194 #define IPMI_RESPONSE_RESPONSE_TYPE 4 /* The response for 195 a sent response, giving any 196 error status for sending the 197 response. When you send a 198 response message, this will 199 be returned. */ 200 /* Note that async events and received commands do not have a completion 201 code as the first byte of the incoming data, unlike a response. */ 202 203 204 /* 205 * Modes for ipmi_set_maint_mode() and the userland IOCTL. The AUTO 206 * setting is the default and means it will be set on certain 207 * commands. Hard setting it on and off will override automatic 208 * operation. 209 */ 210 #define IPMI_MAINTENANCE_MODE_AUTO 0 211 #define IPMI_MAINTENANCE_MODE_OFF 1 212 #define IPMI_MAINTENANCE_MODE_ON 2 213 214 215 216 /* 217 * The userland interface 218 */ 219 220 /* 221 * The userland interface for the IPMI driver is a standard character 222 * device, with each instance of an interface registered as a minor 223 * number under the major character device. 224 * 225 * The read and write calls do not work, to get messages in and out 226 * requires ioctl calls because of the complexity of the data. select 227 * and poll do work, so you can wait for input using the file 228 * descriptor, you just can use read to get it. 229 * 230 * In general, you send a command down to the interface and receive 231 * responses back. You can use the msgid value to correlate commands 232 * and responses, the driver will take care of figuring out which 233 * incoming messages are for which command and find the proper msgid 234 * value to report. You will only receive reponses for commands you 235 * send. Asynchronous events, however, go to all open users, so you 236 * must be ready to handle these (or ignore them if you don't care). 237 * 238 * The address type depends upon the channel type. When talking 239 * directly to the BMC (IPMC_BMC_CHANNEL), the address is ignored 240 * (IPMI_UNUSED_ADDR_TYPE). When talking to an IPMB channel, you must 241 * supply a valid IPMB address with the addr_type set properly. 242 * 243 * When talking to normal channels, the driver takes care of the 244 * details of formatting and sending messages on that channel. You do 245 * not, for instance, have to format a send command, you just send 246 * whatever command you want to the channel, the driver will create 247 * the send command, automatically issue receive command and get even 248 * commands, and pass those up to the proper user. 249 */ 250 251 252 /* The magic IOCTL value for this interface. */ 253 #define IPMI_IOC_MAGIC 'i' 254 255 256 /* Messages sent to the interface are this format. */ 257 struct ipmi_req { 258 unsigned char *addr; /* Address to send the message to. */ 259 unsigned int addr_len; 260 261 long msgid; /* The sequence number for the message. This 262 exact value will be reported back in the 263 response to this request if it is a command. 264 If it is a response, this will be used as 265 the sequence value for the response. */ 266 267 struct ipmi_msg msg; 268 }; 269 /* 270 * Send a message to the interfaces. error values are: 271 * - EFAULT - an address supplied was invalid. 272 * - EINVAL - The address supplied was not valid, or the command 273 * was not allowed. 274 * - EMSGSIZE - The message to was too large. 275 * - ENOMEM - Buffers could not be allocated for the command. 276 */ 277 #define IPMICTL_SEND_COMMAND _IOR(IPMI_IOC_MAGIC, 13, \ 278 struct ipmi_req) 279 280 /* Messages sent to the interface with timing parameters are this 281 format. */ 282 struct ipmi_req_settime { 283 struct ipmi_req req; 284 285 /* See ipmi_request_settime() above for details on these 286 values. */ 287 int retries; 288 unsigned int retry_time_ms; 289 }; 290 /* 291 * Send a message to the interfaces with timing parameters. error values 292 * are: 293 * - EFAULT - an address supplied was invalid. 294 * - EINVAL - The address supplied was not valid, or the command 295 * was not allowed. 296 * - EMSGSIZE - The message to was too large. 297 * - ENOMEM - Buffers could not be allocated for the command. 298 */ 299 #define IPMICTL_SEND_COMMAND_SETTIME _IOR(IPMI_IOC_MAGIC, 21, \ 300 struct ipmi_req_settime) 301 302 /* Messages received from the interface are this format. */ 303 struct ipmi_recv { 304 int recv_type; /* Is this a command, response or an 305 asyncronous event. */ 306 307 unsigned char *addr; /* Address the message was from is put 308 here. The caller must supply the 309 memory. */ 310 unsigned int addr_len; /* The size of the address buffer. 311 The caller supplies the full buffer 312 length, this value is updated to 313 the actual message length when the 314 message is received. */ 315 316 long msgid; /* The sequence number specified in the request 317 if this is a response. If this is a command, 318 this will be the sequence number from the 319 command. */ 320 321 struct ipmi_msg msg; /* The data field must point to a buffer. 322 The data_size field must be set to the 323 size of the message buffer. The 324 caller supplies the full buffer 325 length, this value is updated to the 326 actual message length when the message 327 is received. */ 328 }; 329 330 /* 331 * Receive a message. error values: 332 * - EAGAIN - no messages in the queue. 333 * - EFAULT - an address supplied was invalid. 334 * - EINVAL - The address supplied was not valid. 335 * - EMSGSIZE - The message to was too large to fit into the message buffer, 336 * the message will be left in the buffer. */ 337 #define IPMICTL_RECEIVE_MSG _IOWR(IPMI_IOC_MAGIC, 12, \ 338 struct ipmi_recv) 339 340 /* 341 * Like RECEIVE_MSG, but if the message won't fit in the buffer, it 342 * will truncate the contents instead of leaving the data in the 343 * buffer. 344 */ 345 #define IPMICTL_RECEIVE_MSG_TRUNC _IOWR(IPMI_IOC_MAGIC, 11, \ 346 struct ipmi_recv) 347 348 /* Register to get commands from other entities on this interface. */ 349 struct ipmi_cmdspec { 350 unsigned char netfn; 351 unsigned char cmd; 352 }; 353 354 /* 355 * Register to receive a specific command. error values: 356 * - EFAULT - an address supplied was invalid. 357 * - EBUSY - The netfn/cmd supplied was already in use. 358 * - ENOMEM - could not allocate memory for the entry. 359 */ 360 #define IPMICTL_REGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 14, \ 361 struct ipmi_cmdspec) 362 /* 363 * Unregister a regsitered command. error values: 364 * - EFAULT - an address supplied was invalid. 365 * - ENOENT - The netfn/cmd was not found registered for this user. 366 */ 367 #define IPMICTL_UNREGISTER_FOR_CMD _IOR(IPMI_IOC_MAGIC, 15, \ 368 struct ipmi_cmdspec) 369 370 /* 371 * Register to get commands from other entities on specific channels. 372 * This way, you can only listen on specific channels, or have messages 373 * from some channels go to one place and other channels to someplace 374 * else. The chans field is a bitmask, (1 << channel) for each channel. 375 * It may be IPMI_CHAN_ALL for all channels. 376 */ 377 struct ipmi_cmdspec_chans { 378 unsigned int netfn; 379 unsigned int cmd; 380 unsigned int chans; 381 }; 382 383 /* 384 * Register to receive a specific command on specific channels. error values: 385 * - EFAULT - an address supplied was invalid. 386 * - EBUSY - One of the netfn/cmd/chans supplied was already in use. 387 * - ENOMEM - could not allocate memory for the entry. 388 */ 389 #define IPMICTL_REGISTER_FOR_CMD_CHANS _IOR(IPMI_IOC_MAGIC, 28, \ 390 struct ipmi_cmdspec_chans) 391 /* 392 * Unregister some netfn/cmd/chans. error values: 393 * - EFAULT - an address supplied was invalid. 394 * - ENOENT - None of the netfn/cmd/chans were found registered for this user. 395 */ 396 #define IPMICTL_UNREGISTER_FOR_CMD_CHANS _IOR(IPMI_IOC_MAGIC, 29, \ 397 struct ipmi_cmdspec_chans) 398 399 /* 400 * Set whether this interface receives events. Note that the first 401 * user registered for events will get all pending events for the 402 * interface. error values: 403 * - EFAULT - an address supplied was invalid. 404 */ 405 #define IPMICTL_SET_GETS_EVENTS_CMD _IOR(IPMI_IOC_MAGIC, 16, int) 406 407 /* 408 * Set and get the slave address and LUN that we will use for our 409 * source messages. Note that this affects the interface, not just 410 * this user, so it will affect all users of this interface. This is 411 * so some initialization code can come in and do the OEM-specific 412 * things it takes to determine your address (if not the BMC) and set 413 * it for everyone else. You should probably leave the LUN alone. 414 */ 415 struct ipmi_channel_lun_address_set { 416 unsigned short channel; 417 unsigned char value; 418 }; 419 #define IPMICTL_SET_MY_CHANNEL_ADDRESS_CMD \ 420 _IOR(IPMI_IOC_MAGIC, 24, struct ipmi_channel_lun_address_set) 421 #define IPMICTL_GET_MY_CHANNEL_ADDRESS_CMD \ 422 _IOR(IPMI_IOC_MAGIC, 25, struct ipmi_channel_lun_address_set) 423 #define IPMICTL_SET_MY_CHANNEL_LUN_CMD \ 424 _IOR(IPMI_IOC_MAGIC, 26, struct ipmi_channel_lun_address_set) 425 #define IPMICTL_GET_MY_CHANNEL_LUN_CMD \ 426 _IOR(IPMI_IOC_MAGIC, 27, struct ipmi_channel_lun_address_set) 427 /* Legacy interfaces, these only set IPMB 0. */ 428 #define IPMICTL_SET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 17, unsigned int) 429 #define IPMICTL_GET_MY_ADDRESS_CMD _IOR(IPMI_IOC_MAGIC, 18, unsigned int) 430 #define IPMICTL_SET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 19, unsigned int) 431 #define IPMICTL_GET_MY_LUN_CMD _IOR(IPMI_IOC_MAGIC, 20, unsigned int) 432 433 /* 434 * Get/set the default timing values for an interface. You shouldn't 435 * generally mess with these. 436 */ 437 struct ipmi_timing_parms { 438 int retries; 439 unsigned int retry_time_ms; 440 }; 441 #define IPMICTL_SET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 22, \ 442 struct ipmi_timing_parms) 443 #define IPMICTL_GET_TIMING_PARMS_CMD _IOR(IPMI_IOC_MAGIC, 23, \ 444 struct ipmi_timing_parms) 445 446 /* 447 * Set the maintenance mode. See ipmi_set_maintenance_mode() above 448 * for a description of what this does. 449 */ 450 #define IPMICTL_GET_MAINTENANCE_MODE_CMD _IOR(IPMI_IOC_MAGIC, 30, int) 451 #define IPMICTL_SET_MAINTENANCE_MODE_CMD _IOW(IPMI_IOC_MAGIC, 31, int) 452 453 #endif /* __LINUX_IPMI_H */ 454