507 lines
16 KiB
C
507 lines
16 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
|
|
ChibiOS - Copyright (C) 2021 Stefan Kerkmann
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file OTG/hal_usb_lld.h
|
|
* @brief GD32 USB subsystem low level driver header.
|
|
*
|
|
* @addtogroup USB
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_USB_LLD_H
|
|
#define HAL_USB_LLD_H
|
|
|
|
#if HAL_USE_USB || defined(__DOXYGEN__)
|
|
|
|
#include "gd32_otg.h"
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Status stage handling method.
|
|
*/
|
|
#define USB_EP0_STATUS_STAGE USB_EP0_STATUS_STAGE_SW
|
|
|
|
/**
|
|
* @brief The address can be changed immediately upon packet reception.
|
|
*/
|
|
#define USB_SET_ADDRESS_MODE USB_EARLY_SET_ADDRESS
|
|
|
|
/**
|
|
* @brief Method for set address acknowledge.
|
|
*/
|
|
#define USB_SET_ADDRESS_ACK_HANDLING USB_SET_ADDRESS_ACK_SW
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief USBFS driver enable switch.
|
|
* @details If set to @p TRUE the support for USBFS is included.
|
|
* @note The default is @p FALSE
|
|
*/
|
|
#if !defined(GD32_USB_USE_USBFS) || defined(__DOXYGEN__)
|
|
#define GD32_USB_USE_USBFS FALSE
|
|
#endif
|
|
|
|
/**
|
|
* @brief USBFS interrupt priority level setting.
|
|
*/
|
|
#if !defined(GD32_USB_USBFS_IRQ_PRIORITY) || defined(__DOXYGEN__)
|
|
#define GD32_USB_USBFS_IRQ_PRIORITY 1
|
|
#endif
|
|
|
|
/**
|
|
* @brief USBFS interrupt trigger setting.
|
|
*/
|
|
#if !defined(GD32_USB_USBFS_IRQ_TRIGGER) || defined(__DOXYGEN__)
|
|
#define GD32_USB_USBFS_IRQ_TRIGGER ECLIC_TRIGGER_DEFAULT
|
|
#endif
|
|
|
|
/**
|
|
* @brief USBFS RX shared FIFO size.
|
|
* @note Must be a multiple of 4.
|
|
*/
|
|
#if !defined(GD32_USB_USBFS_RX_FIFO_SIZE) || defined(__DOXYGEN__)
|
|
#define GD32_USB_USBFS_RX_FIFO_SIZE 128
|
|
#endif
|
|
|
|
/**
|
|
* @brief Exception priority level during TXFIFOs operations.
|
|
* @note Because an undocumented silicon behavior the operation of
|
|
* copying a packet into a TXFIFO must not be interrupted by
|
|
* any other operation on the USBFS peripheral.
|
|
* This parameter represents the priority mask during copy
|
|
* operations. The default value only allows to call USB
|
|
* functions from callbacks invoked from USB ISR handlers.
|
|
* If you need to invoke USB functions from other handlers
|
|
* then raise this priority mast to the same level of the
|
|
* handler you need to use.
|
|
* @note The value zero means disabled, when disabled calling USB
|
|
* functions is only safe from thread level or from USB
|
|
* callbacks.
|
|
*/
|
|
#if !defined(GD32_USB_USBFSFIFO_FILL_BASEPRI) || defined(__DOXYGEN__)
|
|
#define GD32_USB_USBFSFIFO_FILL_BASEPRI 0
|
|
#endif
|
|
|
|
/**
|
|
* @brief Host wake-up procedure duration.
|
|
*/
|
|
#if !defined(GD32_USB_HOST_WAKEUP_DURATION) || defined(__DOXYGEN__)
|
|
#define GD32_USB_HOST_WAKEUP_DURATION 2
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/* Registry checks.*/
|
|
#if GD32_HAS_USBFS && !defined(GD32_USBFS_ENDPOINTS)
|
|
#error "GD32_USBFS_ENDPOINTS not defined in registry"
|
|
#endif
|
|
|
|
#if GD32_HAS_USBFS && !defined(GD32_USBFS_FIFO_MEM_SIZE)
|
|
#error "GD32_USBFS_FIFO_MEM_SIZE not defined in registry"
|
|
#endif
|
|
|
|
#if (GD32_USB_USE_USBFS && !defined(GD32_USBFS_HANDLER))
|
|
#error "GD32_USBFS_HANDLER not defined in registry"
|
|
#endif
|
|
|
|
#if (GD32_USB_USE_USBFS && !defined(GD32_USBFS_NUMBER))
|
|
#error "GD32_USBFS_NUMBER not defined in registry"
|
|
#endif
|
|
|
|
/**
|
|
* @brief Maximum endpoint address.
|
|
*/
|
|
#define USB_MAX_ENDPOINTS GD32_USBFS_ENDPOINTS
|
|
|
|
#if GD32_USB_USE_USBFS && !GD32_HAS_USBFS
|
|
#error "USBFS not present in the selected device"
|
|
#endif
|
|
|
|
#if !GD32_USB_USE_USBFS
|
|
#error "USB driver activated but no USB peripheral assigned"
|
|
#endif
|
|
|
|
#if GD32_USB_USE_USBFS && \
|
|
!OSAL_IRQ_IS_VALID_PRIORITY(GD32_USB_USBFS_IRQ_PRIORITY)
|
|
#error "Invalid IRQ priority assigned to USBFS"
|
|
#endif
|
|
|
|
#if (GD32_USB_USBFS_RX_FIFO_SIZE & 3) != 0
|
|
#error "USBFS RX FIFO size must be a multiple of 4"
|
|
#endif
|
|
|
|
#define GD32_USBCLK GD32_USBFSCLK
|
|
|
|
/* Allowing for a small tolerance.*/
|
|
#if GD32_USBCLK < 47880000 || GD32_USBCLK > 48120000
|
|
#error "the USB OTG driver requires a 48MHz clock"
|
|
#endif
|
|
|
|
#if (GD32_USB_HOST_WAKEUP_DURATION < 2) || (GD32_USB_HOST_WAKEUP_DURATION > 15)
|
|
#error "invalid GD32_USB_HOST_WAKEUP_DURATION setting, it must be between 2 and 15"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Peripheral-specific parameters block.
|
|
*/
|
|
typedef struct {
|
|
uint32_t rx_fifo_size;
|
|
uint32_t otg_ram_size;
|
|
uint32_t num_endpoints;
|
|
} gd32_usbfs_params_t;
|
|
|
|
/**
|
|
* @brief Type of an IN endpoint state structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Requested transmit transfer size.
|
|
*/
|
|
size_t txsize;
|
|
/**
|
|
* @brief Transmitted bytes so far.
|
|
*/
|
|
size_t txcnt;
|
|
/**
|
|
* @brief Pointer to the transmission linear buffer.
|
|
*/
|
|
const uint8_t *txbuf;
|
|
#if (USB_USE_WAIT == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Waiting thread.
|
|
*/
|
|
thread_reference_t thread;
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
/**
|
|
* @brief Total transmit transfer size.
|
|
*/
|
|
size_t totsize;
|
|
} USBInEndpointState;
|
|
|
|
/**
|
|
* @brief Type of an OUT endpoint state structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Requested receive transfer size.
|
|
*/
|
|
size_t rxsize;
|
|
/**
|
|
* @brief Received bytes so far.
|
|
*/
|
|
size_t rxcnt;
|
|
/**
|
|
* @brief Pointer to the receive linear buffer.
|
|
*/
|
|
uint8_t *rxbuf;
|
|
#if (USB_USE_WAIT == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Waiting thread.
|
|
*/
|
|
thread_reference_t thread;
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
/**
|
|
* @brief Total receive transfer size.
|
|
*/
|
|
size_t totsize;
|
|
} USBOutEndpointState;
|
|
|
|
/**
|
|
* @brief Type of an USB endpoint configuration structure.
|
|
* @note Platform specific restrictions may apply to endpoints.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Type and mode of the endpoint.
|
|
*/
|
|
uint32_t ep_mode;
|
|
/**
|
|
* @brief Setup packet notification callback.
|
|
* @details This callback is invoked when a setup packet has been
|
|
* received.
|
|
* @post The application must immediately call @p usbReadPacket() in
|
|
* order to access the received packet.
|
|
* @note This field is only valid for @p USB_EP_MODE_TYPE_CTRL
|
|
* endpoints, it should be set to @p NULL for other endpoint
|
|
* types.
|
|
*/
|
|
usbepcallback_t setup_cb;
|
|
/**
|
|
* @brief IN endpoint notification callback.
|
|
* @details This field must be set to @p NULL if callback is not required.
|
|
*/
|
|
usbepcallback_t in_cb;
|
|
/**
|
|
* @brief OUT endpoint notification callback.
|
|
* @details This field must be set to @p NULL if callback is not required.
|
|
*/
|
|
usbepcallback_t out_cb;
|
|
/**
|
|
* @brief IN endpoint maximum packet size.
|
|
* @details This field must be set to zero if the IN endpoint is not used.
|
|
*/
|
|
uint16_t in_maxsize;
|
|
/**
|
|
* @brief OUT endpoint maximum packet size.
|
|
* @details This field must be set to zero if the OUT endpoint is not used.
|
|
*/
|
|
uint16_t out_maxsize;
|
|
/**
|
|
* @brief @p USBEndpointState associated to the IN endpoint.
|
|
* @details This field must be set to @p NULL if the IN endpoint is not
|
|
* used.
|
|
*/
|
|
USBInEndpointState *in_state;
|
|
/**
|
|
* @brief @p USBEndpointState associated to the OUT endpoint.
|
|
* @details This field must be set to @p NULL if the OUT endpoint is not
|
|
* used.
|
|
*/
|
|
USBOutEndpointState *out_state;
|
|
/* End of the mandatory fields.*/
|
|
/**
|
|
* @brief Determines the space allocated for the TXFIFO as multiples of
|
|
* the packet size (@p in_maxsize). Note that zero is interpreted
|
|
* as one for simplicity and robustness.
|
|
*/
|
|
uint16_t in_multiplier;
|
|
/**
|
|
* @brief Pointer to a buffer for setup packets.
|
|
* @details Setup packets require a dedicated 8-bytes buffer, set this
|
|
* field to @p NULL for non-control endpoints.
|
|
*/
|
|
uint8_t *setup_buf;
|
|
} USBEndpointConfig;
|
|
|
|
/**
|
|
* @brief Type of an USB driver configuration structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief USB events callback.
|
|
* @details This callback is invoked when an USB driver event is registered.
|
|
*/
|
|
usbeventcb_t event_cb;
|
|
/**
|
|
* @brief Device GET_DESCRIPTOR request callback.
|
|
* @note This callback is mandatory and cannot be set to @p NULL.
|
|
*/
|
|
usbgetdescriptor_t get_descriptor_cb;
|
|
/**
|
|
* @brief Requests hook callback.
|
|
* @details This hook allows to be notified of standard requests or to
|
|
* handle non standard requests.
|
|
*/
|
|
usbreqhandler_t requests_hook_cb;
|
|
/**
|
|
* @brief Start Of Frame callback.
|
|
*/
|
|
usbcallback_t sof_cb;
|
|
/* End of the mandatory fields.*/
|
|
} USBConfig;
|
|
|
|
/**
|
|
* @brief Structure representing an USB driver.
|
|
*/
|
|
struct USBDriver {
|
|
/**
|
|
* @brief Driver state.
|
|
*/
|
|
usbstate_t state;
|
|
/**
|
|
* @brief Current configuration data.
|
|
*/
|
|
const USBConfig *config;
|
|
/**
|
|
* @brief Bit map of the transmitting IN endpoints.
|
|
*/
|
|
uint16_t transmitting;
|
|
/**
|
|
* @brief Bit map of the receiving OUT endpoints.
|
|
*/
|
|
uint16_t receiving;
|
|
/**
|
|
* @brief Active endpoints configurations.
|
|
*/
|
|
const USBEndpointConfig *epc[USB_MAX_ENDPOINTS + 1];
|
|
/**
|
|
* @brief Fields available to user, it can be used to associate an
|
|
* application-defined handler to an IN endpoint.
|
|
* @note The base index is one, the endpoint zero does not have a
|
|
* reserved element in this array.
|
|
*/
|
|
void *in_params[USB_MAX_ENDPOINTS];
|
|
/**
|
|
* @brief Fields available to user, it can be used to associate an
|
|
* application-defined handler to an OUT endpoint.
|
|
* @note The base index is one, the endpoint zero does not have a
|
|
* reserved element in this array.
|
|
*/
|
|
void *out_params[USB_MAX_ENDPOINTS];
|
|
/**
|
|
* @brief Endpoint 0 state.
|
|
*/
|
|
usbep0state_t ep0state;
|
|
/**
|
|
* @brief Next position in the buffer to be transferred through endpoint 0.
|
|
*/
|
|
uint8_t *ep0next;
|
|
/**
|
|
* @brief Number of bytes yet to be transferred through endpoint 0.
|
|
*/
|
|
size_t ep0n;
|
|
/**
|
|
* @brief Endpoint 0 end transaction callback.
|
|
*/
|
|
usbcallback_t ep0endcb;
|
|
/**
|
|
* @brief Setup packet buffer.
|
|
*/
|
|
uint8_t setup[8];
|
|
/**
|
|
* @brief Current USB device status.
|
|
*/
|
|
uint16_t status;
|
|
/**
|
|
* @brief Assigned USB address.
|
|
*/
|
|
uint8_t address;
|
|
/**
|
|
* @brief Current USB device configuration.
|
|
*/
|
|
uint8_t configuration;
|
|
/**
|
|
* @brief State of the driver when a suspend happened.
|
|
*/
|
|
usbstate_t saved_state;
|
|
#if defined(USB_DRIVER_EXT_FIELDS)
|
|
USB_DRIVER_EXT_FIELDS
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
/**
|
|
* @brief Pointer to the USBFS peripheral associated to this driver.
|
|
*/
|
|
gd32_usbfs_t *otg;
|
|
/**
|
|
* @brief Peripheral-specific parameters.
|
|
*/
|
|
const gd32_usbfs_params_t *otgparams;
|
|
/**
|
|
* @brief Pointer to the next address in the packet memory.
|
|
*/
|
|
uint32_t pmnext;
|
|
};
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Returns the exact size of a receive transaction.
|
|
* @details The received size can be different from the size specified in
|
|
* @p usbStartReceiveI() because the last packet could have a size
|
|
* different from the expected one.
|
|
* @pre The OUT endpoint must have been configured in transaction mode
|
|
* in order to use this function.
|
|
*
|
|
* @param[in] usbp pointer to the @p USBDriver object
|
|
* @param[in] ep endpoint number
|
|
* @return Received data size.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define usb_lld_get_transaction_size(usbp, ep) \
|
|
((usbp)->epc[ep]->out_state->rxcnt)
|
|
|
|
/**
|
|
* @brief Connects the USB device.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define usb_lld_connect_bus(usbp) ((usbp)->otg->GCCFG |= GCCFG_VBUSBCEN)
|
|
|
|
/**
|
|
* @brief Disconnect the USB device.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define usb_lld_disconnect_bus(usbp) ((usbp)->otg->GCCFG &= ~GCCFG_VBUSBCEN)
|
|
|
|
/**
|
|
* @brief Start of host wake-up procedure.
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define usb_lld_wakeup_host(usbp) \
|
|
do { \
|
|
(usbp)->otg->DCTL |= DCTL_RWKUP; \
|
|
osalThreadSleepMilliseconds(GD32_USB_HOST_WAKEUP_DURATION); \
|
|
(usbp)->otg->DCTL &= ~DCTL_RWKUP; \
|
|
} while (false)
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if GD32_USB_USE_USBFS && !defined(__DOXYGEN__)
|
|
extern USBDriver USBD1;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void usb_lld_init(void);
|
|
void usb_lld_start(USBDriver *usbp);
|
|
void usb_lld_stop(USBDriver *usbp);
|
|
void usb_lld_reset(USBDriver *usbp);
|
|
void usb_lld_set_address(USBDriver *usbp);
|
|
void usb_lld_init_endpoint(USBDriver *usbp, usbep_t ep);
|
|
void usb_lld_disable_endpoints(USBDriver *usbp);
|
|
usbepstatus_t usb_lld_get_status_in(USBDriver *usbp, usbep_t ep);
|
|
usbepstatus_t usb_lld_get_status_out(USBDriver *usbp, usbep_t ep);
|
|
void usb_lld_read_setup(USBDriver *usbp, usbep_t ep, uint8_t *buf);
|
|
void usb_lld_start_out(USBDriver *usbp, usbep_t ep);
|
|
void usb_lld_start_in(USBDriver *usbp, usbep_t ep);
|
|
void usb_lld_stall_out(USBDriver *usbp, usbep_t ep);
|
|
void usb_lld_stall_in(USBDriver *usbp, usbep_t ep);
|
|
void usb_lld_clear_out(USBDriver *usbp, usbep_t ep);
|
|
void usb_lld_clear_in(USBDriver *usbp, usbep_t ep);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_USB */
|
|
|
|
#endif /* HAL_USB_LLD_H */
|
|
|
|
/** @} */
|