LibXR::STM32Endpoint Class Reference

STM32 USB 端点实现 / STM32 USB endpoint implementation. More...

#include <stm32_usb_ep.hpp>

Inheritance diagram for LibXR::STM32Endpoint:

Collaboration diagram for LibXR::STM32Endpoint:

Public Member Functions
void	Configure (const Config &cfg) override
	配置端点协议参数 / Configure endpoint protocol parameters
void	Close () override
	关闭端点 / Close endpoint
ErrorCode	Transfer (size_t size) override
	启动一次传输 / Start a transfer
ErrorCode	Stall () override
	置 STALL / Stall endpoint
ErrorCode	ClearStall () override
	清除 STALL / Clear stall
size_t	MaxTransferSize () const override
	返回当前最大可传输字节数 / Return maximum transferable size at this time
Public Member Functions inherited from LibXR::USB::Endpoint
	Endpoint (EPNumber number, Direction dir, RawData buffer)
	构造函数 / Constructor
virtual	~Endpoint ()=default
	虚析构函数 / Virtual destructor
	Endpoint (const Endpoint &)=delete
Endpoint &	operator= (const Endpoint &)=delete
EPNumber	GetNumber () const
	获取端点号 / Get endpoint number
Direction	AvailableDirection () const
	获取允许配置的方向 / Get allowed endpoint direction
Direction	GetDirection () const
	获取当前端点方向 / Get current endpoint direction
uint8_t	GetAddress () const
	获取端点地址（方向 + 号） / Get endpoint address (dir + num)
State	GetState () const
	获取端点状态 / Get endpoint state
void	SetState (State state)
	设置端点状态 / Set endpoint state
Type	GetType () const
	获取端点类型 / Get endpoint type
uint16_t	MaxPacketSize () const
	获取最大包长 / Get max packet size
bool	IsStalled () const
	是否处于 STALL 状态 / Whether endpoint is stalled
bool	UseDoubleBuffer () const
	是否启用双缓冲 / Whether double buffer is enabled
RawData	GetBuffer () const
	获取当前可用于传输的缓冲区 / Get current transfer buffer
void	SetOnTransferCompleteCallback (Callback< ConstRawData & > cb)
	设置传输完成回调 / Set transfer complete callback
void	SetActiveLength (uint16_t len)
	设置当前活动缓冲区有效长度 / Set active buffer valid length
size_t	GetActiveLength ()
	获取当前活动缓冲区有效长度 / Get active buffer valid length
virtual ErrorCode	TransferMultiBulk (RawData &data)
	Bulk 多包传输辅助接口 / Helper for multi-packet bulk transfer.
virtual ErrorCode	TransferZLP ()
	发送/接收 ZLP（零长度包） / Transfer zero length packet (ZLP)
void	OnTransferCompleteCallback (bool in_isr, size_t actual_transfer_size)
	由底层在传输完成时调用 / Called by low-level driver when transfer completes

Data Fields
PCD_HandleTypeDef *	hpcd_
size_t	last_transfer_size_ = 0
stm32_usb_dev_id_t	id_

Additional Inherited Members
Public Types inherited from LibXR::USB::Endpoint
enum class	Direction : uint8_t { OUT = 0 , IN = 1 , BOTH = 2 }
	端点方向 Endpoint direction More...
enum class	EPNumber : uint8_t {   EP0 = 0 , EP1 = 1 , EP2 = 2 , EP3 = 3 ,   EP4 = 4 , EP5 = 5 , EP6 = 6 , EP7 = 7 ,   EP8 = 8 , EP9 = 9 , EP10 = 10 , EP11 = 11 ,   EP12 = 12 , EP13 = 13 , EP14 = 14 , EP15 = 15 ,   EP_MAX_NUM = 16 , EP_AUTO = 0xFE , EP_INVALID = 0xFF }
	端点号 Endpoint number More...
enum class	Type : uint8_t { CONTROL = 0 , ISOCHRONOUS = 1 , BULK = 2 , INTERRUPT = 3 }
	端点类型 Endpoint type More...
enum class	State : uint8_t {   DISABLED , IDLE , BUSY , STALLED ,   ERROR }
	端点状态 Endpoint state More...
Static Public Member Functions inherited from LibXR::USB::Endpoint
static constexpr uint8_t	EPNumberToInt8 (EPNumber ep)
	端点号转换为 uint8_t / Convert endpoint number to uint8_t
static constexpr uint8_t	EPNumberToAddr (EPNumber ep, Direction dir)
	端点号转换为端点地址 / Convert endpoint number to endpoint address
static constexpr EPNumber	AddrToEPNumber (uint8_t addr, Direction &dir)
	端点地址转换为端点号 / Convert endpoint address to endpoint number
static constexpr EPNumber	NextEPNumber (EPNumber ep)
	获取下一个端点号 / Get the next endpoint number
Protected Member Functions inherited from LibXR::USB::Endpoint
Config &	GetConfig ()
	获取当前配置引用 / Get endpoint config reference
