include/linux/ipmi_smi.h

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