Skip to content

Commit 4eb3bc1

Browse files
committed
docs: release v1.6.1
Signed-off-by: sakumisu <1203593632@qq.com>
1 parent 1a885c7 commit 4eb3bc1

14 files changed

Lines changed: 106 additions & 74 deletions

File tree

CMakeLists.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ if(BL_SDK_BASE)
1010
set(CONFIG_CHERRYUSB_DEVICE_MSC 1)
1111
set(CONFIG_CHERRYUSB_DEVICE_AUDIO 1)
1212
set(CONFIG_CHERRYUSB_DEVICE_VIDEO 1)
13+
set(CONFIG_CHERRYUSB_DEVICE_DFU 1)
1314
set(CONFIG_CHERRYUSB_DEVICE_GAMEPAD 1)
1415

1516
set(CONFIG_CHERRYUSB_HOST_CDC_ACM 1)
@@ -183,6 +184,7 @@ elseif(HPM_SDK_BASE)
183184
set(CONFIG_CHERRYUSB_DEVICE_MSC 1)
184185
set(CONFIG_CHERRYUSB_DEVICE_AUDIO 1)
185186
set(CONFIG_CHERRYUSB_DEVICE_VIDEO 1)
187+
set(CONFIG_CHERRYUSB_DEVICE_DFU 1)
186188
set(CONFIG_CHERRYUSB_DEVICE_GAMEPAD 1)
187189

188190
set(CONFIG_CHERRYUSB_HOST_CDC_ACM 1)

Kconfig.rttpkg

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,12 +516,14 @@ if PKG_USING_CHERRYUSB
516516

517517
choice
518518
prompt "Version"
519-
default PKG_USING_CHERRYUSB_V010503
519+
default PKG_USING_CHERRYUSB_V010601
520520
help
521521
Select the package version
522522

523523
config PKG_USING_CHERRYUSB_LATEST_VERSION
524524
bool "latest"
525+
config PKG_USING_CHERRYUSB_V010601
526+
bool "v1.6.1"
525527
config PKG_USING_CHERRYUSB_V010600
526528
bool "v1.6.0"
527529
config PKG_USING_CHERRYUSB_V010503
@@ -543,6 +545,7 @@ if PKG_USING_CHERRYUSB
543545
config PKG_CHERRYUSB_VER
544546
string
545547
default "latest" if PKG_USING_CHERRYUSB_LATEST_VERSION
548+
default "v1.6.1" if PKG_USING_CHERRYUSB_V010601
546549
default "v1.6.0" if PKG_USING_CHERRYUSB_V010600
547550
default "v1.5.3.99" if PKG_USING_CHERRYUSB_V010503
548551
default "v1.5.2" if PKG_USING_CHERRYUSB_V010502

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,18 @@ CherryUSB Device Stack resource usage (GCC 10.2 with -O2, disable log):
8686

8787
| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) |
8888
|:-------------:|:--------------:|:-------------------------:|:-------------:|:----------------:|
89-
|usbd_core.c | ~4500 | (512(default) + 320) * bus | 0 | 0 |
90-
|usbd_cdc_acm.c | ~900 | 0 | 0 | 0 |
91-
|usbd_msc.c | ~5000 | (128 + 512(default)) * bus | 16 * bus | 0 |
92-
|usbd_hid.c | ~300 | 0 | 0 | 0 |
93-
|usbd_audio.c | ~4000 | 0 | 0 | 0 |
94-
|usbd_video.c | ~7000 | 0 | 132 * bus | 0 |
95-
|usbd_rndis.c | ~2500 | 2 * 1580(default)+156+8 | 80 | 0 |
96-
|usbd_cdc_ecm.c | ~900 | 2 * 1514(default)+16 | 42 | 0 |
89+
|usbd_core.c | ~4000 | (512(default) + 320) * bus | 8 | 0 |
90+
|usbd_cdc_acm.c | ~400 | 0 | 0 | 0 |
91+
|usbd_msc.c | ~3200 | (128 + 512(default)) * bus | 16 * bus | 0 |
92+
|usbd_hid.c | ~200 | 0 | 0 | 0 |
93+
|usbd_audio.c | ~1300 | 0 | 8 * bus | 0 |
94+
|usbd_video.c | ~2500 | 0 | 124 * bus | 0 |
95+
|usbd_rndis.c | ~2000 | 2 * 1580(default)+156+8 | 76 | 0 |
96+
|usbd_cdc_ecm.c | ~1500 | 2 * 1514(default)+16 | 42 | 0 |
9797
|usbd_mtp.c | ~9000 | 2048(default)+128 | sizeof(struct mtp_object) * n| 0 |
98-
|usbd_dfu.c | ~2200 | 0 | 45 | 0 |
98+
|usbd_dfu.c | ~800 | 0 | 1 | 0 |
99+
100+
![usbdevice_usage](docs/assets/usbdevice_usage.png)
99101

