LibXR::USB::BosManager Class Reference

BOS 管理器：能力收集、BOS 描述符拼装、Vendor 请求链式分发 BOS manager: capability collection, descriptor building, vendor dispatch. More...

#include <bos.hpp>

Collaboration diagram for LibXR::USB::BosManager:

Public Member Functions
	BosManager (size_t buffer_size, size_t cap_num)
	构造函数 / Constructor
	BosManager (const BosManager &)=delete
BosManager &	operator= (const BosManager &)=delete
void	ClearCapabilities ()
	清空已注册能力 / Clear registered capabilities
bool	AddCapability (BosCapability *cap)
	添加能力 / Add capability
ConstRawData	GetBosDescriptor ()
	构建 BOS 描述符（BOS 头 + 能力块） Build BOS descriptor (header + blocks).
ErrorCode	ProcessVendorRequest (bool in_isr, const SetupPacket *setup, BosVendorResult &result)
	Vendor 请求分发 / Vendor request dispatch.

Private Attributes
size_t	cap_capacity_ = 0
	能力指针容量 / Capability pointer capacity
BosCapability **	caps_ = nullptr
	能力指针表 / Capability pointer table
size_t	count_ = 0
	已注册能力数量 / Registered capability count
RawData	bos_buffer_ = {nullptr, 0}
	BOS 缓冲区 / BOS buffer.

Detailed Description

BOS 管理器：能力收集、BOS 描述符拼装、Vendor 请求链式分发 BOS manager: capability collection, descriptor building, vendor dispatch.

Note

仅拥有内部数组/缓冲区，不拥有 BosCapability 对象。

Definition at line 112 of file bos.hpp.

Constructor & Destructor Documentation

BosManager()

LibXR::USB::BosManager::BosManager ( size_t buffer_size, size_t cap_num )

inline

构造函数 / Constructor

Parameters

buffer_size	BOS 描述符缓冲区大小 / BOS buffer size
cap_num	能力指针容量 / Capability pointer capacity

Definition at line 121 of file bos.hpp.

      : cap_capacity_(cap_num),
        caps_(new BosCapability*[cap_num]),
        bos_buffer_({new uint8_t[buffer_size], buffer_size})
  {
  }

Member Function Documentation

AddCapability()

bool LibXR::USB::BosManager::AddCapability ( BosCapability * cap )

inline

添加能力 / Add capability

Parameters

cap	能力指针 / Capability pointer

Returns

true：成功；false：失败 / true: success; false: failure

Definition at line 142 of file bos.hpp.

  {
    ASSERT(bos_buffer_.addr_);
    ASSERT(cap != nullptr);
    ASSERT(count_ < cap_capacity_);
 
    caps_[count_++] = cap;
    return true;
  }

ClearCapabilities()

void LibXR::USB::BosManager::ClearCapabilities ( )

inline

清空已注册能力 / Clear registered capabilities

Definition at line 134 of file bos.hpp.

{ count_ = 0; }

GetBosDescriptor()

ConstRawData LibXR::USB::BosManager::GetBosDescriptor ( )

inline

构建 BOS 描述符（BOS 头 + 能力块） Build BOS descriptor (header + blocks).

Returns

ConstRawData BOS 描述符数据 / BOS descriptor bytes

