usb_dc.h

Go to the documentation of this file.

/* usb_dc.h - USB device controller driver interface */
 
/*
 * Copyright (c) 2016 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_USB_USB_DC_H_
#define ZEPHYR_INCLUDE_DRIVERS_USB_USB_DC_H_
 
#include <device.h>
 
#define USB_EP_DIR_MASK         0x80U
#define USB_EP_DIR_IN           0x80U
#define USB_EP_DIR_OUT          0x00U
 
#define USB_EP_GET_IDX(ep) ((ep) & ~USB_EP_DIR_MASK)
#define USB_EP_GET_DIR(ep) ((ep) & USB_EP_DIR_MASK)
#define USB_EP_GET_ADDR(idx, dir) ((idx) | ((dir) & USB_EP_DIR_MASK))
#define USB_EP_DIR_IS_IN(ep) (USB_EP_GET_DIR(ep) == USB_EP_DIR_IN)
#define USB_EP_DIR_IS_OUT(ep) (USB_EP_GET_DIR(ep) == USB_EP_DIR_OUT)
 
#define USB_EP_TRANSFER_TYPE_MASK 0x3U
 
#define USB_EP_SYNCHRONIZATION_TYPE_MASK (0x3 << 2U)
 
enum usb_dc_status_code {
        USB_DC_ERROR,
        USB_DC_RESET,
        USB_DC_CONNECTED,
        USB_DC_CONFIGURED,
        USB_DC_DISCONNECTED,
        USB_DC_SUSPEND,
        USB_DC_RESUME,
        USB_DC_INTERFACE,
        USB_DC_SET_HALT,
        USB_DC_CLEAR_HALT,
        USB_DC_SOF,
        USB_DC_UNKNOWN
};
 
enum usb_dc_ep_cb_status_code {
        USB_DC_EP_SETUP,
        USB_DC_EP_DATA_OUT,
        USB_DC_EP_DATA_IN
};
 
enum usb_dc_ep_transfer_type {
        USB_DC_EP_CONTROL = 0,
        USB_DC_EP_ISOCHRONOUS,
        USB_DC_EP_BULK,
        USB_DC_EP_INTERRUPT
};
 
enum usb_dc_ep_synchronozation_type {
        USB_DC_EP_NO_SYNCHRONIZATION = (0U << 2U),
        USB_DC_EP_ASYNCHRONOUS = (1U << 2U),
        USB_DC_EP_ADAPTIVE = (2U << 2U),
        USB_DC_EP_SYNCHRONOUS = (3U << 2U)
};
 
struct usb_dc_ep_cfg_data {
        uint8_t ep_addr;
        uint16_t ep_mps;
        enum usb_dc_ep_transfer_type ep_type;
};
 
typedef void (*usb_dc_ep_callback)(uint8_t ep,
                                   enum usb_dc_ep_cb_status_code cb_status);
 
typedef void (*usb_dc_status_callback)(enum usb_dc_status_code cb_status,
                                       const uint8_t *param);
 
int usb_dc_attach(void);
 
int usb_dc_detach(void);
 
int usb_dc_reset(void);
 
int usb_dc_set_address(const uint8_t addr);
 
void usb_dc_set_status_callback(const usb_dc_status_callback cb);
 
int usb_dc_ep_check_cap(const struct usb_dc_ep_cfg_data * const cfg);
 
int usb_dc_ep_configure(const struct usb_dc_ep_cfg_data * const cfg);
 
int usb_dc_ep_set_stall(const uint8_t ep);
 
int usb_dc_ep_clear_stall(const uint8_t ep);
 
int usb_dc_ep_is_stalled(const uint8_t ep, uint8_t *const stalled);
 
int usb_dc_ep_halt(const uint8_t ep);
 
int usb_dc_ep_enable(const uint8_t ep);
 
int usb_dc_ep_disable(const uint8_t ep);
 
int usb_dc_ep_flush(const uint8_t ep);
 
int usb_dc_ep_write(const uint8_t ep, const uint8_t *const data,
                    const uint32_t data_len, uint32_t * const ret_bytes);
 
int usb_dc_ep_read(const uint8_t ep, uint8_t *const data,
                   const uint32_t max_data_len, uint32_t *const read_bytes);
 
int usb_dc_ep_set_callback(const uint8_t ep, const usb_dc_ep_callback cb);
 
int usb_dc_ep_read_wait(uint8_t ep, uint8_t *data, uint32_t max_data_len,
                        uint32_t *read_bytes);
 
int usb_dc_ep_read_continue(uint8_t ep);
 
int usb_dc_ep_mps(uint8_t ep);
 
int usb_dc_wakeup_request(void);
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_USB_USB_DC_H_ */