Documentation/hwmon/smm665

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