Major refactor, use a class for each device type

Author: Steve-Tech

cros_ec_python/__init__.py

@@ -1,3 +1,6 @@
-from .cros_ec import CrOS_EC, DeviceTypes
+from .cros_ec import get_cros_ec, DeviceTypes
+from .baseclass import CrosEcClass
+from .devices.dev import CrosEcDev
+from .devices.lpc import CrosEcLpc
 from .commands import memmap, general, features, pwm, leds, thermal
 from .exceptions import ECError

cros_ec_python/baseclass.py

@@ -0,0 +1,51 @@
+import abc
+from .constants.COMMON import *
+
+
+class CrosEcClass(metaclass=abc.ABCMeta):
+    @staticmethod
+    @abc.abstractmethod
+    def detect() -> bool:
+        """
+        Detect the EC type.
+        """
+        pass
+
+    @abc.abstractmethod
+    def ec_init(self) -> None:
+        """
+        Initialise the EC, this shouldn't need to be called unless the keyword arg init was set to false.
+        """
+        pass
+
+    @abc.abstractmethod
+    def ec_exit(self) -> None:
+        """
+        Close connection to the EC.
+        """
+        pass
+
+    @abc.abstractmethod
+    def command(self, version: Int32, command: Int32, outsize: Int32, insize: Int32, data: bytes = None,
+                warn: bool = True) -> bytes:
+        """
+        Send a command to the EC and return the response.
+        @param version: Command version number (often 0).
+        @param command: Command to send (EC_CMD_...).
+        @param outsize: Outgoing length in bytes.
+        @param insize: Max number of bytes to accept from the EC.
+        @param data: Outgoing data to EC.
+        @param warn: Whether to warn if the response size is not as expected. Default is True.
+        @return: Response from the EC.
+        """
+        pass
+
+    @abc.abstractmethod
+    def memmap(self, offset: Int32, num_bytes: Int32) -> bytes:
+        """
+        Read memory from the EC.
+        @param offset: Offset to read from.
+        @param num_bytes: Number of bytes to read.
+        @return: Bytes read from the EC.
+        """
+        pass

cros_ec_python/commands/features.py

@@ -1,7 +1,7 @@
 from typing import Final
 from enum import Enum
 import struct
-from ..cros_ec import CrOS_EC
+from ..baseclass import CrosEcClass
 from ..constants.COMMON import *
 
 EC_CMD_GET_FEATURES: Final = 0x000D
@@ -139,7 +139,7 @@ class EcFeatureCode(Enum):
     EC_FEATURE_TYPEC_AP_VDM_SEND = 46
 
 
-def get_features(ec: CrOS_EC) -> UInt64:
+def get_features(ec: CrosEcClass) -> UInt64:
     """
     List the features supported by the firmware
     @param ec: The CrOS_EC object.

cros_ec_python/commands/general.py

@@ -1,12 +1,12 @@
 from typing import Final, Literal
 import struct
-from ..cros_ec import CrOS_EC
+from ..baseclass import CrosEcClass
 from ..constants.COMMON import *
 
 EC_CMD_PROTO_VERSION: Final = 0x0000
 
 
-def proto_version(ec: CrOS_EC) -> UInt32:
+def proto_version(ec: CrosEcClass) -> UInt32:
     """
     Get protocol version, used to deal with non-backward compatible protocol changes.
     @param ec: The CrOS_EC object.
@@ -19,7 +19,7 @@ def proto_version(ec: CrOS_EC) -> UInt32:
 EC_CMD_HELLO: Final = 0x0001
 
 
-def hello(ec: CrOS_EC, in_data: UInt32) -> UInt32:
+def hello(ec: CrosEcClass, in_data: UInt32) -> UInt32:
     """
     Hello.  This is a simple command to test the EC is responsive to commands.
     @param ec: The CrOS_EC object.
@@ -34,7 +34,7 @@ def hello(ec: CrOS_EC, in_data: UInt32) -> UInt32:
 EC_CMD_GET_VERSION: Final = 0x0002
 
 
-def get_version(ec: CrOS_EC, version: Literal[0, 1] = 0) -> dict[str, str | int]:
+def get_version(ec: CrosEcClass, version: Literal[0, 1] = 0) -> dict[str, str | int]:
     """
     Get version number
     @param ec: The CrOS_EC object.
@@ -71,7 +71,7 @@ def get_version(ec: CrOS_EC, version: Literal[0, 1] = 0) -> dict[str, str | int]
 EC_CMD_GET_BUILD_INFO: Final = 0x0004
 
 
