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