udi_cdc.h

Go to the documentation of this file.

/*
 * Support and FAQ: visit <a href="https://www.microchip.com/support/">Microchip Support</a>
 */

#ifndef _UDI_CDC_H_
#define _UDI_CDC_H_

#include "conf_usb.h"
#include "usb_protocol.h"
#include "usb_protocol_cdc.h"
#include "udd.h"
#include "udc_desc.h"
#include "udi.h"

// Check the number of port
#ifndef  UDI_CDC_PORT_NB
# define  UDI_CDC_PORT_NB 1
#endif
#if (UDI_CDC_PORT_NB < 1) || (UDI_CDC_PORT_NB > 7)
# error UDI_CDC_PORT_NB must be between 1 and 7
#endif

#ifdef __cplusplus
extern "C" {
#endif

extern UDC_DESC_STORAGE udi_api_t udi_api_cdc_comm;
extern UDC_DESC_STORAGE udi_api_t udi_api_cdc_data;


typedef struct {
        usb_iface_desc_t iface;
        usb_cdc_hdr_desc_t header;
        usb_cdc_acm_desc_t acm;
        usb_cdc_union_desc_t union_desc;
        usb_cdc_call_mgmt_desc_t call_mgmt;
        usb_ep_desc_t ep_notify;
} udi_cdc_comm_desc_t;


typedef struct {
        usb_iface_desc_t iface;
        usb_ep_desc_t ep_in;
        usb_ep_desc_t ep_out;
} udi_cdc_data_desc_t;


#define UDI_CDC_COMM_EP_SIZE        64
#define UDI_CDC_DATA_EPS_FS_SIZE    64
#define UDI_CDC_DATA_EPS_HS_SIZE    512

#ifndef UDI_CDC_IAD_STRING_ID_0
#define UDI_CDC_IAD_STRING_ID_0   0
#endif
#ifndef UDI_CDC_COMM_STRING_ID_0
#define UDI_CDC_COMM_STRING_ID_0   0
#endif
#ifndef UDI_CDC_DATA_STRING_ID_0
#define UDI_CDC_DATA_STRING_ID_0   0
#endif
#define UDI_CDC_IAD_DESC_0      UDI_CDC_IAD_DESC(0)
#define UDI_CDC_COMM_DESC_0     UDI_CDC_COMM_DESC(0)
#define UDI_CDC_DATA_DESC_0_FS  UDI_CDC_DATA_DESC_FS(0)
#define UDI_CDC_DATA_DESC_0_HS  UDI_CDC_DATA_DESC_HS(0)

#ifndef UDI_CDC_IAD_STRING_ID_1
#define UDI_CDC_IAD_STRING_ID_1  0
#endif
#ifndef UDI_CDC_COMM_STRING_ID_1
#define UDI_CDC_COMM_STRING_ID_1 0
#endif
#ifndef UDI_CDC_DATA_STRING_ID_1
#define UDI_CDC_DATA_STRING_ID_1 0
#endif
#define UDI_CDC_IAD_DESC_1      UDI_CDC_IAD_DESC(1)
#define UDI_CDC_COMM_DESC_1     UDI_CDC_COMM_DESC(1)
#define UDI_CDC_DATA_DESC_1_FS  UDI_CDC_DATA_DESC_FS(1)
#define UDI_CDC_DATA_DESC_1_HS  UDI_CDC_DATA_DESC_HS(1)

#ifndef UDI_CDC_IAD_STRING_ID_2
#define UDI_CDC_IAD_STRING_ID_2   0
#endif
#ifndef UDI_CDC_COMM_STRING_ID_2
#define UDI_CDC_COMM_STRING_ID_2   0
#endif
#ifndef UDI_CDC_DATA_STRING_ID_2
#define UDI_CDC_DATA_STRING_ID_2   0
#endif
#define UDI_CDC_IAD_DESC_2      UDI_CDC_IAD_DESC(2)
#define UDI_CDC_COMM_DESC_2     UDI_CDC_COMM_DESC(2)
#define UDI_CDC_DATA_DESC_2_FS  UDI_CDC_DATA_DESC_FS(2)
#define UDI_CDC_DATA_DESC_2_HS  UDI_CDC_DATA_DESC_HS(2)

#ifndef UDI_CDC_IAD_STRING_ID_3
#define UDI_CDC_IAD_STRING_ID_3   0
#endif
#ifndef UDI_CDC_COMM_STRING_ID_3
#define UDI_CDC_COMM_STRING_ID_3   0
#endif
#ifndef UDI_CDC_DATA_STRING_ID_3
#define UDI_CDC_DATA_STRING_ID_3   0
#endif
#define UDI_CDC_IAD_DESC_3      UDI_CDC_IAD_DESC(3)
#define UDI_CDC_COMM_DESC_3     UDI_CDC_COMM_DESC(3)
#define UDI_CDC_DATA_DESC_3_FS  UDI_CDC_DATA_DESC_FS(3)
#define UDI_CDC_DATA_DESC_3_HS  UDI_CDC_DATA_DESC_HS(3)

#ifndef UDI_CDC_IAD_STRING_ID_4
#define UDI_CDC_IAD_STRING_ID_4   0
#endif
#ifndef UDI_CDC_COMM_STRING_ID_4
#define UDI_CDC_COMM_STRING_ID_4   0
#endif
#ifndef UDI_CDC_DATA_STRING_ID_4
#define UDI_CDC_DATA_STRING_ID_4   0
#endif
#define UDI_CDC_IAD_DESC_4      UDI_CDC_IAD_DESC(4)
#define UDI_CDC_COMM_DESC_4     UDI_CDC_COMM_DESC(4)
#define UDI_CDC_DATA_DESC_4_FS  UDI_CDC_DATA_DESC_FS(4)
#define UDI_CDC_DATA_DESC_4_HS  UDI_CDC_DATA_DESC_HS(4)

#ifndef UDI_CDC_IAD_STRING_ID_5
#define UDI_CDC_IAD_STRING_ID_5   0
#endif
#ifndef UDI_CDC_COMM_STRING_ID_5
#define UDI_CDC_COMM_STRING_ID_5   0
#endif
#ifndef UDI_CDC_DATA_STRING_ID_5
#define UDI_CDC_DATA_STRING_ID_5   0
#endif
#define UDI_CDC_IAD_DESC_5      UDI_CDC_IAD_DESC(5)
#define UDI_CDC_COMM_DESC_5     UDI_CDC_COMM_DESC(5)
#define UDI_CDC_DATA_DESC_5_FS  UDI_CDC_DATA_DESC_FS(5)
#define UDI_CDC_DATA_DESC_5_HS  UDI_CDC_DATA_DESC_HS(5)

#ifndef UDI_CDC_IAD_STRING_ID_6
#define UDI_CDC_IAD_STRING_ID_6   0
#endif
#ifndef UDI_CDC_COMM_STRING_ID_6
#define UDI_CDC_COMM_STRING_ID_6   0
#endif
#ifndef UDI_CDC_DATA_STRING_ID_6
#define UDI_CDC_DATA_STRING_ID_6   0
#endif
#define UDI_CDC_IAD_DESC_6      UDI_CDC_IAD_DESC(6)
#define UDI_CDC_COMM_DESC_6     UDI_CDC_COMM_DESC(6)
#define UDI_CDC_DATA_DESC_6_FS  UDI_CDC_DATA_DESC_FS(6)
#define UDI_CDC_DATA_DESC_6_HS  UDI_CDC_DATA_DESC_HS(6)



#define UDI_CDC_IAD_DESC(port) { \
   .bLength                      = sizeof(usb_iad_desc_t),\
   .bDescriptorType              = USB_DT_IAD,\
   .bInterfaceCount              = 2,\
   .bFunctionClass               = CDC_CLASS_COMM,\
   .bFunctionSubClass            = CDC_SUBCLASS_ACM,\
   .bFunctionProtocol            = CDC_PROTOCOL_V25TER,\
   .bFirstInterface              = UDI_CDC_COMM_IFACE_NUMBER_##port,\
   .iFunction                    = UDI_CDC_IAD_STRING_ID_##port,\
   }

