sys/sys/ipmi.h

   1 /*-
   2  * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef __SYS_IPMI_H__
  30 #define __SYS_IPMI_H__
  31
  32 #define IPMI_MAX_ADDR_SIZE              0x20
  33 #define IPMI_MAX_RX                     1024
  34 #define IPMI_BMC_SLAVE_ADDR             0x20 /* Linux Default slave address */
  35 #define IPMI_BMC_CHANNEL                0x0f /* Linux BMC channel */
  36
  37 #define IPMI_BMC_SMS_LUN                0x02
  38
  39 #define IPMI_SYSTEM_INTERFACE_ADDR_TYPE 0x0c
  40 #define IPMI_IPMB_ADDR_TYPE             0x01
  41 #define IPMI_IPMB_BROADCAST_ADDR_TYPE   0x41
  42
  43 #define IPMI_IOC_MAGIC                  'i'
  44 #define IPMICTL_RECEIVE_MSG_TRUNC       _IOWR(IPMI_IOC_MAGIC, 11, struct ipmi_recv)
  45 #define IPMICTL_RECEIVE_MSG             _IOWR(IPMI_IOC_MAGIC, 12, struct ipmi_recv)
  46 #define IPMICTL_SEND_COMMAND            _IOW(IPMI_IOC_MAGIC, 13, struct ipmi_req)
  47 #define IPMICTL_REGISTER_FOR_CMD        _IOW(IPMI_IOC_MAGIC, 14, struct ipmi_cmdspec)
  48 #define IPMICTL_UNREGISTER_FOR_CMD      _IOW(IPMI_IOC_MAGIC, 15, struct ipmi_cmdspec)
  49 #define IPMICTL_SET_GETS_EVENTS_CMD     _IOW(IPMI_IOC_MAGIC, 16, int)
  50 #define IPMICTL_SET_MY_ADDRESS_CMD      _IOW(IPMI_IOC_MAGIC, 17, unsigned int)
  51 #define IPMICTL_GET_MY_ADDRESS_CMD      _IOR(IPMI_IOC_MAGIC, 18, unsigned int)
  52 #define IPMICTL_SET_MY_LUN_CMD          _IOW(IPMI_IOC_MAGIC, 19, unsigned int)
  53 #define IPMICTL_GET_MY_LUN_CMD          _IOR(IPMI_IOC_MAGIC, 20, unsigned int)
  54
  55 #define IPMI_RESPONSE_RECV_TYPE         1
  56 #define IPMI_ASYNC_EVENT_RECV_TYPE      2
  57 #define IPMI_CMD_RECV_TYPE              3
  58
  59 #define IPMI_CHASSIS_REQUEST            0x00
  60 # define IPMI_CHASSIS_CONTROL           0x02
  61 #  define IPMI_CC_POWER_DOWN            0x0
  62 #  define IPMI_CC_POWER_UP              0x1
  63 #  define IPMI_CC_POWER_CYCLE           0x2
  64 #  define IPMI_CC_HARD_RESET            0x3
  65 #  define IPMI_CC_PULSE_DI              0x4
  66 #  define IPMI_CC_SOFT_OVERTEMP         0x5
  67
  68 #define IPMI_APP_REQUEST                0x06
  69 #define IPMI_GET_DEVICE_ID              0x01
  70 # define IPMI_ADS_CHASSIS               0x80
  71 # define IPMI_ADS_BRIDGE                0x40
  72 # define IPMI_ADS_EVENT_GEN             0x20
  73 # define IPMI_ADS_EVENT_RCV             0x10
  74 # define IPMI_ADS_FRU_INV               0x08
  75 # define IPMI_ADS_SEL                   0x04
  76 # define IPMI_ADS_SDR                   0x02
  77 # define IPMI_ADS_SENSOR                0x01
  78 #define IPMI_CLEAR_FLAGS                0x30
  79 #define IPMI_GET_MSG_FLAGS              0x31
  80 # define IPMI_MSG_AVAILABLE             0x01
  81 # define IPMI_MSG_BUFFER_FULL           0x02
  82 # define IPMI_WDT_PRE_TIMEOUT           0x08
  83 #define IPMI_GET_MSG                    0x33
  84 #define IPMI_SEND_MSG                   0x34
  85 #define IPMI_GET_CHANNEL_INFO           0x42
  86 #define IPMI_RESET_WDOG                 0x22
  87 #define IPMI_SET_WDOG                   0x24
  88 #define IPMI_GET_WDOG                   0x25
  89
  90 #define IPMI_SET_WD_TIMER_SMS_OS        0x04
  91 #define IPMI_SET_WD_TIMER_DONT_STOP     0x40
  92 #define IPMI_SET_WD_ACTION_NONE         0x00
  93 #define IPMI_SET_WD_ACTION_RESET        0x01
  94 #define IPMI_SET_WD_ACTION_POWER_DOWN   0x02
  95 #define IPMI_SET_WD_ACTION_POWER_CYCLE  0x03
  96 #define IPMI_SET_WD_PREACTION_NONE      (0x00 << 4)
  97 #define IPMI_SET_WD_PREACTION_SMI       (0x01 << 4)
  98 #define IPMI_SET_WD_PREACTION_NMI       (0x02 << 4)
  99 #define IPMI_SET_WD_PREACTION_MI        (0x03 << 4)
 100
 101 struct ipmi_msg {
 102         unsigned char   netfn;
 103         unsigned char   cmd;
 104         unsigned short  data_len;
 105         unsigned char   *data;
 106 };
 107
 108 struct ipmi_req {
 109         unsigned char   *addr;
 110         unsigned int    addr_len;
 111         long            msgid;
 112         struct ipmi_msg msg;
 113 };
 114
 115 struct ipmi_recv {
 116         int             recv_type;
 117         unsigned char   *addr;
 118         unsigned int    addr_len;
 119         long            msgid;
 120         struct ipmi_msg msg;
 121 };
 122
 123 struct ipmi_cmdspec {
 124         unsigned char   netfn;
 125         unsigned char   cmd;
 126 };
 127
 128
 129 struct ipmi_addr {
 130         int             addr_type;
 131         short           channel;
 132         unsigned char   data[IPMI_MAX_ADDR_SIZE];
 133 };
 134
 135 struct ipmi_system_interface_addr {
 136         int             addr_type;
 137         short           channel;
 138         unsigned char   lun;
 139 };
 140
 141 struct ipmi_ipmb_addr {
 142         int             addr_type;
 143         short           channel;
 144         unsigned char   slave_addr;
 145         unsigned char   lun;
 146 };
 147
 148 #if defined(__amd64__)
 149 /* Compatibility with 32-bit binaries. */
 150
 151 #define IPMICTL_RECEIVE_MSG_TRUNC_32    _IOWR(IPMI_IOC_MAGIC, 11, struct ipmi_recv32)
 152 #define IPMICTL_RECEIVE_MSG_32          _IOWR(IPMI_IOC_MAGIC, 12, struct ipmi_recv32)
 153 #define IPMICTL_SEND_COMMAND_32         _IOW(IPMI_IOC_MAGIC, 13, struct ipmi_req32)
 154
 155 struct ipmi_msg32 {
 156         unsigned char   netfn;
 157         unsigned char   cmd;
 158         unsigned short  data_len;
 159         uint32_t        data;
 160 };
 161
 162 struct ipmi_req32 {
 163         uint32_t        addr;
 164         unsigned int    addr_len;
 165         int32_t         msgid;
 166         struct ipmi_msg32 msg;
 167 };
 168
 169 struct ipmi_recv32 {
 170         int             recv_type;
 171         uint32_t        addr;
 172         unsigned int    addr_len;
 173         int32_t         msgid;
 174         struct ipmi_msg32 msg;
 175 };
 176
 177 #endif
 178
 179 #endif  /* !__SYS_IPMI_H__ */