kopia lustrzana https://github.com/micropython/micropython
137 wiersze
4.9 KiB
C
137 wiersze
4.9 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2022 Blake W. Felt & Angus Gratton
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef MICROPY_INCLUDED_SHARED_TINYUSB_MP_USBD_H
|
|
#define MICROPY_INCLUDED_SHARED_TINYUSB_MP_USBD_H
|
|
|
|
#include "py/mpconfig.h"
|
|
|
|
#if MICROPY_HW_ENABLE_USBDEV
|
|
|
|
#include "py/obj.h"
|
|
#include "py/objarray.h"
|
|
#include "py/runtime.h"
|
|
|
|
#ifndef NO_QSTR
|
|
#include "tusb.h"
|
|
#include "device/dcd.h"
|
|
#endif
|
|
|
|
// Run the TinyUSB device task
|
|
void mp_usbd_task(void);
|
|
|
|
// Schedule a call to mp_usbd_task(), even if no USB interrupt has occurred
|
|
void mp_usbd_schedule_task(void);
|
|
|
|
// Function to be implemented in port code.
|
|
// Can write a string up to MICROPY_HW_USB_DESC_STR_MAX characters long, plus terminating byte.
|
|
extern void mp_usbd_port_get_serial_number(char *buf);
|
|
|
|
// Most ports need to write a hexadecimal serial number from a byte array. This
|
|
// is a helper function for this. out_str must be long enough to hold a string of total
|
|
// length (2 * bytes_len + 1) (including NUL terminator).
|
|
void mp_usbd_hex_str(char *out_str, const uint8_t *bytes, size_t bytes_len);
|
|
|
|
// Length of built-in configuration descriptor
|
|
#define MP_USBD_BUILTIN_DESC_CFG_LEN (TUD_CONFIG_DESC_LEN + \
|
|
(CFG_TUD_CDC ? (TUD_CDC_DESC_LEN) : 0) + \
|
|
(CFG_TUD_MSC ? (TUD_MSC_DESC_LEN) : 0) \
|
|
)
|
|
|
|
// Built-in USB device and configuration descriptor values
|
|
extern const tusb_desc_device_t mp_usbd_builtin_desc_dev;
|
|
extern const uint8_t mp_usbd_builtin_desc_cfg[MP_USBD_BUILTIN_DESC_CFG_LEN];
|
|
|
|
void mp_usbd_task_callback(mp_sched_node_t *node);
|
|
|
|
#if MICROPY_HW_ENABLE_USB_RUNTIME_DEVICE
|
|
void mp_usbd_deinit(void);
|
|
void mp_usbd_init(void);
|
|
|
|
const char *mp_usbd_runtime_string_cb(uint8_t index);
|
|
|
|
// Maximum number of pending exceptions per single TinyUSB task execution
|
|
#define MP_USBD_MAX_PEND_EXCS 2
|
|
|
|
typedef struct {
|
|
mp_obj_base_t base;
|
|
|
|
mp_obj_t desc_dev; // Device descriptor bytes
|
|
mp_obj_t desc_cfg; // Configuration descriptor bytes
|
|
mp_obj_t desc_strs; // List/dict/similar to look up string descriptors by index
|
|
|
|
// Runtime device driver callback functions
|
|
mp_obj_t open_itf_cb;
|
|
mp_obj_t reset_cb;
|
|
mp_obj_t control_xfer_cb;
|
|
mp_obj_t xfer_cb;
|
|
|
|
mp_obj_t builtin_driver; // Points to one of mp_type_usb_device_builtin_nnn
|
|
|
|
bool active; // Has the user set the USB device active?
|
|
bool trigger; // Has the user requested the active state change (or re-activate)?
|
|
|
|
// Temporary pointers for xfer data in progress on each endpoint
|
|
// Ensuring they aren't garbage collected until the xfer completes
|
|
mp_obj_t xfer_data[CFG_TUD_ENDPPOINT_MAX][2];
|
|
|
|
// Pointer to a memoryview that is reused to refer to various pieces of
|
|
// control transfer data that are pushed to USB control transfer
|
|
// callbacks. Python code can't rely on the memoryview contents
|
|
// to remain valid after the callback returns!
|
|
mp_obj_array_t *control_data;
|
|
|
|
// Pointers to exceptions thrown inside Python callbacks. See
|
|
// usbd_callback_function_n().
|
|
mp_uint_t num_pend_excs;
|
|
mp_obj_t pend_excs[MP_USBD_MAX_PEND_EXCS];
|
|
} mp_obj_usb_device_t;
|
|
|
|
// Built-in constant objects, possible values of builtin_driver
|
|
//
|
|
// (Currently not possible to change built-in drivers at runtime, just enable/disable.)
|
|
extern const mp_obj_type_t mp_type_usb_device_builtin_default;
|
|
extern const mp_obj_type_t mp_type_usb_device_builtin_none;
|
|
|
|
// Return true if any built-in driver is enabled
|
|
inline static bool mp_usb_device_builtin_enabled(const mp_obj_usb_device_t *usbd) {
|
|
return usbd->builtin_driver != MP_OBJ_FROM_PTR(&mp_type_usb_device_builtin_none);
|
|
}
|
|
|
|
#else // Static USBD drivers only
|
|
|
|
static inline void mp_usbd_init(void) {
|
|
// Without runtime USB support, this can be a thin wrapper wrapper around tusb_init()
|
|
extern bool tusb_init(void);
|
|
tusb_init();
|
|
}
|
|
|
|
#endif
|
|
|
|
#endif // MICROPY_HW_ENABLE_USBDEV
|
|
|
|
#endif // MICROPY_INCLUDED_SHARED_TINYUSB_USBD_H
|