Orange Pi5 kernel

Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards

3 Commits   0 Branches   0 Tags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) Kernel driver it87
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2) ==================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4) Supported chips:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6)   * IT8603E/IT8623E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8)     Prefix: 'it8603'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14)   * IT8620E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16)     Prefix: 'it8620'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20)   * IT8628E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22)     Prefix: 'it8628'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28)   * IT8705F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30)     Prefix: 'it87'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34)     Datasheet: Once publicly available at the ITE website, but no longer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36)   * IT8712F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38)     Prefix: 'it8712'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42)     Datasheet: Once publicly available at the ITE website, but no longer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44)   * IT8716F/IT8726F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46)     Prefix: 'it8716'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50)     Datasheet: Once publicly available at the ITE website, but no longer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52)   * IT8718F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54)     Prefix: 'it8718'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58)     Datasheet: Once publicly available at the ITE website, but no longer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60)   * IT8720F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62)     Prefix: 'it8720'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68)   * IT8721F/IT8758E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70)     Prefix: 'it8721'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76)   * IT8728F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78)     Prefix: 'it8728'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84)   * IT8732F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86)     Prefix: 'it8732'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92)   * IT8771E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94)     Prefix: 'it8771'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)   * IT8772E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102)     Prefix: 'it8772'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)   * IT8781F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110)     Prefix: 'it8781'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)   * IT8782F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)     Prefix: 'it8782'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)   * IT8783E/F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)     Prefix: 'it8783'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)   * IT8786E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)     Prefix: 'it8786'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)   * IT8790E
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)     Prefix: 'it8790'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146)     Datasheet: Not publicly available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)   * SiS950   [clone of IT8705F]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)     Prefix: 'it87'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152)     Addresses scanned: from Super I/O config space (8 I/O ports)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154)     Datasheet: No longer be available
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) Authors:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158)     - Christophe Gauthron
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159)     - Jean Delvare <jdelvare@suse.de>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) Module Parameters
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) -----------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) * update_vbat: int
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)     0 if vbat should report power on value, 1 if vbat should be updated after
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167)     each read. Default is 0. On some boards the battery voltage is provided
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168)     by either the battery or the onboard power supply. Only the first reading
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169)     at power on will be the actual battery voltage (which the chip does
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)     automatically). On other boards the battery voltage is always fed to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171)     the chip so can be read at any time. Excessive reading may decrease
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172)     battery life but no information is given in the datasheet.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) * fix_pwm_polarity int
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175)     Force PWM polarity to active high (DANGEROUS). Some chips are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176)     misconfigured by BIOS - PWM values would be inverted. This option tries
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177)     to fix this. Please contact your BIOS manufacturer and ask him for fix.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) Hardware Interfaces
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) -------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) All the chips supported by this driver are LPC Super-I/O chips, accessed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) SMBus interface to the hardware monitoring functions. This driver no
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) longer supports this interface though, as it is slower and less reliable
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) than the ISA access, and was only available on a small number of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) motherboard models.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) Description
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) -----------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) This driver implements support for the IT8603E, IT8620E, IT8623E, IT8628E,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) IT8705F, IT8712F, IT8716F, IT8718F, IT8720F, IT8721F, IT8726F, IT8728F, IT8732F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) IT8758E, IT8771E, IT8772E, IT8781F, IT8782F, IT8783E/F, IT8786E, IT8790E, and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) SiS950 chips.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) joysticks and other miscellaneous stuff. For hardware monitoring, they
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) include an 'environment controller' with 3 temperature sensors, 3 fan
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) rotation speed sensors, 8 voltage sensors, associated alarms, and chassis
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) intrusion detection.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) The IT8712F and IT8716F additionally feature VID inputs, used to report
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) the Vcore voltage of the processor. The early IT8712F have 5 VID pins,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) the IT8716F and late IT8712F have 6. They are shared with other functions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) though, so the functionality may not be available on a given system.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) The IT8718F and IT8720F also features VID inputs (up to 8 pins) but the value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) is stored in the Super-I/O configuration space. Due to technical limitations,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) this value can currently only be read once at initialization time, so
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) the driver won't notice and report changes in the VID value. The two
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) upper VID bits share their pins with voltage inputs (in5 and in6) so you
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) can't have both on a given board.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E and later IT8712F revisions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) have support for 2 additional fans. The additional fans are supported by the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) driver.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E, IT8732F, IT8781F, IT8782F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) IT8783E/F, and late IT8712F and IT8705F also have optional 16-bit tachometer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) counters for fans 1 to 3. This is better (no more fan clock divider mess) but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) not compatible with the older chips and revisions. The 16-bit tachometer mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) is enabled by the driver when one of the above chips is detected.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) The IT8726F is just bit enhanced IT8716F with additional hardware
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) for AMD power sequencing. Therefore the chip will appear as IT8716F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) to userspace applications.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) The IT8728F, IT8771E, and IT8772E are considered compatible with the IT8721F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) until a datasheet becomes available (hopefully.)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) The IT8603E/IT8623E is a custom design, hardware monitoring part is similar to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) IT8728F. It only supports 3 fans, 16-bit fan mode, and the full speed mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) of the fan is not supported (value 0 of pwmX_enable).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) The IT8620E and IT8628E are custom designs, hardware monitoring part is similar
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) to IT8728F. It only supports 16-bit fan mode. Both chips support up to 6 fans.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) The IT8790E supports up to 3 fans. 16-bit fan mode is always enabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) The IT8732F supports a closed-loop mode for fan control, but this is not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) currently implemented by the driver.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) Temperatures are measured in degrees Celsius. An alarm is triggered once
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) when the Overtemperature Shutdown limit is crossed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) triggered if the rotation speed has dropped below a programmable limit. When
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) 16-bit tachometer counters aren't used, fan readings can be divided by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) a programmable divider (1, 2, 4 or 8) to give the readings more range or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) accuracy. With a divider of 2, the lowest representable value is around
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) 2600 RPM. Not all RPM values can accurately be represented, so some rounding
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) is done.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) Voltage sensors (also known as IN sensors) report their values in volts. An
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) alarm is triggered if the voltage has crossed a programmable minimum or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) maximum limit. Note that minimum in this case always means 'closest to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) zero'; this is important for negative voltage measurements. On most chips, all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) voltage inputs can measure voltages between 0 and 4.08 volts, with a resolution
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) of 0.016 volt.  IT8603E, IT8721F/IT8758E and IT8728F can measure between 0 and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) 3.06 volts, with a resolution of 0.012 volt.  IT8732F can measure between 0 and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) 2.8 volts with a resolution of 0.0109 volt.  The battery voltage in8 does not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) have limit registers.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) On the IT8603E, IT8620E, IT8628E, IT8721F/IT8758E, IT8732F, IT8781F, IT8782F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) and IT8783E/F, some voltage inputs are internal and scaled inside the chip:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) * in3 (optional)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) * in7 (optional for IT8781F, IT8782F, and IT8783E/F)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) * in8 (always)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) * in9 (relevant for IT8603E only)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) The driver handles this transparently so user-space doesn't have to care.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) The VID lines (IT8712F/IT8716F/IT8718F/IT8720F) encode the core voltage value:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) the voltage level your processor should work with. This is hardcoded by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) the mainboard and/or processor itself. It is a value in volts.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) If an alarm triggers, it will remain triggered until the hardware register
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) is read at least once. This means that the cause for the alarm may already
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) have disappeared! Note that in the current implementation, all hardware
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) registers are read whenever any data is read (unless it is less than 1.5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) seconds since the last update). This means that you can easily miss
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) once-only alarms.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) Out-of-limit readings can also result in beeping, if the chip is properly
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) wired and configured. Beeping can be enabled or disabled per sensor type
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) (temperatures, voltages and fans.)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) The IT87xx only updates its values each 1.5 seconds; reading it more often
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) will do no harm, but will return 'old' values.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) To change sensor N to a thermistor, 'echo 4 > tempN_type' where N is 1, 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) or 3. To change sensor N to a thermal diode, 'echo 3 > tempN_type'.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) Give 0 for unused sensor. Any other value is invalid. To configure this at
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) startup, consult lm_sensors's /etc/sensors.conf. (4 = thermistor;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) 3 = thermal diode)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) Fan speed control
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) -----------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) The fan speed control features are limited to manual PWM mode. Automatic
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) "Smart Guardian" mode control handling is only implemented for older chips
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) (see below.) However if you want to go for "manual mode" just write 1 to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) pwmN_enable.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) If you are only able to control the fan speed with very small PWM values,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) try lowering the PWM base frequency (pwm1_freq). Depending on the fan,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) it may give you a somewhat greater control range. The same frequency is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) used to drive all fan outputs, which is why pwm2_freq and pwm3_freq are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) read-only.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) Automatic fan speed control (old interface)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) -------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) The driver supports the old interface to automatic fan speed control
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) which is implemented by IT8705F chips up to revision F and IT8712F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) chips up to revision G.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) This interface implements 4 temperature vs. PWM output trip points.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) The PWM output of trip point 4 is always the maximum value (fan running
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) at full speed) while the PWM output of the other 3 trip points can be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) freely chosen. The temperature of all 4 trip points can be freely chosen.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) Additionally, trip point 1 has an hysteresis temperature attached, to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) prevent fast switching between fan on and off.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) The chip automatically computes the PWM output value based on the input
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) temperature, based on this simple rule: if the temperature value is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) between trip point N and trip point N+1 then the PWM output value is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) the one of trip point N. The automatic control mode is less flexible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) than the manual control mode, but it reacts faster, is more robust and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) doesn't use CPU cycles.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) Trip points must be set properly before switching to automatic fan speed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) control mode. The driver will perform basic integrity checks before
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) actually switching to automatic control mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) Temperature offset attributes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) -----------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) The driver supports temp[1-3]_offset sysfs attributes to adjust the reported
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) temperature for thermal diodes or diode-connected thermal transistors.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) If a temperature sensor is configured for thermistors, the attribute values
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) are ignored. If the thermal sensor type is Intel PECI, the temperature offset
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348) must be programmed to the critical CPU temperature.