Kernel driver vt1211

지원 장치와 모듈 매개변수

이 드라이버는 VIA VT1211을 지원하며 접두사는 `vt1211`입니다. 주소를 스캔하지 않고 Super-I/O 구성 공간에서 주소를 읽습니다. 데이터시트는 VIA가 요청자에게 NDA 조건으로 제공합니다.

작성자는 Juerg Haefliger입니다. 이 드라이버는 Mark D. Studebaker의 커널 2.4 드라이버와 Lars Ekman의 커널 2.6 포트를 바탕으로 합니다. 문서와 기술 지원을 제공한 VIA의 Joseph Chan과 Fiona Gatt에게 감사를 전합니다.

정수형 `uch_config`는 채널 1~5의 BIOS 기본 범용 채널 UCH 구성을 덮어씁니다. 허용값은 0~31이며 비트 0부터 4가 UCH1부터 UCH5에 대응합니다. 비트가 1이면 해당 UCH의 온도 입력을, 0이면 전압 입력을 활성화합니다.

정수형 `int_mode`는 BIOS의 온도 인터럽트 모드를 덮어씁니다. 가능한 값은 0뿐이며 인터럽트 모드 0을 강제합니다. 이 모드에서는 상태 레지스터를 읽을 때 대기 중 인터럽트가 지워지지만 온도가 히스테리시스 한계보다 높은 동안에는 다시 발생합니다. BIOS 기본값을 덮어쓰면 원하지 않는 부작용이 생길 수 있습니다.

Kernel driver vt1211
====================

Supported chips:

  * VIA VT1211

    Prefix: 'vt1211'

    Addresses scanned: none, address read from Super-I/O config space

    Datasheet: Provided by VIA upon request and under NDA

Authors: Juerg Haefliger <juergh@gmail.com>

This driver is based on the driver for kernel 2.4 by Mark D. Studebaker and
its port to kernel 2.6 by Lars Ekman.

Thanks to Joseph Chan and Fiona Gatt from VIA for providing documentation and
technical support.


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


* uch_config: int
                        Override the BIOS default universal channel (UCH)
                        configuration for channels 1-5.
                        Legal values are in the range of 0-31. Bit 0 maps to
                        UCH1, bit 1 maps to UCH2 and so on. Setting a bit to 1
                        enables the thermal input of that particular UCH and
                        setting a bit to 0 enables the voltage input.

* int_mode: int
                        Override the BIOS default temperature interrupt mode.
                        The only possible value is 0 which forces interrupt
                        mode 0. In this mode, any pending interrupt is cleared
                        when the status register is read but is regenerated as
                        long as the temperature stays above the hysteresis
                        limit.

Be aware that overriding BIOS defaults might cause some unwanted side effects!

입력 매핑과 전압 감시

VIA VT1211 Super-I/O 칩은 완전한 하드웨어 감시 기능을 갖습니다. 전용 온도 입력 `temp1`, `temp2`, 전용 전압 입력 `in5`, 팬 2개를 감시합니다. UCH1~5는 각각 전압 또는 온도 감시로 프로그램할 수 있는 범용 입력입니다.

데이터시트상 팬 속도의 수동·자동 제어를 제공하지만 드라이버는 수동 모드가 설명대로 동작하지 않아 자동 제어만 지원합니다. 자동 모드도 EPIA M10000의 팬이 VT1211 PWM 출력에 연결되지 않아 충분히 시험되지 않았습니다.

전용 Reading 1은 `temp1` Intel 열 다이오드, Reading 3은 `temp2` 내부 열 다이오드입니다. UCH1~5는 전압 모드에서 `in0`~`in4`, 온도 모드에서 `temp3`~`temp7`에 대응합니다. 전용 +3.3 V 입력은 `in5`입니다.

전압은 LSB가 약 10 mV인 8비트 ADC로 샘플링하므로 입력 범위는 0~2.60 V입니다. 범위 밖 전압은 외부 스케일링 저항이 필요하고 `sensors.conf`에 `compute inx @*(1+R1/R2), @/(1+R1/R2)` 같은 계산식을 넣어 보정합니다.

