share/man/man4/imcsmb.4

   1 .\"
   2 .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3 .\"
   4 .\" Copyright (c) 2018 Panasas
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd March 2, 2018
  30 .Dt IMCSMB 4
  31 .Os
  32 .Sh NAME
  33 .Nm imcsmb
  34 .Nd Intel integrated Memory Controller (iMC) SMBus controller driver
  35 .Sh SYNOPSIS
  36 .Cd device pci
  37 .Cd device smbus
  38 .Cd device imcsmb
  39 .Pp
  40 Alternatively, to load the driver as a module at boot time, place the following
  41 line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 imcsmb_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 driver provides
  50 .Xr smbus 4
  51 support for the SMBus controller functionality in the integrated Memory
  52 Controllers (iMCs) embedded in Intel Sandybridge-Xeon, Ivybridge-Xeon,
  53 Haswell-Xeon, and Broadwell-Xeon CPUs.
  54 Each CPU implements one or more iMCs, depending on the number of cores;
  55 each iMC implements two SMBus controllers (iMC-SMBs).
  56 The iMC-SMBs are used by the iMCs to read configuration information from the
  57 DIMMs during POST.
  58 They may also be used, by motherboard firmware or a BMC, to monitor the
  59 temperature of the DIMMs.
  60 .Pp
  61 The iMC-SMBs are
  62 .Sy not
  63 general-purpose SMBus controllers.
  64 By their nature, they are only ever attached to DIMMs, so they implement only
  65 the SMBus operations need for communicating with DIMMs.
  66 Specifically:
  67 .Pp
  68 .Bl -dash -offset indent -compact
  69 .It
  70 READB
  71 .It
  72 READW
  73 .It
  74 WRITEB
  75 .It
  76 WRITEW
  77 .El
  78 .Pp
  79 A more detailed discussion of the hardware and driver architecture can be found
  80 at the top of
  81 .Pa sys/dev/imcsmb/imcsmb_pci.c .
  82 .Sh WARNINGS
  83 As mentioned above, firmware might use the iMC-SMBs to read DIMM temperatures.
  84 The public iMC documentation does not describe any sort of coordination
  85 mechanism to prevent requests from different sources -- such as the motherboard
  86 firmware, a BMC, or the operating system -- from interfering with each other.
  87 .Pp
  88 .Bf Sy
  89 Therefore, it is highly recommended that developers contact the motherboard
  90 vendor for any board-specific instructions on how to disable and re-enable DIMM
  91 temperature monitoring.
  92 .Ef
  93 .Pp
  94 DIMM temperature monitoring should be disabled before returning from
  95 .Fn imcsmb_pci_request_bus ,
  96 and re-enabled before returning from
  97 .Fn imcsmb_pci_release_bus .
  98 The driver includes comments to that effect at the appropriate locations.
  99 The driver has been tested and shown to work, with only that type of
 100 modification, on certain motherboards from Intel.
 101 .Po
 102 Unfortunately, those modifications were based on material covered under a
 103 non-disclosure agreement, and therefore are not included in this driver.
 104 .Pc
 105 The driver has also been tested and shown to work as-is on various motherboards
 106 from SuperMicro.
 107 .Pp
 108 The
 109 .Xr smb 4
 110 driver will connect to the
 111 .Xr smbus 4
 112 instances created by
 113 .Nm .
 114 However, since the IMC-SMBs are not general-purpose SMBus controllers, using
 115 .Xr smbmsg 8
 116 with those
 117 .Xr smb 4
 118 devices is not supported.
 119 .Sh SEE ALSO
 120 .Xr jedec_dimm 4 ,
 121 .Xr smbus 4
 122 .Sh HISTORY
 123 The
 124 .Nm
 125 driver first appeared in
 126 .Fx 12.0 .
 127 .Sh AUTHORS
 128 The
 129 .Nm
 130 driver was originally written for Panasas by
 131 .An Joe Kloss .
 132 It was substantially refactored, and this manual page was written, by
 133 .An Ravi Pokala Aq Mt rpokala@freebsd.org