diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/conf.py | 4 | ||||
| -rw-r--r-- | docs/source/quick_start/demo.rst | 47 | ||||
| -rw-r--r-- | docs/source/version.rst | 16 |
3 files changed, 43 insertions, 24 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 12d2b45f..7e783e04 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,8 +6,8 @@ project = 'CherryUSB' copyright = '2022 ~ 2025, sakumisu' author = 'sakumisu' -release = '1.5.1' -version = '1.5.1' +release = '1.5.2' +version = '1.5.2' # -- General configuration diff --git a/docs/source/quick_start/demo.rst b/docs/source/quick_start/demo.rst index 48338aad..b53baa38 100644 --- a/docs/source/quick_start/demo.rst +++ b/docs/source/quick_start/demo.rst @@ -4,24 +4,24 @@ 在学习 USB 或者是学习 CherryUSB 代码之前，我们需要先基于现有的 demo 进行快速验证，为什么？是为了提升对 USB 的兴趣，能有信心进行下一步的动作，如果 demo 都跑不起来，或者自己摸索写代码，或者先看 USB 基本概念，结果看到最后， 发现一点都看不懂，概念好多，根本记不住，从而丧失对 USB 的兴趣。因此，先跑 demo 非常重要。下面我将给大家罗列目前支持的 demo 仓库。 -基于 bouffalolab 系列芯片 ---------------------------- +基于 bouffalolab 系列芯片（官方 SDK 支持） +------------------------------------------ 仓库参考：https://github.com/CherryUSB/cherryusb_bouffalolab - BL616/BL808：USB2.0 内置 HS phy 芯片，支持主从机。device 支持 5 个端点（包括端点0），不支持双向同时使用。 - USB 的相关应用位于 `examples/usbdev` 和 `examples/usbhost` 目录下，根据官方环境搭建完成后，即可编译使用。 -基于 HPMicro 系列芯片 ---------------------------- +基于 HPMicro 系列芯片（官方 SDK 支持） +----------------------------------------------------- 仓库参考：https://github.com/CherryUSB/cherryusb_hpmicro - HPM 系列: USB2.0 内置 HS phy 芯片，支持主从机。device 支持 8/16 端点（包括端点0），并且可以同时使用双向，不同芯片个数有差异。 - USB 的相关应用位于 `samples/cherryusb` ，根据官方环境搭建完成后，即可编译使用。 -基于 esp32s2/s3/p4 系列芯片 ---------------------------- +基于 esp32s2/s3/p4 系列芯片（官方 SDK 即将支持） +------------------------------------------------- 仓库参考：https://github.com/CherryUSB/cherryusb_esp32 @@ -29,42 +29,47 @@ - esp32p4：一个 USB2.0 内置全速 PHY 芯片，一个 USB2.0 内置高速 PHY 芯片，支持主从机。 - 默认 demo 采用组件库安装的形式，在 https://components.espressif.com/ 中搜索 cherryusb 即可 -基于飞腾派系列芯片 ---------------------------- +基于飞腾派系列芯片（官方 SDK 支持） +----------------------------------- 仓库参考：https://gitee.com/phytium_embedded/phytium-free-rtos-sdk - 飞腾派支持两个 USB3.0 主机（采用 XHCI）， 两个 USB2.0 主从机 - USB 的相关应用位于 `example/peripheral/usb` ，根据官方环境搭建完成后，即可编译使用。 -基于 Essemi 系列芯片 ---------------------------- +基于 Essemi 系列芯片（官方 SDK 支持） +----------------------------------------- 仓库参考：https://github.com/CherryUSB/cherryusb_es32 - 支持全速和高速主从机。device 支持 6 个端点（包括端点0），并且可以同时使用双向。 -基于 NXP MCX系列芯片 ---------------------------- - -仓库参考：https://github.com/CherryUSB/cherryusb_mcx 或者 https://github.com/RT-Thread/rt-thread/tree/master/bsp/nxp/mcx - -- 支持全速 IP 和高速 IP， 高速 IP 支持主机和从机。device 支持 8 个端点（包括端点0），并且可以同时使用双向。 - -基于 Artinchip 系列芯片 ---------------------------- +基于 Artinchip 系列芯片（官方 SDK 支持） +----------------------------------------------- 仓库参考：https://gitee.com/artinchip/luban-lite - 支持全速和高速主从机，主机采用 EHCI + OHCI。device 支持 8 个端点（包括端点0），并且可以同时使用双向。 -基于 canmv-k230 芯片 ---------------------------- +基于 canmv-k230 芯片（官方 SDK 支持） +--------------------------------------------- 仓库参考：https://github.com/CherryUSB/k230_sdk - K230: 两个 USB2.0 内置 HS PHY 芯片，支持主从机。device 支持 16 个端点（包括端点0），并且可以同时使用双向。 +基于 NXP MCX系列芯片 +--------------------------- + +仓库参考：https://github.com/CherryUSB/cherryusb_mcx 或者 https://github.com/RT-Thread/rt-thread/tree/master/bsp/nxp/mcx + +- 支持全速 IP 和高速 IP， 高速 IP 支持主机和从机。device 支持 8 个端点（包括端点0），并且可以同时使用双向。 + +基于 RP2040/RP2035 芯片（官方 SDK 即将支持） +-------------------------------------------- + +仓库参考： https://github.com/CherryUSB/pico-examples 和 https://github.com/CherryUSB/pico-sdk + 基于 ST 系列芯片 --------------------------- diff --git a/docs/source/version.rst b/docs/source/version.rst index 6c967e1c..409a7658 100644 --- a/docs/source/version.rst +++ b/docs/source/version.rst @@ -134,4 +134,18 @@ v1.5.1 - **dwc2 增加多个 usbport 不同参数的配置功能，比如一个全速一个高速，fifo配置和phy配置不同** - **ehci 在控制传输中如果没有 nodata 阶段会导致 data qtd 未释放，导致内存泄漏** - **dwc2 读取 setup 使用 usbd_get_next_ep0_state 去判断，避免 setup 和 ep0 out 使用在 USB_OTG_DOEPINT_XFRC 状态下冲突** -- sifli usb device 初步支持
\ No newline at end of file +- sifli usb device 初步支持 + +v1.5.2 +---------------------- + +- 对 1.5.1 下 rt-thread 组件的一些 bugfix +- idf timer osal 替换为 esp timer，freertos timer会有启动失败的可能性；xTaskCreate 使用 xTaskCreatePinnedToCore 替换，方便多核使用 +- 主机枚举中，删除描述符溢出相关的 ASSERT 操作，改成返回错误。获取字符串描述符改成支持才获取。2 ms 延时改成 10ms，因为一些 os 使用的是 100hz，会造成延时失效 +- **dwc2 ep mult 支持，split 传输代码优化，对 split 相关的 cache 处理修改** +- **dwc2 halt 中不能清除 USB_OTG_HCCHAR_EPDIR，reset port 中使用超时机制，防止在枚举时由于拔出而造成死等** +- 更新 DWC2 中 at32，stm32，kendryte，espressif glue 代码 +- musb 对于标准的 IP 结构采用独立 EP 控制寄存器组，不使用 EPIDX 寄存器去控制 +- 删除所有 CONFIG_USBDEV_EP_NUM & CONFIG_USBHOST_PIPE_NUM，不再使用，因为 IP 本身会携带这些信息，或者厂家 SDK 提供了对应的宏 +- CONFIG_USBHOST_MAX_INTF_ALTSETTINGS 默认使用 2 减少内存，只有 UVC 和UAC 使用（商业收费），所以不需要开很大 +- urb interval 从 u8 改 u32，最大支持 2^15 * 125us
\ No newline at end of file |