From 797141a2cdc450c3834476124f483fc6c1741859 Mon Sep 17 00:00:00 2001 From: Emil Lerch Date: Fri, 28 Apr 2023 13:25:48 -0700 Subject: [PATCH] first working version --- README.md | 6 ++ cdc_acm_template.c | 201 +++++++++++++++++++++++++++++++++++++++------ main.c | 12 ++- proj.conf | 4 - 4 files changed, 192 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index bac50b3..487599b 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,9 @@ Flash ``` docker run --rm --device /dev/ttyACM0 -v $(pwd):/build git.lerch.org/lobo/bouffalo_open_sdk:2f6477f flash BOARD=bl616dk CHIP=bl616 COMX=/dev/ttyACM0 ``` + +With rootless podman: + +``` +podman run --annotation run.oci.keep_original_groups=1 --userns=keep-id --rm --device /dev/ttyACM0 -v $(pwd):/build git.lerch.org/lobo/bouffalo_open_sdk:2f6477f flash BOARD=bl616dk CHIP=bl616 COMX=/dev/ttyACM0 +``` diff --git a/cdc_acm_template.c b/cdc_acm_template.c index d50f745..2aa43d7 100644 --- a/cdc_acm_template.c +++ b/cdc_acm_template.c @@ -2,23 +2,83 @@ #include "usbd_cdc.h" /*!< endpoint address */ +/* Transmissions Device->Host (otherwise known as "IN" in these constants */ +/* Need to be >= 0x80 to be considered a transmission. See */ +/* https://github.com/sakumisu/CherryUSB/blob/d7c0add7ef58cfa711cf152c088a7e1c65fa5886/core/usbd_core.c#L1230 */ + +/* + * Endpoint Address + * Bits 0..3b Endpoint Number. + * Bits 4..6b Reserved. Set to Zero + * Bits 7 Direction 0 = Out, 1 = In (Ignored for Control Endpoints) + * + * So, each endpoint needs to have a unique number in 0..3, so a total of 16 + * endpoints. Bit 7 is directional. So 0x00-0x0F is outbound, and 0x80-0x8f is + * inbound, and everything must be unique in the last nibble. At least that is + * my understanding at this point. + */ #define CDC_IN_EP 0x81 #define CDC_OUT_EP 0x02 -#define CDC_INT_EP 0x83 +#define CDC_INT_EP 0x85 -#define USBD_VID 0xFFFF -#define USBD_PID 0xFFFF +#define CDC_IN_DBG_EP 0x83 +#define CDC_OUT_DBG_EP 0x04 +#define CDC_INT_DBG_EP 0x86 + +#define USBD_VID 0x10B0 /* Vendor Id */ +#define USBD_PID 0xDEAD /* Product Id */ #define USBD_MAX_POWER 100 -#define USBD_LANGID_STRING 1033 +#define USBD_LANGID_STRING 1033 /* US English */ /*!< config descriptor size */ -#define USB_CONFIG_SIZE (9 + CDC_ACM_DESCRIPTOR_LEN) +#define USB_CONFIG_SIZE (9 + CDC_ACM_DESCRIPTOR_LEN * 2) + + +/* USB Device descriptors. If you don't know what you're doing, read this + * first: https://beyondlogic.org/usbnutshell/usb5.shtml + * + * We have one and only one Device Descriptor that describes the physical device + * But what linux is calling a "device" has nothing to do with that. I believe + * this varies by the type of USB device. For USB CDC ACM, we are looking at + * each "Interface association" as its own Linux device (as determined by + * /dev/ttyACMx). + * + * From Device Descriptor, we'll have any number of "configurations", which + * typically describes different power profiles, etc. Typically there is only + * one configuration, but it doesn't need to be that way. + * + * Within the configuraiton, we have various interfaces. Using the macro + * CDC_ACM_DESCRIPTOR_INIT provided by CherryUSB will provide us with: + * + * * Interface Association to describe two interfaces ("in" and "out") + * * Interface for outbound traffic + * * Interface for inbound traffic + * + * I believe that the CDC_INT_* constants above refer to the interface association + * + * To actually communicate, we need to setup endpoints, which are associated + * with the interfaces above. So the full heirarchy is: + * + * Device -1:n- Configuration -1:n- Interface -1:n- Endpoint + * + * Where for typical, CDC ACM usage is: + * + * Device -1:1- Configuration -1:n- Interface (2 per what Linux calls device) -1:1- Endpoint + * + */ + /*!< global descriptor */ static const uint8_t cdc_descriptor[] = { USB_DEVICE_DESCRIPTOR_INIT(USB_2_0, 0xEF, 0x02, 0x01, USBD_VID, USBD_PID, 0x0100, 0x01), - USB_CONFIG_DESCRIPTOR_INIT(USB_CONFIG_SIZE, 0x02, 0x01, USB_CONFIG_BUS_POWERED, USBD_MAX_POWER), + USB_CONFIG_DESCRIPTOR_INIT(USB_CONFIG_SIZE, 0x04, 0x01, USB_CONFIG_BUS_POWERED, USBD_MAX_POWER), + /* ^ - Number of interfaces. We need a seperate in and out channel for each virtual */ + /* So for each /dev/ttyACMx, add 2 to this number */ + /* */ + /* The last paramater is the string index for this interface. Linux does not */ + /* seem to report that anywhere, but maybe Windows does? */ CDC_ACM_DESCRIPTOR_INIT(0x00, CDC_INT_EP, CDC_OUT_EP, CDC_IN_EP, 0x02), + CDC_ACM_DESCRIPTOR_INIT(0x02, CDC_INT_DBG_EP, CDC_OUT_DBG_EP, CDC_IN_DBG_EP, 0x02), /////////////////////////////////////// /// string0 descriptor /////////////////////////////////////// @@ -74,6 +134,20 @@ static const uint8_t cdc_descriptor[] = { '-', 0x00, /* wcChar7 */ '1', 0x00, /* wcChar8 */ '9', 0x00, /* wcChar9 */ + /////////////////////////////////////// + /// string4 descriptor + /////////////////////////////////////// + 0x14, /* bLength */ + USB_DESCRIPTOR_TYPE_STRING, /* bDescriptorType */ + 'D', 0x00, /* wcChar0 */ + 'E', 0x00, /* wcChar1 */ + 'B', 0x00, /* wcChar2 */ + 'U', 0x00, /* wcChar3 */ + 'G', 0x00, /* wcChar4 */ + ' ', 0x00, /* wcChar5 */ + 'L', 0x00, /* wcChar6 */ + 'O', 0x00, /* wcChar7 */ + 'G', 0x00, /* wcChar8 */ #ifdef CONFIG_USB_HS /////////////////////////////////////// /// device qualifier descriptor @@ -94,8 +168,16 @@ static const uint8_t cdc_descriptor[] = { USB_NOCACHE_RAM_SECTION USB_MEM_ALIGNX uint8_t read_buffer[2048]; USB_NOCACHE_RAM_SECTION USB_MEM_ALIGNX uint8_t write_buffer[2048]; +USB_NOCACHE_RAM_SECTION USB_MEM_ALIGNX uint8_t debug_buffer[2048]; volatile bool ep_tx_busy_flag = false; +volatile bool ep_dbg_tx_busy_flag = false; + +// TODO: Remove these. Debugging only +volatile uint8_t debug_val_1 = 0; +volatile uint8_t debug_val_2 = 0; +volatile uint32_t debug_val32_1 = 0; +volatile uint32_t debug_val32_2 = 0; #ifdef CONFIG_USB_HS #define CDC_MAX_MPS 512 @@ -107,28 +189,34 @@ void usbd_configure_done_callback(void) { /* setup first out ep read transfer */ usbd_ep_start_read(CDC_OUT_EP, read_buffer, 2048); + usbd_ep_start_read(CDC_OUT_DBG_EP, read_buffer, 2048); } void usbd_cdc_acm_bulk_out(uint8_t ep, uint32_t nbytes) { + //4, 5 (shouldn't we be getting endpoint 2 here?) + debug_val_1 = ep; debug_val32_1 = nbytes; USB_LOG_RAW("actual out len:%d\r\n", nbytes); - // for (int i = 0; i < 100; i++) { - // printf("%02x ", read_buffer[i]); - // } - // printf("\r\n"); + /* setup next out ep read transfer */ - usbd_ep_start_read(CDC_OUT_EP, read_buffer, 2048); + usbd_ep_start_read(ep, read_buffer, 2048); } void usbd_cdc_acm_bulk_in(uint8_t ep, uint32_t nbytes) { + //129, 14 (129=0x81=CDC_IN_EP) + debug_val_2 = ep; debug_val32_2 = nbytes; USB_LOG_RAW("actual in len:%d\r\n", nbytes); if ((nbytes % CDC_MAX_MPS) == 0 && nbytes) { /* send zlp */ - usbd_ep_start_write(CDC_IN_EP, NULL, 0); + usbd_ep_start_write(ep, NULL, 0); } else { + if (ep == CDC_IN_EP) { ep_tx_busy_flag = false; + }else{ + ep_dbg_tx_busy_flag = false; + } } } @@ -146,30 +234,62 @@ struct usbd_endpoint cdc_in_ep = { struct usbd_interface intf0; struct usbd_interface intf1; +struct usbd_endpoint cdc_out_dbg_ep = { + .ep_addr = CDC_OUT_DBG_EP, + .ep_cb = usbd_cdc_acm_bulk_out +}; + +struct usbd_endpoint cdc_in_dbg_ep = { + .ep_addr = CDC_IN_DBG_EP, + .ep_cb = usbd_cdc_acm_bulk_in +}; + +struct usbd_interface intf2; +struct usbd_interface intf3; + /* function ------------------------------------------------------------------*/ void cdc_acm_init(void) { - const uint8_t data[10] = { 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x30 }; - - memcpy(&write_buffer[0], data, 10); - memset(&write_buffer[10], 'a', 2038); - usbd_desc_register(cdc_descriptor); + + + /* Add primary comms channel */ usbd_add_interface(usbd_cdc_acm_init_intf(&intf0)); usbd_add_interface(usbd_cdc_acm_init_intf(&intf1)); usbd_add_endpoint(&cdc_out_ep); usbd_add_endpoint(&cdc_in_ep); + + /* Add debug log comms channel */ + usbd_add_interface(usbd_cdc_acm_init_intf(&intf2)); + usbd_add_interface(usbd_cdc_acm_init_intf(&intf3)); + usbd_add_endpoint(&cdc_out_dbg_ep); + usbd_add_endpoint(&cdc_in_dbg_ep); + usbd_initialize(); } volatile uint8_t dtr_enable = 0; +volatile uint8_t dtr_debug_enable = 0; +/************************************************ + * Callback function from the host based on + * control flow commands + */ void usbd_cdc_acm_set_dtr(uint8_t intf, bool dtr) { + /* Based on above init, intf = 0 is normal, intf = 2 is debug */ if (dtr) { - dtr_enable = 1; + if (intf == 0) { + dtr_enable = 1; + } else { + dtr_debug_enable = 1; + } } else { - dtr_enable = 0; + if (intf == 0) { + dtr_enable = 0; + } else { + dtr_debug_enable = 0; + } } } @@ -183,12 +303,43 @@ void cdc_acm_data_send_with_dtr(const uint8_t *data, uint32_t data_len ) } } -void cdc_acm_data_send_with_dtr_test(void) +void cdc_acm_log_with_dtr(const uint8_t *data, uint32_t data_len ) { - if (dtr_enable) { - ep_tx_busy_flag = true; - usbd_ep_start_write(CDC_IN_EP, write_buffer, 2048); - while (ep_tx_busy_flag) { - } + if (dtr_debug_enable) { + ep_dbg_tx_busy_flag = true; + usbd_ep_start_write(CDC_IN_DBG_EP, data, data_len); + while (ep_dbg_tx_busy_flag) { } + } +} + +uint32_t out_inx = 0; +void log(const char *data){ + /* memcpy(&write_buffer[0], data, strlen(data)); */ + /* write_buffer[9] = 0x30 + debug_val_1; */ + /* write_buffer[20] = 0x30 + debug_val_2; */ + int len = snprintf( + (char *)&write_buffer[0], + 2048, + "%d\r\ndebug u8 val 1: %d, debug val u8 2: %d\r\ndebug 32 val 1: %d, debug 32 val 2: %d\r\nsending to debug...\r\n", + out_inx++, + debug_val_1, + debug_val_2, + debug_val32_1, + debug_val32_2 + ); + cdc_acm_data_send_with_dtr(&write_buffer[0], len); + + + int dbg_len = snprintf( + (char *)&debug_buffer[0], + 2048, + "%d\r\ndebug u8 val 1: %d, debug val u8 2: %d\r\ndebug 32 val 1: %d, debug 32 val 2: %d\r\n(debug log)\r\n", + out_inx, + debug_val_1, + debug_val_2, + debug_val32_1, + debug_val32_2 + ); + cdc_acm_log_with_dtr(&debug_buffer[0], dbg_len); } diff --git a/main.c b/main.c index b8223c6..bf68aa4 100644 --- a/main.c +++ b/main.c @@ -7,6 +7,7 @@ extern void cdc_acm_init(void); extern void cdc_acm_data_send_with_dtr(const uint8_t *, uint32_t); +extern void log(const char *); uint32_t buffer_init(char *); @@ -17,10 +18,17 @@ int main(void) board_init(); uint32_t data_len = buffer_init("Hello world!\r\n"); + uint32_t inx = 0; cdc_acm_init(); + log("Initialized"); while (1) { - cdc_acm_data_send_with_dtr(write_buffer_main, data_len); - bflb_mtimer_delay_ms(2000); + if (inx++ >= 2000){ + cdc_acm_data_send_with_dtr(write_buffer_main, data_len); + log("dtr_enabled_true_callbacks: . Write\r\n"); + /* cdc_acm_log_with_dtr(write_buffer_main, data_len); */ + inx = 0; + } + bflb_mtimer_delay_ms(1); } } diff --git a/proj.conf b/proj.conf index 4b32eea..358046e 100644 --- a/proj.conf +++ b/proj.conf @@ -1,7 +1,3 @@ set(CONFIG_CHERRYUSB 1) set(CONFIG_CHERRYUSB_DEVICE 1) set(CONFIG_CHERRYUSB_DEVICE_CDC 1) -set(CONFIG_CHERRYUSB_DEVICE_HID 1) -set(CONFIG_CHERRYUSB_DEVICE_MSC 1) -set(CONFIG_CHERRYUSB_DEVICE_AUDIO 1) -set(CONFIG_CHERRYUSB_DEVICE_VIDEO 1) \ No newline at end of file