share/man/man4/ipmi.4

   1 .\"
   2 .\" Copyright (c) 2006 Tom Rhodes
   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 .Dd September 30, 2006
  29 .Dt IPMI 4
  30 .Os
  31 .Sh NAME
  32 .Nm ipmi
  33 .Nd "OpenIPMI compatible IPMI interface driver"
  34 .Sh SYNOPSIS
  35 .Cd "device ipmi"
  36 .Sh DESCRIPTION
  37 The
  38 .Tn IPMI
  39 (Intelligent Platform Management Interface) is a standard for
  40 monitoring system hardware by permitting generic code to detect
  41 and monitor the sensors in a system.
  42 The
  43 .Tn IPMI
  44 standard offers watchdog support, an FRU database, and other
  45 support extensions.
  46 It is currently being adopted by the makers of many
  47 single board and embedded system manufacturers.
  48 .Pp
  49 The
  50 .Nm
  51 driver in
  52 .Fx
  53 is heavily adopted from the standard and
  54 .Tn Linux
  55 driver; however, not all features described in the
  56 standard are supported.
  57 .Sh IOCTLS
  58 Sending and receiving messages through the
  59 .Nm
  60 driver requires the use of
  61 .Xr ioctl 2 .
  62 The ioctls are used due to the complexity of
  63 data sent to and from the device.
  64 The
  65 .Xr ioctl 2
  66 command codes below are defined in
  67 .In sys/ipmi.h .
  68 The third argument to
  69 .Xr ioctl 2
  70 should be a pointer to the type indicated.
  71 .Pp
  72 Currently the following ioctls are supported:
  73 .Bl -tag -width indent
  74 .It Dv IPMICTL_RECEIVE_MSG Pq Vt "struct ipmi_recv"
  75 Receive a message.
  76 Possible error values:
  77 .Bl -tag -width Er
  78 .It Bq Er EAGAIN
  79 No messages are in the process queue.
  80 .It Bq Er EFAULT
  81 An address supplied was invalid.
  82 .It Bq Er EMSGSIZE
  83 The address could not fit in the message buffer and
  84 will remain in the buffer.
  85 .El
  86 .It Dv IPMICTL_RECEIVE_MSG_TRUNC Pq Vt "struct ipmi_recv"
  87 Like
  88 .Dv IPMICTL_RECEIVE_MSG
  89 but if the message cannot fit into the buffer, it
  90 will truncate the contents instead of leaving the data
  91 in the buffer.
  92 .It Dv IPMICTL_SEND_COMMAND Pq Vt "struct ipmi_req"
  93 Send a message to the interface.
  94 Possible error values:
  95 .Bl -tag -width Er
  96 .It Bq Er EFAULT
  97 An address supplied was invalid
  98 .It Bq Er ENOMEM
  99 Buffers could not be allowed for the command, out of memory.
 100 .El
 101 .It Dv IPMICTL_SET_MY_ADDRESS_CMD Pq Vt "unsigned int"
 102 Set the slave address for source messages.
 103 .It Dv IPMICTL_GET_MY_ADDRESS_CMD Pq Vt "unsigned int"
 104 Get the slave address for source messages.
 105 .It Dv IPMICTL_SET_MY_LUN_CMD Pq Vt "unsigned int"
 106 Set the slave LUN for source messages.
 107 .It Dv IPMICTL_GET_MY_LUN_CMD Pq Vt "unsigned int"
 108 Get the slave LUN for source messages.
 109 .El
 110 .Ss Unimplemented Ioctls
 111 .Bl -tag -width indent
 112 .It Dv IPMICTL_REGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
 113 Register to receive a specific command
 114 Possible error values:
 115 .Bl -tag -width Er
 116 .It Bq Er EFAULT
 117 An supplied address was invalid.
 118 .It Bq Er EBUSY
 119 The network function/command is already in use.
 120 .It Bq Er ENOMEM
 121 Could not allocate memory.
 122 .El
 123 .It Dv IPMICTL_UNREGISTER_FOR_CMD Pq Vt "struct ipmi_cmdspec"
 124 Unregister to receive a specific command
 125 Possible error values:
 126 .Bl -tag -width Er
 127 .It Bq Er EFAULT
 128 An address supplied was invalid.
 129 .It Bq Er ENOENT
 130 The network function/command was not found.
 131 .El
 132 .El
 133 .Ss Stub Only Ioctl
 134 .Bl -tag -width indent
 135 .It Dv IPMICTL_SET_GETS_EVENTS_CMD Pq Vt int
 136 Set whether this interface receives events.
 137 Possible error values:
 138 .Bl -tag -width Er
 139 .It Bq Er EFAULT
 140 An address supplied was invalid.
 141 .El
 142 .El
 143 .Sh SEE ALSO
 144 .Xr ioctl 2 ,
 145 .Xr watchdog 4 ,
 146 .Xr watchdog 8 ,
 147 .Xr watchdogd 8 ,
 148 .Xr watchdog 9
 149 .Sh HISTORY
 150 The
 151 .Nm
 152 driver first appeared in
 153 .Fx 7.0 .
 154 .Sh AUTHORS
 155 .An -nosplit
 156 The
 157 .Nm
 158 driver was written by
 159 .An Doug Ambrisko Aq ambrisko@FreeBSD.org .
 160 This manual page was written by
 161 .An Tom Rhodes Aq trhodes@FreeBSD.org .
 162 .Sh BUGS
 163 Not all features of the MontaVista driver are supported.
 164 .Pp
 165 Currently, IPMB and BT modes are not implemented.