abituguru.rst 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. Kernel driver abituguru
  2. =======================
  3. Supported chips:
  4. * Abit uGuru revision 1 & 2 (Hardware Monitor part only)
  5. Prefix: 'abituguru'
  6. Addresses scanned: ISA 0x0E0
  7. Datasheet: Not available, this driver is based on reverse engineering.
  8. A "Datasheet" has been written based on the reverse engineering it
  9. should be available in the same dir as this file under the name
  10. abituguru-datasheet.
  11. Note:
  12. The uGuru is a microcontroller with onboard firmware which programs
  13. it to behave as a hwmon IC. There are many different revisions of the
  14. firmware and thus effectively many different revisions of the uGuru.
  15. Below is an incomplete list with which revisions are used for which
  16. Motherboards:
  17. - uGuru 1.00 ~ 1.24 (AI7, KV8-MAX3, AN7) [1]_
  18. - uGuru 2.0.0.0 ~ 2.0.4.2 (KV8-PRO)
  19. - uGuru 2.1.0.0 ~ 2.1.2.8 (AS8, AV8, AA8, AG8, AA8XE, AX8)
  20. - uGuru 2.2.0.0 ~ 2.2.0.6 (AA8 Fatal1ty)
  21. - uGuru 2.3.0.0 ~ 2.3.0.9 (AN8)
  22. - uGuru 3.0.0.0 ~ 3.0.x.x (AW8, AL8, AT8, NI8 SLI, AT8 32X, AN8 32X,
  23. AW9D-MAX) [2]_
  24. .. [1] For revisions 2 and 3 uGuru's the driver can autodetect the
  25. sensortype (Volt or Temp) for bank1 sensors, for revision 1 uGuru's
  26. this does not always work. For these uGuru's the autodetection can
  27. be overridden with the bank1_types module param. For all 3 known
  28. revision 1 motherboards the correct use of this param is:
  29. bank1_types=1,1,0,0,0,0,0,2,0,0,0,0,2,0,0,1
  30. You may also need to specify the fan_sensors option for these boards
  31. fan_sensors=5
  32. .. [2] There is a separate abituguru3 driver for these motherboards,
  33. the abituguru (without the 3 !) driver will not work on these
  34. motherboards (and visa versa)!
  35. Authors:
  36. - Hans de Goede <j.w.r.degoede@hhs.nl>,
  37. - (Initial reverse engineering done by Olle Sandberg
  38. <ollebull@gmail.com>)
  39. Module Parameters
  40. -----------------
  41. * force: bool
  42. Force detection. Note this parameter only causes the
  43. detection to be skipped, and thus the insmod to
  44. succeed. If the uGuru can't be read the actual hwmon
  45. driver will not load and thus no hwmon device will get
  46. registered.
  47. * bank1_types: int[]
  48. Bank1 sensortype autodetection override:
  49. * -1 autodetect (default)
  50. * 0 volt sensor
  51. * 1 temp sensor
  52. * 2 not connected
  53. * fan_sensors: int
  54. Tell the driver how many fan speed sensors there are
  55. on your motherboard. Default: 0 (autodetect).
  56. * pwms: int
  57. Tell the driver how many fan speed controls (fan
  58. pwms) your motherboard has. Default: 0 (autodetect).
  59. * verbose: int
  60. How verbose should the driver be? (0-3):
  61. * 0 normal output
  62. * 1 + verbose error reporting
  63. * 2 + sensors type probing info (default)
  64. * 3 + retryable error reporting
  65. Default: 2 (the driver is still in the testing phase)
  66. Notice: if you need any of the first three options above please insmod the
  67. driver with verbose set to 3 and mail me <j.w.r.degoede@hhs.nl> the output of:
  68. dmesg | grep abituguru
  69. Description
  70. -----------
  71. This driver supports the hardware monitoring features of the first and
  72. second revision of the Abit uGuru chip found on Abit uGuru featuring
  73. motherboards (most modern Abit motherboards).
  74. The first and second revision of the uGuru chip in reality is a Winbond
  75. W83L950D in disguise (despite Abit claiming it is "a new microprocessor
  76. designed by the ABIT Engineers"). Unfortunately this doesn't help since the
  77. W83L950D is a generic microcontroller with a custom Abit application running
  78. on it.
  79. Despite Abit not releasing any information regarding the uGuru, Olle
  80. Sandberg <ollebull@gmail.com> has managed to reverse engineer the sensor part
  81. of the uGuru. Without his work this driver would not have been possible.
  82. Known Issues
  83. ------------
  84. The voltage and frequency control parts of the Abit uGuru are not supported.
  85. .. toctree::
  86. :maxdepth: 1
  87. abituguru-datasheet.rst