i2c-i801: Add support for the ICH10
[sfrench/cifs-2.6.git] / Documentation / i2c / busses / i2c-i801
1 Kernel driver i2c-i801
2
3 Supported adapters:
4   * Intel 82801AA and 82801AB (ICH and ICH0 - part of the
5     '810' and '810E' chipsets)
6   * Intel 82801BA (ICH2 - part of the '815E' chipset)
7   * Intel 82801CA/CAM (ICH3)
8   * Intel 82801DB (ICH4) (HW PEC supported)
9   * Intel 82801EB/ER (ICH5) (HW PEC supported)
10   * Intel 6300ESB
11   * Intel 82801FB/FR/FW/FRW (ICH6)
12   * Intel 82801G (ICH7)
13   * Intel 631xESB/632xESB (ESB2)
14   * Intel 82801H (ICH8)
15   * Intel 82801I (ICH9)
16   * Intel Tolapai
17   * Intel ICH10
18    Datasheets: Publicly available at the Intel website
19
20 Authors: 
21         Mark Studebaker <mdsxyz123@yahoo.com>
22         Jean Delvare <khali@linux-fr.org>
23
24
25 Module Parameters
26 -----------------
27
28 None.
29
30
31 Description
32 -----------
33
34 The ICH (properly known as the 82801AA), ICH0 (82801AB), ICH2 (82801BA),
35 ICH3 (82801CA/CAM) and later devices are Intel chips that are a part of
36 Intel's '810' chipset for Celeron-based PCs, '810E' chipset for
37 Pentium-based PCs, '815E' chipset, and others.
38
39 The ICH chips contain at least SEVEN separate PCI functions in TWO logical
40 PCI devices. An output of lspci will show something similar to the
41 following:
42
43   00:1e.0 PCI bridge: Intel Corporation: Unknown device 2418 (rev 01)
44   00:1f.0 ISA bridge: Intel Corporation: Unknown device 2410 (rev 01)
45   00:1f.1 IDE interface: Intel Corporation: Unknown device 2411 (rev 01)
46   00:1f.2 USB Controller: Intel Corporation: Unknown device 2412 (rev 01)
47   00:1f.3 Unknown class [0c05]: Intel Corporation: Unknown device 2413 (rev 01)
48
49 The SMBus controller is function 3 in device 1f. Class 0c05 is SMBus Serial
50 Controller.
51
52 The ICH chips are quite similar to Intel's PIIX4 chip, at least in the
53 SMBus controller.
54
55
56 Process Call Support
57 --------------------
58
59 Not supported.
60
61
62 I2C Block Read Support
63 ----------------------
64
65 I2C block read is supported on the 82801EB (ICH5) and later chips.
66
67
68 SMBus 2.0 Support
69 -----------------
70
71 The 82801DB (ICH4) and later chips support several SMBus 2.0 features.
72
73
74 Hidden ICH SMBus
75 ----------------
76
77 If your system has an Intel ICH south bridge, but you do NOT see the
78 SMBus device at 00:1f.3 in lspci, and you can't figure out any way in the
79 BIOS to enable it, it means it has been hidden by the BIOS code. Asus is
80 well known for first doing this on their P4B motherboard, and many other
81 boards after that. Some vendor machines are affected as well.
82
83 The first thing to try is the "i2c_ec" ACPI driver. It could be that the
84 SMBus was hidden on purpose because it'll be driven by ACPI. If the
85 i2c_ec driver works for you, just forget about the i2c-i801 driver and
86 don't try to unhide the ICH SMBus. Even if i2c_ec doesn't work, you
87 better make sure that the SMBus isn't used by the ACPI code. Try loading
88 the "fan" and "thermal" drivers, and check in /proc/acpi/fan and
89 /proc/acpi/thermal_zone. If you find anything there, it's likely that
90 the ACPI is accessing the SMBus and it's safer not to unhide it. Only
91 once you are certain that ACPI isn't using the SMBus, you can attempt
92 to unhide it.
93
94 In order to unhide the SMBus, we need to change the value of a PCI
95 register before the kernel enumerates the PCI devices. This is done in
96 drivers/pci/quirks.c, where all affected boards must be listed (see
97 function asus_hides_smbus_hostbridge.) If the SMBus device is missing,
98 and you think there's something interesting on the SMBus (e.g. a
99 hardware monitoring chip), you need to add your board to the list.
100
101 The motherboard is identified using the subvendor and subdevice IDs of the
102 host bridge PCI device. Get yours with "lspci -n -v -s 00:00.0":
103
104 00:00.0 Class 0600: 8086:2570 (rev 02)
105         Subsystem: 1043:80f2
106         Flags: bus master, fast devsel, latency 0
107         Memory at fc000000 (32-bit, prefetchable) [size=32M]
108         Capabilities: [e4] #09 [2106]
109         Capabilities: [a0] AGP version 3.0
110
111 Here the host bridge ID is 2570 (82865G/PE/P), the subvendor ID is 1043
112 (Asus) and the subdevice ID is 80f2 (P4P800-X). You can find the symbolic
113 names for the bridge ID and the subvendor ID in include/linux/pci_ids.h,
114 and then add a case for your subdevice ID at the right place in
115 drivers/pci/quirks.c. Then please give it very good testing, to make sure
116 that the unhidden SMBus doesn't conflict with e.g. ACPI.
117
118 If it works, proves useful (i.e. there are usable chips on the SMBus)
119 and seems safe, please submit a patch for inclusion into the kernel.
120
121 Note: There's a useful script in lm_sensors 2.10.2 and later, named
122 unhide_ICH_SMBus (in prog/hotplug), which uses the fakephp driver to
123 temporarily unhide the SMBus without having to patch and recompile your
124 kernel. It's very convenient if you just want to check if there's
125 anything interesting on your hidden ICH SMBus.
126
127
128 **********************
129 The lm_sensors project gratefully acknowledges the support of Texas
130 Instruments in the initial development of this driver.
131
132 The lm_sensors project gratefully acknowledges the support of Intel in the
133 development of SMBus 2.0 / ICH4 features of this driver.