/* ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010, 2011,2012 Giovanni Di Sirio. This file is part of ChibiOS/RT. ChibiOS/RT 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. ChibiOS/RT 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 . */ /** * @file templates/usb_lld.h * @brief USB Driver subsystem low level driver header template. * * @addtogroup USB * @{ */ #ifndef _USB_LLD_H_ #define _USB_LLD_H_ #if HAL_USE_USB || defined(__DOXYGEN__) #include "stm32_usb.h" /*===========================================================================*/ /* Driver constants. */ /*===========================================================================*/ /** * @brief Maximum endpoint address. */ #define USB_MAX_ENDPOINTS 4 /** * @brief This device requires the address change after the status packet. */ #define USB_SET_ADDRESS_MODE USB_LATE_SET_ADDRESS /*===========================================================================*/ /* Driver pre-compile time settings. */ /*===========================================================================*/ /*===========================================================================*/ /* Derived constants and error checks. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver data structures and types. */ /*===========================================================================*/ /** * @brief Type of an IN endpoint state structure. */ typedef struct { } USBInEndpointState; /** * @brief Type of an OUT endpoint state structure. */ typedef struct { } 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 IN endpoint notification callback. * @details This field must be set to @p NULL if the IN endpoint is not * used. */ usbepcallback_t in_cb; /** * @brief OUT endpoint notification callback. * @details This field must be set to @p NULL if the OUT endpoint is not * used. */ 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 structure maintains the state of the IN endpoint when * the endpoint is not in packet mode. Endpoints configured in * packet mode must set this field to @p NULL. */ USBInEndpointState *in_state; /** * @brief @p USBEndpointState associated to the OUT endpoint. * @details This structure maintains the state of the OUT endpoint when * the endpoint is not in packet mode. Endpoints configured in * packet mode must set this field to @p NULL. */ USBOutEndpointState *out_state; /* End of the mandatory fields.*/ } 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 Field available to user, it can be used to associate an * application-defined handler to the USB driver. */ void *param; /** * @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 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; #if defined(USB_DRIVER_EXT_FIELDS) USB_DRIVER_EXT_FIELDS #endif /* End of the mandatory fields.*/ }; /*===========================================================================*/ /* Driver macros. */ /*===========================================================================*/ /** * @brief Fetches a 16 bits word value from an USB message. * * @param[in] p pointer to the 16 bits word * * @notapi */ #define usb_lld_fetch_word(p) (*(uint16_t *)(p)) /** * @brief Returns the current frame number. * * @param[in] usbp pointer to the @p USBDriver object * @return The current frame number. * * @notapi */ #define usb_lld_get_frame_number(usbp) /** * @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) /** * @brief Returns the exact size of a received packet. * @pre The OUT endpoint must have been configured in packet 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_packet_size(usbp, ep) /*===========================================================================*/ /* External declarations. */ /*===========================================================================*/ #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); size_t usb_lld_read_packet(USBDriver *usbp, usbep_t ep, uint8_t *buf, size_t n); void usb_lld_write_packet(USBDriver *usbp, usbep_t ep, const uint8_t *buf, size_t n); void usb_lld_start_out(USBDriver *usbp, usbep_t ep, uint8_t *buf, size_t n); void usb_lld_start_in(USBDriver *usbp, usbep_t ep, const uint8_t *buf, size_t n); void usb_lld_stall_in(USBDriver *usbp, usbep_t ep); void usb_lld_stall_out(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 /* _USB_LLD_H_ */ /** @} */