arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2025-01-30 01:01:00 +00:00
Code Issues Releases Wiki Activity

docs(core): improve documentation of crc32 function

Browse Source 
[no changelog]
This commit is contained in:
M1nd3r 2024-05-30 11:55:56 +02:00 committed by Petr Sedláček
parent 5c6af8332a
commit 1d747d3b7f
2 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
core/embed/extmod/modtrezorcrypto/modtrezorcrypto-crc.h
View File

@ -26,9 +26,17 @@
/// package: trezorcrypto.crc /// package: trezorcrypto.crc
/// def crc32(data: bytes, crc: int = 0) -> int: /// def crc32(data: bytes, crc: int = 0) -> int:
/// """ /// """
/// Computes a CRC32 checksum of `data`. /// Computes a CRC32 checksum of `data`.
/// """ ///
/// Args:
/// `data` (`bytes`): Input data.
/// `crc` (`int`, `optional`): Initial CRC value for chaining
/// computations over multiple data segments. Defaults to 0.
///
/// Returns:
/// `int`: Computed CRC32 checksum.
/// """
mp_obj_t mod_trezorcrypto_crc_crc32(size_t n_args, const mp_obj_t *args) { mp_obj_t mod_trezorcrypto_crc_crc32(size_t n_args, const mp_obj_t *args) {
mp_buffer_info_t bufinfo = {0}; mp_buffer_info_t bufinfo = {0};
mp_get_buffer_raise(args[0], &bufinfo, MP_BUFFER_READ); mp_get_buffer_raise(args[0], &bufinfo, MP_BUFFER_READ);

12
core/mocks/generated/trezorcrypto/crc.pyi
View File

@ -3,6 +3,12 @@ from typing import *
# extmod/modtrezorcrypto/modtrezorcrypto-crc.h # extmod/modtrezorcrypto/modtrezorcrypto-crc.h
def crc32(data: bytes, crc: int = 0) -> int: def crc32(data: bytes, crc: int = 0) -> int:
""" """
Computes a CRC32 checksum of `data`. Computes a CRC32 checksum of `data`.
""" Args:
`data` (`bytes`): Input data.
`crc` (`int`, `optional`): Initial CRC value for chaining
computations over multiple data segments. Defaults to 0.
Returns:
`int`: Computed CRC32 checksum.
"""