zl6100.rst 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. Kernel driver zl6100
  2. ====================
  3. Supported chips:
  4. * Intersil / Zilker Labs ZL2004
  5. Prefix: 'zl2004'
  6. Addresses scanned: -
  7. Datasheet: http://www.intersil.com/data/fn/fn6847.pdf
  8. * Intersil / Zilker Labs ZL2005
  9. Prefix: 'zl2005'
  10. Addresses scanned: -
  11. Datasheet: http://www.intersil.com/data/fn/fn6848.pdf
  12. * Intersil / Zilker Labs ZL2006
  13. Prefix: 'zl2006'
  14. Addresses scanned: -
  15. Datasheet: http://www.intersil.com/data/fn/fn6850.pdf
  16. * Intersil / Zilker Labs ZL2008
  17. Prefix: 'zl2008'
  18. Addresses scanned: -
  19. Datasheet: http://www.intersil.com/data/fn/fn6859.pdf
  20. * Intersil / Zilker Labs ZL2105
  21. Prefix: 'zl2105'
  22. Addresses scanned: -
  23. Datasheet: http://www.intersil.com/data/fn/fn6851.pdf
  24. * Intersil / Zilker Labs ZL2106
  25. Prefix: 'zl2106'
  26. Addresses scanned: -
  27. Datasheet: http://www.intersil.com/data/fn/fn6852.pdf
  28. * Intersil / Zilker Labs ZL6100
  29. Prefix: 'zl6100'
  30. Addresses scanned: -
  31. Datasheet: http://www.intersil.com/data/fn/fn6876.pdf
  32. * Intersil / Zilker Labs ZL6105
  33. Prefix: 'zl6105'
  34. Addresses scanned: -
  35. Datasheet: http://www.intersil.com/data/fn/fn6906.pdf
  36. * Intersil / Zilker Labs ZL9101M
  37. Prefix: 'zl9101'
  38. Addresses scanned: -
  39. Datasheet: http://www.intersil.com/data/fn/fn7669.pdf
  40. * Intersil / Zilker Labs ZL9117M
  41. Prefix: 'zl9117'
  42. Addresses scanned: -
  43. Datasheet: http://www.intersil.com/data/fn/fn7914.pdf
  44. * Ericsson BMR450, BMR451
  45. Prefix: 'bmr450', 'bmr451'
  46. Addresses scanned: -
  47. Datasheet:
  48. http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146401
  49. * Ericsson BMR462, BMR463, BMR464
  50. Prefixes: 'bmr462', 'bmr463', 'bmr464'
  51. Addresses scanned: -
  52. Datasheet:
  53. http://archive.ericsson.net/service/internet/picov/get?DocNo=28701-EN/LZT146256
  54. Author: Guenter Roeck <linux@roeck-us.net>
  55. Description
  56. -----------
  57. This driver supports hardware monitoring for Intersil / Zilker Labs ZL6100 and
  58. compatible digital DC-DC controllers.
  59. The driver is a client driver to the core PMBus driver. Please see
  60. Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
  61. on PMBus client drivers.
  62. Usage Notes
  63. -----------
  64. This driver does not auto-detect devices. You will have to instantiate the
  65. devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
  66. details.
  67. .. warning::
  68. Do not access chip registers using the i2cdump command, and do not use
  69. any of the i2ctools commands on a command register used to save and restore
  70. configuration data (0x11, 0x12, 0x15, 0x16, and 0xf4). The chips supported by
  71. this driver interpret any access to those command registers (including read
  72. commands) as request to execute the command in question. Unless write accesses
  73. to those registers are protected, this may result in power loss, board resets,
  74. and/or Flash corruption. Worst case, your board may turn into a brick.
  75. Platform data support
  76. ---------------------
  77. The driver supports standard PMBus driver platform data.
  78. Module parameters
  79. -----------------
  80. delay
  81. -----
  82. Intersil/Zilker Labs DC-DC controllers require a minimum interval between I2C
  83. bus accesses. According to Intersil, the minimum interval is 2 ms, though 1 ms
  84. appears to be sufficient and has not caused any problems in testing. The problem
  85. is known to affect all currently supported chips. For manual override, the
  86. driver provides a writeable module parameter, 'delay', which can be used to set
  87. the interval to a value between 0 and 65,535 microseconds.
  88. Sysfs entries
  89. -------------
  90. The following attributes are supported. Limits are read-write; all other
  91. attributes are read-only.
  92. ======================= ========================================================
  93. in1_label "vin"
  94. in1_input Measured input voltage.
  95. in1_min Minimum input voltage.
  96. in1_max Maximum input voltage.
  97. in1_lcrit Critical minimum input voltage.
  98. in1_crit Critical maximum input voltage.
  99. in1_min_alarm Input voltage low alarm.
  100. in1_max_alarm Input voltage high alarm.
  101. in1_lcrit_alarm Input voltage critical low alarm.
  102. in1_crit_alarm Input voltage critical high alarm.
  103. in2_label "vmon"
  104. in2_input Measured voltage on VMON (ZL2004) or VDRV (ZL9101M,
  105. ZL9117M) pin. Reported voltage is 16x the voltage on the
  106. pin (adjusted internally by the chip).
  107. in2_lcrit Critical minimum VMON/VDRV Voltage.
  108. in2_crit Critical maximum VMON/VDRV voltage.
  109. in2_lcrit_alarm VMON/VDRV voltage critical low alarm.
  110. in2_crit_alarm VMON/VDRV voltage critical high alarm.
  111. vmon attributes are supported on ZL2004, ZL9101M,
  112. and ZL9117M only.
  113. inX_label "vout1"
  114. inX_input Measured output voltage.
  115. inX_lcrit Critical minimum output Voltage.
  116. inX_crit Critical maximum output voltage.
  117. inX_lcrit_alarm Critical output voltage critical low alarm.
  118. inX_crit_alarm Critical output voltage critical high alarm.
  119. X is 3 for ZL2004, ZL9101M, and ZL9117M, 2 otherwise.
  120. curr1_label "iout1"
  121. curr1_input Measured output current.
  122. curr1_lcrit Critical minimum output current.
  123. curr1_crit Critical maximum output current.
  124. curr1_lcrit_alarm Output current critical low alarm.
  125. curr1_crit_alarm Output current critical high alarm.
  126. temp[12]_input Measured temperature.
  127. temp[12]_min Minimum temperature.
  128. temp[12]_max Maximum temperature.
  129. temp[12]_lcrit Critical low temperature.
  130. temp[12]_crit Critical high temperature.
  131. temp[12]_min_alarm Chip temperature low alarm.
  132. temp[12]_max_alarm Chip temperature high alarm.
  133. temp[12]_lcrit_alarm Chip temperature critical low alarm.
  134. temp[12]_crit_alarm Chip temperature critical high alarm.
  135. ======================= ========================================================