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