Documentation/hwmon/smm665.rst

   1 Kernel driver smm665
   2 ====================
   3
   4 Supported chips:
   5
   6   * Summit Microelectronics SMM465
   7
   8     Prefix: 'smm465'
   9
  10     Addresses scanned: -
  11
  12     Datasheet:
  13
  14       http://www.summitmicro.com/prod_select/summary/SMM465/SMM465DS.pdf
  15
  16   * Summit Microelectronics SMM665, SMM665B
  17
  18     Prefix: 'smm665'
  19
  20     Addresses scanned: -
  21
  22     Datasheet:
  23
  24       http://www.summitmicro.com/prod_select/summary/SMM665/SMM665B_2089_20.pdf
  25
  26   * Summit Microelectronics SMM665C
  27
  28     Prefix: 'smm665c'
  29
  30     Addresses scanned: -
  31
  32     Datasheet:
  33
  34       http://www.summitmicro.com/prod_select/summary/SMM665C/SMM665C_2125.pdf
  35
  36   * Summit Microelectronics SMM764
  37
  38     Prefix: 'smm764'
  39
  40     Addresses scanned: -
  41
  42     Datasheet:
  43
  44       http://www.summitmicro.com/prod_select/summary/SMM764/SMM764_2098.pdf
  45
  46   * Summit Microelectronics SMM766, SMM766B
  47
  48     Prefix: 'smm766'
  49
  50     Addresses scanned: -
  51
  52     Datasheets:
  53
  54       http://www.summitmicro.com/prod_select/summary/SMM766/SMM766_2086.pdf
  55
  56       http://www.summitmicro.com/prod_select/summary/SMM766B/SMM766B_2122.pdf
  57
  58 Author: Guenter Roeck <linux@roeck-us.net>
  59
  60
  61 Module Parameters
  62 -----------------
  63
  64 * vref: int
  65     Default: 1250 (mV)
  66
  67     Reference voltage on VREF_ADC pin in mV. It should not be necessary to set
  68     this parameter unless a non-default reference voltage is used.
  69
  70
  71 Description
  72 -----------
  73
  74 [From datasheet] The SMM665 is an Active DC Output power supply Controller
  75 that monitors, margins and cascade sequences power. The part monitors six
  76 power supply channels as well as VDD, 12V input, two general-purpose analog
  77 inputs and an internal temperature sensor using a 10-bit ADC.
  78
  79 Each monitored channel has its own high and low limits, plus a critical
  80 limit.
  81
  82 Support for SMM465, SMM764, and SMM766 has been implemented but is untested.
  83
  84
  85 Usage Notes
  86 -----------
  87
  88 This driver does not probe for devices, since there is no register which
  89 can be safely used to identify the chip. You will have to instantiate
  90 the devices explicitly. When instantiating the device, you have to specify
  91 its configuration register address.
  92
  93 Example: the following will load the driver for an SMM665 at address 0x57
  94 on I2C bus #1::
  95
  96         $ modprobe smm665
  97         $ echo smm665 0x57 > /sys/bus/i2c/devices/i2c-1/new_device
  98
  99
 100 Sysfs entries
 101 -------------
 102
 103 This driver uses the values in the datasheet to convert ADC register values
 104 into the values specified in the sysfs-interface document. All attributes are
 105 read only.
 106
 107 Min, max, lcrit, and crit values are used by the chip to trigger external signals
 108 and/or other activity. Triggered signals can include HEALTHY, RST, Power Off,
 109 or Fault depending on the chip configuration. The driver reports values as lcrit
 110 or crit if exceeding the limits triggers RST, Power Off, or Fault, and as min or
 111 max otherwise. For details please see the SMM665 datasheet.
 112
 113 For SMM465 and SMM764, values for Channel E and F are reported but undefined.
 114
 115 ======================= =======================================================
 116 in1_input               12V input voltage (mV)
 117 in2_input               3.3V (VDD) input voltage (mV)
 118 in3_input               Channel A voltage (mV)
 119 in4_input               Channel B voltage (mV)
 120 in5_input               Channel C voltage (mV)
 121 in6_input               Channel D voltage (mV)
 122 in7_input               Channel E voltage (mV)
 123 in8_input               Channel F voltage (mV)
 124 in9_input               AIN1 voltage (mV)
 125 in10_input              AIN2 voltage (mV)
 126
 127 in1_min                 12v input minimum voltage (mV)
 128 in2_min                 3.3V (VDD) input minimum voltage (mV)
 129 in3_min                 Channel A minimum voltage (mV)
 130 in4_min                 Channel B minimum voltage (mV)
 131 in5_min                 Channel C minimum voltage (mV)
 132 in6_min                 Channel D minimum voltage (mV)
 133 in7_min                 Channel E minimum voltage (mV)
 134 in8_min                 Channel F minimum voltage (mV)
 135 in9_min                 AIN1 minimum voltage (mV)
 136 in10_min                AIN2 minimum voltage (mV)
 137
 138 in1_max                 12v input maximum voltage (mV)
 139 in2_max                 3.3V (VDD) input maximum voltage (mV)
 140 in3_max                 Channel A maximum voltage (mV)
 141 in4_max                 Channel B maximum voltage (mV)
 142 in5_max                 Channel C maximum voltage (mV)
 143 in6_max                 Channel D maximum voltage (mV)
 144 in7_max                 Channel E maximum voltage (mV)
 145 in8_max                 Channel F maximum voltage (mV)
 146 in9_max                 AIN1 maximum voltage (mV)
 147 in10_max                AIN2 maximum voltage (mV)
 148
 149 in1_lcrit               12v input critical minimum voltage (mV)
 150 in2_lcrit               3.3V (VDD) input critical minimum voltage (mV)
 151 in3_lcrit               Channel A critical minimum voltage (mV)
 152 in4_lcrit               Channel B critical minimum voltage (mV)
 153 in5_lcrit               Channel C critical minimum voltage (mV)
 154 in6_lcrit               Channel D critical minimum voltage (mV)
 155 in7_lcrit               Channel E critical minimum voltage (mV)
 156 in8_lcrit               Channel F critical minimum voltage (mV)
 157 in9_lcrit               AIN1 critical minimum voltage (mV)
 158 in10_lcrit              AIN2 critical minimum voltage (mV)
 159
 160 in1_crit                12v input critical maximum voltage (mV)
 161 in2_crit                3.3V (VDD) input critical maximum voltage (mV)
 162 in3_crit                Channel A critical maximum voltage (mV)
 163 in4_crit                Channel B critical maximum voltage (mV)
 164 in5_crit                Channel C critical maximum voltage (mV)
 165 in6_crit                Channel D critical maximum voltage (mV)
 166 in7_crit                Channel E critical maximum voltage (mV)
 167 in8_crit                Channel F critical maximum voltage (mV)
 168 in9_crit                AIN1 critical maximum voltage (mV)
 169 in10_crit               AIN2 critical maximum voltage (mV)
 170
 171 in1_crit_alarm          12v input critical alarm
 172 in2_crit_alarm          3.3V (VDD) input critical alarm
 173 in3_crit_alarm          Channel A critical alarm
 174 in4_crit_alarm          Channel B critical alarm
 175 in5_crit_alarm          Channel C critical alarm
 176 in6_crit_alarm          Channel D critical alarm
 177 in7_crit_alarm          Channel E critical alarm
 178 in8_crit_alarm          Channel F critical alarm
 179 in9_crit_alarm          AIN1 critical alarm
 180 in10_crit_alarm         AIN2 critical alarm
 181
 182 temp1_input             Chip temperature
 183 temp1_min               Mimimum chip temperature
 184 temp1_max               Maximum chip temperature
 185 temp1_crit              Critical chip temperature
 186 temp1_crit_alarm        Temperature critical alarm
 187 ======================= =======================================================