USB端点池类 / USB endpoint pool class. More...

#include <ep_pool.hpp>

Inheritance diagram for LibXR::USB::EndpointPool:

Collaboration diagram for LibXR::USB::EndpointPool:

Public Member Functions
	EndpointPool (size_t endpoint_num)
	构造函数 / Constructor

	EndpointPool (const EndpointPool &)=delete

EndpointPool &	operator= (const EndpointPool &)=delete

ErrorCode	Put (Endpoint *ep)
	登记一个端点到池中 / Register an endpoint into the pool

ErrorCode	Get (Endpoint *&ep_info, Endpoint::Direction direction, Endpoint::EPNumber ep_num)
	分配端点 / Allocate endpoint

ErrorCode	Release (Endpoint *ep_info)
	回收端点 / Release endpoint

ErrorCode	FindEndpoint (uint8_t ep_addr, Endpoint *&ans)
	查找端点/ Lookup endpoint

Endpoint *	GetEndpoint0Out ()
	获取端点0的OUT对象 / Get Endpoint 0's OUT object

Endpoint *	GetEndpoint0In ()
	获取端点0的IN对象 / Get Endpoint 0's IN object

void	SetEndpoint0 (Endpoint ep0_in, Endpoint ep0_out)
	设置端点0的IN/OUT对象 / Set Endpoint 0 IN/OUT objects

Private Types
enum class	SlotUse : uint8_t { AVAILABLE , IN_USE }
	槽占用状态 / Slot usage state More...

Static Private Member Functions
static size_t	DirIndex (Endpoint::Direction dir)
	方向枚举转索引下标 / Convert direction enum to array index

Private Attributes
Endpoint *	slots_ [SLOT_COUNT][DIR_COUNT] = {}
	[端点号][方向] 端点指针 / [num][dir]

SlotUse	use_ [SLOT_COUNT][DIR_COUNT] = {}
	对应槽占用状态 / Per-slot usage

Endpoint *	ep0_in_ = nullptr
	端点0 IN对象 / Endpoint 0 IN pointer

Endpoint *	ep0_out_ = nullptr
	端点0 OUT对象 / Endpoint 0 OUT pointer

Static Private Attributes
static constexpr size_t	DIR_COUNT = 2
	方向数量（OUT=0, IN=1）/ Number of direction slots (OUT=0, IN=1)

static constexpr size_t	SLOT_COUNT
	索引数组容量（端点号 0..EP_MAX_NUM-1）/ Index array size (endpoint numbers)

Detailed Description

USB端点池类 / USB endpoint pool class.

按「端点号 × 方向」二维索引管理固定的 Endpoint 指针。所有 Endpoint 对象由后端在初始化时通过 Put() 填入，池只负责登记、分配、查找与回收，不负责对象生命周期。端点 0 的 IN/OUT 不进入索引数组，由 SetEndpoint0/GetEndpoint0* 单独管理。

Manages fixed Endpoint pointers indexed by (endpoint-number, direction). All Endpoint objects are populated by the backend at init time via Put(); the pool only registers, allocates, looks up and recycles them, and does not own their lifetime. Endpoint 0's IN/OUT are kept out of the index array and managed by SetEndpoint0/GetEndpoint0*.

Note: 分配/回收发生在配置切换（SetConfiguration/Reset）这类低频、非并发路径，因此使用普通数组与非原子状态，无需无锁结构。 Allocation/recycling happens on low-frequency, non-concurrent paths (SetConfiguration/Reset), so a plain array with non-atomic state is used.

Definition at line 28 of file ep_pool.hpp.

Member Enumeration Documentation

◆ SlotUse

enum class LibXR::USB::EndpointPool::SlotUse : uint8_t

strongprivate

槽占用状态 / Slot usage state

Enumerator
AVAILABLE	已登记、空闲可分配 / Registered and free to allocate
IN_USE	已分配、正在使用 / Allocated and in use

Definition at line 125 of file ep_pool.hpp.

  {
    AVAILABLE,  
    IN_USE      
  };

Constructor & Destructor Documentation

◆ EndpointPool()

EndpointPool::EndpointPool ( size_t endpoint_num )

explicit

构造函数 / Constructor

Parameters

