1 IPMI(7D)                            Devices                           IPMI(7D)
   2 
   3 
   4 
   5 NAME
   6        ipmi - OpenIPMI compatible IPMI interface driver
   7 
   8 SYNOPSIS
   9        /dev/ipmi0
  10 
  11 
  12 DESCRIPTION
  13        The ipmi device is a character special file that provides access to the
  14        Intelligent Platform Management Interface for the system.  For more
  15        information on IPMI and to obtain a copy of the IPMI specification and
  16        implementation guidelines, refer to
  17        http://www.intel.com/design/servers/ipmi/.  The driver is adapted from
  18        the FreeBSD driver which is in turn adapted from the Linux driver,
  19        however, not all features described in the standard are supported. The
  20        current implementation depends on the smbios(7d) to discover the
  21        existence of an IPMI device.
  22 
  23 
  24 IOCTLS
  25        Sending and receiving messages through the IPMI drivers requires the
  26        use of ioctl(2).
  27 
  28        The ioctl command codes below are defined in sys/ipmi.h.  The third
  29        argument to ioctl should be a pointer to the type indicated.  Currently
  30        the following ioctls are supported:
  31 
  32            o      IPMICTL_RECEIVE_MSG "struct ipmi_recv"
  33                   Receive a message.
  34                   Possible error values:
  35                    EAGAIN No messages are in the process queue.
  36                    EFAULT An address supplied was invalid.
  37                    EMSGSIZE The address could not fit in the message buffer
  38                    and will remain in the buffer.
  39 
  40 
  41            o      IPMICTL_RECEIVE_MSG_TRUNC "struct ipmi_recv"
  42                   Like IPMICTL_RECEIVE_MSG but if the message cannot fit into
  43                   the buffer, it will truncate the contents instead of leaving
  44                   the data in the buffer.
  45 
  46 
  47            o      IPMICTL_SEND_COMMAND "struct ipmi_req"
  48                   Send a message to the interface.
  49                   Possible error values:
  50                    EFAULT An address supplied was invalid
  51                    ENOMEM Buffers could not be allowed for the command, out of
  52                    memory.
  53 
  54 
  55            o      IPMICTL_SET_MY_ADDRESS_CMD "unsigned int"
  56                   Set the slave address for source messages.
  57 
  58 
  59            o      IPMICTL_GET_MY_ADDRESS_CMD "unsigned int"
  60                   Get the slave address for source messages.
  61 
  62 
  63            o      IPMICTL_SET_MY_LUN_CMD "unsigned int"
  64                   Set the slave LUN for source messages.
  65 
  66 
  67            o      IPMICTL_GET_MY_LUN_CMD "unsigned int"
  68                   Get the slave LUN for source messages.
  69 
  70        Stub Only Ioctl
  71 
  72 
  73            o      IPMICTL_SET_GETS_EVENTS_CMD int
  74                   Set whether this interface receives events.
  75 
  76        Unimplemented Ioctls
  77 
  78 
  79            o      IPMICTL_REGISTER_FOR_CMD
  80                   Register to receive a specific command
  81 
  82 
  83            o      IPMICTL_UNREGISTER_FOR_CMD
  84                   Unregister to receive a specific command
  85 
  86 
  87 SEE ALSO
  88        ipmitool(1), ioctl(2), smbios(7d)
  89 
  90 
  91        Intelligent Platform Management Interface Specification Second
  92        Generation, v2.0 -- June 12, 2009 Markup
  93 
  94 NOTES
  95        Not all systems include an IPMI.
  96 
  97 
  98 
  99                                October 31, 2013                       IPMI(7D)