trezor-firmware/embed/extmod/modtrezorio/modtrezorio-hid.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/>.
 */

/// class HID:
///     '''
///     USB HID interface configuration.
///     '''
typedef struct _mp_obj_HID_t {
  mp_obj_base_t base;
  usb_hid_info_t info;
} mp_obj_HID_t;

/// def __init__(self,
///              iface_num: int,
///              ep_in: int,
///              ep_out: int,
///              report_desc: bytes,
///              subclass: int = 0,
///              protocol: int = 0,
///              polling_interval: int = 1,
///              max_packet_len: int = 64) -> None:
///     '''
///     '''
STATIC mp_obj_t mod_trezorio_HID_make_new(const mp_obj_type_t *type,
                                          size_t n_args, size_t n_kw,
                                          const mp_obj_t *args) {
  STATIC const mp_arg_t allowed_args[] = {
      {MP_QSTR_iface_num,
       MP_ARG_REQUIRED | MP_ARG_KW_ONLY | MP_ARG_INT,
       {.u_int = 0}},
      {MP_QSTR_ep_in,
       MP_ARG_REQUIRED | MP_ARG_KW_ONLY | MP_ARG_INT,
       {.u_int = 0}},
      {MP_QSTR_ep_out,
       MP_ARG_REQUIRED | MP_ARG_KW_ONLY | MP_ARG_INT,
       {.u_int = 0}},
      {MP_QSTR_subclass, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 0}},
      {MP_QSTR_protocol, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 0}},
      {MP_QSTR_polling_interval, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 1}},
      {MP_QSTR_max_packet_len, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 64}},
      {MP_QSTR_report_desc,
       MP_ARG_REQUIRED | MP_ARG_KW_ONLY | MP_ARG_OBJ,
       {.u_obj = MP_OBJ_NULL}},
  };
  mp_arg_val_t vals[MP_ARRAY_SIZE(allowed_args)];
  mp_arg_parse_all_kw_array(n_args, n_kw, args, MP_ARRAY_SIZE(allowed_args),
                            allowed_args, vals);

  const mp_int_t iface_num = vals[0].u_int;
  const mp_int_t ep_in = vals[1].u_int;
  const mp_int_t ep_out = vals[2].u_int;
  const mp_int_t subclass = vals[3].u_int;
  const mp_int_t protocol = vals[4].u_int;
  const mp_int_t polling_interval = vals[5].u_int;
  const mp_int_t max_packet_len = vals[6].u_int;
  mp_buffer_info_t report_desc;
  mp_get_buffer_raise(vals[7].u_obj, &report_desc, MP_BUFFER_READ);

  if (report_desc.buf == NULL || report_desc.len == 0 ||
      report_desc.len > 255) {
    mp_raise_ValueError("report_desc is invalid");
  }
  CHECK_PARAM_RANGE(iface_num, 0, 32)
  CHECK_PARAM_RANGE(ep_in, 0, 255)
  CHECK_PARAM_RANGE(ep_out, 0, 255)
  CHECK_PARAM_RANGE(subclass, 0, 255)
  CHECK_PARAM_RANGE(protocol, 0, 255)
  CHECK_PARAM_RANGE(polling_interval, 1, 255)
  CHECK_PARAM_RANGE(max_packet_len, 64, 64)

  mp_obj_HID_t *o = m_new_obj(mp_obj_HID_t);
  o->base.type = type;

  o->info.rx_buffer = m_new(uint8_t, max_packet_len);
  o->info.report_desc = report_desc.buf;
  o->info.iface_num = (uint8_t)(iface_num);
  o->info.ep_in = (uint8_t)(ep_in);
  o->info.ep_out = (uint8_t)(ep_out);
  o->info.subclass = (uint8_t)(subclass);
  o->info.protocol = (uint8_t)(protocol);
  o->info.polling_interval = (uint8_t)(polling_interval);
  o->info.max_packet_len = (uint8_t)(max_packet_len);
  o->info.report_desc_len = (uint8_t)(report_desc.len);

  return MP_OBJ_FROM_PTR(o);
}

/// def iface_num(self) -> int:
///     '''
///     Returns the configured number of this interface.
///     '''
STATIC mp_obj_t mod_trezorio_HID_iface_num(mp_obj_t self) {
  mp_obj_HID_t *o = MP_OBJ_TO_PTR(self);
  return MP_OBJ_NEW_SMALL_INT(o->info.iface_num);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mod_trezorio_HID_iface_num_obj,
                                 mod_trezorio_HID_iface_num);

/// def write(self, msg: bytes) -> int:
///     '''
///     Sends message using USB HID (device) or UDP (emulator).
///     '''
STATIC mp_obj_t mod_trezorio_HID_write(mp_obj_t self, mp_obj_t msg) {
  mp_obj_HID_t *o = MP_OBJ_TO_PTR(self);
  mp_buffer_info_t buf;
  mp_get_buffer_raise(msg, &buf, MP_BUFFER_READ);
  ssize_t r = usb_hid_write(o->info.iface_num, buf.buf, buf.len);
  return MP_OBJ_NEW_SMALL_INT(r);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mod_trezorio_HID_write_obj,
                                 mod_trezorio_HID_write);

STATIC const mp_rom_map_elem_t mod_trezorio_HID_locals_dict_table[] = {
    {MP_ROM_QSTR(MP_QSTR_iface_num),
     MP_ROM_PTR(&mod_trezorio_HID_iface_num_obj)},
    {MP_ROM_QSTR(MP_QSTR_write), MP_ROM_PTR(&mod_trezorio_HID_write_obj)},
};
STATIC MP_DEFINE_CONST_DICT(mod_trezorio_HID_locals_dict,
                            mod_trezorio_HID_locals_dict_table);

STATIC const mp_obj_type_t mod_trezorio_HID_type = {
    {&mp_type_type},
    .name = MP_QSTR_HID,
    .make_new = mod_trezorio_HID_make_new,
    .locals_dict = (void *)&mod_trezorio_HID_locals_dict,
};