trezor-firmware/embed/extmod/modtrezorio/modtrezorio-sdcard.h

/*
 * This file is part of the TREZOR project, https://trezor.io/
 *
 * Copyright (c) SatoshiLabs
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "sdcard.h"

#include "embed/extmod/trezorobj.h"

/// class SDCard:
///     '''
///     '''
typedef struct _mp_obj_SDCard_t {
  mp_obj_base_t base;
} mp_obj_SDCard_t;

/// def __init__(self) -> None:
///     '''
///     '''
STATIC mp_obj_t mod_trezorio_SDCard_make_new(const mp_obj_type_t *type,
                                             size_t n_args, size_t n_kw,
                                             const mp_obj_t *args) {
  mp_arg_check_num(n_args, n_kw, 0, 0, false);
  mp_obj_SDCard_t *o = m_new_obj(mp_obj_SDCard_t);
  o->base.type = type;
#ifdef TREZOR_EMULATOR
  sdcard_init();
#endif
  return MP_OBJ_FROM_PTR(o);
}

/// def present(self) -> bool:
///     '''
///     Returns True if SD card is detected, False otherwise.
///     '''
STATIC mp_obj_t mod_trezorio_SDCard_present(mp_obj_t self) {
  return mp_obj_new_bool(sdcard_is_present());
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_trezorio_SDCard_present_obj,
                                 mod_trezorio_SDCard_present);

/// def power(self, state: bool) -> bool:
///     '''
///     Power on or power off the SD card interface.
///     Returns True if in case of success, False otherwise.
///     '''
STATIC mp_obj_t mod_trezorio_SDCard_power(mp_obj_t self, mp_obj_t state) {
  if (mp_obj_is_true(state)) {
    return mp_obj_new_bool(sdcard_power_on());
  } else {
    sdcard_power_off();
    return mp_const_true;
  }
}
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mod_trezorio_SDCard_power_obj,
                                 mod_trezorio_SDCard_power);

/// def capacity(self) -> int:
///     '''
///     Returns capacity of the SD card in bytes, or zero if not present.
///     '''
STATIC mp_obj_t mod_trezorio_SDCard_capacity(mp_obj_t self) {
  return mp_obj_new_int_from_ull(sdcard_get_capacity_in_bytes());
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_trezorio_SDCard_capacity_obj,
                                 mod_trezorio_SDCard_capacity);

/// def read(self, block_num: int, buf: bytearray) -> bool:
///     '''
///     Reads blocks starting with block_num from the SD card into buf.
///     Number of bytes read is length of buf rounded down to multiply of
///     SDCARD_BLOCK_SIZE. Returns True if in case of success, False otherwise.
///     '''
STATIC mp_obj_t mod_trezorio_SDCard_read(mp_obj_t self, mp_obj_t block_num,
                                         mp_obj_t buf) {
  uint32_t block = trezor_obj_get_uint(block_num);
  mp_buffer_info_t bufinfo;
  mp_get_buffer_raise(buf, &bufinfo, MP_BUFFER_WRITE);
  return mp_obj_new_bool(
      sdcard_read_blocks(bufinfo.buf, block, bufinfo.len / SDCARD_BLOCK_SIZE));
}
STATIC MP_DEFINE_CONST_FUN_OBJ_3(mod_trezorio_SDCard_read_obj,
                                 mod_trezorio_SDCard_read);

/// def write(self, block_num: int, buf: bytes) -> bool:
///     '''
///     Writes blocks starting with block_num from buf to the SD card.
///     Number of bytes written is length of buf rounded down to multiply of
///     SDCARD_BLOCK_SIZE. Returns True if in case of success, False otherwise.
///     '''
STATIC mp_obj_t mod_trezorio_SDCard_write(mp_obj_t self, mp_obj_t block_num,
                                          mp_obj_t buf) {
  uint32_t block = trezor_obj_get_uint(block_num);
  mp_buffer_info_t bufinfo;
  mp_get_buffer_raise(buf, &bufinfo, MP_BUFFER_READ);
  return mp_obj_new_bool(
      sdcard_write_blocks(bufinfo.buf, block, bufinfo.len / SDCARD_BLOCK_SIZE));
}
STATIC MP_DEFINE_CONST_FUN_OBJ_3(mod_trezorio_SDCard_write_obj,
                                 mod_trezorio_SDCard_write);

STATIC const mp_rom_map_elem_t mod_trezorio_SDCard_locals_dict_table[] = {
    {MP_ROM_QSTR(MP_QSTR_present),
     MP_ROM_PTR(&mod_trezorio_SDCard_present_obj)},
    {MP_ROM_QSTR(MP_QSTR_power), MP_ROM_PTR(&mod_trezorio_SDCard_power_obj)},
    {MP_ROM_QSTR(MP_QSTR_capacity),
     MP_ROM_PTR(&mod_trezorio_SDCard_capacity_obj)},
    {MP_ROM_QSTR(MP_QSTR_block_size), MP_OBJ_NEW_SMALL_INT(SDCARD_BLOCK_SIZE)},
    {MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&mod_trezorio_SDCard_read_obj)},
    {MP_ROM_QSTR(MP_QSTR_write), MP_ROM_PTR(&mod_trezorio_SDCard_write_obj)},
};
STATIC MP_DEFINE_CONST_DICT(mod_trezorio_SDCard_locals_dict,
                            mod_trezorio_SDCard_locals_dict_table);

STATIC const mp_obj_type_t mod_trezorio_SDCard_type = {
    {&mp_type_type},
    .name = MP_QSTR_SDCard,
    .make_new = mod_trezorio_SDCard_make_new,
    .locals_dict = (void *)&mod_trezorio_SDCard_locals_dict,
};