Kernel driver i2c-i801

지원 Intel ICH·PCH·SoC

`i2c-i801`은 Intel 82801AA/AB의 ICH·ICH0부터 Wildcat Lake SoC까지 이어지는 ICH, ESB, PCH, SoC 계열 SMBus 컨트롤러를 지원합니다. 82801DB(ICH4)와 82801EB/ER(ICH5)는 하드웨어 PEC를 지원합니다.

데이터시트는 Intel 웹사이트에 공개되어 있습니다. Intel Patsburg 이후 칩셋에서는 일반 호스트 SMBus 컨트롤러와 추가 `Integrated Device Function` 컨트롤러를 모두 지원합니다.

작성자는 Mark Studebaker <mdsxyz123@yahoo.com>와 Jean Delvare <jdelvare@suse.de>입니다.

======================
Kernel driver i2c-i801
======================


Supported adapters:
  * Intel 82801AA and 82801AB (ICH and ICH0 - part of the
    '810' and '810E' chipsets)
  * Intel 82801BA (ICH2 - part of the '815E' chipset)
  * Intel 82801CA/CAM (ICH3)
  * Intel 82801DB (ICH4) (HW PEC supported)
  * Intel 82801EB/ER (ICH5) (HW PEC supported)
  * Intel 6300ESB
  * Intel 82801FB/FR/FW/FRW (ICH6)
  * Intel 82801G (ICH7)
  * Intel 631xESB/632xESB (ESB2)
  * Intel 82801H (ICH8)
  * Intel 82801I (ICH9)
  * Intel EP80579 (Tolapai)
  * Intel 82801JI (ICH10)
  * Intel 5/3400 Series (PCH)
  * Intel 6 Series (PCH)
  * Intel Patsburg (PCH)
  * Intel DH89xxCC (PCH)
  * Intel Panther Point (PCH)
  * Intel Lynx Point (PCH)
  * Intel Avoton (SOC)
  * Intel Wellsburg (PCH)
  * Intel Coleto Creek (PCH)
  * Intel Wildcat Point (PCH)
  * Intel BayTrail (SOC)
  * Intel Braswell (SOC)
  * Intel Sunrise Point (PCH)
  * Intel Kaby Lake (PCH)
  * Intel DNV (SOC)
  * Intel Broxton (SOC)
  * Intel Lewisburg (PCH)
  * Intel Gemini Lake (SOC)
  * Intel Cannon Lake (PCH)
  * Intel Cedar Fork (PCH)
  * Intel Ice Lake (PCH)
  * Intel Comet Lake (PCH)
  * Intel Elkhart Lake (PCH)
  * Intel Tiger Lake (PCH)
  * Intel Jasper Lake (SOC)
  * Intel Emmitsburg (PCH)
  * Intel Alder Lake (PCH)
  * Intel Raptor Lake (PCH)
  * Intel Meteor Lake (SOC and PCH)
  * Intel Birch Stream (SOC)
  * Intel Arrow Lake (SOC)
  * Intel Panther Lake (SOC)
  * Intel Wildcat Lake (SOC)

   Datasheets: Publicly available at the Intel website

On Intel Patsburg and later chipsets, both the normal host SMBus controller
and the additional 'Integrated Device Function' controllers are supported.

Authors:
        - Mark Studebaker <mdsxyz123@yahoo.com>
        - Jean Delvare <jdelvare@suse.de>

기능 비활성화 비트 벡터

모듈 매개변수 `disable_features`는 비트 벡터입니다. 장치가 보통 지원하는 기능 가운데 선택한 항목을 끌 수 있습니다. 특정 기능이 드라이버 또는 하드웨어 문제로 의도대로 동작하지 않을 때 우회책으로 사용합니다.

Module Parameters
-----------------

* disable_features (bit vector)

Disable selected features normally supported by the device. This makes it
possible to work around possible driver or hardware bugs if the feature in
question doesn't work as intended for whatever reason. Bit values:

 ====  =========================================
 0x01  disable SMBus PEC
 0x02  disable the block buffer
 0x08  disable the I2C block read functionality
 0x10  don't use interrupts
 0x20  disable SMBus Host Notify
 ====  =========================================

ICH PCI 기능과 SMBus 위치

ICH의 정식 명칭은 82801AA이고, ICH0은 82801AB, ICH2는 82801BA, ICH3는 82801CA/CAM입니다. 이후 PCH 장치도 같은 계열입니다. 이 칩들은 Celeron 기반 PC용 Intel 810, Pentium 기반 PC용 810E, 815E 및 기타 칩셋의 일부입니다.

