cros_ec_python.commands.thermal

  1"""
  2Thermal engine commands.
  3"""
  4
  5from typing import Final
  6from enum import Enum, auto
  7import struct
  8from ..baseclass import CrosEcClass
  9from ..constants.COMMON import *
 10from .memmap import get_temps
 11
 12EC_CMD_THERMAL_SET_THRESHOLD: Final = 0x0050
 13EC_CMD_THERMAL_GET_THRESHOLD: Final = 0x0051
 14
 15
 16class EcTempThresholds(Enum):
 17    EC_TEMP_THRESH_WARN = 0
 18    EC_TEMP_THRESH_HIGH = auto()
 19    EC_TEMP_THRESH_HALT = auto()
 20
 21    EC_TEMP_THRESH_COUNT = auto()
 22
 23
 24def thermal_get_thresholds(
 25    ec: CrosEcClass, sensor_num: int, adjust: int | float = -273
 26) -> dict[str, list[int | float] | int | float]:
 27    """
 28    Get the temperature threshold configuration for a given sensor.
 29    :param ec: The CrOS_EC object.
 30    :param sensor_num: The sensor number.
 31    :param adjust: The adjustment to apply to the temperature. Default is -273 to convert from Kelvin to Celsius.
 32    :return: A dictionary containing the threshold configuration.
 33    """
 34    data = struct.pack("<I", sensor_num)
 35    thresh_count: Final = EcTempThresholds.EC_TEMP_THRESH_COUNT.value
 36    resp = ec.command(
 37        1,
 38        EC_CMD_THERMAL_GET_THRESHOLD,
 39        4,
 40        4 * thresh_count + 4 * thresh_count + 4 + 4,
 41        data,
 42    )
 43    config = struct.unpack(f"<{thresh_count}I{thresh_count}III", resp)
 44    return {
 45        "temp_host": [(i + adjust) for i in config[0:thresh_count]],
 46        "temp_host_release": [
 47            (i + adjust) for i in config[thresh_count : thresh_count * 2]
 48        ],
 49        "temp_fan_off": config[thresh_count * 2] + adjust,
 50        "temp_fan_max": config[thresh_count * 2 + 1] + adjust,
 51    }
 52
 53
 54def thermal_set_thresholds(
 55    ec: CrosEcClass,
 56    sensor_num: int,
 57    config: dict[str, list[int | float] | int | float],
 58    adjust: int | float = 273,
 59) -> None:
 60    """
 61    Set the temperature thresholds for a given sensor.
 62    :param ec: The CrOS_EC object.
 63    :param sensor_num: The sensor number.
 64    :param config: A dictionary containing the threshold configuration.
 65    :param adjust: The adjustment to apply to the temperature. Default is 273 to convert from Celsius to Kelvin.
 66    """
 67    thresh_count: Final = EcTempThresholds.EC_TEMP_THRESH_COUNT.value
 68    data = struct.pack(
 69        f"<I{thresh_count}I{thresh_count}III",
 70        sensor_num,
 71        *[int(i + adjust) for i in config["temp_host"]],
 72        *[int(i + adjust) for i in config["temp_host_release"]],
 73        int(config["temp_fan_off"] + adjust),
 74        int(config["temp_fan_max"] + adjust),
 75    )
 76    ec.command(1, EC_CMD_THERMAL_SET_THRESHOLD, len(data), 0, data)
 77
 78
 79EC_CMD_THERMAL_AUTO_FAN_CTRL: Final = 0x0052
 80
 81
 82def thermal_auto_fan_ctrl(ec: CrosEcClass, fan_idx: UInt8 | None = None) -> None:
 83    """
 84    Toggle automatic fan control.
 85    :param ec: The CrOS_EC object.
 86    :param fan_idx: The fan index to control (v1 command). If None, it will set all fans (v0 command).
 87    """
 88    if fan_idx is None:
 89        ec.command(0, EC_CMD_THERMAL_AUTO_FAN_CTRL, 0, 0)
 90    else:
 91        data = struct.pack("<B", fan_idx)
 92        ec.command(1, EC_CMD_THERMAL_AUTO_FAN_CTRL, 1, 0, data)
 93
 94
 95EC_CMD_TMP006_GET_CALIBRATION: Final = 0x0053
 96EC_CMD_TMP006_SET_CALIBRATION: Final = 0x0054
 97EC_CMD_TMP006_GET_RAW: Final = 0x0055
 98
 99EC_CMD_TEMP_SENSOR_GET_INFO: Final = 0x0070
100
101class EcTempSensorType(Enum):
102    TEMP_SENSOR_TYPE_IGNORED = -1
103    TEMP_SENSOR_TYPE_CPU = 0
104    TEMP_SENSOR_TYPE_BOARD = auto()
105    TEMP_SENSOR_TYPE_CASE = auto()
106    TEMP_SENSOR_TYPE_BATTERY = auto()
107
108    TEMP_SENSOR_TYPE_COUNT = auto()
109
110def temp_sensor_get_info(ec: CrosEcClass, sensor_idx: UInt8) -> dict[str, EcTempSensorType]:
111    """
112    Get information about a temperature sensor.
113    :param ec: The CrOS_EC object.
114    :param sensor_idx: The sensor index.
115    :return: The response data.
116    """
117    data = struct.pack("<B", sensor_idx)
118    resp = ec.command(0, EC_CMD_TEMP_SENSOR_GET_INFO, 1, 33, data)
119    unpacked = struct.unpack("<32sB", resp)
120    return {
121        "name": unpacked[0].decode("utf-8").rstrip("\x00"),
122        "type": EcTempSensorType(unpacked[1])
123    }
124
125def get_temp_sensors(ec: CrosEcClass) -> dict[str, tuple[int, EcTempSensorType]]:
126    """
127    Get information about all temperature sensors.
128    :param ec: The CrOS_EC object.
129    :return: The response data.
130    """
131    temps = get_temps(ec)
132    ret = {}
133    for i, j in enumerate(temps):
134        info = temp_sensor_get_info(ec, i)
135        ret[info["name"]] = (j, info["type"])
136    return ret