endpoint_num 端点总数（包含端点0，必须 >=2）/ Total number of endpoints (including EP0, must >=2)

Note: 端点对象本身由后端通过 Put() 填入；该参数仅用于合法性校验。 Endpoint objects are populated by the backend via Put(); this argument is only used for a validity check.

Definition at line 5 of file ep_pool.cpp.

5{ ASSERT(endpoint_num >= 2); }

Member Function Documentation

◆ DirIndex()

static size_t LibXR::USB::EndpointPool::DirIndex ( Endpoint::Direction dir )

inlinestaticprivate

方向枚举转索引下标 / Convert direction enum to array index

Parameters

dir	端点方向（IN/OUT）/ Endpoint direction

Returns: size_t 下标（OUT=0, IN=1）/ Index (OUT=0, IN=1)

Definition at line 136 of file ep_pool.hpp.

  {
    return (dir == Endpoint::Direction::IN) ? 1U : 0U;
  }

◆ FindEndpoint()

LibXR::ErrorCode EndpointPool::FindEndpoint	(	uint8_t	ep_addr,
		Endpoint *&	ans )

查找端点/ Lookup endpoint

端点 0 走 ep0_in_/ep0_out_ 旁路；其余端点仅在「已分配（in-use）」状态下可被查到，与原实现语义一致（未分配端点收到端点级请求视为异常）。 Endpoint 0 goes through the ep0_in_/ep0_out_ bypass; other endpoints are visible only while allocated (in-use), matching the original semantics (an endpoint-level request for an unallocated endpoint is treated as an error).

Parameters

	ep_addr	端点地址，IN端点高位需加0x80 / Endpoint address (0x80 for IN endpoints)
[out]	ans	查找到的端点对象指针 / Found endpoint pointer

Return values

ErrorCode 操作结果（OK/NOT_FOUND）/ Operation result

Definition at line 119 of file ep_pool.cpp.

{
  const Endpoint::Direction direction =
      (ep_addr & 0x80) ? Endpoint::Direction::IN : Endpoint::Direction::OUT;
 
  if ((ep_addr & 0x7F) == 0)
  {
    ans = (direction == Endpoint::Direction::IN) ? ep0_in_ : ep0_out_;
    return (ans != nullptr) ? LibXR::ErrorCode::OK : LibXR::ErrorCode::NOT_FOUND;
  }
 
  const size_t num = ep_addr & 0x7F;
  if (num >= SLOT_COUNT)
  {
    return LibXR::ErrorCode::NOT_FOUND;
  }
 
  const size_t d = DirIndex(direction);
  Endpoint* ep = slots_[num][d];
  // 仅「已分配（in-use）」且当前配置地址/方向与请求一致的端点可被反查到。
  // 必须核对 GetAddress()/GetDirection()（当前配置方向），与原实现语义一致：
  // 一个 BOTH 端点被配置成单一方向后，不会再被另一方向的同号地址查到。
  // Only endpoints that are allocated (in-use) AND whose current configured
  // address/direction match the request are visible here. Checking
  // GetAddress()/GetDirection() (the configured direction) preserves the original
  // semantics: once a BOTH endpoint is configured for a single direction, it is no
  // longer reachable via the opposite-direction address of the same number.
  if (ep != nullptr && use_[num][d] == SlotUse::IN_USE && ep->GetAddress() == ep_addr &&
      ep->GetDirection() == direction)
  {
    ans = ep;
    return LibXR::ErrorCode::OK;
  }
 
  return LibXR::ErrorCode::NOT_FOUND;
}

◆ Get()

LibXR::ErrorCode EndpointPool::Get	(	Endpoint *&	ep_info,
		Endpoint::Direction	direction,
		Endpoint::EPNumber	ep_num )

分配端点 / Allocate endpoint

按指定端点号与方向精确匹配一个已登记且空闲的端点。调用方必须显式指定端点号，不再支持自动分配。 Precisely matches a registered, available endpoint by the given number and direction. The caller must specify the endpoint number explicitly; auto-allocation is no longer supported.

Parameters

[out]	ep_info	分配得到的端点对象指针 / Allocated endpoint pointer
	direction	端点方向（IN/OUT）/ Endpoint direction
	ep_num	指定端点号（必填）/ Endpoint number (required)