virtual void	SwitchBuffer ()
	切换双缓冲 / Switch double buffer
virtual void	SetActiveBlock (bool active_block)
	设置当前活动缓冲块 / Set active buffer block

Detailed Description

STM32 USB 端点实现 / STM32 USB endpoint implementation.

Definition at line 17 of file stm32_usb_ep.hpp.

Member Function Documentation

ClearStall()

ErrorCode STM32Endpoint::ClearStall ( )

overridevirtual

清除 STALL / Clear stall

Returns

ErrorCode 错误码 / Error code

Implements LibXR::USB::Endpoint.

Definition at line 282 of file stm32_usb_ep.cpp.

{
  if (GetState() != State::STALLED)
  {
    return ErrorCode::FAILED;
  }
 
  uint8_t addr = EPNumberToAddr(GetNumber(), GetDirection());
 
  if (GetNumber() == USB::Endpoint::EPNumber::EP0)
  {
    SetState(State::IDLE);
    return ErrorCode::OK;
  }
 
  if (HAL_PCD_EP_ClrStall(hpcd_, addr) == HAL_OK)
  {
    SetState(State::IDLE);
    return ErrorCode::OK;
  }
  else
  {
    SetState(State::ERROR);
    return ErrorCode::FAILED;
  }
}

Close()

void STM32Endpoint::Close ( )

overridevirtual

关闭端点 / Close endpoint

Implements LibXR::USB::Endpoint.

Definition at line 175 of file stm32_usb_ep.cpp.

{
  uint8_t addr = EPNumberToAddr(GetNumber(), GetDirection());
  HAL_PCD_EP_Close(hpcd_, addr);
  SetState(State::DISABLED);
}

Configure()

void STM32Endpoint::Configure ( const Config & cfg )

overridevirtual

配置端点协议参数 / Configure endpoint protocol parameters

Parameters

cfg	配置参数 / Configuration parameters

Implements LibXR::USB::Endpoint.

Definition at line 65 of file stm32_usb_ep.cpp.

{
  ASSERT(cfg.direction == Direction::IN || cfg.direction == Direction::OUT);
 
  uint8_t addr = EPNumberToAddr(GetNumber(), cfg.direction);
  uint8_t type = static_cast<uint8_t>(cfg.type);
  auto& ep_cfg = GetConfig();
  size_t packet_size_limit = 0;
 
  ep_cfg = cfg;
 
  switch (cfg.type)
  {
    case Type::BULK:
#if defined(PCD_SPEED_HIGH_IN_FULL)
      if (hpcd_->Init.speed == PCD_SPEED_FULL ||
          hpcd_->Init.speed == PCD_SPEED_HIGH_IN_FULL)
#else
      if (hpcd_->Init.speed == PCD_SPEED_FULL)
#endif
      {
        packet_size_limit = 64;
      }
      else
      {
        packet_size_limit = 512;
      }
      break;
    case Type::INTERRUPT:
#if defined(PCD_SPEED_HIGH_IN_FULL)
      if (hpcd_->Init.speed == PCD_SPEED_FULL ||
          hpcd_->Init.speed == PCD_SPEED_HIGH_IN_FULL)
#else
      if (hpcd_->Init.speed == PCD_SPEED_FULL)
#endif
      {
        packet_size_limit = 64;
      }
      else
      {
        packet_size_limit = 1024;
      }
      break;
    case Type::ISOCHRONOUS:
#if defined(PCD_SPEED_HIGH_IN_FULL)
      if (hpcd_->Init.speed == PCD_SPEED_FULL ||
          hpcd_->Init.speed == PCD_SPEED_HIGH_IN_FULL)
#else
      if (hpcd_->Init.speed == PCD_SPEED_FULL)
#endif
      {
        packet_size_limit = 1023;
      }
      else
      {
        packet_size_limit = 1024;
      }
      break;
    case Type::CONTROL:
      packet_size_limit = 64;
      break;
    default:
      break;
  }
 
#if defined(USB_OTG_FS) || defined(USB_OTG_HS)
  if (packet_size_limit > fifo_size_)
  {
    packet_size_limit = fifo_size_;
  }
#endif
 
#if defined(USB_BASE)
  if (packet_size_limit > hw_buffer_size_)
  {
    packet_size_limit = hw_buffer_size_;
  }
#endif
 
  auto buffer = GetBuffer();
 
  if (packet_size_limit > buffer.size_)
  {
    packet_size_limit = buffer.size_;
  }
 
  size_t max_packet_size = cfg.max_packet_size;
 
  if (max_packet_size > packet_size_limit)
  {
    max_packet_size = packet_size_limit;
  }
 
  ep_cfg.max_packet_size = max_packet_size;
 
  if (max_packet_size < 8)
  {
    max_packet_size = 8;
  }
 
  if (HAL_PCD_EP_Open(hpcd_, addr, max_packet_size, type) == HAL_OK)
  {
    SetState(State::IDLE);
  }
  else
  {
    SetState(State::ERROR);
  }
}