100102
## Host Stack Overview
101103

@@ -128,19 +130,27 @@ CherryUSB Host Stack resource usage (GCC 10.2 with -O2, disable log):
128130

129131
| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) |
130132
|:-------------:|:--------------:|:-------------------------------:|:---------------------------:|:------------:|
131-
|usbh_core.c | ~4500 | (512(default) + 8 * (1+x) *n) * bus | sizeof(struct usbh_hub) * bus | raw_config_desc |
132-
|usbh_hub.c | ~3500 | (32 + 4 * (1+x)) * bus | 12 + sizeof(struct usbh_hub) * x | 0 |
133-
|usbh_cdc_acm.c | ~600 | 7 * x | 4 + sizeof(struct usbh_cdc_acm) * x | 0 |
134-
|usbh_msc.c | ~2000 | 128 * x | 4 + sizeof(struct usbh_msc) * x | 0 |
135-
|usbh_hid.c | ~800 | 64 * x | 4 + sizeof(struct usbh_hid) * x | 0 |
136-
|usbh_video.c | ~5000 | 128 * x | 4 + sizeof(struct usbh_video) * x | 0 |
137-
|usbh_audio.c | ~4000 | 128 * x | 4 + sizeof(struct usbh_audio) * x | 0 |
133+
|usbh_core.c | ~4000 | (512(default) + 8 * (1+x) *n) * bus | sizeof(struct usbh_hub) * bus | raw_config_desc |
134+
|usbh_hub.c | ~3000 | (32 + 4 * (1+x)) * bus | 12 + sizeof(struct usbh_hub) * x | 0 |
135+
|usbh_msc.c | ~1500 | 128 * x | 4 + sizeof(struct usbh_msc) * x | 0 |
136+
|usbh_hid.c | ~2000 | 64 * x | 4 + sizeof(struct usbh_hid) * x | 0 |
137+
|usbh_video.c | ~2500 | 128 * x | 4 + sizeof(struct usbh_video) * x | 0 |
138+
|usbh_audio.c | ~3000 | 128 * x | 4 + sizeof(struct usbh_audio) * x | 0 |
138139
|usbh_rndis.c | ~3000 | 512 + 2 * 2048(default)| sizeof(struct usbh_rndis) * 1 | 0 |
139140
|usbh_cdc_ecm.c | ~1500 | 2 * 1514 + 16 | sizeof(struct usbh_cdc_ecm) * 1 | 0 |
140141
|usbh_cdc_ncm.c | ~2000 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_cdc_ncm) * 1| 0 |
141142
|usbh_bluetooth.c | ~1000 | 2 * 2048(default) | sizeof(struct usbh_bluetooth) * 1 | 0 |
142-
|usbh_asix.c | ~7000 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_asix) * 1 | 0 |
143-
|usbh_rtl8152.c | ~9000 | 16K+ 2K(default) + 2 + 32 | sizeof(struct usbh_rtl8152) * 1 | 0 |
143+
|usbh_asix.c | ~3500 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_asix) * 1 | 0 |
144+
|usbh_rtl8152.c | ~5500 | 16K+ 2K(default) + 2 + 32 | sizeof(struct usbh_rtl8152) * 1 | 0 |
145+
|usbh_serial.c | ~3000 | (512 * 2 + 32 * 2) * x | sizeof(struct usbh_serial) * x (2048 default) | 0 |
146+
|usbh_cdc_acm.c | ~1000 | 0 | 0 | 0 |
147+
|usbh_ch340.c | ~1200 | 0 | 0 | 0 |
148+
|usbh_ftdi.c | ~1200 | 0 | 0 | 0 |
149+
|usbh_cp2102.c | ~2200 | 0 | 0 | 0 |
150+
|usbh_pl2303.c | ~2500 | 0 | 0 | 0 |
151+
|usbh_gsm.c | ~300 | 0 | 0 | 0 |
152+
153+
![usbhost_usage](docs/assets/usbhost_usage.png)
144154

