ina209.rst 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. Kernel driver ina209
  2. ====================
  3. Supported chips:
  4. * Burr-Brown / Texas Instruments INA209
  5. Prefix: 'ina209'
  6. Addresses scanned: -
  7. Datasheet:
  8. https://www.ti.com/lit/gpn/ina209
  9. Author:
  10. - Paul Hays <Paul.Hays@cattail.ca>
  11. - Ira W. Snyder <iws@ovro.caltech.edu>
  12. - Guenter Roeck <linux@roeck-us.net>
  13. Description
  14. -----------
  15. The TI / Burr-Brown INA209 monitors voltage, current, and power on the high side
  16. of a D.C. power supply. It can perform measurements and calculations in the
  17. background to supply readings at any time. It includes a programmable
  18. calibration multiplier to scale the displayed current and power values.
  19. Sysfs entries
  20. -------------
  21. The INA209 chip is highly configurable both via hardwiring and via
  22. the I2C bus. See the datasheet for details.
  23. This tries to expose most monitoring features of the hardware via
  24. sysfs. It does not support every feature of this chip.
  25. ======================= =======================================================
  26. in0_input shunt voltage (mV)
  27. in0_input_highest shunt voltage historical maximum reading (mV)
  28. in0_input_lowest shunt voltage historical minimum reading (mV)
  29. in0_reset_history reset shunt voltage history
  30. in0_max shunt voltage max alarm limit (mV)
  31. in0_min shunt voltage min alarm limit (mV)
  32. in0_crit_max shunt voltage crit max alarm limit (mV)
  33. in0_crit_min shunt voltage crit min alarm limit (mV)
  34. in0_max_alarm shunt voltage max alarm limit exceeded
  35. in0_min_alarm shunt voltage min alarm limit exceeded
  36. in0_crit_max_alarm shunt voltage crit max alarm limit exceeded
  37. in0_crit_min_alarm shunt voltage crit min alarm limit exceeded
  38. in1_input bus voltage (mV)
  39. in1_input_highest bus voltage historical maximum reading (mV)
  40. in1_input_lowest bus voltage historical minimum reading (mV)
  41. in1_reset_history reset bus voltage history
  42. in1_max bus voltage max alarm limit (mV)
  43. in1_min bus voltage min alarm limit (mV)
  44. in1_crit_max bus voltage crit max alarm limit (mV)
  45. in1_crit_min bus voltage crit min alarm limit (mV)
  46. in1_max_alarm bus voltage max alarm limit exceeded
  47. in1_min_alarm bus voltage min alarm limit exceeded
  48. in1_crit_max_alarm bus voltage crit max alarm limit exceeded
  49. in1_crit_min_alarm bus voltage crit min alarm limit exceeded
  50. power1_input power measurement (uW)
  51. power1_input_highest power historical maximum reading (uW)
  52. power1_reset_history reset power history
  53. power1_max power max alarm limit (uW)
  54. power1_crit power crit alarm limit (uW)
  55. power1_max_alarm power max alarm limit exceeded
  56. power1_crit_alarm power crit alarm limit exceeded
  57. curr1_input current measurement (mA)
  58. update_interval data conversion time; affects number of samples used
  59. to average results for shunt and bus voltages.
  60. ======================= =======================================================
  61. General Remarks
  62. ---------------
  63. The power and current registers in this chip require that the calibration
  64. register is programmed correctly before they are used. Normally this is expected
  65. to be done in the BIOS. In the absence of BIOS programming, the shunt resistor
  66. voltage can be provided using platform data. The driver uses platform data from
  67. the ina2xx driver for this purpose. If calibration register data is not provided
  68. via platform data, the driver checks if the calibration register has been
  69. programmed (ie has a value not equal to zero). If so, this value is retained.
  70. Otherwise, a default value reflecting a shunt resistor value of 10 mOhm is
  71. programmed into the calibration register.
  72. Output Pins
  73. -----------
  74. Output pin programming is a board feature which depends on the BIOS. It is
  75. outside the scope of a hardware monitoring driver to enable or disable output
  76. pins.