MaxTransferSize()

size_t STM32Endpoint::MaxTransferSize ( ) const

overridevirtual

返回当前最大可传输字节数 / Return maximum transferable size at this time

Returns

size_t 最大可传输字节数 / Maximum transferable bytes

Reimplemented from LibXR::USB::Endpoint.

Definition at line 309 of file stm32_usb_ep.cpp.

{
  if (GetNumber() == USB::Endpoint::EPNumber::EP0)
  {
    return MaxPacketSize();
  }
  else
  {
    return GetBuffer().size_;
  }
}

Stall()

ErrorCode STM32Endpoint::Stall ( )

overridevirtual

置 STALL / Stall endpoint

Returns

ErrorCode 错误码 / Error code

Implements LibXR::USB::Endpoint.

Definition at line 262 of file stm32_usb_ep.cpp.

{
  if (GetState() != State::IDLE)
  {
    return ErrorCode::BUSY;
  }
 
  uint8_t addr = EPNumberToAddr(GetNumber(), GetDirection());
  if (HAL_PCD_EP_SetStall(hpcd_, addr) == HAL_OK)
  {
    SetState(State::STALLED);
    return ErrorCode::OK;
  }
  else
  {
    SetState(State::ERROR);
    return ErrorCode::FAILED;
  }
}

Transfer()

ErrorCode STM32Endpoint::Transfer ( size_t size )

overridevirtual

启动一次传输 / Start a transfer

Parameters

size	传输长度 / Transfer size

Returns

ErrorCode 错误码 / Error code

Implements LibXR::USB::Endpoint.

Definition at line 182 of file stm32_usb_ep.cpp.

{
  if (GetState() == State::BUSY)
  {
    return ErrorCode::BUSY;
  }
 
  bool is_in = GetDirection() == Direction::IN;
  auto ep_addr = EPNumberToAddr(GetNumber(), GetDirection());
 
  PCD_EPTypeDef* ep = is_in ? &hpcd_->IN_ep[ep_addr & EP_ADDR_MSK]
                            : &hpcd_->OUT_ep[ep_addr & EP_ADDR_MSK];
 
  auto buffer = GetBuffer();
 
  if (buffer.size_ < size)
  {
    return ErrorCode::NO_BUFF;
  }
 
  ep->xfer_buff = reinterpret_cast<uint8_t*>(buffer.addr_);
 
  if (UseDoubleBuffer() && GetDirection() == Direction::IN && size > 0)
  {
    SwitchBuffer();
  }
 
  ep->xfer_len = size;
  ep->xfer_count = 0U;
  ep->is_in = is_in ? 1U : 0U;
  ep->num = ep_addr & EP_ADDR_MSK;
  last_transfer_size_ = size;
 
#if defined(USB_OTG_FS) || defined(USB_OTG_HS)
  if (hpcd_->Init.dma_enable == 1U)
  {
    ep->dma_addr = reinterpret_cast<uint32_t>(ep->xfer_buff);
 
#if defined(__DCACHE_PRESENT) && (__DCACHE_PRESENT == 1U)
    if (is_in == true)
    {
      SCB_CleanDCache_by_Addr(reinterpret_cast<uint32_t*>(buffer.addr_),
                              static_cast<int32_t>(size));
    }
#endif
  }
#endif
 
#if defined(USB_BASE)
  if (is_in)
  {
    ep->xfer_fill_db = 0U;
    ep->xfer_len_db = 0U;
  }
#endif
 
  SetState(State::BUSY);
 
#if defined(USB_OTG_FS) || defined(USB_OTG_HS)
  auto ans = USB_EPStartXfer(hpcd_->Instance, ep, hpcd_->Init.dma_enable);
#else
  auto ans = USB_EPStartXfer(hpcd_->Instance, ep);
  if (size == 0 && GetNumber() == USB::Endpoint::EPNumber::EP0 &&
      GetDirection() == Direction::OUT)
  {
    OnTransferCompleteCallback(false, 0);
  }
#endif
 
  if (ans == HAL_OK)
  {
    return ErrorCode::OK;
  }
  else
  {
    SetState(State::ERROR);
    return ErrorCode::FAILED;
  }
}

Field Documentation

hpcd_

PCD_HandleTypeDef* LibXR::STM32Endpoint::hpcd_

Definition at line 39 of file stm32_usb_ep.hpp.

id_

stm32_usb_dev_id_t LibXR::STM32Endpoint::id_

Definition at line 49 of file stm32_usb_ep.hpp.

last_transfer_size_

size_t LibXR::STM32Endpoint::last_transfer_size_ = 0

Definition at line 41 of file stm32_usb_ep.hpp.

---

The documentation for this class was generated from the following files:

• driver/st/stm32_usb_ep.hpp
• driver/st/stm32_usb_ep.cpp