145155
Among them, `sizeof(struct usbh_hub)` and `sizeof(struct usbh_hubport)` are affected by the following macros:
146156

README_zh.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,16 @@ CherryUSB Device 协议栈资源占用说明(GCC 10.2 with -O2):
8686

8787
| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) |
8888
|:-------------:|:--------------:|:-------------------------:|:-------------:|:----------------:|
89-
|usbd_core.c | ~4500 | (512(default) + 320) * bus | 0 | 0 |
90-
|usbd_cdc_acm.c | ~900 | 0 | 0 | 0 |
91-
|usbd_msc.c | ~5000 | (128 + 512(default)) * bus | 16 * bus | 0 |
92-
|usbd_hid.c | ~300 | 0 | 0 | 0 |
93-
|usbd_audio.c | ~4000 | 0 | 0 | 0 |
94-
|usbd_video.c | ~7000 | 0 | 132 * bus | 0 |
95-
|usbd_rndis.c | ~2500 | 2 * 1580(default)+156+8 | 80 | 0 |
96-
|usbd_cdc_ecm.c | ~900 | 2 * 1514(default)+16 | 42 | 0 |
89+
|usbd_core.c | ~4000 | (512(default) + 320) * bus | 8 | 0 |
90+
|usbd_cdc_acm.c | ~400 | 0 | 0 | 0 |
91+
|usbd_msc.c | ~3200 | (128 + 512(default)) * bus | 16 * bus | 0 |
92+
|usbd_hid.c | ~200 | 0 | 0 | 0 |
93+
|usbd_audio.c | ~1300 | 0 | 8 * bus | 0 |
94+
|usbd_video.c | ~2500 | 0 | 124 * bus | 0 |
95+
|usbd_rndis.c | ~2000 | 2 * 1580(default)+156+8 | 76 | 0 |
96+
|usbd_cdc_ecm.c | ~1500 | 2 * 1514(default)+16 | 42 | 0 |
9797
|usbd_mtp.c | ~9000 | 2048(default)+128 | sizeof(struct mtp_object) * n| 0 |
98-
|usbd_dfu.c | ~2200 | 0 | 45 | 0 |
98+
|usbd_dfu.c | ~800 | 0 | 1 | 0 |
9999

100100
## Host 协议栈简介
101101

@@ -128,19 +128,25 @@ CherryUSB Host 协议栈资源占用说明(GCC 10.2 with -O2,关闭 log)
128128

