Răsfoiți Sursa

added TODO item for changelog

- rewrite changelog it better later on
- simplify the issue template
hathach 5 ani în urmă
părinte
comite
7f92e255cf

+ 9 - 18
.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:
 Steps to reproduce the behavior:
 1. Go to '...'
 1. Go to '...'
 2. Click on '....'
 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

+ 2 - 11
.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

+ 1 - 7
.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**
 **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.

+ 1 - 1
.github/ISSUE_TEMPLATE/question.md

@@ -7,4 +7,4 @@ assignees: ''
 
 
 ---
 ---
 
 
-**Here is my question**
+**Question Description**

+ 2 - 2
README.md

@@ -32,7 +32,7 @@ The stack supports the following MCUs:
 
 
 - **Espressif:** ESP32-S2
 - **Espressif:** ESP32-S2
 - **MicroChip:** SAMD21, SAMD51 (device only)
 - **MicroChip:** SAMD21, SAMD51 (device only)
-- **NordicSemi:** nRF52840, nRF52833
+- **NordicSemi:** nRF52833, nRF52840
 - **Nuvoton:** NUC120, NUC121/NUC125, NUC126, NUC505
 - **Nuvoton:** NUC120, NUC121/NUC125, NUC126, NUC505
 - **NXP:** 
 - **NXP:** 
   - LPC Series: 11Uxx, 13xx, 175x_6x, 177x_8x, 18xx, 40xx, 43xx, 51Uxx, 54xxx, 55xx
   - 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 ...
 - Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ...
 - Mass Storage Class (MSC): with multiple LUNs
 - Mass Storage Class (MSC): with multiple LUNs
 - Musical Instrument Digital Interface (MIDI)
 - 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)
 - 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.
 - 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
 - [WebUSB](https://github.com/WICG/webusb) with vendor-specific class

+ 18 - 2
changelog.md

@@ -5,18 +5,34 @@
 ### Breaking
 ### 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:
 - 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
   - 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
   - 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
   - Give application full control of IRQ handler, can be useful e.g signaling there is new usb event without constant polling
 
 
 ### MCU
 ### MCU
 
 
+- Added support for Espressif ESP32-S2 and saola-1 board
 - All default IRQ Handler is renamed to `dcd_int_handler()`
 - 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
 ### 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
 ## 0.6.0 - 2019.03.30