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