VIA 권장 보드 배율은 실제 보드 설계에 따라 달라질 수 있으므로 메인보드 문서를 확인해 `sensors.conf`를 조정해야 합니다. VccP의 1400 mV는 VIA C3 Nehemiah 예시입니다. 내부 +3.3 V의 R1·R2는 칩 내부에 있고 드라이버가 자체적으로 스케일링합니다. 각 측정 전압에는 교차 시 경보를 내는 최소·최대 한계가 있습니다.

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

The VIA VT1211 Super-I/O chip includes complete hardware monitoring
capabilities. It monitors 2 dedicated temperature sensor inputs (temp1 and
temp2), 1 dedicated voltage (in5) and 2 fans. Additionally, the chip
implements 5 universal input channels (UCH1-5) that can be individually
programmed to either monitor a voltage or a temperature.

This chip also provides manual and automatic control of fan speeds (according
to the datasheet). The driver only supports automatic control since the manual
mode doesn't seem to work as advertised in the datasheet. In fact I couldn't
get manual mode to work at all! Be aware that automatic mode hasn't been
tested very well (due to the fact that my EPIA M10000 doesn't have the fans
connected to the PWM outputs of the VT1211 :-().

The following table shows the relationship between the vt1211 inputs and the
sysfs nodes.

=============== ============== =========== ================================
Sensor          Voltage Mode   Temp Mode   Default Use (from the datasheet)
=============== ============== =========== ================================
Reading 1                      temp1       Intel thermal diode
Reading 3                      temp2       Internal thermal diode
UCH1/Reading2   in0            temp3       NTC type thermistor
UCH2            in1            temp4       +2.5V
UCH3            in2            temp5       VccP (processor core)
UCH4            in3            temp6       +5V
UCH5            in4            temp7       +12V
+3.3V           in5                        Internal VCC (+3.3V)
=============== ============== =========== ================================


Voltage Monitoring
------------------

Voltages are sampled by an 8-bit ADC with a LSB of ~10mV. The supported input
range is thus from 0 to 2.60V. Voltage values outside of this range need
external scaling resistors. This external scaling needs to be compensated for
via compute lines in sensors.conf, like:

compute inx @*(1+R1/R2), @/(1+R1/R2)

The board level scaling resistors according to VIA's recommendation are as
follows. And this is of course totally dependent on the actual board
implementation :-) You will have to find documentation for your own
motherboard and edit sensors.conf accordingly.

============= ====== ====== ========= ============
                                      Expected
Voltage       R1     R2     Divider   Raw Value
============= ====== ====== ========= ============
+2.5V         2K     10K    1.2       2083 mV
VccP          ---    ---    1.0       1400 mV [1]_
+5V           14K    10K    2.4       2083 mV
+12V          47K    10K    5.7       2105 mV
+3.3V (int)   2K     3.4K   1.588     3300 mV [2]_
+3.3V (ext)   6.8K   10K    1.68      1964 mV
============= ====== ====== ========= ============

.. [1] Depending on the CPU (1.4V is for a VIA C3 Nehemiah).

.. [2] R1 and R2 for 3.3V (int) are internal to the VT1211 chip and the driver
       performs the scaling and returns the properly scaled voltage value.

Each measured voltage has an associated low and high limit which triggers an
alarm when crossed.

온도 감시와 서미스터 계산

온도는 밀리섭씨로 보고됩니다. 각 온도에는 초과 시 경보를 발생시키는 상한이 있고, 인터럽트 모드 0에서는 온도가 대응 히스테리시스 아래로 내려가야 경보가 해제됩니다. BIOS가 모드 0을 설정하지 않으면 `int_mode=0`으로 강제할 수 있습니다.

`temp2`를 제외한 온도 채널은 모두 외부 입력입니다. `temp2`는 VT1211 내부 열 다이오드이므로 드라이버가 모든 스케일링을 수행합니다. 외부 `temp1`, `temp3`~`temp7`의 보정은 보드 구현에 따라 달라서 사용자 공간의 `sensors.conf`에서 처리해야 합니다.