-def get_build_info(ec: CrOS_EC) -> str:
+def get_build_info(ec: CrosEcClass) -> str:
     """
     Get build information
     @param ec: The CrOS_EC object.
@@ -84,7 +84,7 @@ def get_build_info(ec: CrOS_EC) -> str:
 EC_CMD_GET_CHIP_INFO: Final = 0x0005
 
 
-def get_chip_info(ec: CrOS_EC) -> dict[str, str]:
+def get_chip_info(ec: CrosEcClass) -> dict[str, str]:
     """
     Get chip info
     @param ec: The CrOS_EC object.
@@ -102,7 +102,7 @@ def get_chip_info(ec: CrOS_EC) -> dict[str, str]:
 EC_CMD_GET_BOARD_VERSION: Final = 0x0006
 
 
-def get_board_version(ec: CrOS_EC) -> UInt16:
+def get_board_version(ec: CrosEcClass) -> UInt16:
     """
     Get board HW version
     @param ec: The CrOS_EC object.
@@ -118,7 +118,7 @@ def get_board_version(ec: CrOS_EC) -> UInt16:
 EC_CMD_GET_CMD_VERSIONS: Final = 0x0008
 
 
-def get_cmd_versions(ec: CrOS_EC, cmd: UInt8 | UInt16, version: Literal[0, 1] | None = None) -> UInt32:
+def get_cmd_versions(ec: CrosEcClass, cmd: UInt8 | UInt16, version: Literal[0, 1] | None = None) -> UInt32:
     """
     Read versions supported for a command.
     @param ec: The CrOS_EC object.
