libxr  1.0
Want to be the best embedded framework
Loading...
Searching...
No Matches
ep.hpp
1#pragma once
2
3#include <cstdint>
4
5#include "double_buffer.hpp"
6#include "libxr_cb.hpp"
7#include "libxr_def.hpp"
8#include "libxr_rw.hpp"
9#include "libxr_type.hpp"
10
11namespace LibXR::USB
12{
13
23{
24 public:
29 enum class Direction : uint8_t
30 {
31 OUT = 0,
32 IN = 1,
33 BOTH = 2
34 };
35
40 enum class EPNumber : uint8_t
41 {
42 EP0 = 0,
43 EP1 = 1,
44 EP2 = 2,
45 EP3 = 3,
46 EP4 = 4,
47 EP5 = 5,
48 EP6 = 6,
49 EP7 = 7,
50 EP8 = 8,
51 EP9 = 9,
52 EP10 = 10,
53 EP11 = 11,
54 EP12 = 12,
55 EP13 = 13,
56 EP14 = 14,
57 EP15 = 15,
58 EP_MAX_NUM = 16,
59 EP_AUTO = 0xFE,
60 EP_INVALID = 0xFF
61 };
62
67 enum class Type : uint8_t
68 {
69 CONTROL = 0,
70 ISOCHRONOUS = 1,
71 BULK = 2,
72 INTERRUPT = 3
73 };
74
79 enum class State : uint8_t
80 {
81 DISABLED,
82 IDLE,
83 BUSY,
84 STALLED,
85 ERROR
86 };
87
93 static constexpr uint8_t EPNumberToInt8(EPNumber ep)
94 {
95 return static_cast<uint8_t>(ep);
96 }
97
104 static constexpr uint8_t EPNumberToAddr(EPNumber ep, Direction dir)
105 {
106 ASSERT(dir == Direction::IN || dir == Direction::OUT);
107 return static_cast<uint8_t>(ep) | (dir == Direction::IN ? 0x80 : 0x00);
108 }
109
116 static constexpr EPNumber AddrToEPNumber(uint8_t addr, Direction& dir)
117 {
118 dir = addr & 0x80 ? Direction::IN : Direction::OUT;
119 return static_cast<EPNumber>(addr & 0x7F);
120 }
121
127 static constexpr EPNumber NextEPNumber(EPNumber ep)
128 {
129 ASSERT(ep <= EPNumber::EP15);
130 return static_cast<EPNumber>(EPNumberToInt8(ep) + 1);
131 }
132
137 struct Config
138 {
141 uint16_t max_packet_size = UINT16_MAX;
142 bool double_buffer = false;
143 uint8_t mult = 0;
144 };
145
152 explicit Endpoint(EPNumber number, Direction dir, RawData buffer)
153 : number_(number), avail_direction_(dir), buffer_(buffer), double_buffer_(buffer)
154 {
155 }
156
160 virtual ~Endpoint() = default;
161
162 Endpoint(const Endpoint&) = delete;
163 Endpoint& operator=(const Endpoint&) = delete;
164
169 EPNumber GetNumber() const { return number_; }
170
176
182 {
183 if (state_ == State::DISABLED)
184 {
185 return AvailableDirection();
186 }
187 return config_.direction;
188 }
189
194 uint8_t GetAddress() const
195 {
196 if (state_ == State::DISABLED)
197 {
198 return EPNumberToInt8(number_) & 0x0F;
199 }
201 }
202
207 State GetState() const { return state_; }
208
213 void SetState(State state) { state_ = state; }
214
219 Type GetType() const { return config_.type; }
220
225 uint16_t MaxPacketSize() const { return config_.max_packet_size; }
226
232 bool IsStalled() const { return state_ == State::STALLED; }
233
239 bool UseDoubleBuffer() const { return config_.double_buffer; }
240
246 {
248 {
250 }
251 else
252 {
253 return buffer_;
254 }
255 }
256
265
270 void SetActiveLength(uint16_t len) { double_buffer_.SetActiveLength(len); }
271
277
282 virtual size_t MaxTransferSize() const { return MaxPacketSize(); }
283
288 virtual void Configure(const Config& cfg) = 0;
289
293 virtual void Close() = 0;
294
299 virtual ErrorCode Stall() = 0;
300
305 virtual ErrorCode ClearStall() = 0;
306
312 virtual ErrorCode Transfer(size_t size) = 0;
313
320 virtual ErrorCode TransferMultiBulk(RawData& data)
321 {
322 auto ep_buf = GetBuffer();
323 size_t max_chunk = MaxTransferSize();
324
325 ASSERT(max_chunk > 0);
326
327 // 单包就能搞定的情况:不进入 multi-bulk 状态机,保持原有行为
328 if (data.size_ <= max_chunk)
329 {
331 {
332 multi_bulk_ = false;
334 multi_bulk_data_ = {nullptr, 0};
335
336 auto src = static_cast<const uint8_t*>(data.addr_);
337 auto dst = static_cast<uint8_t*>(ep_buf.addr_);
338 Memory::FastCopy(dst, src, data.size_);
339
340 return Transfer(data.size_);
341 }
342
343 // OUT:接收——为了把数据回填到 data,单包也走 multi-bulk
345 {
346 multi_bulk_ = true;
347 multi_bulk_data_ = data;
348 multi_bulk_remain_ = data.size_; // OUT: 剩余可写容量
349 return Transfer(data.size_);
350 }
351
352 return ErrorCode::ARG_ERR;
353 }
354
355 // 需要多包处理的情况
356 multi_bulk_ = true;
357 multi_bulk_data_ = data; // 应用层 buffer 指针 + 最大容量 / 逻辑总长
358 multi_bulk_remain_ = data.size_; // IN: 剩余待发送;OUT: 剩余可写容量
359
360 // 第一包大小
361 size_t first = max_chunk;
362 if (first > multi_bulk_remain_)
363 {
364 first = multi_bulk_remain_;
365 }
366
368 {
369 // IN:发送时,先把第一 chunk 拷到 EP buffer
370 auto src = static_cast<const uint8_t*>(multi_bulk_data_.addr_);
371 auto dst = static_cast<uint8_t*>(ep_buf.addr_);
372 Memory::FastCopy(dst, src, first);
373
374 multi_bulk_remain_ -= first; // 已经准备好 first 字节要发
375 }
376 // OUT:接收时,先启动一次接收,稍后在回调里拷贝到 multi_bulk_data_
377
378 return Transfer(first);
379 }
380
385 virtual ErrorCode TransferZLP() { return Transfer(0); }
386
392 void OnTransferCompleteCallback(bool in_isr, size_t actual_transfer_size)
393 {
394 if (GetState() != State::BUSY)
395 {
396 return;
397 }
398
399 bool callback_uses_app_buffer = false;
400 bool out_switched_before_cb = false;
401
402 const Direction DIR = GetDirection();
403 const size_t MAX_CHUNK = MaxTransferSize();
404 const bool DB = UseDoubleBuffer();
405
406 if (multi_bulk_)
407 {
408 if (DIR == Direction::IN)
409 {
410 if (multi_bulk_remain_ > 0)
411 {
412 auto ep_buf = GetBuffer(); // 此时应是“下一块 Active”(因为 Transfer 已切换)
413 const size_t SENT = multi_bulk_data_.size_ - multi_bulk_remain_;
414
415 size_t chunk = MAX_CHUNK;
416 if (chunk > multi_bulk_remain_) chunk = multi_bulk_remain_;
417
418 auto src = static_cast<const uint8_t*>(multi_bulk_data_.addr_) + SENT;
419 auto dst = static_cast<uint8_t*>(ep_buf.addr_);
420 Memory::FastCopy(dst, src, chunk);
421 multi_bulk_remain_ -= chunk;
422
424 (void)Transfer(chunk);
425 return;
426 }
427
428 // 结束:对上层报告 app buffer
429 multi_bulk_ = false;
430 callback_uses_app_buffer = true;
431 actual_transfer_size = multi_bulk_data_.size_;
432 }
433 else
434 {
435 // OUT:完成时 Active 里是数据
436 auto ep_buf = GetBuffer();
437 size_t prev_remain = multi_bulk_remain_;
438 size_t recvd = actual_transfer_size;
439 if (recvd > prev_remain)
440 {
441 recvd = prev_remain;
442 }
443
444 const size_t OFFSET = multi_bulk_data_.size_ - prev_remain;
445
446 auto dst = static_cast<uint8_t*>(multi_bulk_data_.addr_) + OFFSET;
447 auto src = static_cast<const uint8_t*>(ep_buf.addr_);
448 Memory::FastCopy(dst, src, recvd);
449
450 multi_bulk_remain_ = prev_remain - recvd;
451
452 const bool SHORT_PACKET = (recvd < MAX_CHUNK);
453 const bool BUFFER_FULL = (multi_bulk_remain_ == 0);
454
455 if (DB)
456 {
457 SwitchBuffer(); // 切换后 Pending = 刚接收的包;Active = 下次用
458 out_switched_before_cb = true;
459 }
460
461 if (!SHORT_PACKET && !BUFFER_FULL)
462 {
463 size_t chunk = MAX_CHUNK;
464 if (chunk > multi_bulk_remain_)
465 {
466 chunk = multi_bulk_remain_;
467 }
468
470 (void)Transfer(chunk); // 下一包将落到新的 Active(
471 return;
472 }
473
474 multi_bulk_ = false;
475 callback_uses_app_buffer = true;
476 actual_transfer_size = multi_bulk_data_.size_ - multi_bulk_remain_;
477 }
478 }
479
480 // 非 multi-bulk:OUT 也必须“回调前切换”
481 if (!multi_bulk_ && DB && DIR == Direction::OUT && !out_switched_before_cb)
482 {
483 SwitchBuffer();
484 out_switched_before_cb = true;
485 }
486
488
489 ConstRawData data;
490 if (callback_uses_app_buffer)
491 {
492 data = ConstRawData(multi_bulk_data_.addr_, actual_transfer_size);
493 }
494 else
495 {
496 if (DB)
497 {
498 // 回调里永远取 Pending = 刚刚完成的那包(IN/OUT 一致)
499 data = ConstRawData(double_buffer_.PendingBuffer(), actual_transfer_size);
500 }
501 else
502 {
503 data = ConstRawData(buffer_.addr_, actual_transfer_size);
504 }
505 }
506
507 on_transfer_complete_.Run(in_isr, data);
508 }
509
510 protected:
515 Config& GetConfig() { return config_; }
516
520 virtual void SwitchBuffer()
521 {
524 }
525
531 virtual void SetActiveBlock(bool active_block)
532 {
533 double_buffer_.SetActiveBlock(active_block);
535 }
536
537 private:
540
547
548 bool multi_bulk_ = false;
551 0;
552};
553
554} // namespace LibXR::USB
通用回调包装,支持动态参数传递 / Generic callback wrapper supporting dynamic argument passing
Definition libxr_cb.hpp:150
void Run(bool in_isr, PassArgs &&... args) const
执行回调函数并传递参数 / Execute the callback with arguments
Definition libxr_cb.hpp:225
常量原始数据封装类。 A class for encapsulating constant raw data.
双缓冲区管理类 / Double buffer manager class
void SetActiveLength(size_t length)
设置当前活动缓冲区的数据长度 Sets the size of the active buffer
void SetActiveBlock(bool block)
设置当前活动缓冲区 Sets the active buffer
void EnablePending()
手动启用 pending 状态 Manually sets the pending state to true
size_t Size() const
获取每个缓冲区的大小(单位:字节) Gets the size of each buffer in bytes
uint8_t * ActiveBuffer() const
获取当前正在使用的缓冲区指针 Returns the currently active buffer
size_t GetActiveLength() const
获取当前活动缓冲区中准备好的数据长度 Gets the size of valid data in active buffer
uint8_t * PendingBuffer() const
获取备用缓冲区的指针 Returns the pending (inactive) buffer
void Switch()
切换到备用缓冲区(若其有效) Switches to the pending buffer if it's valid
static void FastCopy(void *dst, const void *src, size_t size)
快速内存拷贝 / Fast memory copy
Definition libxr_mem.cpp:3
原始数据封装类。 A class for encapsulating raw data.
size_t size_
数据大小(字节)。 The size of the data (in bytes).
void * addr_
数据存储地址。 The storage address of the data.
USB 端点基类 / USB Endpoint base class.
Definition ep.hpp:23
Endpoint(EPNumber number, Direction dir, RawData buffer)
构造函数 / Constructor
Definition ep.hpp:152
EPNumber
端点号 Endpoint number
Definition ep.hpp:41
@ EP0
端点 0 / Endpoint 0
@ EP11
端点 11 / Endpoint 11
@ EP5
端点 5 / Endpoint 5
@ EP14
端点 14 / Endpoint 14
@ EP1
端点 1 / Endpoint 1
@ EP_AUTO
自动分配端点号 / Auto allocate
@ EP8
端点 8 / Endpoint 8
@ EP2
端点 2 / Endpoint 2
@ EP7
端点 7 / Endpoint 7
@ EP4
端点 4 / Endpoint 4
@ EP15
端点 15 / Endpoint 15
@ EP_MAX_NUM
端点数量上限 / Maximum number of endpoints
@ EP13
端点 13 / Endpoint 13
@ EP10
端点 10 / Endpoint 10
@ EP3
端点 3 / Endpoint 3
@ EP6
端点 6 / Endpoint 6
@ EP9
端点 9 / Endpoint 9
@ EP_INVALID
非法端点号 / Invalid endpoint
@ EP12
端点 12 / Endpoint 12
RawData multi_bulk_data_
多包 bulk 应用层 buffer / App buffer for multi-bulk
Definition ep.hpp:549
LibXR::DoubleBuffer double_buffer_
双缓冲管理 / Double buffer manager
Definition ep.hpp:546
Direction AvailableDirection() const
获取允许配置的方向 / Get allowed endpoint direction
Definition ep.hpp:175
Type GetType() const
获取端点类型 / Get endpoint type
Definition ep.hpp:219
uint8_t GetAddress() const
获取端点地址(方向 + 号) / Get endpoint address (dir + num)
Definition ep.hpp:194
bool IsStalled() const
是否处于 STALL 状态 / Whether endpoint is stalled
Definition ep.hpp:232
static constexpr uint8_t EPNumberToInt8(EPNumber ep)
端点号转换为 uint8_t / Convert endpoint number to uint8_t
Definition ep.hpp:93
virtual ErrorCode Stall()=0
置 STALL / Stall endpoint
Direction avail_direction_
可配置方向 / Allowed direction
Definition ep.hpp:542
Direction
端点方向 Endpoint direction
Definition ep.hpp:30
@ BOTH
双向(可配置为 IN/OUT) / Both (configurable as IN/OUT)
@ IN
输入方向 / IN direction
@ OUT
输出方向 / OUT direction
static constexpr uint8_t EPNumberToAddr(EPNumber ep, Direction dir)
端点号转换为端点地址 / Convert endpoint number to endpoint address
Definition ep.hpp:104
Direction GetDirection() const
获取当前端点方向 / Get current endpoint direction
Definition ep.hpp:181
virtual ~Endpoint()=default
虚析构函数 / Virtual destructor
bool UseDoubleBuffer() const
是否启用双缓冲 / Whether double buffer is enabled
Definition ep.hpp:239
static constexpr EPNumber AddrToEPNumber(uint8_t addr, Direction &dir)
端点地址转换为端点号 / Convert endpoint address to endpoint number
Definition ep.hpp:116
State state_
当前状态 / Current state
Definition ep.hpp:544
virtual ErrorCode TransferMultiBulk(RawData &data)
Bulk 多包传输辅助接口 / Helper for multi-packet bulk transfer.
Definition ep.hpp:320
virtual void SwitchBuffer()
切换双缓冲 / Switch double buffer
Definition ep.hpp:520
Config & GetConfig()
获取当前配置引用 / Get endpoint config reference
Definition ep.hpp:515
void SetActiveLength(uint16_t len)
设置当前活动缓冲区有效长度 / Set active buffer valid length
Definition ep.hpp:270
void OnTransferCompleteCallback(bool in_isr, size_t actual_transfer_size)
由底层在传输完成时调用 / Called by low-level driver when transfer completes
Definition ep.hpp:392
EPNumber number_
端点号 / Endpoint number
Definition ep.hpp:541
virtual ErrorCode ClearStall()=0
清除 STALL / Clear stall
virtual size_t MaxTransferSize() const
返回当前最大可传输字节数 / Return maximum transferable size at this time
Definition ep.hpp:282
LibXR::RawData buffer_
端点缓冲区 / Endpoint buffer
Definition ep.hpp:545
void SetOnTransferCompleteCallback(Callback< ConstRawData & > cb)
设置传输完成回调 / Set transfer complete callback
Definition ep.hpp:261
static constexpr EPNumber NextEPNumber(EPNumber ep)
获取下一个端点号 / Get the next endpoint number
Definition ep.hpp:127
bool multi_bulk_
多包 bulk 状态机使能 / Multi-bulk state enabled
Definition ep.hpp:548
LibXR::Callback< LibXR::ConstRawData & > on_transfer_complete_
传输完成回调 / Transfer complete callback
Definition ep.hpp:539
virtual void Configure(const Config &cfg)=0
配置端点协议参数 / Configure endpoint protocol parameters
Type
端点类型 Endpoint type
Definition ep.hpp:68
@ ISOCHRONOUS
等时端点 / Isochronous
@ BULK
批量端点 / Bulk
@ INTERRUPT
中断端点 / Interrupt
@ CONTROL
控制端点 / Control
EPNumber GetNumber() const
获取端点号 / Get endpoint number
Definition ep.hpp:169
virtual void Close()=0
关闭端点 / Close endpoint
size_t GetActiveLength()
获取当前活动缓冲区有效长度 / Get active buffer valid length
Definition ep.hpp:276
uint16_t MaxPacketSize() const
获取最大包长 / Get max packet size
Definition ep.hpp:225
State
端点状态 Endpoint state
Definition ep.hpp:80
@ DISABLED
禁用 / Disabled
@ STALLED
停止/挂起 / Stalled
virtual void SetActiveBlock(bool active_block)
设置当前活动缓冲块 / Set active buffer block
Definition ep.hpp:531
void SetState(State state)
设置端点状态 / Set endpoint state
Definition ep.hpp:213
State GetState() const
获取端点状态 / Get endpoint state
Definition ep.hpp:207
virtual ErrorCode TransferZLP()
发送/接收 ZLP(零长度包) / Transfer zero length packet (ZLP)
Definition ep.hpp:385
virtual ErrorCode Transfer(size_t size)=0
启动一次传输 / Start a transfer
Config config_
当前配置 / Current configuration
Definition ep.hpp:543
RawData GetBuffer() const
获取当前可用于传输的缓冲区 / Get current transfer buffer
Definition ep.hpp:245
size_t multi_bulk_remain_
多包 bulk 剩余字节数 / Remaining bytes for multi-bulk
Definition ep.hpp:550
端点配置参数 / Endpoint configuration parameters
Definition ep.hpp:138
Type type
端点类型 / Endpoint type
Definition ep.hpp:140
bool double_buffer
是否启用双缓冲 / Enable double buffer
Definition ep.hpp:142
uint8_t mult
多包倍数(高带宽端点) / Multiplier (high-bandwidth)
Definition ep.hpp:143
uint16_t max_packet_size
最大包长 / Max packet size
Definition ep.hpp:141
Direction direction
端点方向 / Endpoint direction
Definition ep.hpp:139