mirror of
https://github.com/espressif/esp-idf.git
synced 2025-11-04 06:11:06 +00:00
f7b31defc9
- updated doxygen for the whole usb_host stack
- doxygen for test_apps is not updated
- fixed error codes propagation problems in the usb_host stack
99 lines
2.8 KiB
C
99 lines
2.8 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stddef.h>
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <sys/queue.h>
|
|
#include "usb/usb_types_ch9.h"
|
|
#include "usb/usb_types_stack.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
// ------------------------------------------------------ Types --------------------------------------------------------
|
|
|
|
typedef struct {
|
|
uint8_t *data_buffer;
|
|
size_t data_buffer_size;
|
|
int num_bytes;
|
|
int actual_num_bytes;
|
|
uint32_t flags;
|
|
usb_device_handle_t device_handle;
|
|
uint8_t bEndpointAddress;
|
|
usb_transfer_status_t status;
|
|
uint32_t timeout;
|
|
usb_transfer_cb_t callback;
|
|
void *context;
|
|
int num_isoc_packets;
|
|
usb_isoc_packet_desc_t isoc_packet_desc[0];
|
|
} usb_transfer_dummy_t;
|
|
_Static_assert(sizeof(usb_transfer_dummy_t) == sizeof(usb_transfer_t), "usb_transfer_dummy_t does not match usb_transfer_t");
|
|
|
|
struct urb_s {
|
|
TAILQ_ENTRY(urb_s) tailq_entry;
|
|
// HCD Layer: Handler pointer and variables. Must be initialized to NULL and 0 respectively
|
|
void *hcd_ptr;
|
|
uint32_t hcd_var;
|
|
// Host Lib Layer:
|
|
void *usb_host_client; // Currently only used when submitted to shared pipes (i.e., Device default pipes)
|
|
bool usb_host_inflight; // Debugging variable, used to prevent re-submitting URBs already inflight
|
|
// Public transfer structure. Must be last due to variable length array
|
|
usb_transfer_t transfer;
|
|
};
|
|
typedef struct urb_s urb_t;
|
|
|
|
/**
|
|
* @brief Processing request source
|
|
*
|
|
* Enum to indicate which layer of the USB Host stack requires processing. The main handling loop should then call that
|
|
* layer's processing function (i.e., xxx_process()).
|
|
*/
|
|
typedef enum {
|
|
USB_PROC_REQ_SOURCE_USBH = 0x01,
|
|
USB_PROC_REQ_SOURCE_HUB = 0x02,
|
|
USB_PROC_REQ_SOURCE_ENUM = 0x03
|
|
} usb_proc_req_source_t;
|
|
|
|
/**
|
|
* @brief Processing request callback
|
|
*
|
|
* Callback function provided to each layer of the USB Host stack so that each layer can request calls to their
|
|
* processing function.
|
|
*/
|
|
typedef bool (*usb_proc_req_cb_t)(usb_proc_req_source_t source, bool in_isr, void *context);
|
|
|
|
// --------------------------------------------------- Allocation ------------------------------------------------------
|
|
|
|
/**
|
|
* @brief Allocate a URB
|
|
*
|
|
* - Data buffer is allocated in DMA capable memory
|
|
* - The constant fields of the URB are also set
|
|
* - The data_buffer field of the URB is set to point to start of the allocated data buffer.
|
|
*
|
|
* @param[in] data_buffer_size Size of the URB's data buffer
|
|
* @param[in] num_isoc_packets Number of isochronous packet descriptors
|
|
*
|
|
* @return
|
|
* - urb_t* URB object
|
|
*/
|
|
urb_t *urb_alloc(size_t data_buffer_size, int num_isoc_packets);
|
|
|
|
/**
|
|
* @brief Free a URB
|
|
*
|
|
* @param[in] urb URB object
|
|
*/
|
|
void urb_free(urb_t *urb);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|