Microchip® Advanced Software Framework

usbc_device.c File Reference

USB Device driver Compliance with common driver UDD.

Copyright (c) 2012-2018 Microchip Technology Inc. and its subsidiaries.

#include "conf_usb.h"
#include "sysclk.h"
#include "udd.h"
#include "usbc_otg.h"
#include "usbc_device.h"
#include <string.h>
#include "sleepmgr.h"

Macros

#define dbg_print(...)
 
#define UDD_EP_USED(ep)   (USB_DEVICE_MAX_EP >= ep)
 
#define UDD_USB_INT_FUN   USBC_Handler
 
#define UDD_USB_INT_LEVEL   5
 

Functions

USB IO PADs handlers
static void uhd_vbus_handler (void)
 USB VBus pin change handler. More...
 

Variables

static volatile usb_desc_table_t udd_g_ep_table [2 *(USB_DEVICE_MAX_EP+1)]
 USB SRAM data about endpoint descriptor table The content of the USB SRAM can be : More...
 

Power management routine.

#define USBC_SLEEP_MODE_USB_SUSPEND   SLEEPMGR_SLEEP_1
 Definition of sleep levels. More...
 
#define USBC_SLEEP_MODE_USB_IDLE   SLEEPMGR_ACTIVE
 
static bool udd_b_idle
 State of USB line. More...
 
static void udd_sleep_mode (bool b_idle)
 Authorize or not the CPU powerdown mode. More...
 

Control endpoint low level management routine.

This function performs control endpoint management.

It handle the SETUP/DATA/HANDSHAKE phases of a control transaction.

enum  udd_ctrl_ep_state_t {
  UDD_EPCTRL_SETUP = 0,
  UDD_EPCTRL_DATA_OUT = 1,
  UDD_EPCTRL_DATA_IN = 2,
  UDD_EPCTRL_HANDSHAKE_WAIT_IN_ZLP = 3,
  UDD_EPCTRL_HANDSHAKE_WAIT_OUT_ZLP = 4,
  UDD_EPCTRL_STALL_REQ = 5
}
 Bit definitions about endpoint control state machine for udd_ep_control_state. More...
 
COMPILER_WORD_ALIGNED
udd_ctrl_request_t 
udd_g_ctrlreq
 Global variable to give and record information about setup request management. More...
 
static udd_ctrl_ep_state_t udd_ep_control_state
 State of the endpoint control management. More...
 
static uint16_t udd_ctrl_prev_payload_nb_trans
 Total number of data received/sent during data packet phase with previous payload buffers. More...
 
static uint16_t udd_ctrl_payload_nb_trans
 Number of data received/sent to/from udd_g_ctrlreq.payload buffer. More...
 

Management of bulk/interrupt/isochronous endpoints

Buffer to store the data received on control endpoint (SETUP/OUT endpoint 0)

Used to avoid a RAM buffer overflow in case of the payload buffer is smaller than control endpoint size

The UDD manages the data transfer on endpoints:

  • Start data transfer on endpoint with USB Device DMA
  • Send a ZLP packet if requested
  • Call callback registered to signal end of transfer The transfer abort and stall feature are supported.
 udd_ep_job_t
 
static udd_ep_job_t udd_ep_job [USB_DEVICE_MAX_EP]
 Array to register a job on bulk/interrupt/isochronous endpoint. More...
 
 UDC_BSS (4)
 Buffer to store the data received on bulk/interrupt endpoints. More...
 
bool udd_include_vbus_monitoring (void)
 Authorizes the VBUS event. More...
 
void udd_enable (void)
 Enables the USB Device mode. More...
 
void udd_disable (void)
 Disables the USB Device mode. More...
 
void udd_attach (void)
 Attach device to the bus when possible. More...
 
void udd_detach (void)
 Detaches the device from the bus. More...
 
bool udd_is_high_speed (void)
 Test whether the USB Device Controller is running at high speed or not. More...
 
void udd_set_address (uint8_t address)
 Changes the USB address of device. More...
 
uint8_t udd_getaddress (void)
 Returns the USB address of device. More...
 
uint16_t udd_get_frame_number (void)
 Returns the current start of frame number. More...
 
uint16_t udd_get_micro_frame_number (void)
 Returns the current micro start of frame number. More...
 
void udd_send_remotewakeup (void)
 The USB driver sends a resume signal called Upstream Resume. More...
 
void udd_set_setup_payload (uint8_t *payload, uint16_t payload_size)
 Load setup payload. More...
 
bool udd_ep_alloc (udd_ep_id_t ep, uint8_t bmAttributes, uint16_t MaxEndpointSize)
 Configures and enables an endpoint. More...
 
void udd_ep_free (udd_ep_id_t ep)
 Disables an endpoint. More...
 
bool udd_ep_is_halted (udd_ep_id_t ep)
 Check if the endpoint ep is halted. More...
 
bool udd_ep_set_halt (udd_ep_id_t ep)
 Set the halted state of the endpoint ep. More...
 
bool udd_ep_clear_halt (udd_ep_id_t ep)
 Clear the halted state of the endpoint ep. More...
 
bool udd_ep_run (udd_ep_id_t ep, bool b_shortpacket, uint8_t *buf, iram_size_t buf_size, udd_callback_trans_t callback)
 Allows to receive or send data on an endpoint. More...
 
void udd_ep_abort (udd_ep_id_t ep)
 Aborts transfer on going on endpoint. More...
 
bool udd_ep_wait_stall_clear (udd_ep_id_t ep, udd_callback_halt_cleared_t callback)
 Registers a callback to call when endpoint halt is cleared. More...
 
static void udd_reset_ep_ctrl (void)
 
static void udd_ctrl_init (void)
 
static void udd_ctrl_setup_received (void)
 
static void udd_ctrl_in_sent (void)
 
static void udd_ctrl_out_received (void)
 
static void udd_ctrl_underflow (void)
 
static void udd_ctrl_overflow (void)
 
static void udd_ctrl_stall_data (void)
 
static void udd_ctrl_send_zlp_in (void)
 
static void udd_ctrl_send_zlp_out (void)
 
static void udd_ctrl_endofrequest (void)
 
static bool udd_ctrl_interrupt (void)
 
static void udd_ep_trans_done (udd_ep_id_t ep)
 
static bool udd_ep_interrupt (void)
 

#define UDD_EP_USED (   ep)    (USB_DEVICE_MAX_EP >= ep)
#define UDD_USB_INT_FUN   USBC_Handler
#define UDD_USB_INT_LEVEL   5

Referenced by udd_enable().