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