mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-06 07:35:26 +00:00
83b9f69755
Both operands of an operator in the arithmetic conversions performed shall have the same essential type category. Changes are related to converting the integer constants to the unsigned integer constants Signed-off-by: Aastha Grover <aastha.grover@intel.com>
445 lines
13 KiB
C
445 lines
13 KiB
C
/* usb_dc.h - USB device controller driver interface */
|
|
|
|
/*
|
|
* Copyright (c) 2016 Intel Corporation.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @brief USB device controller APIs
|
|
*
|
|
* This file contains the USB device controller APIs. All device controller
|
|
* drivers should implement the APIs described in this file.
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_DRIVERS_USB_USB_DC_H_
|
|
#define ZEPHYR_INCLUDE_DRIVERS_USB_USB_DC_H_
|
|
|
|
#include <device.h>
|
|
|
|
/**
|
|
* USB endpoint direction and number.
|
|
*/
|
|
#define USB_EP_DIR_MASK 0x80U
|
|
#define USB_EP_DIR_IN 0x80U
|
|
#define USB_EP_DIR_OUT 0x00U
|
|
|
|
/** Get endpoint index (number) from endpoint address */
|
|
#define USB_EP_GET_IDX(ep) ((ep) & ~USB_EP_DIR_MASK)
|
|
/** Get direction from endpoint address */
|
|
#define USB_EP_GET_DIR(ep) ((ep) & USB_EP_DIR_MASK)
|
|
/** Get endpoint address from endpoint index and direction */
|
|
#define USB_EP_GET_ADDR(idx, dir) ((idx) | ((dir) & USB_EP_DIR_MASK))
|
|
/** True if the endpoint is an IN endpoint */
|
|
#define USB_EP_DIR_IS_IN(ep) (USB_EP_GET_DIR(ep) == USB_EP_DIR_IN)
|
|
/** True if the endpoint is an OUT endpoint */
|
|
#define USB_EP_DIR_IS_OUT(ep) (USB_EP_GET_DIR(ep) == USB_EP_DIR_OUT)
|
|
|
|
/**
|
|
* USB endpoint Transfer Type mask.
|
|
*/
|
|
#define USB_EP_TRANSFER_TYPE_MASK 0x3U
|
|
|
|
/**
|
|
* USB endpoint Synchronization Type mask.
|
|
*
|
|
* @note Valid only for Isochronous Endpoints
|
|
*/
|
|
#define USB_EP_SYNCHRONIZATION_TYPE_MASK (0x3 << 2U)
|
|
|
|
/**
|
|
* @brief USB Device Controller API
|
|
* @defgroup _usb_device_controller_api USB Device Controller API
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief USB Driver Status Codes
|
|
*
|
|
* Status codes reported by the registered device status callback.
|
|
*/
|
|
enum usb_dc_status_code {
|
|
/** USB error reported by the controller */
|
|
USB_DC_ERROR,
|
|
/** USB reset */
|
|
USB_DC_RESET,
|
|
/** USB connection established, hardware enumeration is completed */
|
|
USB_DC_CONNECTED,
|
|
/** USB configuration done */
|
|
USB_DC_CONFIGURED,
|
|
/** USB connection lost */
|
|
USB_DC_DISCONNECTED,
|
|
/** USB connection suspended by the HOST */
|
|
USB_DC_SUSPEND,
|
|
/** USB connection resumed by the HOST */
|
|
USB_DC_RESUME,
|
|
/** USB interface selected */
|
|
USB_DC_INTERFACE,
|
|
/** Set Feature ENDPOINT_HALT received */
|
|
USB_DC_SET_HALT,
|
|
/** Clear Feature ENDPOINT_HALT received */
|
|
USB_DC_CLEAR_HALT,
|
|
/** Start of Frame received */
|
|
USB_DC_SOF,
|
|
/** Initial USB connection status */
|
|
USB_DC_UNKNOWN
|
|
};
|
|
|
|
/**
|
|
* @brief USB Endpoint Callback Status Codes
|
|
*
|
|
* Status Codes reported by the registered endpoint callback.
|
|
*/
|
|
enum usb_dc_ep_cb_status_code {
|
|
/** SETUP received */
|
|
USB_DC_EP_SETUP,
|
|
/** Out transaction on this EP, data is available for read */
|
|
USB_DC_EP_DATA_OUT,
|
|
/** In transaction done on this EP */
|
|
USB_DC_EP_DATA_IN
|
|
};
|
|
|
|
/**
|
|
* @brief USB Endpoint Transfer Type
|
|
*/
|
|
enum usb_dc_ep_transfer_type {
|
|
/** Control type endpoint */
|
|
USB_DC_EP_CONTROL = 0,
|
|
/** Isochronous type endpoint */
|
|
USB_DC_EP_ISOCHRONOUS,
|
|
/** Bulk type endpoint */
|
|
USB_DC_EP_BULK,
|
|
/** Interrupt type endpoint */
|
|
USB_DC_EP_INTERRUPT
|
|
};
|
|
|
|
/**
|
|
* @brief USB Endpoint Synchronization Type
|
|
*
|
|
* @note Valid only for Isochronous Endpoints
|
|
*/
|
|
enum usb_dc_ep_synchronozation_type {
|
|
/** No Synchronization */
|
|
USB_DC_EP_NO_SYNCHRONIZATION = (0U << 2U),
|
|
/** Asynchronous */
|
|
USB_DC_EP_ASYNCHRONOUS = (1U << 2U),
|
|
/** Adaptive */
|
|
USB_DC_EP_ADAPTIVE = (2U << 2U),
|
|
/** Synchronous*/
|
|
USB_DC_EP_SYNCHRONOUS = (3U << 2U)
|
|
};
|
|
|
|
/**
|
|
* @brief USB Endpoint Configuration.
|
|
*
|
|
* Structure containing the USB endpoint configuration.
|
|
*/
|
|
struct usb_dc_ep_cfg_data {
|
|
/** The number associated with the EP in the device
|
|
* configuration structure
|
|
* IN EP = 0x80 | \<endpoint number\>
|
|
* OUT EP = 0x00 | \<endpoint number\>
|
|
*/
|
|
uint8_t ep_addr;
|
|
/** Endpoint max packet size */
|
|
uint16_t ep_mps;
|
|
/** Endpoint Transfer Type.
|
|
* May be Bulk, Interrupt, Control or Isochronous
|
|
*/
|
|
enum usb_dc_ep_transfer_type ep_type;
|
|
};
|
|
|
|
/**
|
|
* Callback function signature for the USB Endpoint status
|
|
*/
|
|
typedef void (*usb_dc_ep_callback)(uint8_t ep,
|
|
enum usb_dc_ep_cb_status_code cb_status);
|
|
|
|
/**
|
|
* Callback function signature for the device
|
|
*/
|
|
typedef void (*usb_dc_status_callback)(enum usb_dc_status_code cb_status,
|
|
const uint8_t *param);
|
|
|
|
/**
|
|
* @brief Attach USB for device connection
|
|
*
|
|
* Function to attach USB for device connection. Upon success, the USB PLL
|
|
* is enabled, and the USB device is now capable of transmitting and receiving
|
|
* on the USB bus and of generating interrupts.
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_attach(void);
|
|
|
|
/**
|
|
* @brief Detach the USB device
|
|
*
|
|
* Function to detach the USB device. Upon success, the USB hardware PLL
|
|
* is powered down and USB communication is disabled.
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_detach(void);
|
|
|
|
/**
|
|
* @brief Reset the USB device
|
|
*
|
|
* This function returns the USB device and firmware back to it's initial state.
|
|
* N.B. the USB PLL is handled by the usb_detach function
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_reset(void);
|
|
|
|
/**
|
|
* @brief Set USB device address
|
|
*
|
|
* @param[in] addr Device address
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_set_address(const uint8_t addr);
|
|
|
|
/**
|
|
* @brief Set USB device controller status callback
|
|
*
|
|
* Function to set USB device controller status callback. The registered
|
|
* callback is used to report changes in the status of the device controller.
|
|
* The status code are described by the usb_dc_status_code enumeration.
|
|
*
|
|
* @param[in] cb Callback function
|
|
*/
|
|
void usb_dc_set_status_callback(const usb_dc_status_callback cb);
|
|
|
|
/**
|
|
* @brief check endpoint capabilities
|
|
*
|
|
* Function to check capabilities of an endpoint. usb_dc_ep_cfg_data structure
|
|
* provides the endpoint configuration parameters: endpoint address,
|
|
* endpoint maximum packet size and endpoint type.
|
|
* The driver should check endpoint capabilities and return 0 if the
|
|
* endpoint configuration is possible.
|
|
*
|
|
* @param[in] cfg Endpoint config
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_check_cap(const struct usb_dc_ep_cfg_data * const cfg);
|
|
|
|
/**
|
|
* @brief Configure endpoint
|
|
*
|
|
* Function to configure an endpoint. usb_dc_ep_cfg_data structure provides
|
|
* the endpoint configuration parameters: endpoint address, endpoint maximum
|
|
* packet size and endpoint type.
|
|
*
|
|
* @param[in] cfg Endpoint config
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_configure(const struct usb_dc_ep_cfg_data * const cfg);
|
|
|
|
/**
|
|
* @brief Set stall condition for the selected endpoint
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_set_stall(const uint8_t ep);
|
|
|
|
/**
|
|
* @brief Clear stall condition for the selected endpoint
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_clear_stall(const uint8_t ep);
|
|
|
|
/**
|
|
* @brief Check if the selected endpoint is stalled
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
* @param[out] stalled Endpoint stall status
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_is_stalled(const uint8_t ep, uint8_t *const stalled);
|
|
|
|
/**
|
|
* @brief Halt the selected endpoint
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_halt(const uint8_t ep);
|
|
|
|
/**
|
|
* @brief Enable the selected endpoint
|
|
*
|
|
* Function to enable the selected endpoint. Upon success interrupts are
|
|
* enabled for the corresponding endpoint and the endpoint is ready for
|
|
* transmitting/receiving data.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_enable(const uint8_t ep);
|
|
|
|
/**
|
|
* @brief Disable the selected endpoint
|
|
*
|
|
* Function to disable the selected endpoint. Upon success interrupts are
|
|
* disabled for the corresponding endpoint and the endpoint is no longer able
|
|
* for transmitting/receiving data.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_disable(const uint8_t ep);
|
|
|
|
/**
|
|
* @brief Flush the selected endpoint
|
|
*
|
|
* This function flushes the FIFOs for the selected endpoint.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_flush(const uint8_t ep);
|
|
|
|
/**
|
|
* @brief Write data to the specified endpoint
|
|
*
|
|
* This function is called to write data to the specified endpoint. The
|
|
* supplied usb_ep_callback function will be called when data is transmitted
|
|
* out.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
* @param[in] data Pointer to data to write
|
|
* @param[in] data_len Length of the data requested to write. This may
|
|
* be zero for a zero length status packet.
|
|
* @param[out] ret_bytes Bytes scheduled for transmission. This value
|
|
* may be NULL if the application expects all
|
|
* bytes to be written
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_write(const uint8_t ep, const uint8_t *const data,
|
|
const uint32_t data_len, uint32_t * const ret_bytes);
|
|
|
|
/**
|
|
* @brief Read data from the specified endpoint
|
|
*
|
|
* This function is called by the endpoint handler function, after an OUT
|
|
* interrupt has been received for that EP. The application must only call this
|
|
* function through the supplied usb_ep_callback function. This function clears
|
|
* the ENDPOINT NAK, if all data in the endpoint FIFO has been read,
|
|
* so as to accept more data from host.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
* @param[in] data Pointer to data buffer to write to
|
|
* @param[in] max_data_len Max length of data to read
|
|
* @param[out] read_bytes Number of bytes read. If data is NULL and
|
|
* max_data_len is 0 the number of bytes
|
|
* available for read should be returned.
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_read(const uint8_t ep, uint8_t *const data,
|
|
const uint32_t max_data_len, uint32_t *const read_bytes);
|
|
|
|
/**
|
|
* @brief Set callback function for the specified endpoint
|
|
*
|
|
* Function to set callback function for notification of data received and
|
|
* available to application or transmit done on the selected endpoint,
|
|
* NULL if callback not required by application code. The callback status
|
|
* code is described by usb_dc_ep_cb_status_code.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
* @param[in] cb Callback function
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_set_callback(const uint8_t ep, const usb_dc_ep_callback cb);
|
|
|
|
/**
|
|
* @brief Read data from the specified endpoint
|
|
*
|
|
* This is similar to usb_dc_ep_read, the difference being that, it doesn't
|
|
* clear the endpoint NAKs so that the consumer is not bogged down by further
|
|
* upcalls till he is done with the processing of the data. The caller should
|
|
* reactivate ep by invoking usb_dc_ep_read_continue() do so.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
* @param[in] data Pointer to data buffer to write to
|
|
* @param[in] max_data_len Max length of data to read
|
|
* @param[out] read_bytes Number of bytes read. If data is NULL and
|
|
* max_data_len is 0 the number of bytes
|
|
* available for read should be returned.
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_read_wait(uint8_t ep, uint8_t *data, uint32_t max_data_len,
|
|
uint32_t *read_bytes);
|
|
|
|
/**
|
|
* @brief Continue reading data from the endpoint
|
|
*
|
|
* Clear the endpoint NAK and enable the endpoint to accept more data
|
|
* from the host. Usually called after usb_dc_ep_read_wait() when the consumer
|
|
* is fine to accept more data. Thus these calls together act as a flow control
|
|
* mechanism.
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_ep_read_continue(uint8_t ep);
|
|
|
|
/**
|
|
* @brief Get endpoint max packet size
|
|
*
|
|
* @param[in] ep Endpoint address corresponding to the one
|
|
* listed in the device configuration table
|
|
*
|
|
* @return Enpoint max packet size (mps)
|
|
*/
|
|
int usb_dc_ep_mps(uint8_t ep);
|
|
|
|
/**
|
|
* @brief Start the host wake up procedure.
|
|
*
|
|
* Function to wake up the host if it's currently in sleep mode.
|
|
*
|
|
* @return 0 on success, negative errno code on fail.
|
|
*/
|
|
int usb_dc_wakeup_request(void);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* ZEPHYR_INCLUDE_DRIVERS_USB_USB_DC_H_ */
|