129129
| file | FLASH (Byte) | No Cache RAM (Byte) | RAM (Byte) | Heap (Byte) |
130130
|:-------------:|:--------------:|:-------------------------------:|:---------------------------:|:------------:|
131-
|usbh_core.c | ~4500 | (512(default) + 8 * (1+x) *n) * bus | sizeof(struct usbh_hub) * bus | raw_config_desc |
132-
|usbh_hub.c | ~3500 | (32 + 4 * (1+x)) * bus | 12 + sizeof(struct usbh_hub) * x | 0 |
133-
|usbh_cdc_acm.c | ~600 | 7 * x | 4 + sizeof(struct usbh_cdc_acm) * x | 0 |
134-
|usbh_msc.c | ~2000 | 128 * x | 4 + sizeof(struct usbh_msc) * x | 0 |
135-
|usbh_hid.c | ~800 | 64 * x | 4 + sizeof(struct usbh_hid) * x | 0 |
136-
|usbh_video.c | ~5000 | 128 * x | 4 + sizeof(struct usbh_video) * x | 0 |
137-
|usbh_audio.c | ~4000 | 128 * x | 4 + sizeof(struct usbh_audio) * x | 0 |
131+
|usbh_core.c | ~4000 | (512(default) + 8 * (1+x) *n) * bus | sizeof(struct usbh_hub) * bus | raw_config_desc |
132+
|usbh_hub.c | ~3000 | (32 + 4 * (1+x)) * bus | 12 + sizeof(struct usbh_hub) * x | 0 |
133+
|usbh_msc.c | ~1500 | 128 * x | 4 + sizeof(struct usbh_msc) * x | 0 |
134+
|usbh_hid.c | ~2000 | 64 * x | 4 + sizeof(struct usbh_hid) * x | 0 |
135+
|usbh_video.c | ~2500 | 128 * x | 4 + sizeof(struct usbh_video) * x | 0 |
136+
|usbh_audio.c | ~3000 | 128 * x | 4 + sizeof(struct usbh_audio) * x | 0 |
138137
|usbh_rndis.c | ~3000 | 512 + 2 * 2048(default)| sizeof(struct usbh_rndis) * 1 | 0 |
139138
|usbh_cdc_ecm.c | ~1500 | 2 * 1514 + 16 | sizeof(struct usbh_cdc_ecm) * 1 | 0 |
140139
|usbh_cdc_ncm.c | ~2000 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_cdc_ncm) * 1| 0 |
141140
|usbh_bluetooth.c | ~1000 | 2 * 2048(default) | sizeof(struct usbh_bluetooth) * 1 | 0 |
142-
|usbh_asix.c | ~7000 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_asix) * 1 | 0 |
143-
|usbh_rtl8152.c | ~9000 | 16K+ 2K(default) + 2 + 32 | sizeof(struct usbh_rtl8152) * 1 | 0 |
141+
|usbh_asix.c | ~3500 | 2 * 2048(default) + 16 + 32 | sizeof(struct usbh_asix) * 1 | 0 |
142+
|usbh_rtl8152.c | ~5500 | 16K+ 2K(default) + 2 + 32 | sizeof(struct usbh_rtl8152) * 1 | 0 |
143+
|usbh_serial.c | ~3000 | (512 * 2 + 32 * 2) * x | sizeof(struct usbh_serial) * x (2048 default) | 0 |
144+
|usbh_cdc_acm.c | ~1000 | 0 | 0 | 0 |
145+
|usbh_ch340.c | ~1200 | 0 | 0 | 0 |
146+
|usbh_ftdi.c | ~1200 | 0 | 0 | 0 |
147+
|usbh_cp2102.c | ~2200 | 0 | 0 | 0 |
148+
|usbh_pl2303.c | ~2500 | 0 | 0 | 0 |
149+
|usbh_gsm.c | ~300 | 0 | 0 | 0 |
144150

145151
其中,`sizeof(struct usbh_hub)``sizeof(struct usbh_hubport)` 受以下宏影响:
146152

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
VERSION_MAJOR = 1
22
VERSION_MINOR = 6
3-
PATCHLEVEL = 0
3+
PATCHLEVEL = 1
44
VERSION_TWEAK = 0
55
EXTRAVERSION = 0

common/usb_version.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
#undef CHERRYUSB_VERSION_STR
1616
#endif
1717

18-
#define CHERRYUSB_VERSION 0x010600
19-
#define CHERRYUSB_VERSION_STR "v1.6.0"
18+
#define CHERRYUSB_VERSION 0x010601
19+
#define CHERRYUSB_VERSION_STR "v1.6.1"
2020

2121
#endif

docs/assets/usbdevice_usage.png

51.1 KB
Loading

docs/assets/usbhost_usage.png

92.9 KB
Loading

docs/en/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
copyright = '2022 ~ 2026, sakumisu'
77
author = 'sakumisu'
88

9-
release = '1.6.0'
10-
version = '1.6.0'
9+
release = '1.6.1'
10+
version = '1.6.1'
1111

1212
# -- General configuration
1313

docs/zh/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
copyright = '2022 ~ 2026, sakumisu'
77
author = 'sakumisu'
88

9-
release = '1.6.0'
10-
version = '1.6.0'
9+
release = '1.6.1'
10+
version = '1.6.1'
1111

1212
# -- General configuration
1313

0 commit comments

Comments
 (0)