rp2040_usb.h

Go to the documentation of this file.

#ifndef RP2040_COMMON_H_
#define RP2040_COMMON_H_
 
#if defined(RP2040_USB_HOST_MODE) && defined(RP2040_USB_DEVICE_MODE)
#error TinyUSB device and host mode not supported at the same time
#endif
 
#include "common/tusb_common.h"
 
#include "pico.h"
#include "hardware/structs/usb.h"
#include "hardware/irq.h"
#include "hardware/resets.h"
#include "hardware/timer.h"
 
#if defined(PICO_RP2040_USB_DEVICE_ENUMERATION_FIX) && !defined(TUD_OPT_RP2040_USB_DEVICE_ENUMERATION_FIX)
#define TUD_OPT_RP2040_USB_DEVICE_ENUMERATION_FIX PICO_RP2040_USB_DEVICE_ENUMERATION_FIX
#endif
 
#if defined(PICO_RP2040_USB_DEVICE_UFRAME_FIX) && !defined(TUD_OPT_RP2040_USB_DEVICE_UFRAME_FIX)
#define TUD_OPT_RP2040_USB_DEVICE_UFRAME_FIX PICO_RP2040_USB_DEVICE_UFRAME_FIX
#endif
 
#if TUD_OPT_RP2040_USB_DEVICE_UFRAME_FIX
#undef PICO_RP2040_USB_FAST_IRQ
#define PICO_RP2040_USB_FAST_IRQ 1
#endif
 
#ifndef PICO_RP2040_USB_FAST_IRQ
#define PICO_RP2040_USB_FAST_IRQ 0
#endif
 
#if PICO_RP2040_USB_FAST_IRQ
#define __tusb_irq_path_func(x) __no_inline_not_in_flash_func(x)
#else
#define __tusb_irq_path_func(x) x
#endif
 
#define usb_hw_set    ((usb_hw_t *) hw_set_alias_untyped(usb_hw))
#define usb_hw_clear  ((usb_hw_t *) hw_clear_alias_untyped(usb_hw))
 
#define pico_info(...)  TU_LOG(2, __VA_ARGS__)
#define pico_trace(...) TU_LOG(3, __VA_ARGS__)
 
// Hardware information per endpoint
typedef struct hw_endpoint
{
    // Is this a valid struct
    bool configured;
 
    // Transfer direction (i.e. IN is rx for host but tx for device)
    // allows us to common up transfer functions
    bool rx;
 
    uint8_t ep_addr;
    uint8_t next_pid;
 
    // Endpoint control register
    io_rw_32 *endpoint_control;
 
    // Buffer control register
    io_rw_32 *buffer_control;
 
    // Buffer pointer in usb dpram
    uint8_t *hw_data_buf;
 
    // User buffer in main memory
    uint8_t *user_buf;
 
    // Current transfer information
    uint16_t remaining_len;
    uint16_t xferred_len;
 
    // Data needed from EP descriptor
    uint16_t wMaxPacketSize;
 
    // Endpoint is in use
    bool active;
 
    // Interrupt, bulk, etc
    uint8_t transfer_type;
 
    // Transfer scheduled but not active
    uint8_t pending;
 
#if CFG_TUH_ENABLED
    // Only needed for host
    uint8_t dev_addr;
 
    // If interrupt endpoint
    uint8_t interrupt_num;
#endif
 
} hw_endpoint_t;
 
#if TUD_OPT_RP2040_USB_DEVICE_UFRAME_FIX
extern volatile uint32_t e15_last_sof;
#endif
 
void rp2040_usb_init(void);
 
void hw_endpoint_xfer_start(struct hw_endpoint *ep, uint8_t *buffer, uint16_t total_len);
bool hw_endpoint_xfer_continue(struct hw_endpoint *ep);
void hw_endpoint_reset_transfer(struct hw_endpoint *ep);
void hw_endpoint_start_next_buffer(struct hw_endpoint *ep);
 
TU_ATTR_ALWAYS_INLINE static inline void hw_endpoint_lock_update(__unused struct hw_endpoint * ep, __unused int delta) {
  // todo add critsec as necessary to prevent issues between worker and IRQ...
  //  note that this is perhaps as simple as disabling IRQs because it would make
  //  sense to have worker and IRQ on same core, however I think using critsec is about equivalent.
}
 
void _hw_endpoint_buffer_control_update32(struct hw_endpoint *ep, uint32_t and_mask, uint32_t or_mask);
 
TU_ATTR_ALWAYS_INLINE static inline uint32_t _hw_endpoint_buffer_control_get_value32 (struct hw_endpoint *ep)
{
  return *ep->buffer_control;
}
 
TU_ATTR_ALWAYS_INLINE static inline void _hw_endpoint_buffer_control_set_value32 (struct hw_endpoint *ep, uint32_t value)
{
  _hw_endpoint_buffer_control_update32(ep, 0, value);
}
 
TU_ATTR_ALWAYS_INLINE static inline void _hw_endpoint_buffer_control_set_mask32 (struct hw_endpoint *ep, uint32_t value)
{
  _hw_endpoint_buffer_control_update32(ep, ~value, value);
}
 
TU_ATTR_ALWAYS_INLINE static inline void _hw_endpoint_buffer_control_clear_mask32 (struct hw_endpoint *ep, uint32_t value)
{
  _hw_endpoint_buffer_control_update32(ep, ~value, 0);
}
 
static inline uintptr_t hw_data_offset (uint8_t *buf)
{
  // Remove usb base from buffer pointer
  return (uintptr_t) buf ^ (uintptr_t) usb_dpram;
}
 
extern const char *ep_dir_string[];
 
#endif