File: libuuu.py

package info (click to toggle)
mfgtools 1.5.239-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,296 kB
  • sloc: cpp: 10,087; javascript: 546; python: 335; sh: 85; xml: 53; makefile: 18
file content (322 lines) | stat: -rw-r--r-- 9,489 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
#
# Copyright 2024-2025 NXP
#
# SPDX-License-Identifier: BSD-3-Clause

"""Main module for libuuu wrapper."""

import logging
import pathlib
import platform
from ctypes import (
    CDLL,
    CFUNCTYPE,
    POINTER,
    Structure,
    Union,
    c_char_p,
    c_int,
    c_size_t,
    c_ulonglong,
    c_ushort,
    c_void_p,
)
from dataclasses import dataclass
from enum import Enum, auto


class UUUNotifyType(Enum):
    """An enumeration to represent the different types of notifications from uuu."""

    NOTIFY_CMD_TOTAL = 0
    NOTIFY_CMD_START = auto()
    NOTIFY_CMD_END = auto()

    NOTIFY_CMD_INDEX = auto()

    NOTIFY_CMD_INFO = auto()

    NOTIFY_PHASE_TOTAL = auto()
    NOTIFY_PHASE_INDEX = auto()

    NOTIFY_TRANS_SIZE = auto()
    NOTIFY_TRANS_POS = auto()

    NOTIFY_WAIT_FOR = auto()
    NOTIFY_DEV_ATTACH = auto()

    NOTIFY_DECOMPRESS_START = auto()
    NOTIFY_DECOMPRESS_SIZE = auto()
    NOTIFY_DECOMPRESS_POS = auto()

    NOTIFY_DOWNLOAD_START = auto()
    NOTIFY_DOWNLOAD_END = auto()
    NOTIFY_THREAD_EXIT = auto()

    NOTIFY_DONE = auto()


@dataclass
class UUUNotifyDataUnion(Union):
    """A union to store data from a uuu notification."""

    _fields_ = [
        ("status", c_int),
        ("index", c_size_t),
        ("total", c_size_t),
        ("str", c_char_p),
    ]


@dataclass
class UUUNotifyStruct(Structure):
    """A class to store a notification from uuu."""

    _fields_ = [
        ("_type", c_int),
        ("id", c_ulonglong),
        ("timestamp", c_ulonglong),
        ("response", UUUNotifyDataUnion),
    ]

    @property
    def type(self) -> UUUNotifyType:
        """Return type attribute as an enum.

        :return UUUNotifyType enum
        """
        return UUUNotifyType(self._type)


@dataclass
class UUUCommandResponse(Structure):
    """A class to store the response from a uuu command."""

    _fields_ = [
        ("value", c_char_p),
    ]


UUUNotifyCallback = CFUNCTYPE(c_int, UUUNotifyStruct, POINTER(c_void_p))

UUUShowConfig = CFUNCTYPE(
    c_int,
    c_char_p,
    c_char_p,
    c_char_p,
    c_ushort,
    c_ushort,
    c_ushort,
    c_ushort,
    c_void_p,
)


@dataclass
class UUUState:
    """A class to store the state of a uuu library command call."""

    # pylint: disable=too-many-instance-attributes
    def __init__(self) -> None:
        """Constructor of UUUState class."""
        self.logger = logging.getLogger("UUUState")
        self.cmd: str = ""
        self.dev: str = ""

        self.waiting: bool = False
        self.done: bool = False
        self.error: bool = False

        self.cmd_status: bool = False
        self.cmd_done: bool = False

        self.cmd_end: int = 0
        self.cmd_pos: int = 0
        self.cmd_start: int = 0

        self.cmd_total: int = 0
        self.cmd_index: int = 0

        self.trans_pos: int = 0
        self.trans_size: int = 0

    def update(self, struct: UUUNotifyStruct) -> None:
        """Update the state with a notification from uuu.

        :param struct: A UUUNotifyStruct object
        """
        self.waiting = struct.type == UUUNotifyType.NOTIFY_WAIT_FOR
        self.done = struct.type == UUUNotifyType.NOTIFY_DONE

        if struct.type == UUUNotifyType.NOTIFY_CMD_TOTAL:
            self.cmd_total = struct.response.total
        elif struct.type == UUUNotifyType.NOTIFY_CMD_START:
            self.cmd = struct.response.str
            self.cmd_pos = 0
            self.cmd_start = struct.timestamp
        elif struct.type == UUUNotifyType.NOTIFY_CMD_END:
            status = struct.response.status
            self.done = True
            self.error = status != 0
            self.cmd_end = struct.timestamp
            if status != 0:
                self.logger.warning(f"Command {self.cmd} failed")
        elif struct.type == UUUNotifyType.NOTIFY_DEV_ATTACH:
            self.dev = struct.response.str
            self.done = False
            self.error = False
        elif struct.type == UUUNotifyType.NOTIFY_TRANS_SIZE:
            self.trans_size = struct.response.total
        elif struct.type == UUUNotifyType.NOTIFY_TRANS_POS:
            self.trans_pos = struct.response.total

        self.logger.debug(f"{self.cmd=},{self.dev=},{self.waiting=}")


