From 7f92e255cf27541f3d673fbd80aededd0f462d00 Mon Sep 17 00:00:00 2001 From: hathach Date: Sun, 19 Apr 2020 14:02:39 +0700 Subject: [PATCH] added TODO item for changelog - rewrite changelog it better later on - simplify the issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 27 ++++++++--------------- .github/ISSUE_TEMPLATE/feature_request.md | 13 ++--------- .github/ISSUE_TEMPLATE/porting.md | 8 +------ .github/ISSUE_TEMPLATE/question.md | 2 +- README.md | 4 ++-- changelog.md | 20 +++++++++++++++-- 6 files changed, 33 insertions(+), 41 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 97903dc36..c4d2757d2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,26 +7,17 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +**Set up (mandatory):** +Provide details of your setup help us to reproduce the issue as quick as possible + - **PC OS** : Ubuntu 18.04 / Windows 10/ macOS 10.15 + - **Board** : Feather nRF52840 Express + - **Firmware**: examples/device/cdc_msc -**Set up (please complete the following information):** - - OS: [e.g. Ubuntu 18.04] - - Board: [e.g pca10056] - - Firmware Code: [e.g examples/device/cdc_msc_hid] +**Bug Description** +Describe what the bug is. -**To Reproduce** +**Reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. +3. See error diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e74cb57fa..cb211eeb4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,5 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. +**Feature Description** +Describe your feature diff --git a/.github/ISSUE_TEMPLATE/porting.md b/.github/ISSUE_TEMPLATE/porting.md index fc2b2b8d8..9e4097ac2 100644 --- a/.github/ISSUE_TEMPLATE/porting.md +++ b/.github/ISSUE_TEMPLATE/porting.md @@ -7,11 +7,5 @@ assignees: '' --- -**Porting layer** - - [ ] Device Controller Driver (DCD) - - [ ] Host Controller Driver (HCD) - - [ ] Board Supported Package (BSP) - - [ ] OS Abstraction Layer (OSAL) - **Description** -A clear and concise description of what you want to happen. +Describe which API you want to port (DCD/HCD/OSAL/BSP). It is also helpful to go through [porting.md](docs/porting.md) first if you haven't yet. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 1de8fb9a4..3a9fd205c 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -7,4 +7,4 @@ assignees: '' --- -**Here is my question** +**Question Description** diff --git a/README.md b/README.md index 86fd0d800..a8a533fd4 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ The stack supports the following MCUs: - **Espressif:** ESP32-S2 - **MicroChip:** SAMD21, SAMD51 (device only) -- **NordicSemi:** nRF52840, nRF52833 +- **NordicSemi:** nRF52833, nRF52840 - **Nuvoton:** NUC120, NUC121/NUC125, NUC126, NUC505 - **NXP:** - LPC Series: 11Uxx, 13xx, 175x_6x, 177x_8x, 18xx, 40xx, 43xx, 51Uxx, 54xxx, 55xx @@ -52,7 +52,7 @@ Supports multiple device configurations by dynamically changing usb descriptors. - Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ... - Mass Storage Class (MSC): with multiple LUNs - Musical Instrument Digital Interface (MIDI) -- Network with RNDIS, CDC-ECM, CDC-EEM (work in progress) +- Network with RNDIS, CDC-ECM (work in progress) - USB Test and Measurement Class (USBTMC) - Vendor-specific class support with generic In & Out endpoints. Can be used with MS OS 2.0 compatible descriptor to load winUSB driver without INF file. - [WebUSB](https://github.com/WICG/webusb) with vendor-specific class diff --git a/changelog.md b/changelog.md index 59af2ea74..a71a986f2 100644 --- a/changelog.md +++ b/changelog.md @@ -5,18 +5,34 @@ ### Breaking - TinyUSB does not directly implement USB IRQ Handler function anymore. Application must implement IRQ Handler and invoke `tud_int_handler(rhport)`. This is due to: - - IRQ Handler name can be different across system depending on the startup - Some OS need to execute enterISR()/exitISR() to work properly, also tracing tool may need to insert trace ISR enter/exit to record usb event - Give application full control of IRQ handler, can be useful e.g signaling there is new usb event without constant polling ### MCU +- Added support for Espressif ESP32-S2 and saola-1 board - All default IRQ Handler is renamed to `dcd_int_handler()` +- STM32 Synopsys + - Bus events disconnection/suspend/resume are supported +- Added `dcd_connect()` and `dcd_disconnect()` to enable/disable internal pullup on D+/D- on supported MCUs. +- Added `dcd_edpt_close()` for STM32 FSDev + +### Device Stack + +- tud_cdc_n_write_flush() return number of bytes forced to transfer instead of bool +- Support multiple configuration descriptors. `TUD_CONFIG_DESCRIPTOR()` template has extra config_num as 1st argument +- Improve class driver management + - Driver detection is done by open() API + - IAD is handled to assign driver id +- Improve Alternate Interface request with `SET_INTERFACE()` (not fully supported yet). +- Fixed CDC ZLP response #260 +- Remove ACM-EEM due to lack of support from host ### Others -- tud_cdc_n_write_flush() return number of bytes forced to transfer instead of bool +- Added OPT_OS_CUMSTOM as hook for application to overwrite and/or add their own OS implementation +- Enhanced `net_lwip_webserver` example with multiple configuration: RNDIS for Windows, CDC-ECM for macOS (Linux will work with both) ## 0.6.0 - 2019.03.30