Return values

ErrorCode 操作结果（OK/NOT_FOUND）/ Operation result

Definition at line 52 of file ep_pool.cpp.

{
  const auto num = static_cast<size_t>(ep_num);
  if (num >= SLOT_COUNT || direction == Endpoint::Direction::BOTH)
  {
    return LibXR::ErrorCode::NOT_FOUND;
  }
 
  const size_t d = DirIndex(direction);
  Endpoint* ep = slots_[num][d];
  if (ep == nullptr || use_[num][d] != SlotUse::AVAILABLE)
  {
    return LibXR::ErrorCode::NOT_FOUND;
  }
 
  // 端点登记方向必须与请求方向兼容（具体方向匹配，或登记为 BOTH）。
  // The registered direction must be compatible with the requested one (exact match, or
  // registered as BOTH).
  const Endpoint::Direction avail = ep->AvailableDirection();
  if (avail != direction && avail != Endpoint::Direction::BOTH)
  {
    return LibXR::ErrorCode::NOT_FOUND;
  }
 
  ep_info = ep;
 
  // BOTH 端点占用后，两个方向槽一并标记为使用中。
  // For a BOTH endpoint, mark both direction slots as in-use together.
  if (avail == Endpoint::Direction::BOTH)
  {
    use_[num][0] = SlotUse::IN_USE;
    use_[num][1] = SlotUse::IN_USE;
  }
  else
  {
    use_[num][d] = SlotUse::IN_USE;
  }
  return LibXR::ErrorCode::OK;
}

◆ GetEndpoint0In()

Endpoint * EndpointPool::GetEndpoint0In ( )

获取端点0的IN对象 / Get Endpoint 0's IN object

Returns: Endpoint* 端点0 IN对象指针 / Endpoint 0 IN pointer

Definition at line 158 of file ep_pool.cpp.

158{ return ep0_in_; }

◆ GetEndpoint0Out()

Endpoint * EndpointPool::GetEndpoint0Out ( )

获取端点0的OUT对象 / Get Endpoint 0's OUT object

Returns: Endpoint* 端点0 OUT对象指针 / Endpoint 0 OUT pointer

Definition at line 156 of file ep_pool.cpp.

156{ return ep0_out_; }

◆ Put()

LibXR::ErrorCode EndpointPool::Put ( Endpoint * ep )

登记一个端点到池中 / Register an endpoint into the pool

按端点自身的号（GetNumber）与可用方向（AvailableDirection）入位。端点 0 不应通过此接口登记（应使用 SetEndpoint0）。 Registered by the endpoint's own number (GetNumber) and available direction (AvailableDirection). Endpoint 0 must not be registered here (use SetEndpoint0).

Parameters

ep	待登记的端点对象指针 / Endpoint pointer to register

Return values

ErrorCode 操作结果（OK/ARG_ERR/FULL）/ Operation result

Definition at line 7 of file ep_pool.cpp.

{
  if (ep == nullptr)
  {
    return LibXR::ErrorCode::ARG_ERR;
  }
 
  const auto ep_num = static_cast<size_t>(ep->GetNumber());
  if (ep_num >= SLOT_COUNT)
  {
    return LibXR::ErrorCode::ARG_ERR;
  }
 
  const Endpoint::Direction dir = ep->AvailableDirection();
 
  // BOTH 端点同时登记到该号的两个方向槽；其余按具体方向入位。
  // A BOTH endpoint is registered into both direction slots of its number; others go
  // into their concrete direction slot.
  if (dir == Endpoint::Direction::BOTH)
  {
    for (size_t d = 0; d < DIR_COUNT; ++d)
    {
      if (slots_[ep_num][d] != nullptr)
      {
        return LibXR::ErrorCode::FULL;
      }
    }
    for (size_t d = 0; d < DIR_COUNT; ++d)
    {
      slots_[ep_num][d] = ep;
      use_[ep_num][d] = SlotUse::AVAILABLE;
    }
    return LibXR::ErrorCode::OK;
  }
 
  const size_t d = DirIndex(dir);
  if (slots_[ep_num][d] != nullptr)
  {
    return LibXR::ErrorCode::FULL;
  }
  slots_[ep_num][d] = ep;
  use_[ep_num][d] = SlotUse::AVAILABLE;
  return LibXR::ErrorCode::OK;
}

