0001 Kernel driver ina209
0002 ====================
0003
0004 Supported chips:
0005
0006 * Burr-Brown / Texas Instruments INA209
0007
0008 Prefix: 'ina209'
0009
0010 Addresses scanned: -
0011
0012 Datasheet:
0013 https://www.ti.com/lit/gpn/ina209
0014
0015 Author:
0016 - Paul Hays <Paul.Hays@cattail.ca>
0017 - Ira W. Snyder <iws@ovro.caltech.edu>
0018 - Guenter Roeck <linux@roeck-us.net>
0019
0020
0021 Description
0022 -----------
0023
0024 The TI / Burr-Brown INA209 monitors voltage, current, and power on the high side
0025 of a D.C. power supply. It can perform measurements and calculations in the
0026 background to supply readings at any time. It includes a programmable
0027 calibration multiplier to scale the displayed current and power values.
0028
0029
0030 Sysfs entries
0031 -------------
0032
0033 The INA209 chip is highly configurable both via hardwiring and via
0034 the I2C bus. See the datasheet for details.
0035
0036 This tries to expose most monitoring features of the hardware via
0037 sysfs. It does not support every feature of this chip.
0038
0039 ======================= =======================================================
0040 in0_input shunt voltage (mV)
0041 in0_input_highest shunt voltage historical maximum reading (mV)
0042 in0_input_lowest shunt voltage historical minimum reading (mV)
0043 in0_reset_history reset shunt voltage history
0044 in0_max shunt voltage max alarm limit (mV)
0045 in0_min shunt voltage min alarm limit (mV)
0046 in0_crit_max shunt voltage crit max alarm limit (mV)
0047 in0_crit_min shunt voltage crit min alarm limit (mV)
0048 in0_max_alarm shunt voltage max alarm limit exceeded
0049 in0_min_alarm shunt voltage min alarm limit exceeded
0050 in0_crit_max_alarm shunt voltage crit max alarm limit exceeded
0051 in0_crit_min_alarm shunt voltage crit min alarm limit exceeded
0052
0053 in1_input bus voltage (mV)
0054 in1_input_highest bus voltage historical maximum reading (mV)
0055 in1_input_lowest bus voltage historical minimum reading (mV)
0056 in1_reset_history reset bus voltage history
0057 in1_max bus voltage max alarm limit (mV)
0058 in1_min bus voltage min alarm limit (mV)
0059 in1_crit_max bus voltage crit max alarm limit (mV)
0060 in1_crit_min bus voltage crit min alarm limit (mV)
0061 in1_max_alarm bus voltage max alarm limit exceeded
0062 in1_min_alarm bus voltage min alarm limit exceeded
0063 in1_crit_max_alarm bus voltage crit max alarm limit exceeded
0064 in1_crit_min_alarm bus voltage crit min alarm limit exceeded
0065
0066 power1_input power measurement (uW)
0067 power1_input_highest power historical maximum reading (uW)
0068 power1_reset_history reset power history
0069 power1_max power max alarm limit (uW)
0070 power1_crit power crit alarm limit (uW)
0071 power1_max_alarm power max alarm limit exceeded
0072 power1_crit_alarm power crit alarm limit exceeded
0073
0074 curr1_input current measurement (mA)
0075
0076 update_interval data conversion time; affects number of samples used
0077 to average results for shunt and bus voltages.
0078 ======================= =======================================================
0079
0080 General Remarks
0081 ---------------
0082
0083 The power and current registers in this chip require that the calibration
0084 register is programmed correctly before they are used. Normally this is expected
0085 to be done in the BIOS. In the absence of BIOS programming, the shunt resistor
0086 voltage can be provided using platform data. The driver uses platform data from
0087 the ina2xx driver for this purpose. If calibration register data is not provided
0088 via platform data, the driver checks if the calibration register has been
0089 programmed (ie has a value not equal to zero). If so, this value is retained.
0090 Otherwise, a default value reflecting a shunt resistor value of 10 mOhm is
0091 programmed into the calibration register.
0092
0093
0094 Output Pins
0095 -----------
0096
0097 Output pin programming is a board feature which depends on the BIOS. It is
0098 outside the scope of a hardware monitoring driver to enable or disable output
0099 pins.
