1#include "esp_usb_dev.hpp"
3#if SOC_USB_OTG_SUPPORTED && defined(CONFIG_IDF_TARGET_ESP32S3) && \
4 CONFIG_IDF_TARGET_ESP32S3
9#include "esp32s3/rom/usb/cdc_acm.h"
10#include "esp32s3/rom/usb/usb_dc.h"
11#include "esp32s3/rom/usb/usb_device.h"
14#include "esp_private/usb_phy.h"
16#include "esp_usb_ep.hpp"
17#include "soc/interrupts.h"
24ESP32USBDevice::ESP32USBDevice(
25 const std::initializer_list<EPConfig> ep_cfgs,
28 const std::initializer_list<const USB::DescriptorStrings::LanguagePack*> lang_list,
29 const std::initializer_list<
const std::initializer_list<USB::ConfigDescriptorItem*>>
32 : USB::EndpointPool(ep_cfgs.size() * 2U),
33 USB::DeviceCore(*this, USB::USBSpec::USB_2_1, USB::Speed::
FULL, packet_size, vid,
34 pid, bcd, lang_list, configs, uid)
36 ASSERT(ep_cfgs.size() > 0U && ep_cfgs.size() <= ENDPOINT_COUNT);
38 auto cfg_it = ep_cfgs.begin();
40 auto* ep0_out =
new ESP32USBEndpoint(*
this, USB::Endpoint::EPNumber::EP0,
41 USB::Endpoint::Direction::OUT, cfg_it->buffer);
42 auto* ep0_in =
new ESP32USBEndpoint(*
this, USB::Endpoint::EPNumber::EP0,
43 USB::Endpoint::Direction::IN, cfg_it->buffer);
45 SetEndpoint0(ep0_in, ep0_out);
46 endpoint_map_.in[0] = ep0_in;
47 endpoint_map_.out[0] = ep0_out;
49 auto ep_num = USB::Endpoint::EPNumber::EP1;
50 for (++cfg_it; cfg_it != ep_cfgs.end();
51 ++cfg_it, ep_num = USB::Endpoint::NextEPNumber(ep_num))
53 ASSERT(USB::Endpoint::EPNumberToInt8(ep_num) < ENDPOINT_COUNT);
55 if (cfg_it->direction_hint == EPConfig::DirectionHint::BothDirections)
57 auto* ep_out =
new ESP32USBEndpoint(*
this, ep_num, USB::Endpoint::Direction::OUT,
59 auto* ep_in =
new ESP32USBEndpoint(*
this, ep_num, USB::Endpoint::Direction::IN,
61 endpoint_map_.out[USB::Endpoint::EPNumberToInt8(ep_num)] = ep_out;
62 endpoint_map_.in[USB::Endpoint::EPNumberToInt8(ep_num)] = ep_in;
68 const auto direction = (cfg_it->direction_hint == EPConfig::DirectionHint::InOnly)
69 ? USB::Endpoint::Direction::IN
70 : USB::Endpoint::Direction::OUT;
71 auto* ep =
new ESP32USBEndpoint(*
this, ep_num, direction, cfg_it->buffer);
72 if (direction == USB::Endpoint::Direction::IN)
74 endpoint_map_.in[USB::Endpoint::EPNumberToInt8(ep_num)] = ep;
78 endpoint_map_.out[USB::Endpoint::EPNumberToInt8(ep_num)] = ep;
85void ESP32USBDevice::Init(
bool in_isr)
90 USB::DeviceCore::Init(in_isr);
93void ESP32USBDevice::Deinit(
bool in_isr) { USB::DeviceCore::Deinit(in_isr); }
97ErrorCode ESP32USBDevice::SetAddress(uint8_t address, USB::DeviceCore::Context context)
99 if (context == USB::DeviceCore::Context::SETUP_BEFORE_STATUS)
101 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
102 dev->dcfg_reg.devaddr = address;
104 return ErrorCode::OK;
107void ESP32USBDevice::Start(
bool)
112 if (runtime_.started)
117 EnsureRomUsbCleaned();
118 ASSERT(EnsurePhyReady());
119 ASSERT(EnsureInterruptReady());
124 USB::DeviceCore::Deinit(
false);
125 USB::DeviceCore::Init(
false);
128 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
129 dev->dctl_reg.sftdiscon = 0;
130 dev->gahbcfg_reg.glbllntrmsk = 1;
131 if (runtime_.intr_handle !=
nullptr)
133 esp_intr_enable(runtime_.intr_handle);
135 runtime_.started =
true;
138void ESP32USBDevice::Stop(
bool)
142 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
143 dev->gahbcfg_reg.glbllntrmsk = 0;
144 dev->gintmsk_reg.val = 0;
145 if (runtime_.intr_handle !=
nullptr)
147 esp_intr_disable(runtime_.intr_handle);
149 dev->dctl_reg.sftdiscon = 1;
150 runtime_.started =
false;
153void IRAM_ATTR ESP32USBDevice::IsrEntry(
void* arg)
155 auto* self =
static_cast<ESP32USBDevice*
>(arg);
158 self->HandleInterrupt();
162bool ESP32USBDevice::EnsurePhyReady()
166 if (runtime_.phy_ready)
171 usb_phy_config_t phy_conf = {
172 .controller = USB_PHY_CTRL_OTG,
173 .target = USB_PHY_TARGET_INT,
174 .otg_mode = USB_OTG_MODE_DEVICE,
175 .otg_speed = USB_PHY_SPEED_UNDEFINED,
176 .ext_io_conf =
nullptr,
177 .otg_io_conf =
nullptr,
180 usb_phy_handle_t handle =
nullptr;
181 if (usb_new_phy(&phy_conf, &handle) != ESP_OK)
186 runtime_.phy_handle = handle;
187 runtime_.phy_ready =
true;
191bool ESP32USBDevice::EnsureInterruptReady()
195 if (runtime_.irq_ready)
200 if (esp_intr_alloc(ETS_USB_INTR_SOURCE, ESP_INTR_FLAG_IRAM | ESP_INTR_FLAG_INTRDISABLED,
201 IsrEntry,
this, &runtime_.intr_handle) != ESP_OK)
203 runtime_.intr_handle =
nullptr;
207 runtime_.irq_ready =
true;
211void ESP32USBDevice::EnsureRomUsbCleaned()
215 if (runtime_.rom_usb_cleaned)
221 usb_dw_ctrl_deinit();
222 uart_acm_dev =
nullptr;
223 runtime_.rom_usb_cleaned =
true;
226void ESP32USBDevice::InitializeCore()
231 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
233 dev->gahbcfg_reg.glbllntrmsk = 0;
235 while (!dev->grstctl_reg.ahbidle)
239 dev->gusbcfg_reg.forcehstmode = 0;
240 dev->gusbcfg_reg.forcedevmode = 1;
241 dev->gusbcfg_reg.physel = 1;
242 dev->gusbcfg_reg.usbtrdtim = 5;
243 dev->gusbcfg_reg.toutcal = 7;
244 dev->gusbcfg_reg.srpcap = 0;
245 dev->gusbcfg_reg.hnpcap = 0;
247 dev->grstctl_reg.csftrst = 1;
248 while (dev->grstctl_reg.csftrst)
251 while (!dev->grstctl_reg.ahbidle)
255 dev->pcgcctl_reg.stoppclk = 0;
256 dev->pcgcctl_reg.gatehclk = 0;
257 dev->pcgcctl_reg.pwrclmp = 0;
258 dev->pcgcctl_reg.rstpdwnmodule = 0;
259 dev->gotgctl_reg.avalidoven = 0;
260 dev->gotgctl_reg.bvalidoven = 1;
261 dev->gotgctl_reg.bvalidovval = 1;
263 ClearTxFifoRegisters();
268 dev->gintsts_reg.val = 0xFFFFFFFFU;
269 dev->gotgint_reg.val = 0xFFFFFFFFU;
270 dev->gintmsk_reg.val = 0U;
271 dev->gahbcfg_reg.hbstlen = ESPUSBDetail::DMA_BURST_INCR4;
272 dev->gahbcfg_reg.dmaen = DmaEnabled() ? 1U : 0U;
273 dev->gahbcfg_reg.nptxfemplvl = 1;
274 dev->gahbcfg_reg.ptxfemplvl = 1;
275 dev->dcfg_reg.descdma = 0;
276 dev->dcfg_reg.nzstsouthshk = 1;
277 dev->gintmsk_reg.usbrstmsk = 1;
278 dev->gintmsk_reg.enumdonemsk = 1;
279 dev->gintmsk_reg.usbsuspmsk = 1;
280 dev->gintmsk_reg.wkupintmsk = 1;
281 dev->gintmsk_reg.rxflvlmsk = DmaEnabled() ? 0U : 1U;
282 dev->gintmsk_reg.oepintmsk = 1;
283 dev->gintmsk_reg.iepintmsk = 1;
284 dev->gintmsk_reg.otgintmsk = 1;
287void ESP32USBDevice::ClearTxFifoRegisters()
291 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
292 dev->gnptxfsiz_reg.val = 0U;
293 const size_t tx_fifo_reg_count =
294 sizeof(dev->dieptxf_regs) /
sizeof(dev->dieptxf_regs[0]);
295 for (
size_t i = 0U; i < tx_fifo_reg_count; ++i)
297 dev->dieptxf_regs[i].val = 0U;
301void ESP32USBDevice::FlushFifos()
305 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
306 dev->grstctl_reg.txfnum = ESPUSBDetail::FLUSH_ALL_TX_FIFO;
307 dev->grstctl_reg.txfflsh = 1;
308 while (dev->grstctl_reg.txfflsh)
311 dev->grstctl_reg.rxfflsh = 1;
312 while (dev->grstctl_reg.rxfflsh)
317void ESP32USBDevice::ResetFifoState()
322 fifo_state_.depth_words = ESPUSBDetail::GetHardwareFifoDepthWords();
323 ASSERT(fifo_state_.depth_words > 0U);
324 fifo_state_.rx_words =
325 ESPUSBDetail::CalcConfiguredRxFifoWords(64U, ENDPOINT_COUNT, DmaEnabled());
326 fifo_state_.tx_next_words = fifo_state_.rx_words;
327 std::memset(fifo_state_.tx_words, 0,
sizeof(fifo_state_.tx_words));
328 std::memset(fifo_state_.tx_bound, 0,
sizeof(fifo_state_.tx_bound));
329 fifo_state_.allocated_in = 0U;
332void ESP32USBDevice::ResetDeviceState()
340 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
341 dev->grxfsiz_reg.rxfdep = fifo_state_.rx_words;
342 ClearTxFifoRegisters();
345void ESP32USBDevice::ResetEndpointHardwareState()
349 for (uint8_t i = 0; i < ENDPOINT_COUNT; ++i)
351 if (endpoint_map_.in[i] !=
nullptr)
353 static_cast<ESP32USBEndpoint*
>(endpoint_map_.in[i])->ResetHardwareState();
355 if (endpoint_map_.out[i] !=
nullptr)
357 static_cast<ESP32USBEndpoint*
>(endpoint_map_.out[i])->ResetHardwareState();
362void ESP32USBDevice::ReloadSetupPacketCount()
366 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
367 dev->doeptsiz0_reg.val = 0U;
370 dev->doeptsiz0_reg.xfersize = 3U * SETUP_PACKET_BYTES;
371 dev->doeptsiz0_reg.pktcnt = 1U;
372 dev->doeptsiz0_reg.supcnt = 3U;
374 ESPUSBDetail::CacheSyncDmaBuffer(setup_packet_, SETUP_DMA_BUFFER_BYTES,
false));
375 dev->doepdma0_reg.dmaaddr =
376 static_cast<uint32_t
>(
reinterpret_cast<uintptr_t
>(setup_packet_));
377 dev->doepctl0_reg.cnak = 1;
378 dev->doepctl0_reg.epena = 1;
379 if (endpoint_map_.out[0] !=
nullptr)
381 static_cast<ESP32USBEndpoint*
>(endpoint_map_.out[0])->ep0_out_phase_ =
382 ESP32USBEndpoint::Ep0OutPhase::SETUP;
387 dev->doeptsiz0_reg.pktcnt = 1U;
388 dev->doeptsiz0_reg.xfersize = 3U * SETUP_PACKET_BYTES;
389 dev->doeptsiz0_reg.supcnt = 3U;
393void ESP32USBDevice::ResetControlState() { control_ = {}; }
397void ESP32USBDevice::UpdateSetupState(
const uint8_t* setup)
399 control_.setup_direction_out = (setup !=
nullptr) && ((setup[0] & 0x80U) == 0U);
402void IRAM_ATTR ESP32USBDevice::HandleInterrupt()
406 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
407 for (uint32_t guard = 0; guard < INTERRUPT_DISPATCH_GUARD; ++guard)
409 usb_dwc_gintsts_reg_t pending = {};
410 pending.val = dev->gintsts_reg.val & dev->gintmsk_reg.val;
412 if (pending.val == 0U)
419 dev->gintsts_reg.usbrst = 1;
420 HandleBusReset(
true);
423 if (pending.enumdone)
425 dev->gintsts_reg.enumdone = 1;
426 const uint32_t enum_speed = dev->dsts_reg.enumspd;
427 if (enum_speed != ESPUSBDetail::ENUM_SPEED_FULL_30_TO_60_MHZ &&
428 enum_speed != ESPUSBDetail::ENUM_SPEED_FULL_48_MHZ)
436 dev->gintsts_reg.usbsusp = 1;
441 dev->gintsts_reg.wkupint = 1;
444 if (!DmaEnabled() && pending.rxflvl)
446 dev->gintmsk_reg.rxflvlmsk = 0;
447 while (dev->gintsts_reg.rxflvl)
451 dev->gintmsk_reg.rxflvlmsk = 1;
456 HandleEndpointInterrupt(
true,
false);
461 HandleEndpointInterrupt(
true,
true);
466 const uint32_t otg_status = dev->gotgint_reg.val;
467 dev->gotgint_reg.val = otg_status;
472void ESP32USBDevice::HandleBusReset(
bool in_isr)
477 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
479 for (uint8_t i = 0; i < ENDPOINT_COUNT; ++i)
483 ESPUSBDetail::DisableOutEndpointAndWait(dev->doepctl0_reg);
487 ESPUSBDetail::DisableOutEndpointAndWait(dev->out_eps[i - 1U].doepctl_reg);
491 for (uint8_t i = 0; i < ENDPOINT_COUNT; ++i)
495 if (dev->diepctl0_reg.epena)
497 dev->diepctl0_reg.snak = 1;
498 dev->diepctl0_reg.epdis = 1;
501 else if (dev->in_eps[i - 1U].diepctl_reg.epena)
503 dev->in_eps[i - 1U].diepctl_reg.snak = 1;
504 dev->in_eps[i - 1U].diepctl_reg.epdis = 1;
508 dev->daintmsk_reg.val = 0U;
509 dev->doepmsk_reg.val = 0U;
510 dev->diepmsk_reg.val = 0U;
511 dev->diepempmsk_reg.val = 0U;
512 dev->doepmsk_reg.setupmsk = 1;
513 dev->doepmsk_reg.xfercomplmsk = 1;
514 dev->doepmsk_reg.epdisbldmsk = 1;
515 dev->doepmsk_reg.ahberrmsk = 1;
516 dev->doepmsk_reg.outtknepdismsk = 1;
517 dev->doepmsk_reg.stsphsercvdmsk = 1;
518 dev->doepmsk_reg.outpkterrmsk = 1;
519 dev->doepmsk_reg.bnaoutintrmsk = 1;
520 dev->doepmsk_reg.bbleerrmsk = 1;
521 dev->doepmsk_reg.nakmsk = 1;
522 dev->doepmsk_reg.nyetmsk = 1;
523 dev->diepmsk_reg.xfercomplmsk = 1;
524 dev->diepmsk_reg.timeoutmsk = 1;
528 ResetEndpointHardwareState();
530 dev->dcfg_reg.devaddr = 0U;
538 ReloadSetupPacketCount();
541void ESP32USBDevice::HandleEndpointInterrupt(
bool in_isr,
bool in_dir)
546 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
547 const uint32_t daint = dev->daint_reg.val & dev->daintmsk_reg.val;
548 const uint32_t bits = in_dir ? (daint & 0xFFFFU) : ((daint >> 16U) & 0xFFFFU);
550 for (uint8_t ep_num = 0; ep_num < ENDPOINT_COUNT; ++ep_num)
552 if ((bits & (1UL << ep_num)) == 0U)
557 USB::Endpoint* ep = in_dir ? endpoint_map_.in[ep_num] : endpoint_map_.out[ep_num];
563 auto* esp_ep =
static_cast<ESP32USBEndpoint*
>(ep);
566 esp_ep->HandleInInterrupt(in_isr);
570 esp_ep->HandleOutInterrupt(in_isr);
575void ESP32USBDevice::HandleRxFifoLevel()
580 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
581 usb_dwc_grxstsp_reg_t status = {};
582 status.val = dev->grxstsp_reg.val;
583 const uint8_t ep_num =
static_cast<uint8_t
>(status.chnum);
587 if ((ep_num < ENDPOINT_COUNT) && (endpoint_map_.out[ep_num] !=
nullptr))
589 static_cast<ESP32USBEndpoint*
>(endpoint_map_.out[ep_num])
590 ->ObserveDmaRxStatus(status.pktsts, status.bcnt);
595 switch (status.pktsts)
597 case ESPUSBDetail::RX_STATUS_GLOBAL_OUT_NAK:
600 case ESPUSBDetail::RX_STATUS_SETUP_DATA:
601 ESPUSBDetail::ReadFifoPacket(ESPUSBDetail::GetEndpointFifo(dev, 0), setup_packet_,
602 sizeof(setup_packet_));
603 UpdateSetupState(setup_packet_);
606 case ESPUSBDetail::RX_STATUS_SETUP_DONE:
607 ReloadSetupPacketCount();
610 case ESPUSBDetail::RX_STATUS_DATA:
612 USB::Endpoint* ep = (ep_num < ENDPOINT_COUNT) ? endpoint_map_.out[ep_num] : nullptr;
615 static_cast<ESP32USBEndpoint*
>(ep)->HandleRxData(status.bcnt);
619 uint8_t sink[64] = {};
620 ESPUSBDetail::ReadFifoPacket(ESPUSBDetail::GetEndpointFifo(dev, 0), sink,
626 case ESPUSBDetail::RX_STATUS_TRANSFER_COMPLETE:
632bool ESP32USBDevice::AllocateTxFifo(uint8_t ep_num, uint16_t packet_size,
bool is_bulk,
633 uint16_t& fifo_words)
638 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
639 const uint8_t max_in_ep_num =
640 static_cast<uint8_t
>(
sizeof(dev->dieptxf_regs) /
sizeof(dev->dieptxf_regs[0]));
644 if (ep_num > max_in_ep_num)
649 const uint16_t words = ESPUSBDetail::CalcTxFifoWords(packet_size, DmaEnabled());
650 if (!fifo_state_.tx_bound[ep_num] && (fifo_state_.allocated_in >= IN_ENDPOINT_LIMIT))
655 for (uint8_t index = 0U; index <= ep_num; ++index)
657 const uint16_t requested_words =
658 (index == ep_num) ? words : ESPUSBDetail::ESP32_SX_FS_MIN_TX_FIFO_WORDS;
659 if (fifo_state_.tx_words[index] != 0U)
661 if (fifo_state_.tx_words[index] < requested_words)
668 const uint16_t next_words =
669 static_cast<uint16_t
>(fifo_state_.tx_next_words + requested_words);
670 if (next_words > fifo_state_.depth_words)
675 const uint32_t tx_fifo_reg =
676 ESPUSBDetail::PackTxFifoSizeReg(fifo_state_.tx_next_words, requested_words);
679 dev->gnptxfsiz_reg.val = tx_fifo_reg;
683 dev->dieptxf_regs[index - 1U].val = tx_fifo_reg;
686 fifo_state_.tx_words[index] = requested_words;
687 fifo_state_.tx_next_words = next_words;
690 if (!fifo_state_.tx_bound[ep_num])
692 fifo_state_.tx_bound[ep_num] =
true;
693 fifo_state_.allocated_in++;
699bool ESP32USBDevice::EnsureRxFifo(uint16_t packet_size)
704 auto* dev =
reinterpret_cast<usb_dwc_dev_t*
>(ESPUSBDetail::DWC2_FS_REG_BASE);
705 const uint16_t needed =
706 ESPUSBDetail::CalcConfiguredRxFifoWords(packet_size, ENDPOINT_COUNT, DmaEnabled());
707 if (needed <= fifo_state_.rx_words)
712 if (fifo_state_.tx_next_words != fifo_state_.rx_words)
717 if (needed > fifo_state_.depth_words)
722 fifo_state_.rx_words = needed;
723 fifo_state_.tx_next_words = needed;
724 dev->grxfsiz_reg.rxfdep = fifo_state_.rx_words;
PacketSize0
控制端点0最大包长度枚举 Packet size for endpoint 0 (bMaxPacketSize0)