Intel형 열 다이오드인 `temp1`은 sysfs 값과 실제 온도 사이에 `compute temp1 (@-Offset)/Gain, (@*Gain)+Offset` 공식을 사용합니다. BIOS 포팅 가이드는 Intel CPU에 Offset 88.638/Gain 0.9528, VIA C3 Ezra에 83.869/0.9528, Ezra-T에 73.869/0.9528을 권장합니다. Intel의 65.000/0.9686 식은 lm_sensors 2.10.0 설정에서 가져온 것으로 유래는 알려지지 않았습니다.

`temp3`~`temp7`은 NTC 서미스터를 지원합니다. 드라이버는 UCH1~5 핀의 전압을 반환합니다. 핀 전압은 `Vpin = 2200 * Rth / (Rs + Rth)`이며 2200은 ADC 최대 2200 mV입니다. 서미스터는 `Rth = Ro * exp(B * (1 / T - 1 / To))`를 따르고 `To`는 298.15 K(25 °C), `Ro`는 25 °C 정격 저항입니다.

두 식을 합치고 `Rs = Ro`, `B = 3435`로 가정하면 원문에 제시된 `compute tempx` 양방향 수식으로 `sensors.conf`에서 온도와 핀 전압을 변환할 수 있습니다.

Temperature Monitoring
----------------------

Temperatures are reported in millidegree Celsius. Each measured temperature
has a high limit which triggers an alarm if crossed. There is an associated
hysteresis value with each temperature below which the temperature has to drop
before the alarm is cleared (this is only true for interrupt mode 0). The
interrupt mode can be forced to 0 in case the BIOS doesn't do it
automatically. See the 'Module Parameters' section for details.

All temperature channels except temp2 are external. Temp2 is the VT1211
internal thermal diode and the driver does all the scaling for temp2 and
returns the temperature in millidegree Celsius. For the external channels
temp1 and temp3-temp7, scaling depends on the board implementation and needs
to be performed in userspace via sensors.conf.

Temp1 is an Intel-type thermal diode which requires the following formula to
convert between sysfs readings and real temperatures:

compute temp1 (@-Offset)/Gain, (@*Gain)+Offset

According to the VIA VT1211 BIOS porting guide, the following gain and offset
values should be used:

=============== ======== ===========
Diode Type      Offset   Gain
=============== ======== ===========
Intel CPU       88.638   0.9528
                65.000   0.9686 [3]_
VIA C3 Ezra     83.869   0.9528
VIA C3 Ezra-T   73.869   0.9528
=============== ======== ===========

.. [3] This is the formula from the lm_sensors 2.10.0 sensors.conf file. I don't
       know where it comes from or how it was derived, it's just listed here for
       completeness.

Temp3-temp7 support NTC thermistors. For these channels, the driver returns
the voltages as seen at the individual pins of UCH1-UCH5. The voltage at the
pin (Vpin) is formed by a voltage divider made of the thermistor (Rth) and a
scaling resistor (Rs)::

  Vpin = 2200 * Rth / (Rs + Rth)   (2200 is the ADC max limit of 2200 mV)

The equation for the thermistor is as follows (google it if you want to know
more about it)::

  Rth = Ro * exp(B * (1 / T - 1 / To))   (To is 298.15K (25C) and Ro is the
                                          nominal resistance at 25C)