#define UDI_CDC_COMM_DESC(port) { \
   .iface.bLength                = sizeof(usb_iface_desc_t),\
   .iface.bDescriptorType        = USB_DT_INTERFACE,\
   .iface.bAlternateSetting      = 0,\
   .iface.bNumEndpoints          = 1,\
   .iface.bInterfaceClass        = CDC_CLASS_COMM,\
   .iface.bInterfaceSubClass     = CDC_SUBCLASS_ACM,\
   .iface.bInterfaceProtocol     = CDC_PROTOCOL_V25TER,\
   .header.bFunctionLength       = sizeof(usb_cdc_hdr_desc_t),\
   .header.bDescriptorType       = CDC_CS_INTERFACE,\
   .header.bDescriptorSubtype    = CDC_SCS_HEADER,\
   .header.bcdCDC                = LE16(0x0110),\
   .call_mgmt.bFunctionLength    = sizeof(usb_cdc_call_mgmt_desc_t),\
   .call_mgmt.bDescriptorType    = CDC_CS_INTERFACE,\
   .call_mgmt.bDescriptorSubtype = CDC_SCS_CALL_MGMT,\
   .call_mgmt.bmCapabilities     = \
                        CDC_CALL_MGMT_SUPPORTED | CDC_CALL_MGMT_OVER_DCI,\
   .acm.bFunctionLength          = sizeof(usb_cdc_acm_desc_t),\
   .acm.bDescriptorType          = CDC_CS_INTERFACE,\
   .acm.bDescriptorSubtype       = CDC_SCS_ACM,\
   .acm.bmCapabilities           = CDC_ACM_SUPPORT_LINE_REQUESTS,\
   .union_desc.bFunctionLength   = sizeof(usb_cdc_union_desc_t),\
   .union_desc.bDescriptorType   = CDC_CS_INTERFACE,\
   .union_desc.bDescriptorSubtype= CDC_SCS_UNION,\
   .ep_notify.bLength            = sizeof(usb_ep_desc_t),\
   .ep_notify.bDescriptorType    = USB_DT_ENDPOINT,\
   .ep_notify.bmAttributes       = USB_EP_TYPE_INTERRUPT,\
   .ep_notify.wMaxPacketSize     = LE16(UDI_CDC_COMM_EP_SIZE),\
   .ep_notify.bInterval          = 0x10,\
   .ep_notify.bEndpointAddress   = UDI_CDC_COMM_EP_##port,\
   .iface.bInterfaceNumber       = UDI_CDC_COMM_IFACE_NUMBER_##port,\
   .call_mgmt.bDataInterface     = UDI_CDC_DATA_IFACE_NUMBER_##port,\
   .union_desc.bMasterInterface  = UDI_CDC_COMM_IFACE_NUMBER_##port,\
   .union_desc.bSlaveInterface0  = UDI_CDC_DATA_IFACE_NUMBER_##port,\
   .iface.iInterface             = UDI_CDC_COMM_STRING_ID_##port,\
   }

