cdc.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Dylan Laduranty <dylan.laduranty@mesotic.com>
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for
 * more details.
 */
 
#pragma once

 
#include <stdint.h>
 
#include "usb.h"
#include "usb/descriptor.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define USB_TYPE_DESCRIPTOR_CDC      0x24   
#define USB_CDC_VERSION_BCD          0x0120 

#define USB_CDC_SUBCLASS_NONE          0x00 
#define USB_CDC_SUBCLASS_DLCM          0x01 
#define USB_CDC_SUBCLASS_ACM           0x02 
#define USB_CDC_SUBCLASS_TCM           0x03 
#define USB_CDC_SUBCLASS_MCCM          0x04 
#define USB_CDC_SUBCLASS_CCM           0x05 
#define USB_CDC_SUBCLASS_ENCM          0x06 
#define USB_CDC_SUBCLASS_ANCM          0x07 
#define USB_CDC_SUBCLASS_WHCM          0x08 
#define USB_CDC_SUBCLASS_DM            0x09 
#define USB_CDC_SUBCLASS_MDLM          0x0A 
#define USB_CDC_SUBCLASS_OBEX          0x0B 
#define USB_CDC_SUBCLASS_EEM           0x0C 
#define USB_CDC_SUBCLASS_NCM           0x0D 

#define USB_CDC_PROTOCOL_NONE          0x00 
#define USB_CDC_PROTOCOL_ITU           0x01 
#define USB_CDC_PROTOCOL_PCCA          0x02 
#define USB_CDC_PROTOCOL_PCCA_A        0x03 
#define USB_CDC_PROTOCOL_GSM           0x04 
#define USB_CDC_PROTOCOL_3GPP          0x05 
#define USB_CDC_PROTOCOL_CS            0x06 
#define USB_CDC_PROTOCOL_EEM           0x07 
#define USB_CDC_PROTOCOL_EXT           0xFE 
#define USB_CDC_PROTOCOL_VENDOR        0xFF 

#define USB_CDC_DESCR_SUBTYPE_FUNCTIONAL    0x00 
#define USB_CDC_DESCR_SUBTYPE_CALL_MGMT     0x01 
#define USB_CDC_DESCR_SUBTYPE_ACM           0x02 
#define USB_CDC_DESCR_SUBTYPE_UNION         0x06 
#define USB_CDC_DESCR_SUBTYPE_ETH_NET       0x0f 


#define USB_CDC_MGNT_REQUEST_SET_LINE_CODING            (0x20)

#define USB_CDC_MGNT_REQUEST_GET_LINE_CODING            (0x21)

#define USB_CDC_MGNT_REQUEST_SET_CONTROL_LINE_STATE     (0x22)

#define USB_CDC_MGNT_REQUEST_SET_ETH_MULTICAST_FILTER   0x40

#define USB_CDC_MGNT_REQUEST_SET_ETH_PM_PATTERN_FILTER  0x41

#define USB_CDC_MGNT_REQUEST_GET_ETH_PM_PATTERN_FILTER  0x42

#define USB_CDC_MGNT_REQUEST_SET_ETH_PACKET_FILTER      0x43

#define USB_CDC_MGNT_REQUEST_GET_ETH_STATISTICS         0x44


#define USB_CDC_ACM_CONTROL_LINE_DTE            (0x01)

#define USB_CDC_ACM_CONTROL_LINE_CARRIER        (0x02)


#define USB_CDC_MGNT_NOTIF_NETWORK_CONNECTION   0x00

#define USB_CDC_MGNT_NOTIF_RESPONSE_AVAILABLE   0x01

#define USB_CDC_MGNT_NOTIF_AUX_JACK_HOOK_STATE  0x08

#define USB_CDC_MGNT_NOTIF_RING_DETECT          0x09

#define USB_CDC_MGNT_NOTIF_SERIAL_STATE         0x20

#define USB_CDC_MGNT_NOTIF_CALL_STATE_CHANGE    0x28

#define USB_CDC_MGNT_NOTIF_LINE_STATE_CHANGE    0x29

#define USB_CDC_MGNT_NOTIF_CONN_SPEED_CHANGE    0x2A


typedef struct __attribute__((packed)) {
    uint8_t length;                 
    uint8_t type;                   
    uint8_t subtype;                
    uint8_t macaddress;             
    uint32_t ethernetstatistics;    
    uint16_t maxsegmentsize;        
    uint16_t numbermcfilters;       
    uint8_t numberpowerfilters;     
} usb_desc_ecm_t;

typedef struct __attribute__((packed)) {
    uint8_t length;         
    uint8_t type;           
    uint8_t subtype;        
    uint8_t capabilities;   
} usb_desc_acm_t;

typedef struct __attribute__((packed)) {
    uint8_t length;     
    uint8_t type;       
    uint8_t subtype;    
    uint16_t bcd_cdc;   
} usb_desc_cdc_t;

typedef struct __attribute__((packed)) {
    uint8_t length;     
    uint8_t type;       
    uint8_t subtype;    
    uint8_t master_if;  
    uint8_t slave_if;   
} usb_desc_union_t;

typedef struct __attribute__((packed)) {
    uint8_t length;     
    uint8_t type;       
    uint8_t subtype;    
    uint8_t capabilities; 
    uint8_t data_if;      
} usb_desc_call_mngt_t;

typedef struct __attribute__((packed)) {
    usb_setup_t setup;  
    uint32_t down;      
    uint32_t up;        
} usb_desc_cdcecm_speed_t;


typedef struct __attribute__((packed)) {
    uint32_t baud;      
    uint8_t format;     
    uint8_t parity;     
    uint8_t databits;   
} usb_req_cdcacm_coding_t;
 
#define USB_CDC_ACM_CODING_STOP_BITS_1      0 
#define USB_CDC_ACM_CODING_STOP_BITS_1_5    1 
#define USB_CDC_ACM_CODING_STOP_BITS_2      2 
 
#define USB_CDC_ACM_CODING_PARITY_NONE      0 
#define USB_CDC_ACM_CODING_PARITY_ODD       1 
#define USB_CDC_ACM_CODING_PARITY_EVEN      2 
#define USB_CDC_ACM_CODING_PARITY_MARK      3 
#define USB_CDC_ACM_CODING_PARITY_SPACE     4 
 
#ifdef __cplusplus
}
#endif