1#include "esp_usb_ep.hpp"
3#if SOC_USB_OTG_SUPPORTED && defined(CONFIG_IDF_TARGET_ESP32S3) && \
4 CONFIG_IDF_TARGET_ESP32S3
9#include "esp_heap_caps.h"
11#include "esp_usb_dev.hpp"
13namespace Detail = LibXR::ESPUSBDetail;
18ESP32USBEndpoint::ESP32USBEndpoint(ESP32USBDevice& device, EPNumber number,
19 Direction direction, RawData buffer)
20 : USB::Endpoint(number, direction, buffer), device_(device)
24void ESP32USBEndpoint::Configure(
const Config& cfg)
26 ASSERT(cfg.direction == Direction::IN || cfg.direction == Direction::OUT);
28 auto& ep_cfg = GetConfig();
30 ep_cfg.max_packet_size = Detail::ClampPacketSize(cfg.type, cfg.max_packet_size);
31 if (ep_cfg.max_packet_size == 0U)
33 ep_cfg.max_packet_size = (cfg.type == Type::ISOCHRONOUS) ? 1023U : 64U;
36 auto buffer = GetBuffer();
37 if (buffer.size_ < ep_cfg.max_packet_size)
39 ep_cfg.max_packet_size =
static_cast<uint16_t
>(buffer.size_);
42 ASSERT(ep_cfg.max_packet_size > 0U);
44 if (device_.DmaEnabled() && (buffer.size_ > 0U) && !EnsureDmaShadow(buffer.size_))
46 SetState(State::ERROR);
50 if (cfg.direction == Direction::IN)
52 const bool is_bulk = (cfg.type == Type::BULK);
53 if (!fifo_allocated_ &&
54 !device_.AllocateTxFifo(EPNumberToInt8(GetNumber()), ep_cfg.max_packet_size,
55 is_bulk, fifo_words_))
57 SetState(State::ERROR);
60 fifo_allocated_ =
true;
64 if (!device_.EnsureRxFifo(ep_cfg.max_packet_size))
66 SetState(State::ERROR);
71 ActivateHardwareEndpoint();
73 SetState(State::IDLE);
76void ESP32USBEndpoint::Close()
78 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
79 const uint8_t ep_num = EPNumberToInt8(GetNumber());
81 if (GetDirection() == Direction::IN)
85 if (dev->diepctl0_reg.epena)
87 Detail::DisableInEndpointAndWait(dev);
92 dev->diepempmsk_reg.val &= ~(1UL << ep_num);
93 if (dev->in_eps[ep_num - 1U].diepctl_reg.epena)
95 Detail::DisableInEndpointAndWait(dev, ep_num);
98 dev->daintmsk_reg.val &= ~(1UL << ep_num);
104 Detail::DisableOutEndpointAndWait(dev->doepctl0_reg);
108 Detail::DisableOutEndpointAndWait(dev->out_eps[ep_num - 1U].doepctl_reg);
110 dev->daintmsk_reg.val &= ~(1UL << (16U + ep_num));
113 ResetTransferState();
114 SetState(State::DISABLED);
119 const bool is_in = (GetDirection() == Direction::IN);
120 if ((GetState() == State::BUSY) && is_in)
122 return ErrorCode::BUSY;
125 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
126 const uint8_t ep_num = EPNumberToInt8(GetNumber());
132 dev->diepctl0_reg.stall = 1;
136 dev->in_eps[ep_num - 1U].diepctl_reg.stall = 1;
143 dev->doepctl0_reg.stall = 1;
147 dev->out_eps[ep_num - 1U].doepctl_reg.stall = 1;
151 SetState(State::STALLED);
152 return ErrorCode::OK;
157 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
158 const uint8_t ep_num = EPNumberToInt8(GetNumber());
160 if (GetDirection() == Direction::IN)
164 dev->diepctl0_reg.stall = 0;
168 auto& reg = dev->in_eps[ep_num - 1U].diepctl_reg;
177 dev->doepctl0_reg.stall = 0;
181 auto& reg = dev->out_eps[ep_num - 1U].doepctl_reg;
187 SetState(State::IDLE);
188 return ErrorCode::OK;
191ErrorCode ESP32USBEndpoint::Transfer(
size_t size)
193 if (GetState() == State::BUSY)
195 return ErrorCode::BUSY;
198 auto buffer = GetBuffer();
199 if (buffer.size_ < size)
201 return ErrorCode::NO_BUFF;
204 transfer_buffer_ =
static_cast<uint8_t*
>(buffer.addr_);
205 transfer_request_size_ = size;
206 transfer_actual_size_ = 0U;
207 transfer_queued_size_ = 0U;
209 const uint8_t ep_num = EPNumberToInt8(GetNumber());
210 if ((ep_num == 0U) && (GetDirection() == Direction::OUT))
212 ep0_out_phase_ = (size == 0U) ? Ep0OutPhase::STATUS : Ep0OutPhase::DATA;
215 if (UseDoubleBuffer() && GetDirection() == Direction::IN && size > 0U)
220 if (!PrepareTransferBuffer(size))
222 ResetTransferState();
223 return ErrorCode::NO_MEM;
226 SetState(State::BUSY);
227 ProgramTransfer(size);
228 return ErrorCode::OK;
231size_t ESP32USBEndpoint::MaxTransferSize()
const
233 if (GetNumber() == EPNumber::EP0)
235 return MaxPacketSize();
237 return GetBuffer().size_;
240void ESP32USBEndpoint::ResetHardwareState()
242 fifo_allocated_ =
false;
244 ResetTransferState();
245 SetState(State::DISABLED);
248void ESP32USBEndpoint::HandleInInterrupt(
bool in_isr)
250 const uint8_t ep_num = EPNumberToInt8(GetNumber());
251 usb_dwc_diepint_reg_t intr = {};
252 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
256 intr.val = dev->diepint0_reg.val;
257 dev->diepint0_reg.val = intr.val;
261 intr.val = dev->in_eps[ep_num - 1U].diepint_reg.val;
262 dev->in_eps[ep_num - 1U].diepint_reg.val = intr.val;
265 if (!device_.DmaEnabled() && intr.txfemp)
268 if (transfer_queued_size_ >= transfer_request_size_)
270 dev->diepempmsk_reg.val &= ~(1UL << ep_num);
276 const bool rearm_ep0_setup = (ep_num == 0U) && device_.DmaEnabled() &&
277 (transfer_request_size_ == 0U) &&
278 device_.LastSetupDirectionOut();
279 dev->diepempmsk_reg.val &= ~(1UL << ep_num);
280 const size_t actual =
281 device_.DmaEnabled() ? GetCompletedTransferSize() : transfer_request_size_;
282 OnTransferCompleteCallback(in_isr, actual);
285 device_.ReloadSetupPacketCount();
287 if (GetState() != State::BUSY)
289 ResetTransferState();
294void ESP32USBEndpoint::FinishPendingEp0InStatus(
bool in_isr)
296 if (!device_.DmaEnabled() || (device_.endpoint_map_.in[0] ==
nullptr))
301 auto* ep0_in =
static_cast<ESP32USBEndpoint*
>(device_.endpoint_map_.in[0]);
302 if ((ep0_in->GetState() != State::BUSY) || (ep0_in->transfer_request_size_ != 0U))
307 ep0_in->OnTransferCompleteCallback(in_isr, 0U);
308 if (ep0_in->GetState() != State::BUSY)
310 ep0_in->ResetTransferState();
314void ESP32USBEndpoint::HandleOutInterrupt(
bool in_isr)
316 const uint8_t ep_num = EPNumberToInt8(GetNumber());
317 usb_dwc_doepint_reg_t intr = {};
318 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
322 intr.val = dev->doepint0_reg.val;
323 dev->doepint0_reg.val = intr.val;
327 intr.val = dev->out_eps[ep_num - 1U].doepint_reg.val;
328 dev->out_eps[ep_num - 1U].doepint_reg.val = intr.val;
331 const bool ep0_setup_related =
332 (ep_num == 0U) && (intr.setup || intr.stuppktrcvd || intr.back2backsetup);
333 const bool has_active_ep0_transfer =
334 (ep_num == 0U) && (GetState() == State::BUSY) &&
335 ((transfer_buffer_ !=
nullptr) || (transfer_request_size_ > 0U));
337 if (intr.xfercompl &&
338 ((ep_num != 0U) || ((ep0_out_phase_ != Ep0OutPhase::SETUP) && !ep0_setup_related &&
339 has_active_ep0_transfer)))
341 const size_t actual =
342 device_.DmaEnabled() ? GetCompletedTransferSize() : transfer_actual_size_;
343 ASSERT(FinishOutTransfer(actual));
346 FinishPendingEp0InStatus(in_isr);
348 OnTransferCompleteCallback(in_isr, actual);
349 if ((ep_num == 0U) && device_.DmaEnabled() && (transfer_request_size_ == 0U))
351 device_.ReloadSetupPacketCount();
353 if (GetState() != State::BUSY)
355 ResetTransferState();
361 if (device_.DmaEnabled())
363 ASSERT(Detail::CacheSyncDmaBuffer(device_.setup_packet_,
364 ESP32USBDevice::kSetupDmaBufferBytes,
false));
366 device_.UpdateSetupState(device_.setup_packet_);
367 const auto* setup =
reinterpret_cast<const USB::SetupPacket*
>(device_.setup_packet_);
368 const bool expect_out_data_stage =
369 ((setup->bmRequestType & 0x80U) == 0U) && (setup->wLength > 0U);
371 FinishPendingEp0InStatus(in_isr);
372 ep0_out_phase_ = Ep0OutPhase::SETUP;
373 ResetTransferState();
374 SetState(State::IDLE);
376 if (device_.endpoint_map_.in[0] !=
nullptr)
378 auto* ep0_in =
static_cast<ESP32USBEndpoint*
>(device_.endpoint_map_.in[0]);
379 if (ep0_in->GetState() == State::BUSY)
381 ep0_in->ResetTransferState();
382 ep0_in->SetState(State::IDLE);
386 if (device_.DmaEnabled() && !expect_out_data_stage)
388 device_.ReloadSetupPacketCount();
390 device_.OnSetupPacket(in_isr, setup);
394void ESP32USBEndpoint::HandleRxData(
size_t size)
396 uint8_t*
const dst = (transfer_buffer_ !=
nullptr)
397 ? (transfer_buffer_ + transfer_actual_size_)
399 const size_t remain = (transfer_request_size_ > transfer_actual_size_)
400 ? (transfer_request_size_ - transfer_actual_size_)
402 const size_t copy_size = std::min(size, remain);
403 const size_t drop_size = size - copy_size;
407 Detail::ReadFifoPacket(
408 Detail::GetEndpointFifo(
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase),
411 transfer_actual_size_ += copy_size;
419 uint8_t sink[64] = {};
420 size_t remain_drop = drop_size;
421 auto* fifo = Detail::GetEndpointFifo(
422 reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase), 0);
423 while (remain_drop > 0U)
425 const size_t chunk = std::min(remain_drop,
sizeof(sink));
426 Detail::ReadFifoPacket(fifo, sink, chunk);
427 remain_drop -= chunk;
431void ESP32USBEndpoint::ObserveDmaRxStatus(uint8_t pktsts,
size_t size)
433 if (!device_.DmaEnabled() || (GetDirection() != Direction::OUT))
438 if (pktsts != Detail::kRxStatusData)
443 dma_rx_status_seen_ =
true;
444 dma_rx_status_bytes_ = std::min(transfer_request_size_, dma_rx_status_bytes_ + size);
447void ESP32USBEndpoint::ResetTransferState()
449 transfer_buffer_ =
nullptr;
450 transfer_hw_buffer_ =
nullptr;
451 transfer_request_size_ = 0U;
452 transfer_actual_size_ = 0U;
453 transfer_queued_size_ = 0U;
454 transfer_uses_shadow_ =
false;
455 transfer_direct_sync_size_ = 0U;
456 dma_rx_status_bytes_ = 0U;
457 dma_rx_status_seen_ =
false;
460bool ESP32USBEndpoint::EnsureDmaShadow(
size_t size)
462 const size_t need = Detail::AlignUp(size, Detail::kUsbDmaAlignment);
468 if ((dma_shadow_buffer_ !=
nullptr) && (dma_shadow_size_ >= need))
474 heap_caps_aligned_alloc(Detail::kUsbDmaAlignment, need, Detail::kDmaMemoryCaps);
475 if (new_buffer ==
nullptr)
480 if (dma_shadow_buffer_ !=
nullptr)
482 heap_caps_free(dma_shadow_buffer_);
485 dma_shadow_buffer_ =
static_cast<uint8_t*
>(new_buffer);
486 dma_shadow_size_ = need;
490bool ESP32USBEndpoint::PrepareTransferBuffer(
size_t size)
492 transfer_hw_buffer_ = transfer_buffer_;
493 transfer_uses_shadow_ =
false;
494 transfer_direct_sync_size_ = 0U;
496 if (!device_.DmaEnabled() || (size == 0U))
501 if (GetDirection() == Direction::IN)
503 if (Detail::CanUseDirectInDmaBuffer(transfer_buffer_, size))
505 return Detail::CacheSyncDmaBuffer(transfer_hw_buffer_, size,
true,
true);
510 auto buffer = GetBuffer();
511 if (Detail::CanUseDirectOutDmaBuffer(buffer.addr_, buffer.size_))
513 transfer_direct_sync_size_ = buffer.size_;
518 if (!EnsureDmaShadow(size))
523 transfer_hw_buffer_ = dma_shadow_buffer_;
524 transfer_uses_shadow_ =
true;
526 if (GetDirection() == Direction::IN)
528 ASSERT(transfer_buffer_ !=
nullptr);
529 std::memcpy(transfer_hw_buffer_, transfer_buffer_, size);
530 return Detail::CacheSyncDmaBuffer(
531 transfer_hw_buffer_, Detail::AlignUp(size, Detail::kUsbDmaAlignment),
true);
534 return Detail::CacheSyncDmaBuffer(
535 transfer_hw_buffer_, Detail::AlignUp(size, Detail::kUsbDmaAlignment),
false);
538bool ESP32USBEndpoint::FinishOutTransfer(
size_t actual_size)
540 transfer_actual_size_ = actual_size;
542 if (!device_.DmaEnabled() || (actual_size == 0U))
547 ASSERT(transfer_hw_buffer_ !=
nullptr);
549 if (!transfer_uses_shadow_)
551 if (transfer_direct_sync_size_ == 0U)
555 return Detail::CacheSyncDmaBuffer(transfer_hw_buffer_, transfer_direct_sync_size_,
559 ASSERT(transfer_buffer_ !=
nullptr);
561 if (!Detail::CacheSyncDmaBuffer(transfer_hw_buffer_,
562 Detail::AlignUp(actual_size, Detail::kUsbDmaAlignment),
568 std::memcpy(transfer_buffer_, transfer_hw_buffer_, actual_size);
572size_t ESP32USBEndpoint::GetRemainingTransferSize()
const
574 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
575 const uint8_t ep_num = EPNumberToInt8(GetNumber());
577 if (GetDirection() == Direction::IN)
581 return dev->dieptsiz0_reg.xfersize;
583 return dev->in_eps[ep_num - 1U].dieptsiz_reg.xfersize;
588 return dev->doeptsiz0_reg.xfersize;
590 return dev->out_eps[ep_num - 1U].doeptsiz_reg.xfersize;
593size_t ESP32USBEndpoint::GetCompletedTransferSize()
const
595 if ((GetDirection() == Direction::OUT) && device_.DmaEnabled() && dma_rx_status_seen_)
597 return dma_rx_status_bytes_;
600 const size_t remaining = GetRemainingTransferSize();
601 return (remaining >= transfer_request_size_) ? 0U
602 : (transfer_request_size_ - remaining);
605void ESP32USBEndpoint::ActivateHardwareEndpoint()
607 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
608 const uint8_t ep_num = EPNumberToInt8(GetNumber());
609 auto& cfg = GetConfig();
611 if (GetDirection() == Direction::IN)
615 usb_dwc_diepctl0_reg_t ctl = {};
616 ctl.mps = Detail::EncodeEp0Mps(cfg.max_packet_size);
618 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
620 dev->diepctl0_reg.val = ctl.val;
624 usb_dwc_diepctl_reg_t ctl = {};
625 ctl.mps = cfg.max_packet_size;
627 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
630 dev->in_eps[ep_num - 1U].diepctl_reg.val = ctl.val;
632 dev->daintmsk_reg.val |= (1UL << ep_num);
638 usb_dwc_doepctl0_reg_t ctl = {};
639 ctl.mps = Detail::EncodeEp0Mps(cfg.max_packet_size);
641 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
642 dev->doepctl0_reg.val = ctl.val;
646 usb_dwc_doepctl_reg_t ctl = {};
647 ctl.mps = cfg.max_packet_size;
649 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
651 dev->out_eps[ep_num - 1U].doepctl_reg.val = ctl.val;
653 dev->daintmsk_reg.val |= (1UL << (16U + ep_num));
657void ESP32USBEndpoint::ProgramTransfer(
size_t size)
659 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
660 const uint8_t ep_num = EPNumberToInt8(GetNumber());
661 const uint16_t pkt_count = Detail::PacketCount(size, MaxPacketSize());
663 if (GetDirection() == Direction::IN)
667 dev->dieptsiz0_reg.xfersize =
static_cast<uint32_t
>(size);
668 dev->dieptsiz0_reg.pktcnt = pkt_count;
669 if (device_.DmaEnabled() && (size > 0U))
671 dev->diepdma0_reg.dmaaddr =
672 static_cast<uint32_t
>(
reinterpret_cast<uintptr_t
>(transfer_hw_buffer_));
674 Detail::StartEndpointTransfer(dev->diepctl0_reg);
678 auto& tsiz = dev->in_eps[ep_num - 1U].dieptsiz_reg;
679 tsiz.xfersize =
static_cast<uint32_t
>(size);
680 tsiz.pktcnt = pkt_count;
682 if (device_.DmaEnabled() && (size > 0U))
684 dev->in_eps[ep_num - 1U].diepdma_reg.dmaddr =
685 static_cast<uint32_t
>(
reinterpret_cast<uintptr_t
>(transfer_hw_buffer_));
687 Detail::StartEndpointTransfer(dev->in_eps[ep_num - 1U].diepctl_reg);
690 if (!device_.DmaEnabled() && (size > 0U))
693 if ((ep_num != 0U) && (transfer_queued_size_ < transfer_request_size_))
695 dev->diepempmsk_reg.val |= (1UL << ep_num);
703 dev->doeptsiz0_reg.val = 0U;
704 dev->doeptsiz0_reg.xfersize =
705 static_cast<uint32_t
>((size == 0U) ? MaxPacketSize() : size);
706 dev->doeptsiz0_reg.pktcnt = pkt_count;
707 if (device_.DmaEnabled() && (size > 0U))
709 dev->doepdma0_reg.dmaaddr =
710 static_cast<uint32_t>(reinterpret_cast<uintptr_t>(transfer_hw_buffer_));
712 Detail::StartEndpointTransfer(dev->doepctl0_reg);
716 auto& tsiz = dev->out_eps[ep_num - 1U].doeptsiz_reg;
717 tsiz.xfersize =
static_cast<uint32_t
>(size);
718 tsiz.pktcnt = pkt_count;
720 if (device_.DmaEnabled() && (size > 0U))
722 dev->out_eps[ep_num - 1U].doepdma_reg.dmaaddr =
723 static_cast<uint32_t
>(
reinterpret_cast<uintptr_t
>(transfer_hw_buffer_));
725 Detail::StartEndpointTransfer(dev->out_eps[ep_num - 1U].doepctl_reg);
730void ESP32USBEndpoint::WriteMoreTxData()
732 if (transfer_buffer_ ==
nullptr || transfer_queued_size_ >= transfer_request_size_)
737 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(Detail::kDwc2FsRegBase);
738 const uint8_t ep_num = EPNumberToInt8(GetNumber());
739 const volatile uint32_t* fifo = Detail::GetEndpointFifo(dev, ep_num);
741 while (transfer_queued_size_ < transfer_request_size_)
743 uint16_t fifo_words = 0U;
746 fifo_words = dev->dtxfsts0_reg.ineptxfspcavail;
750 fifo_words = dev->in_eps[ep_num - 1U].dtxfsts_reg.ineptxfspcavail;
753 const size_t remaining = transfer_request_size_ - transfer_queued_size_;
754 const size_t packet_size = std::min(remaining,
static_cast<size_t>(MaxPacketSize()));
755 if (packet_size >
static_cast<size_t>(fifo_words) * 4U)
760 Detail::WriteFifoPacket(
const_cast<volatile uint32_t*
>(fifo),
761 transfer_buffer_ + transfer_queued_size_, packet_size);
762 transfer_queued_size_ += packet_size;