1Kernel driver smm665
2====================
3
4Supported 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
58Author: Guenter Roeck <linux@roeck-us.net>
59
60
61Module 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
71Description
72-----------
73
74[From datasheet] The SMM665 is an Active DC Output power supply Controller
75that monitors, margins and cascade sequences power. The part monitors six
76power supply channels as well as VDD, 12V input, two general-purpose analog
77inputs and an internal temperature sensor using a 10-bit ADC.
78
79Each monitored channel has its own high and low limits, plus a critical
80limit.
81
82Support for SMM465, SMM764, and SMM766 has been implemented but is untested.
83
84
85Usage Notes
86-----------
87
88This driver does not probe for devices, since there is no register which
89can be safely used to identify the chip. You will have to instantiate
90the devices explicitly. When instantiating the device, you have to specify
91its configuration register address.
92
93Example: the following will load the driver for an SMM665 at address 0x57
94on I2C bus #1::
95
96	$ modprobe smm665
97	$ echo smm665 0x57 > /sys/bus/i2c/devices/i2c-1/new_device
98
99
100Sysfs entries
101-------------
102
103This driver uses the values in the datasheet to convert ADC register values
104into the values specified in the sysfs-interface document. All attributes are
105read only.
106
107Min, max, lcrit, and crit values are used by the chip to trigger external signals
108and/or other activity. Triggered signals can include HEALTHY, RST, Power Off,
109or Fault depending on the chip configuration. The driver reports values as lcrit
110or crit if exceeding the limits triggers RST, Power Off, or Fault, and as min or
111max otherwise. For details please see the SMM665 datasheet.
112
113For SMM465 and SMM764, values for Channel E and F are reported but undefined.
114
115======================= =======================================================
116in1_input		12V input voltage (mV)
117in2_input		3.3V (VDD) input voltage (mV)
118in3_input		Channel A voltage (mV)
119in4_input		Channel B voltage (mV)
120in5_input		Channel C voltage (mV)
121in6_input		Channel D voltage (mV)
122in7_input		Channel E voltage (mV)
123in8_input		Channel F voltage (mV)
124in9_input		AIN1 voltage (mV)
125in10_input		AIN2 voltage (mV)
126
127in1_min			12v input minimum voltage (mV)
128in2_min			3.3V (VDD) input minimum voltage (mV)
129in3_min			Channel A minimum voltage (mV)
130in4_min			Channel B minimum voltage (mV)
131in5_min			Channel C minimum voltage (mV)
132in6_min			Channel D minimum voltage (mV)
133in7_min			Channel E minimum voltage (mV)
134in8_min			Channel F minimum voltage (mV)
135in9_min			AIN1 minimum voltage (mV)
136in10_min		AIN2 minimum voltage (mV)
137
138in1_max			12v input maximum voltage (mV)
139in2_max			3.3V (VDD) input maximum voltage (mV)
140in3_max			Channel A maximum voltage (mV)
141in4_max			Channel B maximum voltage (mV)
142in5_max			Channel C maximum voltage (mV)
143in6_max			Channel D maximum voltage (mV)
144in7_max			Channel E maximum voltage (mV)
145in8_max			Channel F maximum voltage (mV)
146in9_max			AIN1 maximum voltage (mV)
147in10_max		AIN2 maximum voltage (mV)
148
149in1_lcrit		12v input critical minimum voltage (mV)
150in2_lcrit		3.3V (VDD) input critical minimum voltage (mV)
151in3_lcrit		Channel A critical minimum voltage (mV)
152in4_lcrit		Channel B critical minimum voltage (mV)
153in5_lcrit		Channel C critical minimum voltage (mV)
154in6_lcrit		Channel D critical minimum voltage (mV)
155in7_lcrit		Channel E critical minimum voltage (mV)
156in8_lcrit		Channel F critical minimum voltage (mV)
157in9_lcrit		AIN1 critical minimum voltage (mV)
158in10_lcrit		AIN2 critical minimum voltage (mV)
159
160in1_crit		12v input critical maximum voltage (mV)
161in2_crit		3.3V (VDD) input critical maximum voltage (mV)
162in3_crit		Channel A critical maximum voltage (mV)
163in4_crit		Channel B critical maximum voltage (mV)
164in5_crit		Channel C critical maximum voltage (mV)
165in6_crit		Channel D critical maximum voltage (mV)
166in7_crit		Channel E critical maximum voltage (mV)
167in8_crit		Channel F critical maximum voltage (mV)
168in9_crit		AIN1 critical maximum voltage (mV)
169in10_crit		AIN2 critical maximum voltage (mV)
170
171in1_crit_alarm		12v input critical alarm
172in2_crit_alarm		3.3V (VDD) input critical alarm
173in3_crit_alarm		Channel A critical alarm
174in4_crit_alarm		Channel B critical alarm
175in5_crit_alarm		Channel C critical alarm
176in6_crit_alarm		Channel D critical alarm
177in7_crit_alarm		Channel E critical alarm
178in8_crit_alarm		Channel F critical alarm
179in9_crit_alarm		AIN1 critical alarm
180in10_crit_alarm		AIN2 critical alarm
181
182temp1_input		Chip temperature
183temp1_min		Minimum chip temperature
184temp1_max		Maximum chip temperature
185temp1_crit		Critical chip temperature
186temp1_crit_alarm	Temperature critical alarm
187======================= =======================================================
188