#define UDI_CDC_DATA_DESC_COMMON \
   .iface.bLength                = sizeof(usb_iface_desc_t),\
   .iface.bDescriptorType        = USB_DT_INTERFACE,\
   .iface.bAlternateSetting      = 0,\
   .iface.bNumEndpoints          = 2,\
   .iface.bInterfaceClass        = CDC_CLASS_DATA,\
   .iface.bInterfaceSubClass     = 0,\
   .iface.bInterfaceProtocol     = 0,\
   .ep_in.bLength                = sizeof(usb_ep_desc_t),\
   .ep_in.bDescriptorType        = USB_DT_ENDPOINT,\
   .ep_in.bmAttributes           = USB_EP_TYPE_BULK,\
   .ep_in.bInterval              = 0,\
   .ep_out.bLength               = sizeof(usb_ep_desc_t),\
   .ep_out.bDescriptorType       = USB_DT_ENDPOINT,\
   .ep_out.bmAttributes          = USB_EP_TYPE_BULK,\
   .ep_out.bInterval             = 0,

#define UDI_CDC_DATA_DESC_FS(port) { \
   UDI_CDC_DATA_DESC_COMMON \
   .ep_in.wMaxPacketSize         = LE16(UDI_CDC_DATA_EPS_FS_SIZE),\
   .ep_out.wMaxPacketSize        = LE16(UDI_CDC_DATA_EPS_FS_SIZE),\
   .ep_in.bEndpointAddress       = UDI_CDC_DATA_EP_IN_##port,\
   .ep_out.bEndpointAddress      = UDI_CDC_DATA_EP_OUT_##port,\
   .iface.bInterfaceNumber       = UDI_CDC_DATA_IFACE_NUMBER_##port,\
   .iface.iInterface             = UDI_CDC_DATA_STRING_ID_##port,\
   }

