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"
16ESP32USBEndpoint::ESP32USBEndpoint(ESP32USBDevice& device, EPNumber number,
17 Direction direction, RawData buffer)
18 : USB::Endpoint(number, direction, buffer), device_(device)
22void ESP32USBEndpoint::Configure(
const Config& cfg)
24 ASSERT(cfg.direction == Direction::IN || cfg.direction == Direction::OUT);
26 auto& ep_cfg = GetConfig();
28 ep_cfg.max_packet_size = ESPUSBDetail::ClampPacketSize(cfg.type, cfg.max_packet_size);
29 if (ep_cfg.max_packet_size == 0U)
31 ep_cfg.max_packet_size = (cfg.type == Type::ISOCHRONOUS) ? 1023U : 64U;
34 auto buffer = GetBuffer();
35 if (buffer.size_ < ep_cfg.max_packet_size)
37 ep_cfg.max_packet_size =
static_cast<uint16_t
>(buffer.size_);
40 ASSERT(ep_cfg.max_packet_size > 0U);
42 if (device_.DmaEnabled() && (buffer.size_ > 0U) && !EnsureDmaShadow(buffer.size_))
44 SetState(State::ERROR);
48 if (cfg.direction == Direction::IN)
50 const bool is_bulk = (cfg.type == Type::BULK);
51 if (!fifo_allocated_ &&
52 !device_.AllocateTxFifo(EPNumberToInt8(GetNumber()), ep_cfg.max_packet_size,
53 is_bulk, fifo_words_))
55 SetState(State::ERROR);
58 fifo_allocated_ =
true;
62 if (!device_.EnsureRxFifo(ep_cfg.max_packet_size))
64 SetState(State::ERROR);
69 ActivateHardwareEndpoint();
71 SetState(State::IDLE);
74void ESP32USBEndpoint::Close()
76 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
77 const uint8_t ep_num = EPNumberToInt8(GetNumber());
79 if (GetDirection() == Direction::IN)
83 if (dev->diepctl0_reg.epena)
85 ESPUSBDetail::DisableInEndpointAndWait(dev);
90 dev->diepempmsk_reg.val &= ~(1UL << ep_num);
91 if (dev->in_eps[ep_num - 1U].diepctl_reg.epena)
93 ESPUSBDetail::DisableInEndpointAndWait(dev, ep_num);
96 dev->daintmsk_reg.val &= ~(1UL << ep_num);
102 ESPUSBDetail::DisableOutEndpointAndWait(dev->doepctl0_reg);
106 ESPUSBDetail::DisableOutEndpointAndWait(dev->out_eps[ep_num - 1U].doepctl_reg);
108 dev->daintmsk_reg.val &= ~(1UL << (16U + ep_num));
111 ResetTransferState();
112 SetState(State::DISABLED);
117 const bool is_in = (GetDirection() == Direction::IN);
118 if ((GetState() == State::BUSY) && is_in)
120 return ErrorCode::BUSY;
123 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
124 const uint8_t ep_num = EPNumberToInt8(GetNumber());
130 dev->diepctl0_reg.stall = 1;
134 dev->in_eps[ep_num - 1U].diepctl_reg.stall = 1;
141 dev->doepctl0_reg.stall = 1;
145 dev->out_eps[ep_num - 1U].doepctl_reg.stall = 1;
149 SetState(State::STALLED);
150 return ErrorCode::OK;
155 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
156 const uint8_t ep_num = EPNumberToInt8(GetNumber());
158 if (GetDirection() == Direction::IN)
162 dev->diepctl0_reg.stall = 0;
166 auto& reg = dev->in_eps[ep_num - 1U].diepctl_reg;
175 dev->doepctl0_reg.stall = 0;
179 auto& reg = dev->out_eps[ep_num - 1U].doepctl_reg;
185 SetState(State::IDLE);
186 return ErrorCode::OK;
189ErrorCode ESP32USBEndpoint::Transfer(
size_t size)
191 if (GetState() == State::BUSY)
193 return ErrorCode::BUSY;
196 auto buffer = GetBuffer();
197 if (buffer.size_ < size)
199 return ErrorCode::NO_BUFF;
202 transfer_buffer_ =
static_cast<uint8_t*
>(buffer.addr_);
203 transfer_request_size_ = size;
204 transfer_actual_size_ = 0U;
205 transfer_queued_size_ = 0U;
207 const uint8_t ep_num = EPNumberToInt8(GetNumber());
208 if ((ep_num == 0U) && (GetDirection() == Direction::OUT))
210 ep0_out_phase_ = (size == 0U) ? Ep0OutPhase::STATUS : Ep0OutPhase::DATA;
213 if (UseDoubleBuffer() && GetDirection() == Direction::IN && size > 0U)
218 if (!PrepareTransferBuffer(size))
220 ResetTransferState();
221 return ErrorCode::NO_MEM;
224 SetState(State::BUSY);
225 ProgramTransfer(size);
226 return ErrorCode::OK;
229size_t ESP32USBEndpoint::MaxTransferSize()
const
231 if (GetNumber() == EPNumber::EP0)
233 return MaxPacketSize();
235 return GetBuffer().size_;
238void ESP32USBEndpoint::ResetHardwareState()
240 fifo_allocated_ =
false;
242 ResetTransferState();
243 SetState(State::DISABLED);
246void ESP32USBEndpoint::HandleInInterrupt(
bool in_isr)
248 const uint8_t ep_num = EPNumberToInt8(GetNumber());
249 usb_dwc_diepint_reg_t intr = {};
250 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
254 intr.val = dev->diepint0_reg.val;
255 dev->diepint0_reg.val = intr.val;
259 intr.val = dev->in_eps[ep_num - 1U].diepint_reg.val;
260 dev->in_eps[ep_num - 1U].diepint_reg.val = intr.val;
263 if (!device_.DmaEnabled() && intr.txfemp)
266 if (transfer_queued_size_ >= transfer_request_size_)
268 dev->diepempmsk_reg.val &= ~(1UL << ep_num);
274 const bool rearm_ep0_setup = (ep_num == 0U) && device_.DmaEnabled() &&
275 (transfer_request_size_ == 0U) &&
276 device_.LastSetupDirectionOut();
277 dev->diepempmsk_reg.val &= ~(1UL << ep_num);
278 const size_t actual =
279 device_.DmaEnabled() ? GetCompletedTransferSize() : transfer_request_size_;
280 OnTransferCompleteCallback(in_isr, actual);
283 device_.ReloadSetupPacketCount();
285 if (GetState() != State::BUSY)
287 ResetTransferState();
292void ESP32USBEndpoint::FinishPendingEp0InStatus(
bool in_isr)
294 if (!device_.DmaEnabled() || (device_.endpoint_map_.in[0] ==
nullptr))
299 auto* ep0_in =
static_cast<ESP32USBEndpoint*
>(device_.endpoint_map_.in[0]);
300 if ((ep0_in->GetState() != State::BUSY) || (ep0_in->transfer_request_size_ != 0U))
305 ep0_in->OnTransferCompleteCallback(in_isr, 0U);
306 if (ep0_in->GetState() != State::BUSY)
308 ep0_in->ResetTransferState();
312void ESP32USBEndpoint::HandleOutInterrupt(
bool in_isr)
314 const uint8_t ep_num = EPNumberToInt8(GetNumber());
315 usb_dwc_doepint_reg_t intr = {};
316 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
320 intr.val = dev->doepint0_reg.val;
321 dev->doepint0_reg.val = intr.val;
325 intr.val = dev->out_eps[ep_num - 1U].doepint_reg.val;
326 dev->out_eps[ep_num - 1U].doepint_reg.val = intr.val;
329 const bool ep0_setup_related =
330 (ep_num == 0U) && (intr.setup || intr.stuppktrcvd || intr.back2backsetup);
331 const bool has_active_ep0_transfer =
332 (ep_num == 0U) && (GetState() == State::BUSY) &&
333 ((transfer_buffer_ !=
nullptr) || (transfer_request_size_ > 0U));
335 if (intr.xfercompl &&
336 ((ep_num != 0U) || ((ep0_out_phase_ != Ep0OutPhase::SETUP) && !ep0_setup_related &&
337 has_active_ep0_transfer)))
339 const size_t actual =
340 device_.DmaEnabled() ? GetCompletedTransferSize() : transfer_actual_size_;
341 const auto finish_out_transfer_result = FinishOutTransfer(actual);
342 REQUIRE_FROM_CALLBACK(finish_out_transfer_result, in_isr);
345 FinishPendingEp0InStatus(in_isr);
347 OnTransferCompleteCallback(in_isr, actual);
348 if ((ep_num == 0U) && device_.DmaEnabled() && (transfer_request_size_ == 0U))
350 device_.ReloadSetupPacketCount();
352 if (GetState() != State::BUSY)
354 ResetTransferState();
360 if (device_.DmaEnabled())
362 const auto cache_sync_dma_buffer_result = ESPUSBDetail::CacheSyncDmaBuffer(
363 device_.setup_packet_, ESP32USBDevice::SETUP_DMA_BUFFER_BYTES,
false);
364 REQUIRE_FROM_CALLBACK(cache_sync_dma_buffer_result, in_isr);
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 ESPUSBDetail::ReadFifoPacket(
408 ESPUSBDetail::GetEndpointFifo(
409 reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE), 0),
411 transfer_actual_size_ += copy_size;
419 uint8_t sink[64] = {};
420 size_t remain_drop = drop_size;
421 auto* fifo = ESPUSBDetail::GetEndpointFifo(
422 reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE), 0);
423 while (remain_drop > 0U)
425 const size_t chunk = std::min(remain_drop,
sizeof(sink));
426 ESPUSBDetail::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 != ESPUSBDetail::RX_STATUS_DATA)
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 = ESPUSBDetail::AlignUp(size, ESPUSBDetail::USB_DMA_ALIGNMENT);
468 if ((dma_shadow_buffer_ !=
nullptr) && (dma_shadow_size_ >= need))
473 void* new_buffer = heap_caps_aligned_alloc(ESPUSBDetail::USB_DMA_ALIGNMENT, need,
474 ESPUSBDetail::DMA_MEMORY_CAPS);
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 (ESPUSBDetail::CanUseDirectInDmaBuffer(transfer_buffer_, size))
505 return ESPUSBDetail::CacheSyncDmaBuffer(transfer_hw_buffer_, size,
true,
true);
510 auto buffer = GetBuffer();
511 if (ESPUSBDetail::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 DEV_ASSERT(transfer_buffer_ !=
nullptr);
529 std::memcpy(transfer_hw_buffer_, transfer_buffer_, size);
530 return ESPUSBDetail::CacheSyncDmaBuffer(
531 transfer_hw_buffer_, ESPUSBDetail::AlignUp(size, ESPUSBDetail::USB_DMA_ALIGNMENT),
535 return ESPUSBDetail::CacheSyncDmaBuffer(
536 transfer_hw_buffer_, ESPUSBDetail::AlignUp(size, ESPUSBDetail::USB_DMA_ALIGNMENT),
540bool ESP32USBEndpoint::FinishOutTransfer(
size_t actual_size)
542 transfer_actual_size_ = actual_size;
544 if (!device_.DmaEnabled() || (actual_size == 0U))
549 DEV_ASSERT(transfer_hw_buffer_ !=
nullptr);
551 if (!transfer_uses_shadow_)
553 if (transfer_direct_sync_size_ == 0U)
557 return ESPUSBDetail::CacheSyncDmaBuffer(transfer_hw_buffer_,
558 transfer_direct_sync_size_,
false);
561 DEV_ASSERT(transfer_buffer_ !=
nullptr);
563 if (!ESPUSBDetail::CacheSyncDmaBuffer(
565 ESPUSBDetail::AlignUp(actual_size, ESPUSBDetail::USB_DMA_ALIGNMENT),
false))
570 std::memcpy(transfer_buffer_, transfer_hw_buffer_, actual_size);
574size_t ESP32USBEndpoint::GetRemainingTransferSize()
const
576 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
577 const uint8_t ep_num = EPNumberToInt8(GetNumber());
579 if (GetDirection() == Direction::IN)
583 return dev->dieptsiz0_reg.xfersize;
585 return dev->in_eps[ep_num - 1U].dieptsiz_reg.xfersize;
590 return dev->doeptsiz0_reg.xfersize;
592 return dev->out_eps[ep_num - 1U].doeptsiz_reg.xfersize;
595size_t ESP32USBEndpoint::GetCompletedTransferSize()
const
597 if ((GetDirection() == Direction::OUT) && device_.DmaEnabled() && dma_rx_status_seen_)
599 return dma_rx_status_bytes_;
602 const size_t remaining = GetRemainingTransferSize();
603 return (remaining >= transfer_request_size_) ? 0U
604 : (transfer_request_size_ - remaining);
607void ESP32USBEndpoint::ActivateHardwareEndpoint()
609 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
610 const uint8_t ep_num = EPNumberToInt8(GetNumber());
611 auto& cfg = GetConfig();
613 if (GetDirection() == Direction::IN)
617 usb_dwc_diepctl0_reg_t ctl = {};
618 ctl.mps = ESPUSBDetail::EncodeEp0Mps(cfg.max_packet_size);
620 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
622 dev->diepctl0_reg.val = ctl.val;
626 usb_dwc_diepctl_reg_t ctl = {};
627 ctl.mps = cfg.max_packet_size;
629 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
632 dev->in_eps[ep_num - 1U].diepctl_reg.val = ctl.val;
634 dev->daintmsk_reg.val |= (1UL << ep_num);
640 usb_dwc_doepctl0_reg_t ctl = {};
641 ctl.mps = ESPUSBDetail::EncodeEp0Mps(cfg.max_packet_size);
643 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
644 dev->doepctl0_reg.val = ctl.val;
648 usb_dwc_doepctl_reg_t ctl = {};
649 ctl.mps = cfg.max_packet_size;
651 ctl.eptype =
static_cast<uint32_t
>(cfg.type);
653 dev->out_eps[ep_num - 1U].doepctl_reg.val = ctl.val;
655 dev->daintmsk_reg.val |= (1UL << (16U + ep_num));
659void ESP32USBEndpoint::ProgramTransfer(
size_t size)
661 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
662 const uint8_t ep_num = EPNumberToInt8(GetNumber());
663 const uint16_t pkt_count = ESPUSBDetail::PacketCount(size, MaxPacketSize());
665 if (GetDirection() == Direction::IN)
669 dev->dieptsiz0_reg.xfersize =
static_cast<uint32_t
>(size);
670 dev->dieptsiz0_reg.pktcnt = pkt_count;
671 if (device_.DmaEnabled() && (size > 0U))
673 dev->diepdma0_reg.dmaaddr =
674 static_cast<uint32_t
>(
reinterpret_cast<uintptr_t
>(transfer_hw_buffer_));
676 ESPUSBDetail::StartEndpointTransfer(dev->diepctl0_reg);
680 auto& tsiz = dev->in_eps[ep_num - 1U].dieptsiz_reg;
681 tsiz.xfersize =
static_cast<uint32_t
>(size);
682 tsiz.pktcnt = pkt_count;
684 if (device_.DmaEnabled() && (size > 0U))
686 dev->in_eps[ep_num - 1U].diepdma_reg.dmaddr =
687 static_cast<uint32_t
>(
reinterpret_cast<uintptr_t
>(transfer_hw_buffer_));
689 ESPUSBDetail::StartEndpointTransfer(dev->in_eps[ep_num - 1U].diepctl_reg);
692 if (!device_.DmaEnabled() && (size > 0U))
695 if ((ep_num != 0U) && (transfer_queued_size_ < transfer_request_size_))
697 dev->diepempmsk_reg.val |= (1UL << ep_num);
705 dev->doeptsiz0_reg.val = 0U;
706 dev->doeptsiz0_reg.xfersize =
707 static_cast<uint32_t
>((size == 0U) ? MaxPacketSize() : size);
708 dev->doeptsiz0_reg.pktcnt = pkt_count;
709 if (device_.DmaEnabled() && (size > 0U))
711 dev->doepdma0_reg.dmaaddr =
712 static_cast<uint32_t>(reinterpret_cast<uintptr_t>(transfer_hw_buffer_));
714 ESPUSBDetail::StartEndpointTransfer(dev->doepctl0_reg);
718 auto& tsiz = dev->out_eps[ep_num - 1U].doeptsiz_reg;
719 tsiz.xfersize =
static_cast<uint32_t
>(size);
720 tsiz.pktcnt = pkt_count;
722 if (device_.DmaEnabled() && (size > 0U))
724 dev->out_eps[ep_num - 1U].doepdma_reg.dmaaddr =
725 static_cast<uint32_t
>(
reinterpret_cast<uintptr_t
>(transfer_hw_buffer_));
727 ESPUSBDetail::StartEndpointTransfer(dev->out_eps[ep_num - 1U].doepctl_reg);
732void ESP32USBEndpoint::WriteMoreTxData()
734 if (transfer_buffer_ ==
nullptr || transfer_queued_size_ >= transfer_request_size_)
739 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
740 const uint8_t ep_num = EPNumberToInt8(GetNumber());
741 const volatile uint32_t* fifo = ESPUSBDetail::GetEndpointFifo(dev, ep_num);
743 while (transfer_queued_size_ < transfer_request_size_)
745 uint16_t fifo_words = 0U;
748 fifo_words = dev->dtxfsts0_reg.ineptxfspcavail;
752 fifo_words = dev->in_eps[ep_num - 1U].dtxfsts_reg.ineptxfspcavail;
755 const size_t remaining = transfer_request_size_ - transfer_queued_size_;
756 const size_t packet_size = std::min(remaining,
static_cast<size_t>(MaxPacketSize()));
757 if (packet_size >
static_cast<size_t>(fifo_words) * 4U)
762 ESPUSBDetail::WriteFifoPacket(
const_cast<volatile uint32_t*
>(fifo),
763 transfer_buffer_ + transfer_queued_size_, packet_size);
764 transfer_queued_size_ += packet_size;
LibXR 命名空间 / LibXR namespace.
ErrorCode
定义错误码枚举 / Defines an enumeration for error codes