◆ Release()

LibXR::ErrorCode EndpointPool::Release ( Endpoint * ep_info )

回收端点 / Release endpoint

Parameters

ep_info 待回收的端点对象指针 / Endpoint pointer to release

Return values

ErrorCode 操作结果（OK/NOT_FOUND）/ Operation result

Definition at line 93 of file ep_pool.cpp.

{
  if (ep_info == nullptr)
  {
    return LibXR::ErrorCode::NOT_FOUND;
  }
 
  const auto num = static_cast<size_t>(ep_info->GetNumber());
  if (num >= SLOT_COUNT)
  {
    return LibXR::ErrorCode::NOT_FOUND;
  }
 
  bool released = false;
  for (size_t d = 0; d < DIR_COUNT; ++d)
  {
    if (slots_[num][d] == ep_info && use_[num][d] == SlotUse::IN_USE)
    {
      use_[num][d] = SlotUse::AVAILABLE;
      released = true;
    }
  }
 
  return released ? LibXR::ErrorCode::OK : LibXR::ErrorCode::NOT_FOUND;
}

◆ SetEndpoint0()

void EndpointPool::SetEndpoint0	(	Endpoint *	ep0_in,
		Endpoint *	ep0_out )

设置端点0的IN/OUT对象 / Set Endpoint 0 IN/OUT objects

Parameters

ep0_in	端点0 IN对象指针 / Endpoint 0 IN pointer
ep0_out	端点0 OUT对象指针 / Endpoint 0 OUT pointer

Definition at line 160 of file ep_pool.cpp.

{
  ep0_in_ = ep0_in;
  ep0_out_ = ep0_out;
}

Field Documentation

◆ DIR_COUNT

size_t LibXR::USB::EndpointPool::DIR_COUNT = 2

staticconstexprprivate

方向数量（OUT=0, IN=1）/ Number of direction slots (OUT=0, IN=1)

Definition at line 119 of file ep_pool.hpp.

◆ ep0_in_

Endpoint* LibXR::USB::EndpointPool::ep0_in_ = nullptr

private

端点0 IN对象 / Endpoint 0 IN pointer

Definition at line 144 of file ep_pool.hpp.

◆ ep0_out_

Endpoint* LibXR::USB::EndpointPool::ep0_out_ = nullptr

private

端点0 OUT对象 / Endpoint 0 OUT pointer

Definition at line 145 of file ep_pool.hpp.

◆ SLOT_COUNT

size_t LibXR::USB::EndpointPool::SLOT_COUNT

staticconstexprprivate

Initial value:

=

static_cast<size_t>(Endpoint::EPNumber::EP_MAX_NUM)

LibXR::USB::Endpoint::EPNumber::EP_MAX_NUM

@ EP_MAX_NUM

端点数量上限 / Maximum number of endpoints

索引数组容量（端点号 0..EP_MAX_NUM-1）/ Index array size (endpoint numbers)

Definition at line 121 of file ep_pool.hpp.

◆ slots_

Endpoint* LibXR::USB::EndpointPool::slots_[SLOT_COUNT][DIR_COUNT] = {}

private

[端点号][方向] 端点指针 / [num][dir]

Definition at line 141 of file ep_pool.hpp.

141{};

◆ use_

SlotUse LibXR::USB::EndpointPool::use_[SLOT_COUNT][DIR_COUNT] = {}

private

对应槽占用状态 / Per-slot usage

Definition at line 142 of file ep_pool.hpp.

142{};

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

src/driver/usb/core/ep_pool.hpp
src/driver/usb/core/ep_pool.cpp

Public Member Functions

Private Types

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ SlotUse

Constructor & Destructor Documentation

◆ EndpointPool()

Member Function Documentation

◆ DirIndex()

◆ FindEndpoint()

◆ Get()

◆ GetEndpoint0In()

◆ GetEndpoint0Out()

◆ Put()

◆ Release()

◆ SetEndpoint0()

Field Documentation

◆ DIR_COUNT

◆ ep0_in_

◆ ep0_out_

◆ SLOT_COUNT

◆ slots_

◆ use_