cdc.h

Go to the documentation of this file.

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Ha Thach (tinyusb.org)
 *
 * 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_CDC_H__
#define _TUSB_CDC_H__
 
#include "common/tusb_common.h"
 
#ifdef __cplusplus
 extern "C" {
#endif
 
//--------------------------------------------------------------------+
// CDC Communication Interface Class
//--------------------------------------------------------------------+
 
typedef enum
{
  CDC_COMM_SUBCLASS_DIRECT_LINE_CONTROL_MODEL      = 0x01 , 
  CDC_COMM_SUBCLASS_ABSTRACT_CONTROL_MODEL         = 0x02 , 
  CDC_COMM_SUBCLASS_TELEPHONE_CONTROL_MODEL        = 0x03 , 
  CDC_COMM_SUBCLASS_MULTICHANNEL_CONTROL_MODEL     = 0x04 , 
  CDC_COMM_SUBCLASS_CAPI_CONTROL_MODEL             = 0x05 , 
  CDC_COMM_SUBCLASS_ETHERNET_CONTROL_MODEL         = 0x06 , 
  CDC_COMM_SUBCLASS_ATM_NETWORKING_CONTROL_MODEL   = 0x07 , 
  CDC_COMM_SUBCLASS_WIRELESS_HANDSET_CONTROL_MODEL = 0x08 , 
  CDC_COMM_SUBCLASS_DEVICE_MANAGEMENT              = 0x09 , 
  CDC_COMM_SUBCLASS_MOBILE_DIRECT_LINE_MODEL       = 0x0A , 
  CDC_COMM_SUBCLASS_OBEX                           = 0x0B , 
  CDC_COMM_SUBCLASS_ETHERNET_EMULATION_MODEL       = 0x0C , 
  CDC_COMM_SUBCLASS_NETWORK_CONTROL_MODEL          = 0x0D   
} cdc_comm_sublcass_type_t;
 
typedef enum
{
  CDC_COMM_PROTOCOL_NONE                          = 0x00 , 
  CDC_COMM_PROTOCOL_ATCOMMAND                     = 0x01 , 
  CDC_COMM_PROTOCOL_ATCOMMAND_PCCA_101            = 0x02 , 
  CDC_COMM_PROTOCOL_ATCOMMAND_PCCA_101_AND_ANNEXO = 0x03 , 
  CDC_COMM_PROTOCOL_ATCOMMAND_GSM_707             = 0x04 , 
  CDC_COMM_PROTOCOL_ATCOMMAND_3GPP_27007          = 0x05 , 
  CDC_COMM_PROTOCOL_ATCOMMAND_CDMA                = 0x06 , 
  CDC_COMM_PROTOCOL_ETHERNET_EMULATION_MODEL      = 0x07   
} cdc_comm_protocol_type_t;
 
//------------- SubType Descriptor in COMM Functional Descriptor -------------//
typedef enum
{
  CDC_FUNC_DESC_HEADER                                           = 0x00 , 
  CDC_FUNC_DESC_CALL_MANAGEMENT                                  = 0x01 , 
  CDC_FUNC_DESC_ABSTRACT_CONTROL_MANAGEMENT                      = 0x02 , 
  CDC_FUNC_DESC_DIRECT_LINE_MANAGEMENT                           = 0x03 , 
  CDC_FUNC_DESC_TELEPHONE_RINGER                                 = 0x04 , 
  CDC_FUNC_DESC_TELEPHONE_CALL_AND_LINE_STATE_REPORTING_CAPACITY = 0x05 , 
  CDC_FUNC_DESC_UNION                                            = 0x06 , 
  CDC_FUNC_DESC_COUNTRY_SELECTION                                = 0x07 , 
  CDC_FUNC_DESC_TELEPHONE_OPERATIONAL_MODES                      = 0x08 , 
  CDC_FUNC_DESC_USB_TERMINAL                                     = 0x09 , 
  CDC_FUNC_DESC_NETWORK_CHANNEL_TERMINAL                         = 0x0A , 
  CDC_FUNC_DESC_PROTOCOL_UNIT                                    = 0x0B , 
  CDC_FUNC_DESC_EXTENSION_UNIT                                   = 0x0C , 
  CDC_FUNC_DESC_MULTICHANEL_MANAGEMENT                           = 0x0D , 
  CDC_FUNC_DESC_CAPI_CONTROL_MANAGEMENT                          = 0x0E , 
  CDC_FUNC_DESC_ETHERNET_NETWORKING                              = 0x0F , 
  CDC_FUNC_DESC_ATM_NETWORKING                                   = 0x10 , 
  CDC_FUNC_DESC_WIRELESS_HANDSET_CONTROL_MODEL                   = 0x11 , 
  CDC_FUNC_DESC_MOBILE_DIRECT_LINE_MODEL                         = 0x12 , 
  CDC_FUNC_DESC_MOBILE_DIRECT_LINE_MODEL_DETAIL                  = 0x13 , 
  CDC_FUNC_DESC_DEVICE_MANAGEMENT_MODEL                          = 0x14 , 
  CDC_FUNC_DESC_OBEX                                             = 0x15 , 
  CDC_FUNC_DESC_COMMAND_SET                                      = 0x16 , 
  CDC_FUNC_DESC_COMMAND_SET_DETAIL                               = 0x17 , 
  CDC_FUNC_DESC_TELEPHONE_CONTROL_MODEL                          = 0x18 , 
  CDC_FUNC_DESC_OBEX_SERVICE_IDENTIFIER                          = 0x19 , 
  CDC_FUNC_DESC_NCM                                              = 0x1A , 
}cdc_func_desc_type_t;
 
//--------------------------------------------------------------------+
// CDC Data Interface Class
//--------------------------------------------------------------------+
 
// SUBCLASS code of Data Interface is not used and should/must be zero
 
// Data Interface Protocol Codes
typedef enum{
  CDC_DATA_PROTOCOL_ISDN_BRI                               = 0x30, 
  CDC_DATA_PROTOCOL_HDLC                                   = 0x31, 
  CDC_DATA_PROTOCOL_TRANSPARENT                            = 0x32, 
  CDC_DATA_PROTOCOL_Q921_MANAGEMENT                        = 0x50, 
  CDC_DATA_PROTOCOL_Q921_DATA_LINK                         = 0x51, 
  CDC_DATA_PROTOCOL_Q921_TEI_MULTIPLEXOR                   = 0x52, 
  CDC_DATA_PROTOCOL_V42BIS_DATA_COMPRESSION                = 0x90, 
  CDC_DATA_PROTOCOL_EURO_ISDN                              = 0x91, 
  CDC_DATA_PROTOCOL_V24_RATE_ADAPTION_TO_ISDN              = 0x92, 
  CDC_DATA_PROTOCOL_CAPI_COMMAND                           = 0x93, 
  CDC_DATA_PROTOCOL_HOST_BASED_DRIVER                      = 0xFD, 
  CDC_DATA_PROTOCOL_IN_PROTOCOL_UNIT_FUNCTIONAL_DESCRIPTOR = 0xFE  
}cdc_data_protocol_type_t;
 
//--------------------------------------------------------------------+
// Management Element Request (Control Endpoint)
//--------------------------------------------------------------------+
 
typedef enum {
  CDC_REQUEST_SEND_ENCAPSULATED_COMMAND                    = 0x00, 
  CDC_REQUEST_GET_ENCAPSULATED_RESPONSE                    = 0x01, 
  CDC_REQUEST_SET_COMM_FEATURE                             = 0x02,
  CDC_REQUEST_GET_COMM_FEATURE                             = 0x03,
  CDC_REQUEST_CLEAR_COMM_FEATURE                           = 0x04,
 
  CDC_REQUEST_SET_AUX_LINE_STATE                           = 0x10,
  CDC_REQUEST_SET_HOOK_STATE                               = 0x11,
  CDC_REQUEST_PULSE_SETUP                                  = 0x12,
  CDC_REQUEST_SEND_PULSE                                   = 0x13,
  CDC_REQUEST_SET_PULSE_TIME                               = 0x14,
  CDC_REQUEST_RING_AUX_JACK                                = 0x15,
 
  CDC_REQUEST_SET_LINE_CODING                              = 0x20,
  CDC_REQUEST_GET_LINE_CODING                              = 0x21,
  CDC_REQUEST_SET_CONTROL_LINE_STATE                       = 0x22,
  CDC_REQUEST_SEND_BREAK                                   = 0x23,
 
  CDC_REQUEST_SET_RINGER_PARMS                             = 0x30,
  CDC_REQUEST_GET_RINGER_PARMS                             = 0x31,
  CDC_REQUEST_SET_OPERATION_PARMS                          = 0x32,
  CDC_REQUEST_GET_OPERATION_PARMS                          = 0x33,
  CDC_REQUEST_SET_LINE_PARMS                               = 0x34,
  CDC_REQUEST_GET_LINE_PARMS                               = 0x35,
  CDC_REQUEST_DIAL_DIGITS                                  = 0x36,
  CDC_REQUEST_SET_UNIT_PARAMETER                           = 0x37,
  CDC_REQUEST_GET_UNIT_PARAMETER                           = 0x38,
  CDC_REQUEST_CLEAR_UNIT_PARAMETER                         = 0x39,
  CDC_REQUEST_GET_PROFILE                                  = 0x3A,
 
  CDC_REQUEST_SET_ETHERNET_MULTICAST_FILTERS               = 0x40,
  CDC_REQUEST_SET_ETHERNET_POWER_MANAGEMENT_PATTERN_FILTER = 0x41,
  CDC_REQUEST_GET_ETHERNET_POWER_MANAGEMENT_PATTERN_FILTER = 0x42,
  CDC_REQUEST_SET_ETHERNET_PACKET_FILTER                   = 0x43,
  CDC_REQUEST_GET_ETHERNET_STATISTIC                       = 0x44,
 
  CDC_REQUEST_SET_ATM_DATA_FORMAT                          = 0x50,
  CDC_REQUEST_GET_ATM_DEVICE_STATISTICS                    = 0x51,
  CDC_REQUEST_SET_ATM_DEFAULT_VC                           = 0x52,
  CDC_REQUEST_GET_ATM_VC_STATISTICS                        = 0x53,
 
  CDC_REQUEST_MDLM_SEMANTIC_MODEL                          = 0x60,
} cdc_management_request_t;
 
typedef enum {
  CDC_CONTROL_LINE_STATE_DTR = 0x01,
  CDC_CONTROL_LINE_STATE_RTS = 0x02,
} cdc_control_line_state_t;
 
typedef enum {
  CDC_LINE_CODING_STOP_BITS_1   = 0, // 1   bit
  CDC_LINE_CODING_STOP_BITS_1_5 = 1, // 1.5 bits
  CDC_LINE_CODING_STOP_BITS_2   = 2, // 2   bits
} cdc_line_coding_stopbits_t;
 
// TODO Backward compatible for typos. Maybe removed in the future release
#define CDC_LINE_CONDING_STOP_BITS_1   CDC_LINE_CODING_STOP_BITS_1
#define CDC_LINE_CONDING_STOP_BITS_1_5 CDC_LINE_CODING_STOP_BITS_1_5
#define CDC_LINE_CONDING_STOP_BITS_2   CDC_LINE_CODING_STOP_BITS_2
 
typedef enum {
  CDC_LINE_CODING_PARITY_NONE  = 0,
  CDC_LINE_CODING_PARITY_ODD   = 1,
  CDC_LINE_CODING_PARITY_EVEN  = 2,
  CDC_LINE_CODING_PARITY_MARK  = 3,
  CDC_LINE_CODING_PARITY_SPACE = 4,
} cdc_line_coding_parity_t;
 
//--------------------------------------------------------------------+
// Management Element Notification (Notification Endpoint)
//--------------------------------------------------------------------+
 
typedef enum {
  CDC_NOTIF_NETWORK_CONNECTION               = 0x00, 
  CDC_NOTIF_RESPONSE_AVAILABLE               = 0x01, 
  CDC_NOTIF_AUX_JACK_HOOK_STATE              = 0x08,
  CDC_NOTIF_RING_DETECT                      = 0x09,
  CDC_NOTIF_SERIAL_STATE                     = 0x20,
  CDC_NOTIF_CALL_STATE_CHANGE                = 0x28,
  CDC_NOTIF_LINE_STATE_CHANGE                = 0x29,
  CDC_NOTIF_CONNECTION_SPEED_CHANGE          = 0x2A, 
  CDC_NOTIF_MDLM_SEMANTIC_MODEL_NOTIFICATION = 0x40,
}cdc_notification_request_t;
 
//--------------------------------------------------------------------+
// Class Specific Functional Descriptor (Communication Interface)
//--------------------------------------------------------------------+
 
// Start of all packed definitions for compiler without per-type packed
TU_ATTR_PACKED_BEGIN
TU_ATTR_BIT_FIELD_ORDER_BEGIN
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength            ; 
  uint8_t bDescriptorType    ; 
  uint8_t bDescriptorSubType ; 
  uint16_t bcdCDC            ; 
}cdc_desc_func_header_t;
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength                  ; 
  uint8_t bDescriptorType          ; 
  uint8_t bDescriptorSubType       ; 
  uint8_t bControlInterface        ; 
  uint8_t bSubordinateInterface    ; 
}cdc_desc_func_union_t;
 