#define UDI_CDC_DATA_DESC_HS(port) { \
   UDI_CDC_DATA_DESC_COMMON \
   .ep_in.wMaxPacketSize         = LE16(UDI_CDC_DATA_EPS_HS_SIZE),\
   .ep_out.wMaxPacketSize        = LE16(UDI_CDC_DATA_EPS_HS_SIZE),\
   .ep_in.bEndpointAddress       = UDI_CDC_DATA_EP_IN_##port,\
   .ep_out.bEndpointAddress      = UDI_CDC_DATA_EP_OUT_##port,\
   .iface.bInterfaceNumber       = UDI_CDC_DATA_IFACE_NUMBER_##port,\
   .iface.iInterface             = UDI_CDC_DATA_STRING_ID_##port,\
   }



void udi_cdc_ctrl_signal_dcd(bool b_set);

void udi_cdc_ctrl_signal_dsr(bool b_set);

void udi_cdc_signal_framing_error(void);

void udi_cdc_signal_parity_error(void);

void udi_cdc_signal_overrun(void);

iram_size_t udi_cdc_get_nb_received_data(void);

bool udi_cdc_is_rx_ready(void);

int udi_cdc_getc(void);

iram_size_t udi_cdc_read_buf(void* buf, iram_size_t size);

iram_size_t udi_cdc_read_no_polling(void* buf, iram_size_t size);

iram_size_t udi_cdc_get_free_tx_buffer(void);

bool udi_cdc_is_tx_ready(void);

int udi_cdc_putc(int value);

iram_size_t udi_cdc_write_buf(const void* buf, iram_size_t size);


void udi_cdc_multi_ctrl_signal_dcd(uint8_t port, bool b_set);

void udi_cdc_multi_ctrl_signal_dsr(uint8_t port, bool b_set);

void udi_cdc_multi_signal_framing_error(uint8_t port);

void udi_cdc_multi_signal_parity_error(uint8_t port);

void udi_cdc_multi_signal_overrun(uint8_t port);

iram_size_t udi_cdc_multi_get_nb_received_data(uint8_t port);

bool udi_cdc_multi_is_rx_ready(uint8_t port);

int udi_cdc_multi_getc(uint8_t port);

iram_size_t udi_cdc_multi_read_buf(uint8_t port, void* buf, iram_size_t size);

iram_size_t udi_cdc_multi_get_free_tx_buffer(uint8_t port);

bool udi_cdc_multi_is_tx_ready(uint8_t port);

int udi_cdc_multi_putc(uint8_t port, int value);

iram_size_t udi_cdc_multi_write_buf(uint8_t port, const void* buf, iram_size_t size);


#ifdef __cplusplus
}
#endif
#endif // _UDI_CDC_H_