Definition at line 158 of file bos.hpp.

  {
    ASSERT(bos_buffer_.addr_);
 
    bool has_usb2_ext = false;
    for (size_t i = 0; i < count_; ++i)
    {
      ConstRawData blk = caps_[i]->GetCapabilityDescriptor();
      ASSERT(blk.addr_ != nullptr);
      ASSERT(blk.size_ >= 3);
 
      const uint8_t* p = reinterpret_cast<const uint8_t*>(blk.addr_);
      if (p[1] == DESCRIPTOR_TYPE_DEVICE_CAPABILITY &&
          p[2] == DEV_CAPABILITY_TYPE_USB20EXT)
      {
        has_usb2_ext = true;
      }
    }
 
    static constexpr uint8_t USB2_EXT_CAP[USB2_EXT_CAP_SIZE] = {7,    0x10, 0x02, 0x00,
                                                                0x00, 0x00, 0x00};
    const bool NEED_AUTO_USB2_EXT = !has_usb2_ext;
 
    size_t total = BOS_HEADER_SIZE;
    for (size_t i = 0; i < count_; ++i)
    {
      ConstRawData blk = caps_[i]->GetCapabilityDescriptor();
      ASSERT(blk.addr_ != nullptr);
      ASSERT(blk.size_ >= 1);
      total += blk.size_;
    }
    if (NEED_AUTO_USB2_EXT)
    {
      total += sizeof(USB2_EXT_CAP);
    }
 
    ASSERT(total <= bos_buffer_.size_);
    ASSERT(total <= 0xFFFF);
 
    auto buffer = reinterpret_cast<uint8_t*>(bos_buffer_.addr_);
 
    buffer[0] = static_cast<uint8_t>(BOS_HEADER_SIZE);
    buffer[1] = DESCRIPTOR_TYPE_BOS;
    buffer[2] = static_cast<uint8_t>(total & 0xFF);
    buffer[3] = static_cast<uint8_t>((total >> 8) & 0xFF);
    buffer[4] = static_cast<uint8_t>(count_ + (NEED_AUTO_USB2_EXT ? 1 : 0));
 
    size_t offset = BOS_HEADER_SIZE;
 
    for (size_t i = 0; i < count_; ++i)
    {
      ConstRawData blk = caps_[i]->GetCapabilityDescriptor();
      ASSERT(offset + blk.size_ <= bos_buffer_.size_);
 
      LibXR::Memory::FastCopy(&buffer[offset], blk.addr_, blk.size_);
      offset += blk.size_;
    }
 
    if (NEED_AUTO_USB2_EXT)
    {
      ASSERT(offset + sizeof(USB2_EXT_CAP) <= bos_buffer_.size_);
      LibXR::Memory::FastCopy(&buffer[offset], USB2_EXT_CAP, sizeof(USB2_EXT_CAP));
      offset += sizeof(USB2_EXT_CAP);
    }
 
    return {buffer, offset};
  }

ProcessVendorRequest()

ErrorCode LibXR::USB::BosManager::ProcessVendorRequest ( bool in_isr, const SetupPacket * setup, BosVendorResult & result )

inline

Vendor 请求分发 / Vendor request dispatch.

Parameters

in_isr	ISR 上下文标志 / ISR context flag
setup	Setup 包 / Setup packet
result	输出结果 / Output result

Returns

OK：已处理；NOT_SUPPORT：无匹配；其他：匹配但失败

Definition at line 234 of file bos.hpp.

  {
    if (setup == nullptr)
    {
      return ErrorCode::ARG_ERR;
    }
 
    for (size_t i = 0; i < count_; ++i)
    {
      BosVendorResult tmp{};
      auto ec = caps_[i]->OnVendorRequest(in_isr, setup, tmp);
 
      if (ec == ErrorCode::NOT_SUPPORT)
      {
        continue;
      }
      if (ec != ErrorCode::OK)
      {
        return ec;
      }
      if (tmp.handled)
      {
        result = tmp;
        return ErrorCode::OK;
      }
      return ErrorCode::FAILED;
    }
 
    return ErrorCode::NOT_SUPPORT;
  }

Field Documentation

bos_buffer_

RawData LibXR::USB::BosManager::bos_buffer_ = {nullptr, 0}

private

BOS 缓冲区 / BOS buffer.

Definition at line 271 of file bos.hpp.

{nullptr, 0};  

cap_capacity_

size_t LibXR::USB::BosManager::cap_capacity_ = 0

private

能力指针容量 / Capability pointer capacity

Definition at line 267 of file bos.hpp.

caps_

BosCapability** LibXR::USB::BosManager::caps_ = nullptr

private

能力指针表 / Capability pointer table

Definition at line 268 of file bos.hpp.

count_

size_t LibXR::USB::BosManager::count_ = 0

private

已注册能力数量 / Registered capability count

Definition at line 269 of file bos.hpp.

---

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

• src/driver/usb/core/bos.hpp