1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-05 05:58:23 +00:00
trezor-firmware/core/mocks/generated/trezorutils.pyi

155 lines
3.9 KiB
Python
Raw Normal View History

2017-06-14 17:27:02 +00:00
from typing import *
2017-06-14 15:41:45 +00:00
# upymod/modtrezorutils/modtrezorutils-meminfo.h
def meminfo(filename: str) -> None:
"""Dumps map of micropython GC arena to a file.
The JSON file can be decoded by analyze.py
Only available in the emulator.
"""
# upymod/modtrezorutils/modtrezorutils.c
def consteq(sec: bytes, pub: bytes) -> bool:
"""
Compares the private information in `sec` with public, user-provided
information in `pub`. Runs in constant time, corresponding to a length
of `pub`. Can access memory behind valid length of `sec`, caller is
expected to avoid any invalid memory access.
"""
# upymod/modtrezorutils/modtrezorutils.c
def memcpy(
dst: bytearray | memoryview,
dst_ofs: int,
src: bytes,
src_ofs: int,
n: int | None = None,
) -> int:
"""
2017-06-14 15:41:45 +00:00
Copies at most `n` bytes from `src` at offset `src_ofs` to
2020-06-26 10:30:12 +00:00
`dst` at offset `dst_ofs`. Returns the number of actually
copied bytes. If `n` is not specified, tries to copy
as much as possible.
"""
2017-06-14 15:41:45 +00:00
# upymod/modtrezorutils/modtrezorutils.c
def halt(msg: str | None = None) -> None:
"""
2017-06-14 15:41:45 +00:00
Halts execution.
"""
# upymod/modtrezorutils/modtrezorutils.c
def firmware_hash(
challenge: bytes | None = None,
callback: Callable[[int, int], None] | None = None,
) -> bytes:
"""
Computes the Blake2s hash of the firmware with an optional challenge as
the key.
"""
# upymod/modtrezorutils/modtrezorutils.c
def firmware_vendor() -> str:
"""
Returns the firmware vendor string from the vendor header.
"""
2022-05-03 09:34:34 +00:00
# upymod/modtrezorutils/modtrezorutils.c
def unit_color() -> int | None:
"""
Returns the color of the unit.
"""
# upymod/modtrezorutils/modtrezorutils.c
def unit_btconly() -> bool | None:
"""
Returns True if the unit is BTConly.
"""
# upymod/modtrezorutils/modtrezorutils.c
def unit_packaging() -> int | None:
"""
Returns the packaging version of the unit.
"""
# upymod/modtrezorutils/modtrezorutils.c
def sd_hotswap_enabled() -> bool:
"""
Returns True if SD card hot swapping is enabled
"""
# upymod/modtrezorutils/modtrezorutils.c
def reboot_to_bootloader(
boot_command : int = 0,
boot_args : bytes | None = None,
) -> None:
"""
Reboots to bootloader.
"""
VersionTuple = Tuple[int, int, int, int]
# upymod/modtrezorutils/modtrezorutils.c
class FirmwareHeaderInfo(NamedTuple):
version: VersionTuple
vendor: str
fingerprint: bytes
hash: bytes
# upymod/modtrezorutils/modtrezorutils.c
def check_firmware_header(header : bytes) -> FirmwareHeaderInfo:
"""Parses incoming firmware header and returns information about it."""
# upymod/modtrezorutils/modtrezorutils.c
def bootloader_locked() -> bool | None:
"""
Returns True/False if the the bootloader is locked/unlocked and None if
the feature is not supported.
"""
SCM_REVISION: bytes
"""Git commit hash of the firmware."""
VERSION: VersionTuple
"""Firmware version as a tuple (major, minor, patch, build)."""
USE_SD_CARD: bool
"""Whether the hardware supports SD card."""
USE_BACKLIGHT: bool
"""Whether the hardware supports backlight brightness control."""
USE_HAPTIC: bool
"""Whether the hardware supports haptic feedback."""
2023-08-23 08:00:41 +00:00
USE_OPTIGA: bool
"""Whether the hardware supports Optiga secure element."""
USE_TOUCH: bool
"""Whether the hardware supports touch screen."""
USE_BUTTON: bool
"""Whether the hardware supports two-button input."""
2019-06-09 09:24:06 +00:00
MODEL: str
"""Model name."""
MODEL_FULL_NAME: str
"""Full name including Trezor prefix."""
MODEL_USB_MANUFACTURER: str
"""USB Manufacturer name."""
MODEL_USB_PRODUCT: str
"""USB Product name."""
INTERNAL_MODEL: str
"""Internal model code."""
2019-06-09 09:24:06 +00:00
EMULATOR: bool
"""Whether the firmware is running in the emulator."""
2020-04-20 14:38:50 +00:00
BITCOIN_ONLY: bool
"""Whether the firmware is Bitcoin-only."""
UI_LAYOUT: str
"""UI layout identifier ("tt" for model T, "tr" for models One and R)."""
USE_THP: bool
"""Whether the firmware supports Trezor-Host Protocol (version 2)."""