1/* 2 * ipmi_smi.h 3 * 4 * MontaVista IPMI system management 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_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. */ 48typedef 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 */ 63struct ipmi_smi_msg { 64 struct list_head link; 65 66 long msgid; 67 void *user_data; 68 69 int data_size; 70 unsigned char data[IPMI_MAX_MSG_LENGTH]; 71 72 int rsp_size; 73 unsigned char rsp[IPMI_MAX_MSG_LENGTH]; 74 75 /* Will be called when the system is done with the message 76 (presumably to free it). */ 77 void (*done)(struct ipmi_smi_msg *msg); 78}; 79 80struct ipmi_smi_handlers { 81 struct module *owner; 82 83 /* The low-level interface cannot start sending messages to 84 the upper layer until this function is called. This may 85 not be NULL, the lower layer must take the interface from 86 this call. */ 87 int (*start_processing)(void *send_info, 88 ipmi_smi_t new_intf); 89 90 /* Called to enqueue an SMI message to be sent. This 91 operation is not allowed to fail. If an error occurs, it 92 should report back the error in a received message. It may 93 do this in the current call context, since no write locks 94 are held when this is run. If the priority is > 0, the 95 message will go into a high-priority queue and be sent 96 first. Otherwise, it goes into a normal-priority queue. */ 97 void (*sender)(void *send_info, 98 struct ipmi_smi_msg *msg, 99 int priority); 100 101 /* Called by the upper layer to request that we try to get 102 events from the BMC we are attached to. */ 103 void (*request_events)(void *send_info); 104 105 /* Called when the interface should go into "run to 106 completion" mode. If this call sets the value to true, the 107 interface should make sure that all messages are flushed 108 out and that none are pending, and any new requests are run 109 to completion immediately. */ 110 void (*set_run_to_completion)(void *send_info, int run_to_completion); 111 112 /* Called to poll for work to do. This is so upper layers can 113 poll for operations during things like crash dumps. */ 114 void (*poll)(void *send_info); 115 116 /* Enable/disable firmware maintenance mode. Note that this 117 is *not* the modes defined, this is simply an on/off 118 setting. The message handler does the mode handling. Note 119 that this is called from interrupt context, so it cannot 120 block. */ 121 void (*set_maintenance_mode)(void *send_info, int enable); 122 123 /* Tell the handler that we are using it/not using it. The 124 message handler get the modules that this handler belongs 125 to; this function lets the SMI claim any modules that it 126 uses. These may be NULL if this is not required. */ 127 int (*inc_usecount)(void *send_info); 128 void (*dec_usecount)(void *send_info); 129}; 130 131struct ipmi_device_id { 132 unsigned char device_id; 133 unsigned char device_revision; 134 unsigned char firmware_revision_1; 135 unsigned char firmware_revision_2; 136 unsigned char ipmi_version; 137 unsigned char additional_device_support; 138 unsigned int manufacturer_id; 139 unsigned int product_id; 140 unsigned char aux_firmware_revision[4]; 141 unsigned int aux_firmware_revision_set : 1; 142}; 143 144#define ipmi_version_major(v) ((v)->ipmi_version & 0xf) 145#define ipmi_version_minor(v) ((v)->ipmi_version >> 4) 146 147/* Take a pointer to a raw data buffer and a length and extract device 148 id information from it. The first byte of data must point to the 149 netfn << 2, the data should be of the format: 150 netfn << 2, cmd, completion code, data 151 as normally comes from a device interface. */ 152static inline int ipmi_demangle_device_id(const unsigned char *data, 153 unsigned int data_len, 154 struct ipmi_device_id *id) 155{ 156 if (data_len < 9) 157 return -EINVAL; 158 if (data[0] != IPMI_NETFN_APP_RESPONSE << 2 || 159 data[1] != IPMI_GET_DEVICE_ID_CMD) 160 /* Strange, didn't get the response we expected. */ 161 return -EINVAL; 162 if (data[2] != 0) 163 /* That's odd, it shouldn't be able to fail. */ 164 return -EINVAL; 165 166 data += 3; 167 data_len -= 3; 168 id->device_id = data[0]; 169 id->device_revision = data[1]; 170 id->firmware_revision_1 = data[2]; 171 id->firmware_revision_2 = data[3]; 172 id->ipmi_version = data[4]; 173 id->additional_device_support = data[5]; 174 if (data_len >= 11) { 175 id->manufacturer_id = (data[6] | (data[7] << 8) | 176 (data[8] << 16)); 177 id->product_id = data[9] | (data[10] << 8); 178 } else { 179 id->manufacturer_id = 0; 180 id->product_id = 0; 181 } 182 if (data_len >= 15) { 183 memcpy(id->aux_firmware_revision, data+11, 4); 184 id->aux_firmware_revision_set = 1; 185 } else 186 id->aux_firmware_revision_set = 0; 187 188 return 0; 189} 190 191/* Add a low-level interface to the IPMI driver. Note that if the 192 interface doesn't know its slave address, it should pass in zero. 193 The low-level interface should not deliver any messages to the 194 upper layer until the start_processing() function in the handlers 195 is called, and the lower layer must get the interface from that 196 call. */ 197int ipmi_register_smi(struct ipmi_smi_handlers *handlers, 198 void *send_info, 199 struct ipmi_device_id *device_id, 200 struct device *dev, 201 const char *sysfs_name, 202 unsigned char slave_addr); 203 204/* 205 * Remove a low-level interface from the IPMI driver. This will 206 * return an error if the interface is still in use by a user. 207 */ 208int ipmi_unregister_smi(ipmi_smi_t intf); 209 210/* 211 * The lower layer reports received messages through this interface. 212 * The data_size should be zero if this is an asyncronous message. If 213 * the lower layer gets an error sending a message, it should format 214 * an error response in the message response. 215 */ 216void ipmi_smi_msg_received(ipmi_smi_t intf, 217 struct ipmi_smi_msg *msg); 218 219/* The lower layer received a watchdog pre-timeout on interface. */ 220void ipmi_smi_watchdog_pretimeout(ipmi_smi_t intf); 221 222struct ipmi_smi_msg *ipmi_alloc_smi_msg(void); 223static inline void ipmi_free_smi_msg(struct ipmi_smi_msg *msg) 224{ 225 msg->done(msg); 226} 227 228/* Allow the lower layer to add things to the proc filesystem 229 directory for this interface. Note that the entry will 230 automatically be dstroyed when the interface is destroyed. */ 231int ipmi_smi_add_proc_entry(ipmi_smi_t smi, char *name, 232 read_proc_t *read_proc, 233 void *data); 234 235#endif /* __LINUX_IPMI_SMI_H */ 236