@@ -144,7 +144,7 @@ def get_cmd_versions(ec: CrOS_EC, cmd: UInt8 | UInt16, version: Literal[0, 1] |
 EC_CMD_TEST_PROTOCOL: Final = 0x000A
 
 
-def test_protocol(ec: CrOS_EC, result: UInt32, ret_len: UInt32, buf: bytes, in_size: Int32 | None = None) -> bytes:
+def test_protocol(ec: CrosEcClass, result: UInt32, ret_len: UInt32, buf: bytes, in_size: Int32 | None = None) -> bytes:
     """
     Fake a variety of responses, purely for testing purposes.
     @param ec: The CrOS_EC object.
@@ -162,7 +162,7 @@ def test_protocol(ec: CrOS_EC, result: UInt32, ret_len: UInt32, buf: bytes, in_s
 EC_CMD_GET_PROTOCOL_INFO: Final = 0x000B
 
 
-def get_protocol_info(ec: CrOS_EC) -> dict[str, int]:
+def get_protocol_info(ec: CrosEcClass) -> dict[str, int]:
     """
     Get protocol info
     @param ec: The CrOS_EC object.

cros_ec_python/commands/leds.py

@@ -1,7 +1,7 @@
 from typing import Final
 from enum import Enum, auto
 import struct
-from ..cros_ec import CrOS_EC
+from ..baseclass import CrosEcClass
 from ..constants.COMMON import *
 
 EC_CMD_LED_CONTROL: Final = 0x0029
@@ -45,7 +45,7 @@ class EcLedColors(Enum):
     EC_LED_COLOR_COUNT = auto()
 
 
-def led_control(ec: CrOS_EC, led_id: EcLedId, flags: UInt8, brightnesses: list[UInt8]) -> list[UInt8]:
+def led_control(ec: CrosEcClass, led_id: EcLedId, flags: UInt8, brightnesses: list[UInt8]) -> list[UInt8]:
     """
     Control an LED
     @param ec: The CrOS_EC object.
@@ -59,7 +59,7 @@ def led_control(ec: CrOS_EC, led_id: EcLedId, flags: UInt8, brightnesses: list[U
     return list(resp)
 
 
-def led_control_set_color(ec: CrOS_EC, led_id: EcLedId, brightness: UInt8, color: EcLedColors) -> list[UInt8]:
+def led_control_set_color(ec: CrosEcClass, led_id: EcLedId, brightness: UInt8, color: EcLedColors) -> list[UInt8]:
     """
     Control an LED
     @param ec: The CrOS_EC object.
@@ -73,7 +73,7 @@ def led_control_set_color(ec: CrOS_EC, led_id: EcLedId, brightness: UInt8, color
     return led_control(ec, led_id, 0, brightnesses)
 
 
-def led_control_get_max_values(ec: CrOS_EC, led_id: EcLedId) -> list[UInt8]:
+def led_control_get_max_values(ec: CrosEcClass, led_id: EcLedId) -> list[UInt8]:
     """
     Get the current brightness values of an LED
     @param ec: The CrOS_EC object.
@@ -83,7 +83,7 @@ def led_control_get_max_values(ec: CrOS_EC, led_id: EcLedId) -> list[UInt8]:
     return led_control(ec, led_id, EC_LED_FLAGS_QUERY, [0] * EcLedColors.EC_LED_COLOR_COUNT.value)
 
 
-def led_control_set_auto(ec: CrOS_EC, led_id: EcLedId) -> list[UInt8]:
+def led_control_set_auto(ec: CrosEcClass, led_id: EcLedId) -> list[UInt8]:
     """
     Get the current brightness values of an LED
     @param ec: The CrOS_EC object.

cros_ec_python/commands/memmap.py

@@ -1,10 +1,10 @@
 import struct
-from ..cros_ec import CrOS_EC
+from ..baseclass import CrosEcClass
 from ..constants.COMMON import *
 from ..constants.MEMMAP import *
 
 
-def get_temps(ec: CrOS_EC, adjust: int | float = -273) -> list[int | float]:
+def get_temps(ec: CrosEcClass, adjust: int | float = -273) -> list[int | float]:
     """
     Get the temperature of all temp sensors.
     @param ec: The CrOS_EC object.
@@ -30,7 +30,7 @@ def get_temps(ec: CrOS_EC, adjust: int | float = -273) -> list[int | float]:
     return ret
 
 
-def get_fans(ec: CrOS_EC) -> list[int | None]:
+def get_fans(ec: CrosEcClass) -> list[int | None]:
     """
     Get the speed of all fans.
     @param ec: The CrOS_EC object.
@@ -46,7 +46,7 @@ def get_fans(ec: CrOS_EC) -> list[int | None]:
     return [None if fan is EC_FAN_SPEED_STALLED else fan for fan in fans if fan < EC_FAN_SPEED_NOT_PRESENT]
 
 
-def get_switches(ec: CrOS_EC) -> dict[str, bool]:
+def get_switches(ec: CrosEcClass) -> dict[str, bool]:
     """
     Get the state of the switches.
     @param ec: The CrOS_EC object.
@@ -66,7 +66,7 @@ def get_switches(ec: CrOS_EC) -> dict[str, bool]:
     }
 
 
-def get_battery_values(ec: CrOS_EC) -> dict[str, int | bool | str]:
+def get_battery_values(ec: CrosEcClass) -> dict[str, int | bool | str]:
     """
     Get the values of the battery.
     @param ec: The CrOS_EC object.
@@ -102,7 +102,7 @@ def get_battery_values(ec: CrOS_EC) -> dict[str, int | bool | str]:
     }
 
 
-def get_als(ec: CrOS_EC) -> list[int | None]:
+def get_als(ec: CrosEcClass) -> list[int | None]:
     """
     Get the current value from all Ambient Light Sensors.
     @param ec: The CrOS_EC object.
@@ -113,7 +113,7 @@ def get_als(ec: CrOS_EC) -> list[int | None]:
     return [val for val in als]
 
 
-def get_accel(ec: CrOS_EC) -> list[int | None]:
+def get_accel(ec: CrosEcClass) -> list[int | None]:
     """
     Get the current value from all accelerometers.
     @param ec: The CrOS_EC object.

cros_ec_python/commands/pwm.py

@@ -1,13 +1,13 @@
 from typing import Final
 from enum import Enum, auto
 import struct
-from ..cros_ec import CrOS_EC
+from ..baseclass import CrosEcClass
 from ..constants.COMMON import *
 
 EC_CMD_PWM_GET_FAN_TARGET_RPM: Final = 0x0020
 
 
-def pwm_get_fan_rpm(ec: CrOS_EC) -> UInt32:
+def pwm_get_fan_rpm(ec: CrosEcClass) -> UInt32:
     """
     Get fan target RPM
     @param ec: The CrOS_EC object.
@@ -20,7 +20,7 @@ def pwm_get_fan_rpm(ec: CrOS_EC) -> UInt32:
 EC_CMD_PWM_SET_FAN_TARGET_RPM: Final = 0x0021
 
 
-def pwm_set_fan_rpm(ec: CrOS_EC, rpm: UInt32, idx: UInt8 | None = None) -> None:
+def pwm_set_fan_rpm(ec: CrosEcClass, rpm: UInt32, idx: UInt8 | None = None) -> None:
     """
     Set target fan RPM
     @param ec: The CrOS_EC object.
@@ -39,7 +39,7 @@ def pwm_set_fan_rpm(ec: CrOS_EC, rpm: UInt32, idx: UInt8 | None = None) -> None:
 EC_CMD_PWM_GET_KEYBOARD_BACKLIGHT: Final = 0x0022
 
 
-def pwm_get_keyboard_backlight(ec: CrOS_EC) -> dict[str, UInt8]:
+def pwm_get_keyboard_backlight(ec: CrosEcClass) -> dict[str, UInt8]:
     """
     Get keyboard backlight
     OBSOLETE - Use EC_CMD_PWM_SET_DUTY
@@ -57,7 +57,7 @@ def pwm_get_keyboard_backlight(ec: CrOS_EC) -> dict[str, UInt8]:
 EC_CMD_PWM_SET_KEYBOARD_BACKLIGHT: Final = 0x0023
 
 
-def pwm_set_keyboard_backlight(ec: CrOS_EC, percent: UInt8) -> None:
+def pwm_set_keyboard_backlight(ec: CrosEcClass, percent: UInt8) -> None:
     """
     Set keyboard backlight
     OBSOLETE - Use EC_CMD_PWM_SET_DUTY
@@ -72,7 +72,7 @@ def pwm_set_keyboard_backlight(ec: CrOS_EC, percent: UInt8) -> None:
 EC_CMD_PWM_SET_FAN_DUTY: Final = 0x0024
 
 
-def pwm_set_fan_duty(ec: CrOS_EC, percent: UInt32, idx: UInt8 | None = None) -> None:
+def pwm_set_fan_duty(ec: CrosEcClass, percent: UInt32, idx: UInt8 | None = None) -> None:
     """
     Set target fan PWM duty cycle
     @param ec: The CrOS_EC object.
@@ -103,7 +103,7 @@ class EcPwmType(Enum):
     EC_PWM_TYPE_COUNT = auto()
 
 
-def pwm_set_duty(ec: CrOS_EC, duty: UInt16, pwm_type: EcPwmType, index: UInt8 = 0) -> None:
+def pwm_set_duty(ec: CrosEcClass, duty: UInt16, pwm_type: EcPwmType, index: UInt8 = 0) -> None:
     """
     Set PWM duty cycle
     @param ec: The CrOS_EC object.
@@ -119,7 +119,7 @@ def pwm_set_duty(ec: CrOS_EC, duty: UInt16, pwm_type: EcPwmType, index: UInt8 =
 EC_CMD_PWM_GET_DUTY: Final = 0x0026
 
 
-def pwm_get_duty(ec: CrOS_EC, pwm_type: EcPwmType, index: UInt8 = 0) -> UInt16:
+def pwm_get_duty(ec: CrosEcClass, pwm_type: EcPwmType, index: UInt8 = 0) -> UInt16:
     """
     Get PWM duty cycle
     @param ec: The CrOS_EC object.

cros_ec_python/commands/thermal.py

@@ -1,6 +1,6 @@
 from typing import Final
 import struct
-from ..cros_ec import CrOS_EC
+from ..baseclass import CrosEcClass
 from ..constants.COMMON import *
 
 EC_CMD_THERMAL_SET_THRESHOLD: Final = 0x0050
@@ -9,7 +9,7 @@
 EC_CMD_THERMAL_AUTO_FAN_CTRL: Final = 0x0052
 
 
-def thermal_auto_fan_ctrl(ec: CrOS_EC, fan_idx: UInt8 | None = None) -> None:
+def thermal_auto_fan_ctrl(ec: CrosEcClass, fan_idx: UInt8 | None = None) -> None:
     """
     Toggle automatic fan control.
     @param ec: The CrOS_EC object.

cros_ec_python/constants/LPC.py

@@ -41,6 +41,7 @@
 EC_LPC_CMDR_SMI		: Final = BIT(6)  # SMI event is pending
 
 EC_LPC_ADDR_MEMMAP       : Final = 0x900
+EC_LPC_ADDR_MEMMAP_FWAMD : Final = 0xE00  # Address on AMD Framework Laptops
 
 
 # Value written to legacy command port / prefix byte to indicate protocol