def get_platform_info() -> tuple[str, str]:
    """Get platform and architecture information."""
    system = platform.system().lower()
    machine = platform.machine().lower()

    # Normalize architecture names
    arch_mapping = {
        "x86_64": "x86_64",
        "amd64": "x86_64",
        "aarch64": "aarch64",
        "arm64": "arm64",
    }

    arch = arch_mapping.get(machine, machine)
    if system == "linux" and arch == "arm64":
        # For Linux on ARM64, we can use the 'aarch64' architecture name
        arch = "aarch64"

    return system, arch


def get_dll_path() -> str:
    """Return path to the appropriate shared library based on platform and architecture."""
    system, arch = get_platform_info()

    base_path = pathlib.Path(__file__).parent / "lib"

    if system == "windows":
        lib_name = "libuuu.dll"
        lib_path = base_path / "windows" / arch / lib_name
    elif system == "darwin":
        lib_name = "libuuu.dylib"
        # macOS uses universal binary
        lib_path = base_path / "darwin" / arch / lib_name
    else:  # Linux and other Unix-like systems
        lib_name = "libuuu.so"
        lib_path = base_path / "linux" / arch / lib_name

    return str(lib_path)


@UUUNotifyCallback
def _default_notify_callback(struct: UUUNotifyStruct, data) -> int:  # type: ignore
    """A default callback function that stores the response in a class variable.

    :param struct: A UUUNotifyStruct object
    :param data: A pointer to data, here it is not used
    """
    # pylint: disable=unused-argument
    LibUUU._state.update(struct)
    if struct.type == UUUNotifyType.NOTIFY_CMD_INFO:
        LibUUU._response.value += bytes(struct.response.str)
    return 1 if LibUUU._state.error else 0


class LibUUU:
    """Wrapper for the libuuu library."""

    DLL = get_dll_path()
    NULL = POINTER(c_void_p)()

    _response = UUUCommandResponse()
    _state = UUUState()

    def __init__(self) -> None:
        """Initialize the library and register the default notify callback function."""
        self._response.value = b""
        self.lib = CDLL(self.DLL, mode=1)
        self.register_notify_callback(_default_notify_callback, self.NULL)

    def set_wait_timeout(self, timeout: int) -> int:
        """Set the wait timeout for uuu in seconds."""
        return self.lib.uuu_set_wait_timeout(c_int(timeout))

    def set_wait_next_timeout(self, timeout: int) -> int:
        """Set the wait next timeout for uuu in seconds."""
        return self.lib.uuu_set_wait_next_timeout(c_int(timeout))

    def set_poll_period(self, period: int) -> int:
        """Set the poll period for uuu in milliseconds."""
        return self.lib.uuu_set_poll_period(c_int(period))

    def set_debug_level(self, level: int) -> int:
        """Set the debug level for uuu.

        :param level: The debug level [15:0] for libusb, [31:16] for uuu
        """
        return self.lib.uuu_set_debug_level(c_int(level))

    def set_small_mem(self, size: int) -> int:
        """Disable small memory mode and buffer all data.

        :param size: The size of the buffer in bytes
        """
        return self.lib.uuu_set_small_mem(c_int(size))

    def get_version_string(self) -> str:
        """Get the version of uuu."""
        self.lib.uuu_get_version_string.restype = c_char_p
        return self.lib.uuu_get_version_string().decode()

    def get_version(self) -> int:
        """Get the version of uuu.

        :return: The version of uuu bits represent version in format [31:24].[23:12].[11:0]
        """
        return self.lib.uuu_get_version()

    def get_last_error_string(self) -> str:
        """Get the last error message from uuu."""
        self.lib.uuu_get_last_err_string.restype = c_char_p
        return self.lib.uuu_get_last_err_string().decode()

    def get_last_error(self) -> int:
        """Get the last error code from uuu."""
        return self.lib.uuu_get_last_err()

    def run_cmd(self, cmd: str, dry: bool = False) -> int:
        """Run a uuu command.

        :param cmd: The command to run
        :param dry: If set to False command will be executed, otherwise its a dry run
        :return: 0 if success
        """
        # pylint: disable=attribute-defined-outside-init
        self._response.value = b""
        return self.lib.uuu_run_cmd(c_char_p(str.encode(cmd)), c_int(1 if dry else 0))

    def register_notify_callback(self, callback: UUUNotifyCallback, data: any) -> int:  # type: ignore
        """Register a callback function to receive notifications from uuu.

        :param callback: A function that will be called when uuu sends a notification
        :param data: A pointer to data that will be passed to the callback function
        :return: 0 on success, otherwise failure
        """
        return self.lib.uuu_register_notify_callback(callback, data)

    def unregister_notify_callback(self, callback: UUUNotifyCallback) -> int:  # type: ignore
        """Unregister the callback function."""
        return self.lib.uuu_unregister_notify_callback(callback)

    @property
    def response(self) -> bytes:
        """Get the response from the last uuu command."""
        return self._response.value