1 /* 2 * ipmi_smi.h 3 * 4 * MontaVista IPMI system management interface 5 * 6 * Author: MontaVista Software, Inc. 7 * Corey Minyard <[email protected]> 8 * [email protected] 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_SMI_H 35 #define __LINUX_IPMI_SMI_H 36 37 #include <linux/ipmi_msgdefs.h> 38 #include <linux/proc_fs.h> 39 #include <linux/module.h> 40 #include <linux/device.h> 41 #include <linux/platform_device.h> 42 #include <linux/ipmi_smi.h> 43 44 /* This files describes the interface for IPMI system management interface 45 drivers to bind into the IPMI message handler. */ 46 47 /* Structure for the low-level drivers. */ 48 typedef struct ipmi_smi *ipmi_smi_t; 49 50 /* 51 * Messages to/from the lower layer. The smi interface will take one 52 * of these to send. After the send has occurred and a response has 53 * been received, it will report this same data structure back up to 54 * the upper layer. If an error occurs, it should fill in the 55 * response with an error code in the completion code location. When 56 * asynchronous data is received, one of these is allocated, the 57 * data_size is set to zero and the response holds the data from the 58 * get message or get event command that the interface initiated. 59 * Note that it is the interfaces responsibility to detect 60 * asynchronous data and messages and request them from the 61 * interface. 62 */ 63 struct ipmi_smi_msg 64 { 65 struct list_head link; 66 67 long msgid; 68 void *user_data; 69 70 int data_size; 71 unsigned char data[IPMI_MAX_MSG_LENGTH]; 72 73 int rsp_size; 74 unsigned char rsp[IPMI_MAX_MSG_LENGTH]; 75 76 /* Will be called when the system is done with the message 77 (presumably to free it). */ 78 void (*done)(struct ipmi_smi_msg *msg); 79 }; 80 81 struct ipmi_smi_handlers 82 { 83 struct module *owner; 84 85 /* The low-level interface cannot start sending messages to 86 the upper layer until this function is called. This may 87 not be NULL, the lower layer must take the interface from 88 this call. */ 89 int (*start_processing)(void *send_info, 90 ipmi_smi_t new_intf); 91 92 /* Called to enqueue an SMI message to be sent. This 93 operation is not allowed to fail. If an error occurs, it 94 should report back the error in a received message. It may 95 do this in the current call context, since no write locks 96 are held when this is run. If the priority is > 0, the 97 message will go into a high-priority queue and be sent 98 first. Otherwise, it goes into a normal-priority queue. */ 99 void (*sender)(void *send_info, 100 struct ipmi_smi_msg *msg, 101 int priority); 102 103 /* Called by the upper layer to request that we try to get 104 events from the BMC we are attached to. */ 105 void (*request_events)(void *send_info); 106 107 /* Called when the interface should go into "run to 108 completion" mode. If this call sets the value to true, the 109 interface should make sure that all messages are flushed 110 out and that none are pending, and any new requests are run 111 to completion immediately. */ 112 void (*set_run_to_completion)(void *send_info, int run_to_completion); 113 114 /* Called to poll for work to do. This is so upper layers can 115 poll for operations during things like crash dumps. */ 116 void (*poll)(void *send_info); 117 118 /* Enable/disable firmware maintenance mode. Note that this 119 is *not* the modes defined, this is simply an on/off 120 setting. The message handler does the mode handling. Note 121 that this is called from interupt context, so it cannot 122 block. */ 123 void (*set_maintenance_mode)(void *send_info, int enable); 124 125 /* Tell the handler that we are using it/not using it. The 126 message handler get the modules that this handler belongs 127 to; this function lets the SMI claim any modules that it 128 uses. These may be NULL if this is not required. */ 129 int (*inc_usecount)(void *send_info); 130 void (*dec_usecount)(void *send_info); 131 }; 132 133 struct ipmi_device_id { 134 unsigned char device_id; 135 unsigned char device_revision; 136 unsigned char firmware_revision_1; 137 unsigned char firmware_revision_2; 138 unsigned char ipmi_version; 139 unsigned char additional_device_support; 140 unsigned int manufacturer_id; 141 unsigned int product_id; 142 unsigned char aux_firmware_revision[4]; 143 unsigned int aux_firmware_revision_set : 1; 144 }; 145 146 #define ipmi_version_major(v) ((v)->ipmi_version & 0xf) 147 #define ipmi_version_minor(v) ((v)->ipmi_version >> 4) 148 149 /* Take a pointer to a raw data buffer and a length and extract device 150 id information from it. The first byte of data must point to the 151 byte from the get device id response after the completion code. 152 The caller is responsible for making sure the length is at least 153 11 and the command completed without error. */ 154 static inline void ipmi_demangle_device_id(unsigned char *data, 155 unsigned int data_len, 156 struct ipmi_device_id *id) 157 { 158 id->device_id = data[0]; 159 id->device_revision = data[1]; 160 id->firmware_revision_1 = data[2]; 161 id->firmware_revision_2 = data[3]; 162 id->ipmi_version = data[4]; 163 id->additional_device_support = data[5]; 164 id->manufacturer_id = data[6] | (data[7] << 8) | (data[8] << 16); 165 id->product_id = data[9] | (data[10] << 8); 166 if (data_len >= 15) { 167 memcpy(id->aux_firmware_revision, data+11, 4); 168 id->aux_firmware_revision_set = 1; 169 } else 170 id->aux_firmware_revision_set = 0; 171 } 172 173 /* Add a low-level interface to the IPMI driver. Note that if the 174 interface doesn't know its slave address, it should pass in zero. 175 The low-level interface should not deliver any messages to the 176 upper layer until the start_processing() function in the handlers 177 is called, and the lower layer must get the interface from that 178 call. */ 179 int ipmi_register_smi(struct ipmi_smi_handlers *handlers, 180 void *send_info, 181 struct ipmi_device_id *device_id, 182 struct device *dev, 183 const char *sysfs_name, 184 unsigned char slave_addr); 185 186 /* 187 * Remove a low-level interface from the IPMI driver. This will 188 * return an error if the interface is still in use by a user. 189 */ 190 int ipmi_unregister_smi(ipmi_smi_t intf); 191 192 /* 193 * The lower layer reports received messages through this interface. 194 * The data_size should be zero if this is an asyncronous message. If 195 * the lower layer gets an error sending a message, it should format 196 * an error response in the message response. 197 */ 198 void ipmi_smi_msg_received(ipmi_smi_t intf, 199 struct ipmi_smi_msg *msg); 200 201 /* The lower layer received a watchdog pre-timeout on interface. */ 202 void ipmi_smi_watchdog_pretimeout(ipmi_smi_t intf); 203 204 struct ipmi_smi_msg *ipmi_alloc_smi_msg(void); 205 static inline void ipmi_free_smi_msg(struct ipmi_smi_msg *msg) 206 { 207 msg->done(msg); 208 } 209 210 /* Allow the lower layer to add things to the proc filesystem 211 directory for this interface. Note that the entry will 212 automatically be dstroyed when the interface is destroyed. */ 213 int ipmi_smi_add_proc_entry(ipmi_smi_t smi, char *name, 214 read_proc_t *read_proc, write_proc_t *write_proc, 215 void *data, struct module *owner); 216 217 #endif /* __LINUX_IPMI_SMI_H */ 218