#define cdc_desc_func_union_n_t(no_slave)\
 struct TU_ATTR_PACKED {                   \
  uint8_t bLength                         ;\
  uint8_t bDescriptorType                 ;\
  uint8_t bDescriptorSubType              ;\
  uint8_t bControlInterface               ;\
  uint8_t bSubordinateInterface[no_slave] ;\
}
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength             ; 
  uint8_t bDescriptorType     ; 
  uint8_t bDescriptorSubType  ; 
  uint8_t iCountryCodeRelDate ; 
  uint16_t wCountryCode       ; 
}cdc_desc_func_country_selection_t;
 
#define cdc_desc_func_country_selection_n_t(no_country) \
  struct TU_ATTR_PACKED {            \
  uint8_t bLength                   ;\
  uint8_t bDescriptorType           ;\
  uint8_t bDescriptorSubType        ;\
  uint8_t iCountryCodeRelDate       ;\
  uint16_t wCountryCode[no_country] ;\
}
 
//--------------------------------------------------------------------+
// PUBLIC SWITCHED TELEPHONE NETWORK (PSTN) SUBCLASS
//--------------------------------------------------------------------+
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength            ; 
  uint8_t bDescriptorType    ; 
  uint8_t bDescriptorSubType ; 
 
  struct {
    uint8_t handle_call    : 1; 
    uint8_t send_recv_call : 1; 
    uint8_t TU_RESERVED    : 6;
  } bmCapabilities;
 
  uint8_t bDataInterface;
}cdc_desc_func_call_management_t;
 
