From ec4ecfa817d6af9d35cf814d6d8d57e8bf71c605 Mon Sep 17 00:00:00 2001 From: Sylvain Munaut Date: Thu, 24 Oct 2019 00:42:42 +0200 Subject: Add support for DFU Runtime class for devices This is really just a few descriptors and then answering to the request from the host to reboot into DFU mode. That latter part is delegated to the app since this is platform specific. Signed-off-by: Sylvain Munaut --- src/class/dfu/dfu_rt_device.c | 120 ++++++++++++++++++++++++++++++++++++++++++ src/class/dfu/dfu_rt_device.h | 77 +++++++++++++++++++++++++++ src/common/tusb_types.h | 2 + src/device/usbd.c | 14 +++++ src/device/usbd.h | 15 ++++++ src/tusb.h | 4 ++ src/tusb_option.h | 4 ++ 7 files changed, 236 insertions(+) create mode 100644 src/class/dfu/dfu_rt_device.c create mode 100644 src/class/dfu/dfu_rt_device.h (limited to 'src') diff --git a/src/class/dfu/dfu_rt_device.c b/src/class/dfu/dfu_rt_device.c new file mode 100644 index 000000000..59adae7ef --- /dev/null +++ b/src/class/dfu/dfu_rt_device.c @@ -0,0 +1,120 @@ +/* + * The MIT License (MIT) + * + * Copyright (c) 2019 Sylvain Munaut + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + * This file is part of the TinyUSB stack. + */ + +#include "tusb_option.h" + +#if (TUSB_OPT_DEVICE_ENABLED && CFG_TUD_DFU_RT) + +#include "dfu_rt_device.h" +#include "device/usbd_pvt.h" + +//--------------------------------------------------------------------+ +// MACRO CONSTANT TYPEDEF +//--------------------------------------------------------------------+ +typedef enum { + DFU_REQUEST_DETACH = 0, + DFU_REQUEST_DNLOAD = 1, + DFU_REQUEST_UPLOAD = 2, + DFU_REQUEST_GETSTATUS = 3, + DFU_REQUEST_CLRSTATUS = 4, + DFU_REQUEST_GETSTATE = 5, + DFU_REQUEST_ABORT = 6, +} dfu_requests_t; + +//--------------------------------------------------------------------+ +// USBD Driver API +//--------------------------------------------------------------------+ +void dfu_rtd_init(void) +{ +} + +void dfu_rtd_reset(uint8_t rhport) +{ + (void) rhport; +} + +bool dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t *p_length) +{ + (void) rhport; + + // Ensure this is DFU Runtime + TU_ASSERT(itf_desc->bInterfaceSubClass == TUD_DFU_APP_SUBCLASS); + TU_ASSERT(itf_desc->bInterfaceProtocol == DFU_PROTOCOL_RT); + + uint8_t const * p_desc = tu_desc_next( itf_desc ); + (*p_length) = sizeof(tusb_desc_interface_t); + + if ( TUSB_DESC_FUNCTIONAL == tu_desc_type(p_desc) ) + { + (*p_length) += p_desc[DESC_OFFSET_LEN]; + p_desc = tu_desc_next(p_desc); + } + + return true; +} + +bool dfu_rtd_control_complete(uint8_t rhport, tusb_control_request_t const * request) +{ + (void) rhport; + + //------------- Class Specific Request -------------// + TU_VERIFY(request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS); + TU_VERIFY(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_INTERFACE); + + return true; +} + +bool dfu_rtd_control_request(uint8_t rhport, tusb_control_request_t const * request) +{ + (void) rhport; + + //------------- Class Specific Request -------------// + TU_ASSERT(request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS); + TU_ASSERT(request->bmRequestType_bit.recipient == TUSB_REQ_RCPT_INTERFACE); + + switch ( request->bRequest ) + { + case DFU_REQUEST_DETACH: + tud_control_status(rhport, request); + tud_dfu_rt_reboot_to_dfu(); + break; + + default: return false; // stall unsupported request + } + + return true; +} + +bool dfu_rtd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) +{ + (void) rhport; + (void) ep_addr; + (void) result; + (void) xferred_bytes; + return true; +} + +#endif diff --git a/src/class/dfu/dfu_rt_device.h b/src/class/dfu/dfu_rt_device.h new file mode 100644 index 000000000..4348a0f3a --- /dev/null +++ b/src/class/dfu/dfu_rt_device.h @@ -0,0 +1,77 @@ +/* + * The MIT License (MIT) + * + * Copyright (c) 2019 Sylvain Munaut + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + * This file is part of the TinyUSB stack. + */ + +#ifndef _TUSB_DFU_RT_DEVICE_H_ +#define _TUSB_DFU_RT_DEVICE_H_ + +#include "common/tusb_common.h" +#include "device/usbd.h" + +#ifdef __cplusplus + extern "C" { +#endif + + +//--------------------------------------------------------------------+ +// Common Definitions +//--------------------------------------------------------------------+ + +// DFU Protocol +typedef enum +{ + DFU_PROTOCOL_RT = 1, + DFU_PROTOCOL_DFU = 2, +} dfu_protocol_type_t; + +// DFU Descriptor Type +typedef enum +{ + DFU_DESC_FUNCTIONAL = 0x21, +} dfu_descriptor_type_t; + + +//--------------------------------------------------------------------+ +// Application Callback API (weak is optional) +//--------------------------------------------------------------------+ + +// Invoked when received new data +TU_ATTR_WEAK void tud_dfu_rt_reboot_to_dfu(void); + +//--------------------------------------------------------------------+ +// Internal Class Driver API +//--------------------------------------------------------------------+ +void dfu_rtd_init(void); +void dfu_rtd_reset(uint8_t rhport); +bool dfu_rtd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t *p_length); +bool dfu_rtd_control_request(uint8_t rhport, tusb_control_request_t const * request); +bool dfu_rtd_control_complete(uint8_t rhport, tusb_control_request_t const * request); +bool dfu_rtd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes); + +#ifdef __cplusplus + } +#endif + +#endif /* _TUSB_DFU_RT_DEVICE_H_ */ diff --git a/src/common/tusb_types.h b/src/common/tusb_types.h index ad42baad7..737b17f76 100644 --- a/src/common/tusb_types.h +++ b/src/common/tusb_types.h @@ -86,6 +86,8 @@ typedef enum TUSB_DESC_BOS = 0x0F, TUSB_DESC_DEVICE_CAPABILITY = 0x10, + TUSB_DESC_FUNCTIONAL = 0x21, + // Class Specific Descriptor TUSB_DESC_CS_DEVICE = 0x21, TUSB_DESC_CS_CONFIGURATION = 0x22, diff --git a/src/device/usbd.c b/src/device/usbd.c index 14e56a9b7..49f28da87 100644 --- a/src/device/usbd.c +++ b/src/device/usbd.c @@ -167,6 +167,20 @@ static usbd_class_driver_t const usbd_class_drivers[] = .sof = NULL }, #endif + + #if CFG_TUD_DFU_RT + { + .class_code = TUD_DFU_APP_CLASS, + //.subclass_code = TUD_DFU_APP_SUBCLASS + .init = dfu_rtd_init, + .reset = dfu_rtd_reset, + .open = dfu_rtd_open, + .control_request = dfu_rtd_control_request, + .control_complete = dfu_rtd_control_complete, + .xfer_cb = dfu_rtd_xfer_cb, + .sof = NULL + }, + #endif }; enum { USBD_CLASS_DRIVER_COUNT = TU_ARRAY_SIZE(usbd_class_drivers) }; diff --git a/src/device/usbd.h b/src/device/usbd.h index f0887f0db..0ad126e94 100644 --- a/src/device/usbd.h +++ b/src/device/usbd.h @@ -304,6 +304,21 @@ TU_ATTR_WEAK bool tud_vendor_control_complete_cb(uint8_t rhport, tusb_control_re /* Endpoint In */\ 7, TUSB_DESC_ENDPOINT, _epin, TUSB_XFER_BULK, U16_TO_U8S_LE(_epsize), 0 +//------------- DFU Runtime -------------// +#define TUD_DFU_APP_CLASS (TUSB_CLASS_APPLICATION_SPECIFIC) +#define TUD_DFU_APP_SUBCLASS 0x01u + +// Length of template descriptr: 18 bytes +#define TUD_DFU_RT_DESC_LEN (9 + 9) + +// DFU runtime descriptor +// Interface number, string index, attributes, detach timeout, transfer size +#define TUD_DFU_RT_DESCRIPTOR(_itfnum, _stridx, _attr, _timeout, _xfer_size) \ + /* Interface */ \ + 9, TUSB_DESC_INTERFACE, _itfnum, 0, 0, TUD_DFU_APP_CLASS, TUD_DFU_APP_SUBCLASS, DFU_PROTOCOL_RT, _stridx, \ + /* Function */ \ + 9, DFU_DESC_FUNCTIONAL, _attr, U16_TO_U8S_LE(_timeout), U16_TO_U8S_LE(_xfer_size), U16_TO_U8S_LE(0x0101) + #ifdef __cplusplus } diff --git a/src/tusb.h b/src/tusb.h index 1a6ff0b10..bf4ad5730 100644 --- a/src/tusb.h +++ b/src/tusb.h @@ -87,6 +87,10 @@ #if CFG_TUD_USBTMC #include "class/usbtmc/usbtmc_device.h" #endif + + #if CFG_TUD_DFU_RT + #include "class/dfu/dfu_rt_device.h" + #endif #endif diff --git a/src/tusb_option.h b/src/tusb_option.h index 6178b2cf9..fc509ae76 100644 --- a/src/tusb_option.h +++ b/src/tusb_option.h @@ -188,6 +188,10 @@ #define CFG_TUD_USBTMC 0 #endif +#ifndef CFG_TUD_DFU_RT + #define CFG_TUD_DFU_RT 0 +#endif + //-------------------------------------------------------------------- // HOST OPTIONS -- cgit v1.3.1 From 880ac1e39823f7e17416b882ff57b0899f2e85da Mon Sep 17 00:00:00 2001 From: hathach Date: Wed, 30 Oct 2019 11:35:25 +0700 Subject: move dcd event helper to be dcd.h as inline function --- src/device/dcd.h | 47 +++++++++++++++++++++++++++++++++++++++-------- src/device/usbd.c | 28 ---------------------------- 2 files changed, 39 insertions(+), 36 deletions(-) (limited to 'src') diff --git a/src/device/dcd.h b/src/device/dcd.h index c417ee4be..444b4a6f9 100644 --- a/src/device/dcd.h +++ b/src/device/dcd.h @@ -79,7 +79,7 @@ typedef struct TU_ATTR_ALIGNED(4) }; } dcd_event_t; -TU_VERIFY_STATIC(sizeof(dcd_event_t) <= 12, "size is not correct"); +//TU_VERIFY_STATIC(sizeof(dcd_event_t) <= 12, "size is not correct"); /*------------------------------------------------------------------*/ /* Device API @@ -119,20 +119,51 @@ void dcd_edpt_stall (uint8_t rhport, uint8_t ep_addr); // clear stall, data toggle is also reset to DATA0 void dcd_edpt_clear_stall (uint8_t rhport, uint8_t ep_addr); -/*------------------------------------------------------------------*/ -/* Event Function - * Called by DCD to notify device stack - *------------------------------------------------------------------*/ +//--------------------------------------------------------------------+ +// Event API +//--------------------------------------------------------------------+ + +// Called by DCD to notify device stack void dcd_event_handler(dcd_event_t const * event, bool in_isr); // helper to send bus signal event -void dcd_event_bus_signal (uint8_t rhport, dcd_eventid_t eid, bool in_isr); +static inline void dcd_event_bus_signal (uint8_t rhport, dcd_eventid_t eid, bool in_isr); // helper to send setup received -void dcd_event_setup_received(uint8_t rhport, uint8_t const * setup, bool in_isr); +static inline void dcd_event_setup_received(uint8_t rhport, uint8_t const * setup, bool in_isr); // helper to send transfer complete event -void dcd_event_xfer_complete (uint8_t rhport, uint8_t ep_addr, uint32_t xferred_bytes, uint8_t result, bool in_isr); +static inline void dcd_event_xfer_complete (uint8_t rhport, uint8_t ep_addr, uint32_t xferred_bytes, uint8_t result, bool in_isr); + + +//--------------------------------------------------------------------+ +// Inline helper +//--------------------------------------------------------------------+ + +static inline void dcd_event_bus_signal (uint8_t rhport, dcd_eventid_t eid, bool in_isr) +{ + dcd_event_t event = { .rhport = rhport, .event_id = eid, }; + dcd_event_handler(&event, in_isr); +} + +static inline void dcd_event_setup_received(uint8_t rhport, uint8_t const * setup, bool in_isr) +{ + dcd_event_t event = { .rhport = rhport, .event_id = DCD_EVENT_SETUP_RECEIVED }; + memcpy(&event.setup_received, setup, 8); + + dcd_event_handler(&event, in_isr); +} + +static inline void dcd_event_xfer_complete (uint8_t rhport, uint8_t ep_addr, uint32_t xferred_bytes, uint8_t result, bool in_isr) +{ + dcd_event_t event = { .rhport = rhport, .event_id = DCD_EVENT_XFER_COMPLETE }; + + event.xfer_complete.ep_addr = ep_addr; + event.xfer_complete.len = xferred_bytes; + event.xfer_complete.result = result; + + dcd_event_handler(&event, in_isr); +} #ifdef __cplusplus } diff --git a/src/device/usbd.c b/src/device/usbd.c index f2becab95..3e6bf68c9 100644 --- a/src/device/usbd.c +++ b/src/device/usbd.c @@ -870,34 +870,6 @@ void dcd_event_handler(dcd_event_t const * event, bool in_isr) } } -// helper to send bus signal event -void dcd_event_bus_signal (uint8_t rhport, dcd_eventid_t eid, bool in_isr) -{ - dcd_event_t event = { .rhport = rhport, .event_id = eid, }; - dcd_event_handler(&event, in_isr); -} - -// helper to send setup received -void dcd_event_setup_received(uint8_t rhport, uint8_t const * setup, bool in_isr) -{ - dcd_event_t event = { .rhport = rhport, .event_id = DCD_EVENT_SETUP_RECEIVED }; - memcpy(&event.setup_received, setup, 8); - - dcd_event_handler(&event, in_isr); -} - -// helper to send transfer complete event -void dcd_event_xfer_complete (uint8_t rhport, uint8_t ep_addr, uint32_t xferred_bytes, uint8_t result, bool in_isr) -{ - dcd_event_t event = { .rhport = rhport, .event_id = DCD_EVENT_XFER_COMPLETE }; - - event.xfer_complete.ep_addr = ep_addr; - event.xfer_complete.len = xferred_bytes; - event.xfer_complete.result = result; - - dcd_event_handler(&event, in_isr); -} - //--------------------------------------------------------------------+ // Helper //--------------------------------------------------------------------+ -- cgit v1.3.1 From 16665672a45c4f85cb2e1a47873825f2b48fcf1a Mon Sep 17 00:00:00 2001 From: hathach Date: Wed, 30 Oct 2019 12:24:07 +0700 Subject: initally adding test_usbd.c --- src/device/dcd.h | 2 +- test/project.yml | 5 +-- test/test/support/tusb_config.h | 11 +++---- test/test/test_usbd.c | 68 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 77 insertions(+), 9 deletions(-) create mode 100644 test/test/test_usbd.c (limited to 'src') diff --git a/src/device/dcd.h b/src/device/dcd.h index 444b4a6f9..9fa98c669 100644 --- a/src/device/dcd.h +++ b/src/device/dcd.h @@ -124,7 +124,7 @@ void dcd_edpt_clear_stall (uint8_t rhport, uint8_t ep_addr); //--------------------------------------------------------------------+ // Called by DCD to notify device stack -void dcd_event_handler(dcd_event_t const * event, bool in_isr); +extern void dcd_event_handler(dcd_event_t const * event, bool in_isr); // helper to send bus signal event static inline void dcd_event_bus_signal (uint8_t rhport, dcd_eventid_t eid, bool in_isr); diff --git a/test/project.yml b/test/project.yml index 403aa0119..cf29c3b04 100644 --- a/test/project.yml +++ b/test/project.yml @@ -9,6 +9,7 @@ :use_exceptions: TRUE :use_test_preprocessor: TRUE :use_auxiliary_dependencies: TRUE + :use_deep_dependencies: TRUE :build_root: _build # :release_build: TRUE :test_file_prefix: test_ @@ -41,10 +42,10 @@ :commmon: &common_defines [] :test: - *common_defines - - TEST + - _TEST_ :test_preprocess: - *common_defines - - TEST + - _TEST_ :cmock: :mock_prefix: mock_ diff --git a/test/test/support/tusb_config.h b/test/test/support/tusb_config.h index b82a09a23..bfe5bf9e9 100644 --- a/test/test/support/tusb_config.h +++ b/test/test/support/tusb_config.h @@ -73,12 +73,11 @@ #define CFG_TUD_ENDOINT0_SIZE 64 //------------- CLASS -------------// -#define CFG_TUD_CDC 1 -#define CFG_TUD_MSC 1 -#define CFG_TUD_HID 1 - -#define CFG_TUD_MIDI 1 -#define CFG_TUD_VENDOR 1 +#define CFG_TUD_CDC 0 +#define CFG_TUD_MSC 0 +#define CFG_TUD_HID 0 +#define CFG_TUD_MIDI 0 +#define CFG_TUD_VENDOR 0 //------------- CDC -------------// diff --git a/test/test/test_usbd.c b/test/test/test_usbd.c new file mode 100644 index 000000000..8c29ee853 --- /dev/null +++ b/test/test/test_usbd.c @@ -0,0 +1,68 @@ +/* + * The MIT License (MIT) + * + * Copyright (c) 2019 hathach for Adafruit Industries + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include "unity.h" + +// Files to test +#include "tusb_fifo.h" +#include "tusb.h" +#include "usbd.h" +TEST_FILE("usbd_control.c") + +// Mock File +#include "mock_dcd.h" + +//--------------------------------------------------------------------+ +// MACRO TYPEDEF CONSTANT ENUM DECLARATION +//--------------------------------------------------------------------+ + +uint8_t const * tud_descriptor_device_cb(void) +{ + return NULL; +} + +uint8_t const * tud_descriptor_configuration_cb(uint8_t index) +{ + return NULL; +} + +uint16_t const* tud_descriptor_string_cb(uint8_t index) +{ + return NULL; +} + +//------------- IMPLEMENTATION -------------// +void setUp(void) +{ + +} + +void tearDown(void) +{ +} + +void test_ok(void) +{ + +} -- cgit v1.3.1 From a0002cc709bd39049d3effbe9a59b62dc198f79d Mon Sep 17 00:00:00 2001 From: hathach Date: Wed, 30 Oct 2019 23:26:34 +0700 Subject: rename usbd_init() to tud_init() --- src/device/usbd.c | 2 +- src/device/usbd.h | 3 +++ src/device/usbd_pvt.h | 2 -- src/tusb.c | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/device/usbd.c b/src/device/usbd.c index 3e6bf68c9..62f6e9922 100644 --- a/src/device/usbd.c +++ b/src/device/usbd.c @@ -276,7 +276,7 @@ bool tud_remote_wakeup(void) //--------------------------------------------------------------------+ // USBD Task //--------------------------------------------------------------------+ -bool usbd_init (void) +bool tud_init (void) { TU_LOG2("USBD init\r\n"); diff --git a/src/device/usbd.h b/src/device/usbd.h index f0887f0db..e340215fe 100644 --- a/src/device/usbd.h +++ b/src/device/usbd.h @@ -41,6 +41,9 @@ // Application API //--------------------------------------------------------------------+ +// Init device stack +bool tud_init (void); + // Task function should be called in main/rtos loop void tud_task (void); diff --git a/src/device/usbd_pvt.h b/src/device/usbd_pvt.h index 892680142..b9947044b 100644 --- a/src/device/usbd_pvt.h +++ b/src/device/usbd_pvt.h @@ -33,8 +33,6 @@ extern "C" { #endif -bool usbd_init (void); - //--------------------------------------------------------------------+ // USBD Endpoint API //--------------------------------------------------------------------+ diff --git a/src/tusb.c b/src/tusb.c index 271b35f1e..7a1e73ec7 100644 --- a/src/tusb.c +++ b/src/tusb.c @@ -47,7 +47,7 @@ bool tusb_init(void) #endif #if TUSB_OPT_DEVICE_ENABLED - TU_ASSERT ( usbd_init() ); // init device stack + TU_ASSERT ( tud_init() ); // init device stack #endif _initialized = true; -- cgit v1.3.1 From e6857d8ee087c8185dda2901646fbec1352e2292 Mon Sep 17 00:00:00 2001 From: hathach Date: Thu, 31 Oct 2019 11:25:41 +0700 Subject: clean up --- src/device/usbd_control.c | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/device/usbd_control.c b/src/device/usbd_control.c index e8bb648c9..8b1c92d81 100644 --- a/src/device/usbd_control.c +++ b/src/device/usbd_control.c @@ -45,7 +45,6 @@ typedef struct void* buffer; uint16_t len; uint16_t total_transferred; - uint16_t requested_len; bool (*complete_cb) (uint8_t, tusb_control_request_t const *); } usbd_control_xfer_t; @@ -90,16 +89,10 @@ void usbd_control_set_complete_callback( bool (*fp) (uint8_t, tusb_control_reque bool tud_control_xfer(uint8_t rhport, tusb_control_request_t const * request, void* buffer, uint16_t len) { - // transmitted length must be <= requested length (USB 2.0 spec: 8.5.3.1 ) - // FIXME: Should logic be here or in place that calls this function? - if(len > request->wLength) - len = request->wLength; - _control_state.request = (*request); _control_state.buffer = buffer; _control_state.total_transferred = 0; - _control_state.requested_len = request->wLength; - _control_state.len = len; + _control_state.len = tu_min16(len, request->wLength); if ( len ) { @@ -131,7 +124,7 @@ bool usbd_control_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t result _control_state.total_transferred += xferred_bytes; _control_state.buffer = ((uint8_t*)_control_state.buffer) + xferred_bytes; - if ( (_control_state.requested_len == _control_state.total_transferred) || xferred_bytes < CFG_TUD_ENDPOINT0_SIZE ) + if ( (_control_state.request.wLength == _control_state.total_transferred) || xferred_bytes < CFG_TUD_ENDPOINT0_SIZE ) { // DATA stage is complete -- cgit v1.3.1 From 0029b584177174ba6269a76151b029a03d8c09fc Mon Sep 17 00:00:00 2001 From: hathach Date: Thu, 31 Oct 2019 12:15:16 +0700 Subject: rename --- src/device/usbd_control.c | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) (limited to 'src') diff --git a/src/device/usbd_control.c b/src/device/usbd_control.c index 8b1c92d81..7c970d605 100644 --- a/src/device/usbd_control.c +++ b/src/device/usbd_control.c @@ -49,14 +49,14 @@ typedef struct bool (*complete_cb) (uint8_t, tusb_control_request_t const *); } usbd_control_xfer_t; -static usbd_control_xfer_t _control_state; +static usbd_control_xfer_t _ctrl_xfer; CFG_TUSB_MEM_SECTION CFG_TUSB_MEM_ALIGN uint8_t _usbd_ctrl_buf[CFG_TUD_ENDPOINT0_SIZE]; void usbd_control_reset (uint8_t rhport) { (void) rhport; - tu_varclr(&_control_state); + tu_varclr(&_ctrl_xfer); } bool tud_control_status(uint8_t rhport, tusb_control_request_t const * request) @@ -68,14 +68,14 @@ bool tud_control_status(uint8_t rhport, tusb_control_request_t const * request) // Each transaction is up to endpoint0's max packet size static bool start_control_data_xact(uint8_t rhport) { - uint16_t const xact_len = tu_min16(_control_state.len - _control_state.total_transferred, CFG_TUD_ENDPOINT0_SIZE); + uint16_t const xact_len = tu_min16(_ctrl_xfer.len - _ctrl_xfer.total_transferred, CFG_TUD_ENDPOINT0_SIZE); uint8_t ep_addr = EDPT_CTRL_OUT; - if ( _control_state.request.bmRequestType_bit.direction == TUSB_DIR_IN ) + if ( _ctrl_xfer.request.bmRequestType_bit.direction == TUSB_DIR_IN ) { ep_addr = EDPT_CTRL_IN; - memcpy(_usbd_ctrl_buf, _control_state.buffer, xact_len); + memcpy(_usbd_ctrl_buf, _ctrl_xfer.buffer, xact_len); } return dcd_edpt_xfer(rhport, ep_addr, _usbd_ctrl_buf, xact_len); @@ -84,15 +84,15 @@ static bool start_control_data_xact(uint8_t rhport) // TODO may find a better way void usbd_control_set_complete_callback( bool (*fp) (uint8_t, tusb_control_request_t const * ) ) { - _control_state.complete_cb = fp; + _ctrl_xfer.complete_cb = fp; } bool tud_control_xfer(uint8_t rhport, tusb_control_request_t const * request, void* buffer, uint16_t len) { - _control_state.request = (*request); - _control_state.buffer = buffer; - _control_state.total_transferred = 0; - _control_state.len = tu_min16(len, request->wLength); + _ctrl_xfer.request = (*request); + _ctrl_xfer.buffer = buffer; + _ctrl_xfer.total_transferred = 0; + _ctrl_xfer.len = tu_min16(len, request->wLength); if ( len ) { @@ -115,32 +115,31 @@ bool usbd_control_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t result (void) result; (void) ep_addr; - if ( _control_state.request.bmRequestType_bit.direction == TUSB_DIR_OUT ) + if ( _ctrl_xfer.request.bmRequestType_bit.direction == TUSB_DIR_OUT ) { - TU_VERIFY(_control_state.buffer); - memcpy(_control_state.buffer, _usbd_ctrl_buf, xferred_bytes); + TU_VERIFY(_ctrl_xfer.buffer); + memcpy(_ctrl_xfer.buffer, _usbd_ctrl_buf, xferred_bytes); } - _control_state.total_transferred += xferred_bytes; - _control_state.buffer = ((uint8_t*)_control_state.buffer) + xferred_bytes; - - if ( (_control_state.request.wLength == _control_state.total_transferred) || xferred_bytes < CFG_TUD_ENDPOINT0_SIZE ) + _ctrl_xfer.total_transferred += xferred_bytes; + _ctrl_xfer.buffer = ((uint8_t*)_ctrl_xfer.buffer) + xferred_bytes; + if ( (_ctrl_xfer.request.wLength == _ctrl_xfer.total_transferred) || xferred_bytes < CFG_TUD_ENDPOINT0_SIZE ) { // DATA stage is complete bool is_ok = true; // invoke complete callback if set // callback can still stall control in status phase e.g out data does not make sense - if ( _control_state.complete_cb ) + if ( _ctrl_xfer.complete_cb ) { - is_ok = _control_state.complete_cb(rhport, &_control_state.request); + is_ok = _ctrl_xfer.complete_cb(rhport, &_ctrl_xfer.request); } if ( is_ok ) { // Send status - TU_ASSERT( tud_control_status(rhport, &_control_state.request) ); + TU_ASSERT( tud_control_status(rhport, &_ctrl_xfer.request) ); }else { // Stall both IN and OUT control endpoint -- cgit v1.3.1 From d9ba4d90a8e8e59c111de814acdc7b2cc7ca5bf8 Mon Sep 17 00:00:00 2001 From: hathach Date: Thu, 31 Oct 2019 12:26:36 +0700 Subject: move function around, more rename --- src/device/usbd_control.c | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) (limited to 'src') diff --git a/src/device/usbd_control.c b/src/device/usbd_control.c index 7c970d605..7636f459d 100644 --- a/src/device/usbd_control.c +++ b/src/device/usbd_control.c @@ -53,11 +53,10 @@ static usbd_control_xfer_t _ctrl_xfer; CFG_TUSB_MEM_SECTION CFG_TUSB_MEM_ALIGN uint8_t _usbd_ctrl_buf[CFG_TUD_ENDPOINT0_SIZE]; -void usbd_control_reset (uint8_t rhport) -{ - (void) rhport; - tu_varclr(&_ctrl_xfer); -} + +//--------------------------------------------------------------------+ +// Application API +//--------------------------------------------------------------------+ bool tud_control_status(uint8_t rhport, tusb_control_request_t const * request) { @@ -66,7 +65,7 @@ bool tud_control_status(uint8_t rhport, tusb_control_request_t const * request) } // Each transaction is up to endpoint0's max packet size -static bool start_control_data_xact(uint8_t rhport) +static bool _ctrl_data_xact(uint8_t rhport) { uint16_t const xact_len = tu_min16(_ctrl_xfer.len - _ctrl_xfer.total_transferred, CFG_TUD_ENDPOINT0_SIZE); @@ -81,12 +80,6 @@ static bool start_control_data_xact(uint8_t rhport) return dcd_edpt_xfer(rhport, ep_addr, _usbd_ctrl_buf, xact_len); } -// TODO may find a better way -void usbd_control_set_complete_callback( bool (*fp) (uint8_t, tusb_control_request_t const * ) ) -{ - _ctrl_xfer.complete_cb = fp; -} - bool tud_control_xfer(uint8_t rhport, tusb_control_request_t const * request, void* buffer, uint16_t len) { _ctrl_xfer.request = (*request); @@ -99,7 +92,7 @@ bool tud_control_xfer(uint8_t rhport, tusb_control_request_t const * request, vo TU_ASSERT(buffer); // Data stage - TU_ASSERT( start_control_data_xact(rhport) ); + TU_ASSERT( _ctrl_data_xact(rhport) ); }else { // Status stage @@ -109,6 +102,22 @@ bool tud_control_xfer(uint8_t rhport, tusb_control_request_t const * request, vo return true; } +//--------------------------------------------------------------------+ +// USBD API +//--------------------------------------------------------------------+ + +void usbd_control_reset (uint8_t rhport) +{ + (void) rhport; + tu_varclr(&_ctrl_xfer); +} + +// TODO may find a better way +void usbd_control_set_complete_callback( bool (*fp) (uint8_t, tusb_control_request_t const * ) ) +{ + _ctrl_xfer.complete_cb = fp; +} + // callback when a transaction complete on DATA stage of control endpoint bool usbd_control_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) { @@ -150,7 +159,7 @@ bool usbd_control_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t result else { // More data to transfer - TU_ASSERT( start_control_data_xact(rhport) ); + TU_ASSERT( _ctrl_data_xact(rhport) ); } return true; -- cgit v1.3.1 From 6de9eb4b1a6bb84832ce4a55f050763d05f8a6b3 Mon Sep 17 00:00:00 2001 From: hathach Date: Thu, 31 Oct 2019 13:06:57 +0700 Subject: add more tests, fix an issue with tud_descriptor_configuration_cb() return NULL --- src/device/usbd.c | 2 ++ test/test/device/usbd/test_usbd.c | 72 +++++++++++++++++++++++++++++++++------ 2 files changed, 63 insertions(+), 11 deletions(-) (limited to 'src') diff --git a/src/device/usbd.c b/src/device/usbd.c index 46affdab4..2d2f1cafd 100644 --- a/src/device/usbd.c +++ b/src/device/usbd.c @@ -785,6 +785,8 @@ static bool process_get_descriptor(uint8_t rhport, tusb_control_request_t const case TUSB_DESC_CONFIGURATION: { tusb_desc_configuration_t const* desc_config = (tusb_desc_configuration_t const*) tud_descriptor_configuration_cb(desc_index); + TU_ASSERT(desc_config); + uint16_t total_len; memcpy(&total_len, &desc_config->wTotalLength, 2); // possibly mis-aligned memory diff --git a/test/test/device/usbd/test_usbd.c b/test/test/device/usbd/test_usbd.c index d4b3f806b..b58a79a8f 100644 --- a/test/test/device/usbd/test_usbd.c +++ b/test/test/device/usbd/test_usbd.c @@ -40,7 +40,7 @@ TEST_FILE("usbd_control.c") uint8_t const rhport = 0; -tusb_desc_device_t const desc_device = +tusb_desc_device_t const data_desc_device = { .bLength = sizeof(tusb_desc_device_t), .bDescriptorType = TUSB_DESC_DEVICE, @@ -65,6 +65,12 @@ tusb_desc_device_t const desc_device = .bNumConfigurations = 0x01 }; +uint8_t const data_desc_configuration[] = +{ + // Interface count, string index, total length, attribute, power in mA + TUD_CONFIG_DESCRIPTOR(0, 0, TUD_CONFIG_DESC_LEN, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100), +}; + tusb_control_request_t const req_get_desc_device = { .bmRequestType = 0x80, @@ -74,20 +80,29 @@ tusb_control_request_t const req_get_desc_device = .wLength = 64 }; +tusb_control_request_t const req_get_desc_configuration = +{ + .bmRequestType = 0x80, + .bRequest = TUSB_REQ_GET_DESCRIPTOR, + .wValue = (TUSB_DESC_CONFIGURATION << 8), + .wIndex = 0x0000, + .wLength = 256 +}; + +uint8_t const* desc_device; +uint8_t const* desc_configuration; + //--------------------------------------------------------------------+ // //--------------------------------------------------------------------+ -uint8_t const * ptr_desc_device; - uint8_t const * tud_descriptor_device_cb(void) { - return ptr_desc_device; + return desc_device; } uint8_t const * tud_descriptor_configuration_cb(uint8_t index) { - TEST_FAIL(); - return NULL; + return desc_configuration; } uint16_t const* tud_descriptor_string_cb(uint8_t index) @@ -105,8 +120,6 @@ void setUp(void) dcd_init_Expect(rhport); tusb_init(); } - - ptr_desc_device = (uint8_t const *) &desc_device; } void tearDown(void) @@ -114,20 +127,23 @@ void tearDown(void) } //--------------------------------------------------------------------+ -// +// Get Descriptor //--------------------------------------------------------------------+ + +//------------- Device -------------// void test_usbd_get_device_descriptor(void) { + desc_device = (uint8_t const *) &data_desc_device; dcd_event_setup_received(rhport, (uint8_t*) &req_get_desc_device, false); - dcd_edpt_xfer_ExpectWithArrayAndReturn(rhport, 0x80, (uint8_t*)&desc_device, sizeof(tusb_desc_device_t), sizeof(tusb_desc_device_t), true); + dcd_edpt_xfer_ExpectWithArrayAndReturn(rhport, 0x80, (uint8_t*)&data_desc_device, sizeof(tusb_desc_device_t), sizeof(tusb_desc_device_t), true); tud_task(); } void test_usbd_get_device_descriptor_null(void) { - ptr_desc_device = NULL; + desc_device = NULL; dcd_event_setup_received(rhport, (uint8_t*) &req_get_desc_device, false); @@ -136,3 +152,37 @@ void test_usbd_get_device_descriptor_null(void) tud_task(); } + +//------------- Configuration -------------// + +void test_usbd_get_configuration_descriptor(void) +{ + desc_configuration = data_desc_configuration; + uint16_t total_len = ((tusb_desc_configuration_t const*) data_desc_configuration)->wTotalLength; + + dcd_event_setup_received(rhport, (uint8_t*) &req_get_desc_configuration, false); + + dcd_edpt_xfer_ExpectWithArrayAndReturn(rhport, 0x80, (uint8_t*) data_desc_configuration, total_len, total_len, true); + + tud_task(); +} + +void test_usbd_get_configuration_descriptor_null(void) +{ + desc_configuration = NULL; + dcd_event_setup_received(rhport, (uint8_t*) &req_get_desc_configuration, false); + + dcd_edpt_stall_Expect(rhport, 0); + dcd_edpt_stall_Expect(rhport, 0x80); + + tud_task(); +} + +//--------------------------------------------------------------------+ +// Control ZLP +//--------------------------------------------------------------------+ + +//void test_control_zlp(void) +//{ +// +//} -- cgit v1.3.1 From cacbb80a9031662074c12652cbec32b491d78507 Mon Sep 17 00:00:00 2001 From: hathach Date: Thu, 31 Oct 2019 21:14:06 +0700 Subject: zlp should work with control in, tested with Unity framework --- src/device/usbd.c | 5 ---- src/device/usbd_control.c | 48 +++++++++++++++++++++++---------------- test/test/device/usbd/test_usbd.c | 2 +- 3 files changed, 30 insertions(+), 25 deletions(-) (limited to 'src') diff --git a/src/device/usbd.c b/src/device/usbd.c index 2d2f1cafd..0b9713e94 100644 --- a/src/device/usbd.c +++ b/src/device/usbd.c @@ -404,7 +404,6 @@ void tud_task (void) if ( 0 == epnum ) { - // control transfer DATA stage callback usbd_control_xfer_cb(event.rhport, ep_addr, event.xfer_complete.result, event.xfer_complete.len); } else @@ -869,10 +868,6 @@ void dcd_event_handler(dcd_event_t const * event, bool in_isr) break; case DCD_EVENT_XFER_COMPLETE: - // skip zero-length control status complete event, should DCD notify us. - // TODO could cause issue with actual zero length data used by class such as DFU - if ( (0 == tu_edpt_number(event->xfer_complete.ep_addr)) && (event->xfer_complete.len == 0) ) break; - osal_queue_send(_usbd_q, event, in_isr); TU_ASSERT(event->xfer_complete.result == XFER_RESULT_SUCCESS,); break; diff --git a/src/device/usbd_control.c b/src/device/usbd_control.c index 7636f459d..27e2a8214 100644 --- a/src/device/usbd_control.c +++ b/src/device/usbd_control.c @@ -42,9 +42,9 @@ typedef struct { tusb_control_request_t request; - void* buffer; - uint16_t len; - uint16_t total_transferred; + uint8_t* buffer; + uint16_t data_len; + uint16_t total_xferred; bool (*complete_cb) (uint8_t, tusb_control_request_t const *); } usbd_control_xfer_t; @@ -64,35 +64,37 @@ bool tud_control_status(uint8_t rhport, tusb_control_request_t const * request) return dcd_edpt_xfer(rhport, request->bmRequestType_bit.direction ? EDPT_CTRL_OUT : EDPT_CTRL_IN, NULL, 0); } -// Each transaction is up to endpoint0's max packet size -static bool _ctrl_data_xact(uint8_t rhport) +// Transfer an transaction in Data Stage +// Each transaction has up to Endpoint0's max packet size. +// This function can also transfer an zero-length packet +static bool _data_stage_xact(uint8_t rhport) { - uint16_t const xact_len = tu_min16(_ctrl_xfer.len - _ctrl_xfer.total_transferred, CFG_TUD_ENDPOINT0_SIZE); + uint16_t const xact_len = tu_min16(_ctrl_xfer.data_len - _ctrl_xfer.total_xferred, CFG_TUD_ENDPOINT0_SIZE); uint8_t ep_addr = EDPT_CTRL_OUT; if ( _ctrl_xfer.request.bmRequestType_bit.direction == TUSB_DIR_IN ) { ep_addr = EDPT_CTRL_IN; - memcpy(_usbd_ctrl_buf, _ctrl_xfer.buffer, xact_len); + if ( xact_len ) memcpy(_usbd_ctrl_buf, _ctrl_xfer.buffer, xact_len); } - return dcd_edpt_xfer(rhport, ep_addr, _usbd_ctrl_buf, xact_len); + return dcd_edpt_xfer(rhport, ep_addr, xact_len ? _usbd_ctrl_buf : NULL, xact_len); } bool tud_control_xfer(uint8_t rhport, tusb_control_request_t const * request, void* buffer, uint16_t len) { - _ctrl_xfer.request = (*request); - _ctrl_xfer.buffer = buffer; - _ctrl_xfer.total_transferred = 0; - _ctrl_xfer.len = tu_min16(len, request->wLength); + _ctrl_xfer.request = (*request); + _ctrl_xfer.buffer = (uint8_t*) buffer; + _ctrl_xfer.total_xferred = 0; + _ctrl_xfer.data_len = tu_min16(len, request->wLength); - if ( len ) + if ( _ctrl_xfer.data_len ) { TU_ASSERT(buffer); // Data stage - TU_ASSERT( _ctrl_data_xact(rhport) ); + TU_ASSERT( _data_stage_xact(rhport) ); }else { // Status stage @@ -122,7 +124,13 @@ void usbd_control_set_complete_callback( bool (*fp) (uint8_t, tusb_control_reque bool usbd_control_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t result, uint32_t xferred_bytes) { (void) result; - (void) ep_addr; + + // Endpoint Address is opposite to direction bit, this is Status Stage complete event + if ( tu_edpt_dir(ep_addr) != _ctrl_xfer.request.bmRequestType_bit.direction ) + { + TU_ASSERT(0 == xferred_bytes); + return true; + } if ( _ctrl_xfer.request.bmRequestType_bit.direction == TUSB_DIR_OUT ) { @@ -130,10 +138,12 @@ bool usbd_control_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t result memcpy(_ctrl_xfer.buffer, _usbd_ctrl_buf, xferred_bytes); } - _ctrl_xfer.total_transferred += xferred_bytes; - _ctrl_xfer.buffer = ((uint8_t*)_ctrl_xfer.buffer) + xferred_bytes; + _ctrl_xfer.total_xferred += xferred_bytes; + _ctrl_xfer.buffer += xferred_bytes; - if ( (_ctrl_xfer.request.wLength == _ctrl_xfer.total_transferred) || xferred_bytes < CFG_TUD_ENDPOINT0_SIZE ) + // Data Stage is complete when all request's length are transferred or + // a short packet is sent including zero-length packet. + if ( (_ctrl_xfer.request.wLength == _ctrl_xfer.total_xferred) || xferred_bytes < CFG_TUD_ENDPOINT0_SIZE ) { // DATA stage is complete bool is_ok = true; @@ -159,7 +169,7 @@ bool usbd_control_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t result else { // More data to transfer - TU_ASSERT( _ctrl_data_xact(rhport) ); + TU_ASSERT( _data_stage_xact(rhport) ); } return true; diff --git a/test/test/device/usbd/test_usbd.c b/test/test/device/usbd/test_usbd.c index ea813ea43..71d15dbca 100644 --- a/test/test/device/usbd/test_usbd.c +++ b/test/test/device/usbd/test_usbd.c @@ -202,7 +202,7 @@ void test_usbd_control_zlp(void) { // 128 byte total len, with EP0 size = 64, and request length = 256 // ZLP must be return - uint8_t zlp_desc_configuration[] = + uint8_t zlp_desc_configuration[CFG_TUD_ENDOINT0_SIZE*2] = { // Interface count, string index, total length, attribute, power in mA TUD_CONFIG_DESCRIPTOR(0, 0, CFG_TUD_ENDOINT0_SIZE*2, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100), -- cgit v1.3.1 From f58726887a58fe60d7384136f78b5b147fb08fbd Mon Sep 17 00:00:00 2001 From: hathach Date: Thu, 31 Oct 2019 21:28:46 +0700 Subject: update doc, hid set report --- docs/porting.md | 10 +++------- src/class/hid/hid_device.c | 3 +-- test/test/support/tusb_config.h | 10 +++++----- 3 files changed, 9 insertions(+), 14 deletions(-) (limited to 'src') diff --git a/docs/porting.md b/docs/porting.md index ded35e7b0..7fdeaeba7 100644 --- a/docs/porting.md +++ b/docs/porting.md @@ -123,17 +123,13 @@ Also make sure to enable endpoint specific interrupts. ##### dcd_edpt_xfer -`dcd_edpt_xfer` is responsible for configuring the peripheral to send or receive data from the host. "xfer" is short for "transfer". **This is one of the core methods you must implement for TinyUSB to work (one other is the interrupt handler).** Data from the host is the OUT direction and data to the host is IN. In other words, direction is relative to the host. - -`dcd_edpt_xfer` is used for all endpoints including the control endpoint 0. Make sure to handle the zero-length packet STATUS packet on endpoint 0 correctly. It may be a special transaction to the peripheral. +`dcd_edpt_xfer` is responsible for configuring the peripheral to send or receive data from the host. "xfer" is short for "transfer". **This is one of the core methods you must implement for TinyUSB to work (one other is the interrupt handler).** Data from the host is the OUT direction and data to the host is IN. It is used for all endpoints including the control endpoint 0. Make sure to handle the zero-length packet STATUS packet on endpoint 0 correctly. It may be a special transaction to the peripheral. Besides that, all other transactions are relatively straight-forward. The endpoint address provides the endpoint number and direction which usually determines where to write the buffer info. The buffer and its length are usually written to a specific location in memory and the peripheral is told the data is valid. (Maybe by writing a 1 to a register or setting a counter register to 0 for OUT or length for IN.) -The transmit buffer is NOT guarenteed to be word-aligned. - One potential pitfall is that the buffer may be longer than the maximum endpoint size of one USB packet. Some peripherals can handle transmitting multiple USB packets for a provided buffer (like the SAMD21). Others (like the nRF52) may need each USB packet queued individually. To make this work you'll need to track @@ -143,11 +139,11 @@ Once the transaction is going, the interrupt handler will notify TinyUSB of tran During transmission, the IN data buffer is guarenteed to remain unchanged in memory until the `dcd_xfer_complete` function is called. The dcd_edpt_xfer function must never add zero-length-packets (ZLP) on its own to a transfer. If a ZLP is required, -then it must be explicitly sent by the module calling dcd_edpt_xfer(), by calling dcd_edpt_xfer() a second time with len=0. +then it must be explicitly sent by the stack calling dcd_edpt_xfer(), by calling dcd_edpt_xfer() a second time with len=0. For control transfers, this is automatically done in `usbd_control.c`. At the moment, only a single buffer can be transmitted at once. There is no provision for double-buffering. new dcd_edpt_xfer() will not -be called again until the driver calls dcd_xfer_complete() (except in cases of USB resets). +be called again on the same endpoint address until the driver calls dcd_xfer_complete() (except in cases of USB resets). ##### dcd_xfer_complete diff --git a/src/class/hid/hid_device.c b/src/class/hid/hid_device.c index 9e7bad976..558adc2bb 100644 --- a/src/class/hid/hid_device.c +++ b/src/class/hid/hid_device.c @@ -241,8 +241,7 @@ bool hidd_control_request(uint8_t rhport, tusb_control_request_t const * p_reque break; case HID_REQ_CONTROL_SET_REPORT: - TU_VERIFY(p_request->wLength <=sizeof(p_hid->epout_buf)); - tud_control_xfer(rhport, p_request, p_hid->epout_buf, p_request->wLength); + tud_control_xfer(rhport, p_request, p_hid->epout_buf, tu_min16(sizeof(p_hid->epout_buf), p_request->wLength)); break; case HID_REQ_CONTROL_SET_IDLE: diff --git a/test/test/support/tusb_config.h b/test/test/support/tusb_config.h index e0ab0c68b..0a1608a64 100644 --- a/test/test/support/tusb_config.h +++ b/test/test/support/tusb_config.h @@ -74,11 +74,11 @@ #define CFG_TUD_ENDOINT0_SIZE 64 //------------- CLASS -------------// -#define CFG_TUD_CDC 0 -#define CFG_TUD_MSC 0 -#define CFG_TUD_HID 0 -#define CFG_TUD_MIDI 0 -#define CFG_TUD_VENDOR 0 +//#define CFG_TUD_CDC 0 +//#define CFG_TUD_MSC 0 +//#define CFG_TUD_HID 0 +//#define CFG_TUD_MIDI 0 +//#define CFG_TUD_VENDOR 0 //------------- CDC -------------// -- cgit v1.3.1 From 981e64d8a175463d8788c8bf2cb98ce97b630814 Mon Sep 17 00:00:00 2001 From: hathach Date: Fri, 1 Nov 2019 10:07:56 +0700 Subject: implement pigrew review --- src/class/hid/hid_device.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/class/hid/hid_device.c b/src/class/hid/hid_device.c index 558adc2bb..fc2e6b35a 100644 --- a/src/class/hid/hid_device.c +++ b/src/class/hid/hid_device.c @@ -241,7 +241,8 @@ bool hidd_control_request(uint8_t rhport, tusb_control_request_t const * p_reque break; case HID_REQ_CONTROL_SET_REPORT: - tud_control_xfer(rhport, p_request, p_hid->epout_buf, tu_min16(sizeof(p_hid->epout_buf), p_request->wLength)); + TU_VERIFY(p_request->wLength <= sizeof(p_hid->epout_buf)); + tud_control_xfer(rhport, p_request, p_hid->epout_buf, p_request->wLength); break; case HID_REQ_CONTROL_SET_IDLE: -- cgit v1.3.1