2#if defined(USE_ESP32_VARIANT_ESP32P4) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
18static optional<CdcEps> get_cdc(
const usb_config_desc_t *config_desc, uint8_t intf_idx) {
19 int conf_offset, ep_offset;
22 eps.bulk_interface_number = 0xFF;
23 eps.interrupt_interface_number = 0xFF;
25 const auto *intf_desc = usb_parse_interface_descriptor(config_desc, intf_idx++, 0, &conf_offset);
27 ESP_LOGE(TAG,
"usb_parse_interface_descriptor failed");
30 ESP_LOGD(TAG,
"intf_desc: bInterfaceClass=%02X, bInterfaceSubClass=%02X, bInterfaceProtocol=%02X, bNumEndpoints=%d",
31 intf_desc->bInterfaceClass, intf_desc->bInterfaceSubClass, intf_desc->bInterfaceProtocol,
32 intf_desc->bNumEndpoints);
33 for (uint8_t i = 0; i != intf_desc->bNumEndpoints; i++) {
34 ep_offset = conf_offset;
35 const auto *ep = usb_parse_endpoint_descriptor_by_index(intf_desc, i, config_desc->wTotalLength, &ep_offset);
37 ESP_LOGE(TAG,
"Ran out of interfaces at %d before finding all endpoints", i);
40 ESP_LOGD(TAG,
"ep: bEndpointAddress=%02X, bmAttributes=%02X", ep->bEndpointAddress, ep->bmAttributes);
41 if (ep->bmAttributes == USB_BM_ATTRIBUTES_XFER_INT) {
43 eps.interrupt_interface_number = intf_desc->bInterfaceNumber;
44 }
else if (ep->bmAttributes == USB_BM_ATTRIBUTES_XFER_BULK && ep->bEndpointAddress & usb_host::USB_DIR_IN &&
45 (eps.bulk_interface_number == 0xFF || eps.bulk_interface_number == intf_desc->bInterfaceNumber)) {
47 eps.bulk_interface_number = intf_desc->bInterfaceNumber;
48 }
else if (ep->bmAttributes == USB_BM_ATTRIBUTES_XFER_BULK && !(ep->bEndpointAddress & usb_host::USB_DIR_IN) &&
49 (eps.bulk_interface_number == 0xFF || eps.bulk_interface_number == intf_desc->bInterfaceNumber)) {
51 eps.bulk_interface_number = intf_desc->bInterfaceNumber;
53 ESP_LOGE(TAG,
"Unexpected endpoint attributes: %02X", ep->bmAttributes);
57 if (eps.in_ep !=
nullptr && eps.out_ep !=
nullptr && eps.notify_ep !=
nullptr)
63 const usb_config_desc_t *config_desc;
64 const usb_device_desc_t *device_desc;
66 std::vector<CdcEps> cdc_devs{};
69 if (usb_host_get_device_descriptor(dev_hdl, &device_desc) != ESP_OK) {
70 ESP_LOGE(TAG,
"get_device_descriptor failed");
73 if (usb_host_get_active_config_descriptor(dev_hdl, &config_desc) != ESP_OK) {
74 ESP_LOGE(TAG,
"get_active_config_descriptor failed");
77 if (device_desc->bDeviceClass == USB_CLASS_COMM || device_desc->bDeviceClass == USB_CLASS_VENDOR_SPEC) {
79 if (
auto eps = get_cdc(config_desc, 0)) {
80 ESP_LOGV(TAG,
"Found CDC-ACM device");
81 cdc_devs.push_back(*eps);
85 if (((device_desc->bDeviceClass == USB_CLASS_MISC) && (device_desc->bDeviceSubClass == USB_SUBCLASS_COMMON) &&
86 (device_desc->bDeviceProtocol == USB_DEVICE_PROTOCOL_IAD)) ||
87 ((device_desc->bDeviceClass == USB_CLASS_PER_INTERFACE) && (device_desc->bDeviceSubClass == USB_SUBCLASS_NULL) &&
88 (device_desc->bDeviceProtocol == USB_PROTOCOL_NULL))) {
90 const auto *this_desc =
reinterpret_cast<const usb_standard_desc_t *
>(config_desc);
92 this_desc = usb_parse_next_descriptor_of_type(this_desc, config_desc->wTotalLength,
93 USB_B_DESCRIPTOR_TYPE_INTERFACE_ASSOCIATION, &desc_offset);
96 const auto *iad_desc =
reinterpret_cast<const usb_iad_desc_t *
>(this_desc);
98 if (iad_desc->bFunctionClass == USB_CLASS_COMM && iad_desc->bFunctionSubClass == USB_CDC_SUBCLASS_ACM) {
99 ESP_LOGV(TAG,
"Found CDC-ACM device in composite device");
100 if (
auto eps = get_cdc(config_desc, iad_desc->bFirstInterface))
101 cdc_devs.push_back(*eps);
118 for (
size_t i = 0; i !=
len; i++) {
131 for (
size_t i = 0; i !=
len; i++) {
139 ESP_LOGD(TAG,
"Channel not initialised - write ignored");
142#ifdef USE_UART_DEBUGGER
144 constexpr size_t BATCH = 16;
146 for (
size_t off = 0; off <
len; off += BATCH) {
147 size_t n = std::min(
len - off, BATCH);
148 memcpy(buf,
">>> ", 4);
156 if (chunk ==
nullptr) {
157 ESP_LOGE(TAG,
"Output pool full - lost %zu bytes",
len);
161 memcpy(chunk->
data, data, chunk_len);
162 chunk->
length =
static_cast<uint8_t
>(chunk_len);
169 this->
parent_->start_output(
this);
180 this->
parent_->start_output(
this);
183 if (!this->
output_queue_.empty() || this->output_started_.load())
197 ESP_LOGV(TAG,
"Channel not initialised - read ignored");
203 ESP_LOGV(TAG,
"underflow: requested %zu but returned %d, bytes",
len,
available);
207 for (
size_t i = 0; i !=
len; i++) {
210 this->
parent_->start_input(
this);
221 auto *channel = chunk->
channel;
223#ifdef USE_UART_DEBUGGER
224 if (channel->debug_) {
226 memcpy(buf,
"<<< ", 4);
228 ESP_LOGD(TAG,
"%s%s", channel->debug_prefix_.c_str(), buf);
241 if (channel->rx_callback_) {
242 channel->rx_callback_();
247 uint16_t dropped = this->
usb_data_queue_.get_and_reset_dropped_count();
249 ESP_LOGW(TAG,
"Dropped %u USB data chunks due to buffer overflow", dropped);
258 USBClient::dump_config();
262 " Baud Rate: %" PRIu32
" baud\n"
266 " Flush Timeout: %" PRIu32
" ms\n"
268 " Dummy receiver: %s",
269 channel->index_, channel->baud_rate_, channel->data_bits_, PARITY_NAMES[channel->parity_],
270 STOP_BITS_NAMES[channel->stop_bits_], channel->flush_timeout_ms_, YESNO(channel->debug_),
271 YESNO(channel->dummy_receiver_));
290 auto started =
false;
291 if (!channel->
input_started_.compare_exchange_strong(started,
true))
296 ESP_LOGV(TAG,
"Transfer result: length: %u; status %X",
status.data_len,
status.error_code);
298 ESP_LOGE(TAG,
"Input transfer failed, status=%s", esp_err_to_name(
status.error_code));
307 if (chunk ==
nullptr) {
329#if defined(USE_SOCKET_SELECT_SUPPORT) && defined(USE_WAKE_LOOP_THREADSAFE)
339 if (!this->
transfer_in(ep->bEndpointAddress, callback, ep->wMaxPacketSize)) {
340 ESP_LOGE(TAG,
"IN transfer submission failed for ep=0x%02X", ep->bEndpointAddress);
353 bool expected =
false;
354 if (!channel->
output_started_.compare_exchange_strong(expected,
true, std::memory_order_acq_rel)) {
359 if (chunk ==
nullptr) {
371 ESP_LOGW(TAG,
"Output transfer failed: status %X",
status.error_code);
373 ESP_LOGV(TAG,
"Output Transfer result: length: %u; status %X",
status.data_len,
status.error_code);
389 ESP_LOGV(TAG,
"Output %u bytes started",
len);
396static void fix_mps(
const usb_ep_desc_t *ep) {
398 auto *ep_mutable =
const_cast<usb_ep_desc_t *
>(ep);
399 if (ep->wMaxPacketSize > 64) {
400 ESP_LOGW(TAG,
"Corrected MPS of EP 0x%02X from %u to 64",
static_cast<uint8_t
>(ep->bEndpointAddress & 0xFF),
402 ep_mutable->wMaxPacketSize = 64;
408 if (cdc_devs.empty()) {
413 ESP_LOGD(TAG,
"Found %zu CDC-ACM devices", cdc_devs.size());
416 if (i == cdc_devs.size()) {
417 ESP_LOGE(TAG,
"No configuration found for channel %d", channel->index_);
421 channel->cdc_dev_ = cdc_devs[i++];
422 fix_mps(channel->cdc_dev_.in_ep);
423 fix_mps(channel->cdc_dev_.out_ep);
424 channel->initialised_.store(
true);
428 if (channel->cdc_dev_.interrupt_interface_number != 0xFF &&
429 channel->cdc_dev_.interrupt_interface_number != channel->cdc_dev_.bulk_interface_number) {
431 channel->cdc_dev_.interrupt_interface_number, 0);
432 if (err_comm != ESP_OK) {
433 ESP_LOGW(TAG,
"Could not claim comm interface %d: %s", channel->cdc_dev_.interrupt_interface_number,
434 esp_err_to_name(err_comm));
435 channel->cdc_dev_.interrupt_interface_number = 0xFF;
437 ESP_LOGD(TAG,
"Claimed comm interface %d", channel->cdc_dev_.interrupt_interface_number);
441 usb_host_interface_claim(this->
handle_, this->
device_handle_, channel->cdc_dev_.bulk_interface_number, 0);
443 ESP_LOGE(TAG,
"usb_host_interface_claim failed: %s, channel=%d, intf=%d", esp_err_to_name(err), channel->index_,
444 channel->cdc_dev_.bulk_interface_number);
456 if (channel->cdc_dev_.in_ep !=
nullptr) {
457 usb_host_endpoint_halt(this->
device_handle_, channel->cdc_dev_.in_ep->bEndpointAddress);
458 usb_host_endpoint_flush(this->
device_handle_, channel->cdc_dev_.in_ep->bEndpointAddress);
460 if (channel->cdc_dev_.out_ep !=
nullptr) {
461 usb_host_endpoint_halt(this->
device_handle_, channel->cdc_dev_.out_ep->bEndpointAddress);
462 usb_host_endpoint_flush(this->
device_handle_, channel->cdc_dev_.out_ep->bEndpointAddress);
464 if (channel->cdc_dev_.notify_ep !=
nullptr) {
465 usb_host_endpoint_halt(this->
device_handle_, channel->cdc_dev_.notify_ep->bEndpointAddress);
466 usb_host_endpoint_flush(this->
device_handle_, channel->cdc_dev_.notify_ep->bEndpointAddress);
468 if (channel->cdc_dev_.interrupt_interface_number != 0xFF &&
469 channel->cdc_dev_.interrupt_interface_number != channel->cdc_dev_.bulk_interface_number) {
470 usb_host_interface_release(this->
handle_, this->
device_handle_, channel->cdc_dev_.interrupt_interface_number);
471 channel->cdc_dev_.interrupt_interface_number = 0xFF;
473 usb_host_interface_release(this->
handle_, this->
device_handle_, channel->cdc_dev_.bulk_interface_number);
475 channel->input_started_.store(
true);
476 channel->output_started_.store(
true);
477 channel->input_buffer_.clear();
481 while ((chunk = channel->output_queue_.pop()) !=
nullptr) {
482 channel->output_pool_.release(chunk);
485 channel->initialised_.store(
false);
487 USBClient::on_disconnected();
491 static constexpr uint8_t CDC_REQUEST_TYPE = usb_host::USB_TYPE_CLASS | usb_host::USB_RECIP_INTERFACE;
492 static constexpr uint8_t CDC_SET_LINE_CODING = 0x20;
493 static constexpr uint8_t CDC_SET_CONTROL_LINE_STATE = 0x22;
494 static constexpr uint16_t CDC_DTR_RTS = 0x0003;
497 if (!channel->initialised_.load())
503 uint32_t baud = channel->baud_rate_;
504 std::vector<uint8_t> line_coding = {
505 static_cast<uint8_t
>(baud & 0xFF),
static_cast<uint8_t
>((baud >> 8) & 0xFF),
506 static_cast<uint8_t
>((baud >> 16) & 0xFF),
static_cast<uint8_t
>((baud >> 24) & 0xFF),
507 static_cast<uint8_t
>(channel->stop_bits_),
508 static_cast<uint8_t
>(channel->parity_),
509 static_cast<uint8_t
>(channel->data_bits_),
511 ESP_LOGD(TAG,
"SET_LINE_CODING: baud=%u stop=%u parity=%u data=%u", (
unsigned) baud, channel->stop_bits_,
512 (
unsigned) channel->parity_, channel->data_bits_);
514 CDC_REQUEST_TYPE, CDC_SET_LINE_CODING, 0, channel->cdc_dev_.interrupt_interface_number,
516 if (!status.success) {
517 ESP_LOGW(TAG,
"SET_LINE_CODING failed: %X", status.error_code);
519 ESP_LOGD(TAG,
"SET_LINE_CODING OK");
524 this->
control_transfer(CDC_REQUEST_TYPE, CDC_SET_CONTROL_LINE_STATE, CDC_DTR_RTS,
526 if (!status.success) {
527 ESP_LOGW(TAG,
"SET_CONTROL_LINE_STATE failed: %X", status.error_code);
529 ESP_LOGD(TAG,
"SET_CONTROL_LINE_STATE (DTR+RTS) OK");
533 this->start_channels();
536void USBUartTypeCdcAcm::start_channels() {
537 for (
auto *channel : this->channels_) {
538 if (!channel->initialised_.load())
540 channel->input_started_.store(
false);
541 channel->output_started_.store(
false);
542 this->start_input(channel);
void wake_loop_threadsafe()
Wake the main event loop from another FreeRTOS task.
void status_set_warning(const char *message=nullptr)
void status_clear_error()
void enable_loop_soon_any_context()
Thread and ISR-safe version of enable_loop() that can be called from any context.
void disable_loop()
Disable this component's loop.
USBUartComponent * parent_
constexpr const char * c_str() const
usb_host_client_handle_t handle_
bool transfer_out(uint8_t ep_address, const transfer_cb_t &callback, const uint8_t *data, uint16_t length)
Performs an output transfer operation.
virtual void disconnect()
bool process_usb_events_()
bool control_transfer(uint8_t type, uint8_t request, uint16_t value, uint16_t index, const transfer_cb_t &callback, const std::vector< uint8_t > &data={})
bool transfer_in(uint8_t ep_address, const transfer_cb_t &callback, uint16_t length)
Performs a transfer input operation.
usb_device_handle_t device_handle_
size_t get_free_space() const
size_t get_available() const
EventPool< UsbOutputChunk, USB_OUTPUT_CHUNK_COUNT - 1 > output_pool_
std::atomic< bool > input_started_
std::atomic< bool > initialised_
LockFreeQueue< UsbOutputChunk, USB_OUTPUT_CHUNK_COUNT > output_queue_
size_t available() override
bool peek_byte(uint8_t *data) override
void write_array(const uint8_t *data, size_t len) override
bool read_array(uint8_t *data, size_t len) override
uint32_t flush_timeout_ms_
uart::FlushResult flush() override
std::atomic< bool > output_started_
std::vector< USBUartChannel * > channels_
LockFreeQueue< UsbDataChunk, USB_DATA_QUEUE_SIZE > usb_data_queue_
void start_output(USBUartChannel *channel)
void dump_config() override
void start_input(USBUartChannel *channel)
EventPool< UsbDataChunk, USB_DATA_QUEUE_SIZE - 1 > chunk_pool_
void on_disconnected() override
void on_connected() override
virtual std::vector< CdcEps > parse_descriptors(usb_device_handle_t dev_hdl)
virtual void enable_channels()
FlushResult
Result of a flush() call.
@ TIMEOUT
Confirmed: timed out before TX completed.
@ SUCCESS
Confirmed: all bytes left the TX FIFO.
char * format_hex_pretty_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length, char separator)
Format byte array as uppercase hex to buffer (base implementation).
constexpr size_t format_hex_pretty_size(size_t byte_count)
Calculate buffer size needed for format_hex_pretty_to with separator: "XX:XX:...:XX\0".
uint32_t IRAM_ATTR HOT millis()
Application App
Global storage of Application pointer - only one Application can exist.
const usb_ep_desc_t * out_ep
const usb_ep_desc_t * in_ep
uint8_t data[MAX_CHUNK_SIZE]
static constexpr size_t MAX_CHUNK_SIZE
uint8_t data[MAX_CHUNK_SIZE]
static constexpr size_t MAX_CHUNK_SIZE