typedef struct TU_ATTR_PACKED
{
  uint8_t support_comm_request                    : 1; 
  uint8_t support_line_request                    : 1; 
  uint8_t support_send_break                      : 1; 
  uint8_t support_notification_network_connection : 1; 
  uint8_t TU_RESERVED                             : 4;
}cdc_acm_capability_t;
 
TU_VERIFY_STATIC(sizeof(cdc_acm_capability_t) == 1, "mostly problem with compiler");
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength                  ; 
  uint8_t bDescriptorType          ; 
  uint8_t bDescriptorSubType       ; 
  cdc_acm_capability_t bmCapabilities ;
}cdc_desc_func_acm_t;
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength            ; 
  uint8_t bDescriptorType    ; 
  uint8_t bDescriptorSubType ; 
  struct {
    uint8_t require_pulse_setup   : 1; 
    uint8_t support_aux_request   : 1; 
    uint8_t support_pulse_request : 1; 
    uint8_t TU_RESERVED           : 5;
  } bmCapabilities;
}cdc_desc_func_direct_line_management_t;
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength            ; 
  uint8_t bDescriptorType    ; 
  uint8_t bDescriptorSubType ; 
  uint8_t bRingerVolSteps    ;
  uint8_t bNumRingerPatterns ;
}cdc_desc_func_telephone_ringer_t;
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength            ; 
  uint8_t bDescriptorType    ; 
  uint8_t bDescriptorSubType ; 
  struct {
    uint8_t simple_mode           : 1;
    uint8_t standalone_mode       : 1;
    uint8_t computer_centric_mode : 1;
    uint8_t TU_RESERVED           : 5;
  } bmCapabilities;
}cdc_desc_func_telephone_operational_modes_t;
 