ICH 칩은 논리 PCI 장치 두 개에 최소 일곱 개의 독립 PCI 기능을 포함합니다. 예시 `lspci` 출력에는 `00:1e.0` PCI 브리지와 `00:1f.0` ISA 브리지, `00:1f.1` IDE, `00:1f.2` USB, `00:1f.3` 클래스 `0c05` 장치가 나타납니다.

SMBus 컨트롤러는 장치 `1f`의 기능 3이며, PCI 클래스 `0c05`는 SMBus Serial Controller를 뜻합니다. SMBus 컨트롤러 관점에서 ICH 칩은 Intel PIIX4 칩과 상당히 비슷합니다.

Description
-----------

The ICH (properly known as the 82801AA), ICH0 (82801AB), ICH2 (82801BA),
ICH3 (82801CA/CAM) and later devices (PCH) are Intel chips that are a part of
Intel's '810' chipset for Celeron-based PCs, '810E' chipset for
Pentium-based PCs, '815E' chipset, and others.

The ICH chips contain at least SEVEN separate PCI functions in TWO logical
PCI devices. An output of lspci will show something similar to the
following::

  00:1e.0 PCI bridge: Intel Corporation: Unknown device 2418 (rev 01)
  00:1f.0 ISA bridge: Intel Corporation: Unknown device 2410 (rev 01)
  00:1f.1 IDE interface: Intel Corporation: Unknown device 2411 (rev 01)
  00:1f.2 USB Controller: Intel Corporation: Unknown device 2412 (rev 01)
  00:1f.3 Unknown class [0c05]: Intel Corporation: Unknown device 2413 (rev 01)

The SMBus controller is function 3 in device 1f. Class 0c05 is SMBus Serial
Controller.

The ICH chips are quite similar to Intel's PIIX4 chip, at least in the
SMBus controller.

Process Call·I2C Block·SMBus 2.0·인터럽트

Block Process Call은 82801EB(ICH5) 이후 칩에서 지원됩니다.

I2C 블록 읽기도 82801EB(ICH5) 이후 칩에서 지원됩니다.

82801DB(ICH4) 이후 칩은 여러 SMBus 2.0 기능을 지원합니다.

PCI 인터럽트 지원은 82801EB(ICH5) 이후 칩에서 제공됩니다.

Process Call Support
--------------------

Block process call is supported on the 82801EB (ICH5) and later chips.


I2C Block Read Support
----------------------

I2C block read is supported on the 82801EB (ICH5) and later chips.


SMBus 2.0 Support
-----------------

The 82801DB (ICH4) and later chips support several SMBus 2.0 features.


Interrupt Support
-----------------

PCI interrupt support is supported on the 82801EB (ICH5) and later chips.

BIOS가 숨긴 ICH SMBus 처리

Intel ICH 사우스브리지가 있는데도 `lspci`의 `00:1f.3`에 SMBus 장치가 없고 BIOS에서도 활성화 방법을 찾을 수 없다면 BIOS 코드가 장치를 숨긴 것입니다. Asus가 P4B 메인보드에서 처음 이 방식을 사용한 것으로 잘 알려져 있으며 이후 여러 보드와 일부 완제품에도 영향을 줍니다.

먼저 `i2c-scmi` ACPI 드라이버를 시험해야 합니다. ACPI가 SMBus를 구동하도록 의도적으로 숨겼을 수 있기 때문입니다. `i2c-scmi`가 동작하면 `i2c-i801`은 사용하지 말고 ICH SMBus를 드러내려 하지 않아야 합니다.

`i2c-scmi`가 동작하지 않더라도 ACPI 코드가 SMBus를 사용하지 않는지 확인해야 합니다. `fan`과 `thermal` 드라이버를 로드하고 `/sys/class/thermal`을 살펴보십시오. 유형이 `acpitz`인 thermal zone이 있으면 ACPI가 SMBus에 접근할 가능성이 크므로 장치를 드러내지 않는 편이 안전합니다. ACPI가 SMBus를 사용하지 않는다고 확신한 뒤에만 unhide를 시도할 수 있습니다.

SMBus를 드러내려면 커널이 PCI 장치를 열거하기 전에 PCI 레지스터 값을 바꿔야 합니다. 이 작업은 `drivers/pci/quirks.c`에서 하며, 영향받는 보드를 모두 목록에 추가해야 합니다. 관련 함수는 `asus_hides_smbus_hostbridge`입니다. SMBus 장치가 없지만 하드웨어 모니터링 칩처럼 유용한 장치가 버스에 있다고 판단되면 보드를 목록에 추가해야 합니다.

