ina238.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. .. SPDX-License-Identifier: GPL-2.0-only
  2. Kernel driver ina238
  3. ====================
  4. Supported chips:
  5. * Texas Instruments INA228
  6. Prefix: 'ina228'
  7. Addresses: I2C 0x40 - 0x4f
  8. Datasheet:
  9. https://www.ti.com/lit/gpn/ina228
  10. * Texas Instruments INA237
  11. Prefix: 'ina237'
  12. Addresses: I2C 0x40 - 0x4f
  13. Datasheet:
  14. https://www.ti.com/lit/gpn/ina237
  15. * Texas Instruments INA238
  16. Prefix: 'ina238'
  17. Addresses: I2C 0x40 - 0x4f
  18. Datasheet:
  19. https://www.ti.com/lit/gpn/ina238
  20. * Texas Instruments INA700
  21. Datasheet:
  22. https://www.ti.com/product/ina700
  23. * Texas Instruments INA780
  24. Datasheet:
  25. https://www.ti.com/product/ina780a
  26. * Silergy SQ52206
  27. Prefix: 'SQ52206'
  28. Addresses: I2C 0x40 - 0x4f
  29. Author: Nathan Rossi <nathan.rossi@digi.com>
  30. Description
  31. -----------
  32. The INA238 is a current shunt, power and temperature monitor with an I2C
  33. interface. It includes a number of programmable functions including alerts,
  34. conversion rate, sample averaging and selectable shunt voltage accuracy.
  35. The shunt value in micro-ohms can be set via device properties, either from
  36. platform code or from device tree data. Please refer to
  37. Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml for bindings if
  38. device tree is used.
  39. INA237 is a functionally equivalent variant of INA238 with slightly
  40. different accuracy. INA228 is another variant of INA238 with higher ADC
  41. resolution. This chip also reports the energy.
  42. INA700 and INA780 are variants of the chip series with built-in shunt resistor.
  43. They also report the energy.
  44. SQ52206 is a mostly compatible chip from Sylergy. It reports the energy
  45. as well as the peak power consumption.
  46. Sysfs entries
  47. -------------
  48. ======================= =======================================================
  49. in0_input Shunt voltage (mV)
  50. in0_min Minimum shunt voltage threshold (mV)
  51. in0_min_alarm Minimum shunt voltage alarm
  52. in0_max Maximum shunt voltage threshold (mV)
  53. in0_max_alarm Maximum shunt voltage alarm
  54. in1_input Bus voltage (mV)
  55. in1_min Minimum bus voltage threshold (mV)
  56. in1_min_alarm Minimum shunt voltage alarm
  57. in1_max Maximum bus voltage threshold (mV)
  58. in1_max_alarm Maximum shunt voltage alarm
  59. power1_input Power measurement (uW)
  60. power1_max Maximum power threshold (uW)
  61. power1_max_alarm Maximum power alarm
  62. power1_input_highest Peak Power (uW)
  63. (SQ52206 only)
  64. curr1_input Current measurement (mA)
  65. curr1_min Minimum current threshold (mA)
  66. curr1_min_alarm Minimum current alarm
  67. curr1_max Maximum current threshold (mA)
  68. curr1_max_alarm Maximum current alarm
  69. energy1_input Energy measurement (uJ)
  70. (SQ52206, INA237, and INA780 only)
  71. temp1_input Die temperature measurement (mC)
  72. temp1_max Maximum die temperature threshold (mC)
  73. temp1_max_alarm Maximum die temperature alarm
  74. ======================= =======================================================