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