typedef struct TU_ATTR_PACKED
{
  uint8_t bLength            ; 
  uint8_t bDescriptorType    ; 
  uint8_t bDescriptorSubType ; 
  struct {
    uint32_t interrupted_dialtone   : 1; 
    uint32_t ringback_busy_fastbusy : 1; 
    uint32_t caller_id              : 1; 
    uint32_t incoming_distinctive   : 1; 
    uint32_t dual_tone_multi_freq   : 1; 
    uint32_t line_state_change      : 1; 
    uint32_t TU_RESERVED0           : 2;
    uint32_t TU_RESERVED1           : 16;
    uint32_t TU_RESERVED2           : 8;
  } bmCapabilities;
}cdc_desc_func_telephone_call_state_reporting_capabilities_t;
 
// TODO remove
static inline uint8_t cdc_functional_desc_typeof(uint8_t const * p_desc)
{
  return p_desc[2];
}
 
//--------------------------------------------------------------------+
// Requests
//--------------------------------------------------------------------+
typedef struct TU_ATTR_PACKED
{
  uint32_t bit_rate;
  uint8_t  stop_bits; 
  uint8_t  parity;    
  uint8_t  data_bits; 
} cdc_line_coding_t;
 
TU_VERIFY_STATIC(sizeof(cdc_line_coding_t) == 7, "size is not correct");
 
typedef struct TU_ATTR_PACKED
{
  uint16_t dtr : 1;
  uint16_t rts : 1;
  uint16_t : 6;
  uint16_t : 8;
} cdc_line_control_state_t;
 
TU_VERIFY_STATIC(sizeof(cdc_line_control_state_t) == 2, "size is not correct");
 
TU_ATTR_PACKED_END  // End of all packed definitions
TU_ATTR_BIT_FIELD_ORDER_END
 
#ifdef __cplusplus
 }
#endif
 
#endif