cros_ec_python.commands.thermal

 1"""
 2Thermal engine commands. Note that there are two implementations.
 3We'll reuse the command number, but the data and behavior is incompatible.
 4
 5Version 0 is what originally shipped on Link.
 6
 7Version 1 separates the CPU thermal limits from the fan control.
 8"""
 9
10from typing import Final
11from enum import Enum, auto
12import struct
13from ..baseclass import CrosEcClass
14from ..constants.COMMON import *
15from .memmap import get_temps
16
17EC_CMD_THERMAL_SET_THRESHOLD: Final = 0x0050
18EC_CMD_THERMAL_GET_THRESHOLD: Final = 0x0051
19
20EC_CMD_THERMAL_AUTO_FAN_CTRL: Final = 0x0052
21
22
23def thermal_auto_fan_ctrl(ec: CrosEcClass, fan_idx: UInt8 | None = None) -> None:
24    """
25    Toggle automatic fan control.
26    :param ec: The CrOS_EC object.
27    :param fan_idx: The fan index to control (v1 command). If None, it will set all fans (v0 command).
28    """
29    if fan_idx is None:
30        ec.command(0, EC_CMD_THERMAL_AUTO_FAN_CTRL, 0, 0)
31    else:
32        data = struct.pack("<B", fan_idx)
33        ec.command(1, EC_CMD_THERMAL_AUTO_FAN_CTRL, 1, 0, data)
34
35
36EC_CMD_TMP006_GET_CALIBRATION: Final = 0x0053
37EC_CMD_TMP006_SET_CALIBRATION: Final = 0x0054
38EC_CMD_TMP006_GET_RAW: Final = 0x0055
39
40EC_CMD_TEMP_SENSOR_GET_INFO: Final = 0x0070
41
42class EcTempSensorType(Enum):
43    TEMP_SENSOR_TYPE_IGNORED = -1
44    TEMP_SENSOR_TYPE_CPU = 0
45    TEMP_SENSOR_TYPE_BOARD = auto()
46    TEMP_SENSOR_TYPE_CASE = auto()
47    TEMP_SENSOR_TYPE_BATTERY = auto()
48
49    TEMP_SENSOR_TYPE_COUNT = auto()
50
51def temp_sensor_get_info(ec: CrosEcClass, sensor_idx: UInt8) -> dict[str, EcTempSensorType]:
52    """
53    Get information about a temperature sensor.
54    :param ec: The CrOS_EC object.
55    :param sensor_idx: The sensor index.
56    :return: The response data.
57    """
58    data = struct.pack("<B", sensor_idx)
59    resp = ec.command(0, EC_CMD_TEMP_SENSOR_GET_INFO, 1, 33, data)
60    unpacked = struct.unpack("<32sB", resp)
61    return {
62        "name": unpacked[0].decode("utf-8").rstrip("\x00"),
63        "type": EcTempSensorType(unpacked[1])
64    }
65
66def get_temp_sensors(ec: CrosEcClass) -> dict[str, tuple[int, EcTempSensorType]]:
67    """
68    Get information about all temperature sensors.
69    :param ec: The CrOS_EC object.
70    :return: The response data.
71    """
72    temps = get_temps(ec)
73    ret = {}
74    for i, j in enumerate(temps):
75        info = temp_sensor_get_info(ec, i)
76        ret[info["name"]] = (j, info["type"])
77    return ret
78