메인보드는 호스트 브리지 PCI 장치의 subvendor 및 subdevice ID로 식별합니다. `lspci -n -v -s 00:00.0`으로 값을 구할 수 있습니다. 예시의 호스트 브리지 ID는 `2570`(82865G/PE/P), subvendor ID는 `1043`(Asus), subdevice ID는 `80f2`(P4P800-X)입니다.

브리지 ID와 subvendor ID의 기호 이름은 `include/linux/pci_ids.h`에서 찾을 수 있습니다. 그런 다음 `drivers/pci/quirks.c`의 알맞은 위치에 subdevice ID 사례를 추가하십시오. 드러낸 SMBus가 ACPI 등과 충돌하지 않는지 매우 철저히 시험해야 합니다.

변경이 동작하고, SMBus에 사용할 수 있는 칩이 있어 유용하며, 안전해 보인다면 커널 포함을 위한 패치를 제출하십시오.

lm_sensors 2.10.2 이후에는 `prog/hotplug`의 `unhide_ICH_SMBus` 스크립트가 있습니다. 이 스크립트는 `fakephp` 드라이버를 사용해 커널 패치와 재컴파일 없이 SMBus를 일시적으로 드러냅니다. 숨겨진 ICH SMBus에 유용한 장치가 있는지만 확인할 때 편리합니다.

Hidden ICH SMBus
----------------

If your system has an Intel ICH south bridge, but you do NOT see the
SMBus device at 00:1f.3 in lspci, and you can't figure out any way in the
BIOS to enable it, it means it has been hidden by the BIOS code. Asus is
well known for first doing this on their P4B motherboard, and many other
boards after that. Some vendor machines are affected as well.

The first thing to try is the "i2c-scmi" ACPI driver. It could be that the
SMBus was hidden on purpose because it'll be driven by ACPI. If the
i2c-scmi driver works for you, just forget about the i2c-i801 driver and
don't try to unhide the ICH SMBus. Even if i2c-scmi doesn't work, you
better make sure that the SMBus isn't used by the ACPI code. Try loading
the "fan" and "thermal" drivers, and check in /sys/class/thermal. If you
find a thermal zone with type "acpitz", it's likely that the ACPI is
accessing the SMBus and it's safer not to unhide it. Only once you are
certain that ACPI isn't using the SMBus, you can attempt to unhide it.

In order to unhide the SMBus, we need to change the value of a PCI
register before the kernel enumerates the PCI devices. This is done in
drivers/pci/quirks.c, where all affected boards must be listed (see
function asus_hides_smbus_hostbridge.) If the SMBus device is missing,
and you think there's something interesting on the SMBus (e.g. a
hardware monitoring chip), you need to add your board to the list.

The motherboard is identified using the subvendor and subdevice IDs of the
host bridge PCI device. Get yours with ``lspci -n -v -s 00:00.0``::

  00:00.0 Class 0600: 8086:2570 (rev 02)
          Subsystem: 1043:80f2
          Flags: bus master, fast devsel, latency 0
          Memory at fc000000 (32-bit, prefetchable) [size=32M]
          Capabilities: [e4] #09 [2106]
          Capabilities: [a0] AGP version 3.0

Here the host bridge ID is 2570 (82865G/PE/P), the subvendor ID is 1043
(Asus) and the subdevice ID is 80f2 (P4P800-X). You can find the symbolic
names for the bridge ID and the subvendor ID in include/linux/pci_ids.h,
and then add a case for your subdevice ID at the right place in
drivers/pci/quirks.c. Then please give it very good testing, to make sure
that the unhidden SMBus doesn't conflict with e.g. ACPI.

If it works, proves useful (i.e. there are usable chips on the SMBus)
and seems safe, please submit a patch for inclusion into the kernel.

Note: There's a useful script in lm_sensors 2.10.2 and later, named
unhide_ICH_SMBus (in prog/hotplug), which uses the fakephp driver to
temporarily unhide the SMBus without having to patch and recompile your
kernel. It's very convenient if you just want to check if there's
anything interesting on your hidden ICH SMBus.

개발 지원에 대한 감사

lm_sensors 프로젝트는 이 드라이버의 초기 개발을 지원한 Texas Instruments에 감사를 표합니다.

또한 이 드라이버의 SMBus 2.0 및 ICH4 기능 개발을 지원한 Intel에 감사를 표합니다.

----------------------------------------------------------------------------

The lm_sensors project gratefully acknowledges the support of Texas
Instruments in the initial development of this driver.

The lm_sensors project gratefully acknowledges the support of Intel in the
development of SMBus 2.0 / ICH4 features of this driver.