Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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> |
Corey Minyard | 50c812b | 2006-03-26 01:37:21 -0800 | [diff] [blame^] | 40 | #include <linux/device.h> |
| 41 | #include <linux/platform_device.h> |
| 42 | #include <linux/ipmi_smi.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | /* Called to enqueue an SMI message to be sent. This |
| 86 | operation is not allowed to fail. If an error occurs, it |
| 87 | should report back the error in a received message. It may |
| 88 | do this in the current call context, since no write locks |
| 89 | are held when this is run. If the priority is > 0, the |
| 90 | message will go into a high-priority queue and be sent |
| 91 | first. Otherwise, it goes into a normal-priority queue. */ |
| 92 | void (*sender)(void *send_info, |
| 93 | struct ipmi_smi_msg *msg, |
| 94 | int priority); |
| 95 | |
| 96 | /* Called by the upper layer to request that we try to get |
| 97 | events from the BMC we are attached to. */ |
| 98 | void (*request_events)(void *send_info); |
| 99 | |
| 100 | /* Called when the interface should go into "run to |
| 101 | completion" mode. If this call sets the value to true, the |
| 102 | interface should make sure that all messages are flushed |
| 103 | out and that none are pending, and any new requests are run |
| 104 | to completion immediately. */ |
| 105 | void (*set_run_to_completion)(void *send_info, int run_to_completion); |
| 106 | |
| 107 | /* Called to poll for work to do. This is so upper layers can |
| 108 | poll for operations during things like crash dumps. */ |
| 109 | void (*poll)(void *send_info); |
| 110 | |
| 111 | /* Tell the handler that we are using it/not using it. The |
| 112 | message handler get the modules that this handler belongs |
| 113 | to; this function lets the SMI claim any modules that it |
| 114 | uses. These may be NULL if this is not required. */ |
| 115 | int (*inc_usecount)(void *send_info); |
| 116 | void (*dec_usecount)(void *send_info); |
| 117 | }; |
| 118 | |
Corey Minyard | 50c812b | 2006-03-26 01:37:21 -0800 | [diff] [blame^] | 119 | struct ipmi_device_id { |
| 120 | unsigned char device_id; |
| 121 | unsigned char device_revision; |
| 122 | unsigned char firmware_revision_1; |
| 123 | unsigned char firmware_revision_2; |
| 124 | unsigned char ipmi_version; |
| 125 | unsigned char additional_device_support; |
| 126 | unsigned int manufacturer_id; |
| 127 | unsigned int product_id; |
| 128 | unsigned char aux_firmware_revision[4]; |
| 129 | unsigned int aux_firmware_revision_set : 1; |
| 130 | }; |
| 131 | |
| 132 | #define ipmi_version_major(v) ((v)->ipmi_version & 0xf) |
| 133 | #define ipmi_version_minor(v) ((v)->ipmi_version >> 4) |
| 134 | |
| 135 | /* Take a pointer to a raw data buffer and a length and extract device |
| 136 | id information from it. The first byte of data must point to the |
| 137 | byte from the get device id response after the completion code. |
| 138 | The caller is responsible for making sure the length is at least |
| 139 | 11 and the command completed without error. */ |
| 140 | static inline void ipmi_demangle_device_id(unsigned char *data, |
| 141 | unsigned int data_len, |
| 142 | struct ipmi_device_id *id) |
| 143 | { |
| 144 | id->device_id = data[0]; |
| 145 | id->device_revision = data[1]; |
| 146 | id->firmware_revision_1 = data[2]; |
| 147 | id->firmware_revision_2 = data[3]; |
| 148 | id->ipmi_version = data[4]; |
| 149 | id->additional_device_support = data[5]; |
| 150 | id->manufacturer_id = data[6] | (data[7] << 8) | (data[8] << 16); |
| 151 | id->product_id = data[9] | (data[10] << 8); |
| 152 | if (data_len >= 15) { |
| 153 | memcpy(id->aux_firmware_revision, data+11, 4); |
| 154 | id->aux_firmware_revision_set = 1; |
| 155 | } else |
| 156 | id->aux_firmware_revision_set = 0; |
| 157 | } |
| 158 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | /* Add a low-level interface to the IPMI driver. Note that if the |
| 160 | interface doesn't know its slave address, it should pass in zero. */ |
| 161 | int ipmi_register_smi(struct ipmi_smi_handlers *handlers, |
| 162 | void *send_info, |
Corey Minyard | 50c812b | 2006-03-26 01:37:21 -0800 | [diff] [blame^] | 163 | struct ipmi_device_id *device_id, |
| 164 | struct device *dev, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | unsigned char slave_addr, |
| 166 | ipmi_smi_t *intf); |
| 167 | |
| 168 | /* |
| 169 | * Remove a low-level interface from the IPMI driver. This will |
| 170 | * return an error if the interface is still in use by a user. |
| 171 | */ |
| 172 | int ipmi_unregister_smi(ipmi_smi_t intf); |
| 173 | |
| 174 | /* |
| 175 | * The lower layer reports received messages through this interface. |
| 176 | * The data_size should be zero if this is an asyncronous message. If |
| 177 | * the lower layer gets an error sending a message, it should format |
| 178 | * an error response in the message response. |
| 179 | */ |
| 180 | void ipmi_smi_msg_received(ipmi_smi_t intf, |
| 181 | struct ipmi_smi_msg *msg); |
| 182 | |
| 183 | /* The lower layer received a watchdog pre-timeout on interface. */ |
| 184 | void ipmi_smi_watchdog_pretimeout(ipmi_smi_t intf); |
| 185 | |
| 186 | struct ipmi_smi_msg *ipmi_alloc_smi_msg(void); |
| 187 | static inline void ipmi_free_smi_msg(struct ipmi_smi_msg *msg) |
| 188 | { |
| 189 | msg->done(msg); |
| 190 | } |
| 191 | |
| 192 | /* Allow the lower layer to add things to the proc filesystem |
| 193 | directory for this interface. Note that the entry will |
| 194 | automatically be dstroyed when the interface is destroyed. */ |
| 195 | int ipmi_smi_add_proc_entry(ipmi_smi_t smi, char *name, |
| 196 | read_proc_t *read_proc, write_proc_t *write_proc, |
| 197 | void *data, struct module *owner); |
| 198 | |
| 199 | #endif /* __LINUX_IPMI_SMI_H */ |