Mingling the above two equations and assuming Rs = Ro and B = 3435 yields the
following formula for sensors.conf::

  compute tempx 1 / (1 / 298.15 - (` (2200 / @ - 1)) / 3435) - 273.15,
                2200 / (1 + (^ (3435 / 298.15 - 3435 / (273.15 + @))))

PWM 자동 팬 제어 지점

VT1211은 팬 2개의 속도를 제어하는 프로그래밍 가능한 PWM 출력 2개를 제공합니다. `pwm[1-2]_enable`에 2를 쓰면 자동 모드가 됩니다. 두 출력은 하나의 컨트롤러를 공유하지만 각각 활성화하거나 비활성화할 수 있습니다.

각 PWM에는 full, high, low, off의 네 듀티 사이클이 있습니다. full과 off는 각각 255(100%)와 0(0%)으로 고정됩니다. high와 low는 `pwm[1-2]_auto_point[2-3]_pwm`으로 설정합니다.

각 PWM 출력은 서로 다른 온도 입력에 연결할 수 있지만 두 출력의 듀티 사이클을 제어하는 온도 임계값 세트는 하나뿐입니다. 임계값은 `pwm[1-2]_auto_point[1-4]_temp`로 보입니다. 두 세트처럼 보여도 같은 VT1211 레지스터를 가리키므로 하나만 설정하면 됩니다. 실제로 `pwm1_auto_point[1-4]_temp`만 쓰기 가능하고 두 번째 세트는 읽기 전용입니다.

Fan Speed Control
-----------------

The VT1211 provides 2 programmable PWM outputs to control the speeds of 2
fans. Writing a 2 to any of the two pwm[1-2]_enable sysfs nodes will put the
PWM controller in automatic mode. There is only a single controller that
controls both PWM outputs but each PWM output can be individually enabled and
disabled.

Each PWM has 4 associated distinct output duty-cycles: full, high, low and
off. Full and off are internally hard-wired to 255 (100%) and 0 (0%),
respectively. High and low can be programmed via
pwm[1-2]_auto_point[2-3]_pwm. Each PWM output can be associated with a
different thermal input but - and here's the weird part - only one set of
thermal thresholds exist that controls both PWMs output duty-cycles. The
thermal thresholds are accessible via pwm[1-2]_auto_point[1-4]_temp. Note
that even though there are 2 sets of 4 auto points each, they map to the same
registers in the VT1211 and programming one set is sufficient (actually only
the first set pwm1_auto_point[1-4]_temp is writable, the second set is
read-only).

========================== =========================================
PWM Auto Point             PWM Output Duty-Cycle
========================== =========================================
pwm[1-2]_auto_point4_pwm   full speed duty-cycle (hard-wired to 255)
pwm[1-2]_auto_point3_pwm   high speed duty-cycle
pwm[1-2]_auto_point2_pwm   low speed duty-cycle
pwm[1-2]_auto_point1_pwm   off duty-cycle (hard-wired to 0)
========================== =========================================

==========================  =================
Temp Auto Point             Thermal Threshold
==========================  =================
pwm[1-2]_auto_point4_temp   full speed temp
pwm[1-2]_auto_point3_temp   high speed temp
pwm[1-2]_auto_point2_temp   low speed temp
pwm[1-2]_auto_point1_temp   off temp
==========================  =================

상승·하강 온도의 PWM 알고리즘

컨트롤러는 입력 온도와 네 온도 임계값을 비교해 PWM 듀티를 정합니다. 상승 중에는 full speed temp 위에서 full, high speed temp와 full speed temp 사이에서 high, low speed temp와 high speed temp 사이에서 low, off temp와 low speed temp 사이에서 off를 사용합니다.

온도가 내려갈 때는 히스테리시스 효과를 위해 한 단계 높은 듀티를 유지합니다. full speed temp 아래에서도 다음 구간까지 full을 유지하고, high speed temp 아래에서는 high, low speed temp 아래에서는 low를 유지합니다. 최하단 off temp 아래에서는 원문 표의 마지막 경계에 따라 off 상태로 진행합니다.

Long story short, the controller implements the following algorithm to set the
PWM output duty-cycle based on the input temperature:

=================== ======================= ========================
Thermal Threshold   Output Duty-Cycle       Output Duty-Cycle
                    (Rising Temp)           (Falling Temp)
=================== ======================= ========================
-                   full speed duty-cycle   full speed duty-cycle
full speed temp
-                    high speed duty-cycle   full speed duty-cycle
high speed temp
-                    low speed duty-cycle    high speed duty-cycle
low speed temp
-                    off duty-cycle          low speed duty-cycle
off temp
=================== ======================= ========================