usb_device.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause */
 
/*
 *  LPCUSB, an USB device driver for LPC microcontrollers
 *  Copyright (C) 2006 Bertrik Sikken (bertrik@sikken.nl)
 *  Copyright (c) 2016 Intel Corporation
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef ZEPHYR_INCLUDE_USB_USB_DEVICE_H_
#define ZEPHYR_INCLUDE_USB_USB_DEVICE_H_
 
#include <zephyr/drivers/usb/usb_dc.h>
#include <zephyr/usb/usb_ch9.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * These macros should be used to place the USB descriptors
 * in predetermined order in the RAM.
 */
#define USBD_DEVICE_DESCR_DEFINE(p) \
        static __in_section(usb, descriptor_##p, 0) __used __aligned(1)
#define USBD_CLASS_DESCR_DEFINE(p, instance) \
        static __in_section(usb, descriptor_##p.1, instance) __used __aligned(1)
#define USBD_MISC_DESCR_DEFINE(p) \
        static __in_section(usb, descriptor_##p, 2) __used __aligned(1)
#define USBD_USER_DESCR_DEFINE(p) \
        static __in_section(usb, descriptor_##p, 3) __used __aligned(1)
#define USBD_STRING_DESCR_DEFINE(p) \
        static __in_section(usb, descriptor_##p, 4) __used __aligned(1)
#define USBD_STRING_DESCR_USER_DEFINE(p) \
        static __in_section(usb, descriptor_##p, 5) __used __aligned(1)
#define USBD_TERM_DESCR_DEFINE(p) \
        static __in_section(usb, descriptor_##p, 6) __used __aligned(1)
 
/*
 * This macro should be used to place the struct usb_cfg_data
 * inside usb data section in the RAM.
 */
#define USBD_DEFINE_CFG_DATA(name) \
        static STRUCT_SECTION_ITERABLE(usb_cfg_data, name)
 
#define USBD_CFG_DATA_DEFINE(p, name) __DEPRECATED_MACRO \
        static __in_section(_usb_cfg_data, static, p##_name) __used __aligned(4)
 
/*************************************************************************
 *  USB configuration
 **************************************************************************/
 
#define USB_MAX_CTRL_MPS        64   
#define USB_MAX_FS_BULK_MPS     64   
#define USB_MAX_FS_INT_MPS      64   
#define USB_MAX_FS_ISO_MPS      1023 
/*************************************************************************
 *  USB application interface
 **************************************************************************/
 
typedef void (*usb_ep_callback)(uint8_t ep,
                                enum usb_dc_ep_cb_status_code cb_status);
 
typedef int (*usb_request_handler)(struct usb_setup_packet *setup,
                                   int32_t *transfer_len, uint8_t **payload_data);
 
typedef void (*usb_interface_config)(struct usb_desc_header *head,
                                     uint8_t bInterfaceNumber);
 
struct usb_ep_cfg_data {
        usb_ep_callback ep_cb;
        uint8_t ep_addr;
};
 
struct usb_interface_cfg_data {
        usb_request_handler class_handler;
        usb_request_handler vendor_handler;
        usb_request_handler custom_handler;
};
 
struct usb_cfg_data {
        const uint8_t *usb_device_description;
        void *interface_descriptor;
        usb_interface_config interface_config;
        void (*cb_usb_status)(struct usb_cfg_data *cfg,
                              enum usb_dc_status_code cb_status,
                              const uint8_t *param);
        struct usb_interface_cfg_data interface;
        uint8_t num_endpoints;
        struct usb_ep_cfg_data *endpoint;
};
 
int usb_set_config(const uint8_t *usb_descriptor);
 
int usb_deconfig(void);
 
int usb_enable(usb_dc_status_callback status_cb);
 
int usb_disable(void);
 
int usb_write(uint8_t ep, const uint8_t *data, uint32_t data_len, uint32_t *bytes_ret);
 
int usb_read(uint8_t ep, uint8_t *data, uint32_t max_data_len, uint32_t *ret_bytes);
 
int usb_ep_set_stall(uint8_t ep);
 
int usb_ep_clear_stall(uint8_t ep);
 
int usb_ep_read_wait(uint8_t ep, uint8_t *data, uint32_t max_data_len,
                     uint32_t *read_bytes);
 
 
int usb_ep_read_continue(uint8_t ep);
 
typedef void (*usb_transfer_callback)(uint8_t ep, int tsize, void *priv);
 
/* USB transfer flags */
#define USB_TRANS_READ       BIT(0)   
#define USB_TRANS_WRITE      BIT(1)   
#define USB_TRANS_NO_ZLP     BIT(2)   
void usb_transfer_ep_callback(uint8_t ep, enum usb_dc_ep_cb_status_code);
 
int usb_transfer(uint8_t ep, uint8_t *data, size_t dlen, unsigned int flags,
                 usb_transfer_callback cb, void *priv);
 
int usb_transfer_sync(uint8_t ep, uint8_t *data, size_t dlen, unsigned int flags);
 
void usb_cancel_transfer(uint8_t ep);
 
void usb_cancel_transfers(void);
 
bool usb_transfer_is_busy(uint8_t ep);
 
int usb_wakeup_request(void);
 
bool usb_get_remote_wakeup_status(void);
 
#define USB_DEVICE_BOS_DESC_DEFINE_CAP \
        static __in_section(usb, bos_desc_area, 1) __aligned(1) __used
 
void usb_bos_register_cap(void *hdr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_USB_USB_DEVICE_H_ */