usb_cdc.h

Go to the documentation of this file.

/* usb_cdc.h - USB CDC-ACM and CDC-ECM public header */
 
/*
 * Copyright (c) 2017 PHYTEC Messtechnik GmbH
 * Copyright (c) 2025 - 2026 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 

 
#ifndef ZEPHYR_INCLUDE_USB_CLASS_USB_CDC_H_
#define ZEPHYR_INCLUDE_USB_CLASS_USB_CDC_H_

#define CDC_SRN_1_20                    0x0120 __DEPRECATED_MACRO

#define ACM_SUBCLASS                    0x02
#define ECM_SUBCLASS                    0x06
#define EEM_SUBCLASS                    0x0c
#define NCM_SUBCLASS                    0x0d

#define AT_CMD_V250_PROTOCOL            0x01
#define EEM_PROTOCOL                    0x07
#define ACM_VENDOR_PROTOCOL             0xFF
#define NCM_DATA_PROTOCOL               0x01

#define DATA_INTERFACE_CLASS            0x0A

#define HEADER_FUNC_DESC                0x00
#define CALL_MANAGEMENT_FUNC_DESC       0x01
#define ACM_FUNC_DESC                   0x02
#define UNION_FUNC_DESC                 0x06
#define ETHERNET_FUNC_DESC              0x0F
#define ETHERNET_FUNC_DESC_NCM          0x1a


#define USB_CDC_NETWORK_CONNECTION      0x00
#define USB_CDC_RESPONSE_AVAILABLE      0x01
#define USB_CDC_CONNECTION_SPEED_CHANGE 0x2A

#define CDC_SEND_ENC_CMD                0x00
#define CDC_GET_ENC_RSP                 0x01
#define SET_LINE_CODING                 0x20
#define GET_LINE_CODING                 0x21
#define SET_CONTROL_LINE_STATE          0x22


#define USB_CDC_AUX_JACK_HOOK_STATE     0x08
#define USB_CDC_RING_DETECT             0x09
#define USB_CDC_SERIAL_STATE            0x20
#define USB_CDC_LINE_STATE_CHANGE       0x23
#define USB_CDC_CALL_STATE_CHANGE       0x28

#define USB_CDC_SERIAL_STATE_OVERRUN    BIT(6)
#define USB_CDC_SERIAL_STATE_PARITY     BIT(5)
#define USB_CDC_SERIAL_STATE_FRAMING    BIT(4)
#define USB_CDC_SERIAL_STATE_RINGSIGNAL BIT(3)
#define USB_CDC_SERIAL_STATE_BREAK      BIT(2)
#define USB_CDC_SERIAL_STATE_TXCARRIER  BIT(1)
#define USB_CDC_SERIAL_STATE_RXCARRIER  BIT(0)

#define SET_CONTROL_LINE_STATE_RTS      0x02
#define SET_CONTROL_LINE_STATE_DTR      0x01

#define USB_CDC_LINE_CTRL_BAUD_RATE     UART_LINE_CTRL_BAUD_RATE
#define USB_CDC_LINE_CTRL_DCD           UART_LINE_CTRL_DCD
#define USB_CDC_LINE_CTRL_DSR           UART_LINE_CTRL_DSR
#define USB_CDC_LINE_CTRL_BREAK         BIT(5)
#define USB_CDC_LINE_CTRL_RING_SIGNAL   BIT(6)
#define USB_CDC_LINE_CTRL_FRAMING       BIT(7)
#define USB_CDC_LINE_CTRL_PARITY        BIT(8)
#define USB_CDC_LINE_CTRL_OVER_RUN      BIT(9)

#define SERIAL_STATE_OVER_RUN           0x40
#define SERIAL_STATE_PARITY             0x20
#define SERIAL_STATE_FRAMING            0x10
#define SERIAL_STATE_RING_SIGNAL        0x08
#define SERIAL_STATE_BREAK              0x04
#define SERIAL_STATE_TX_CARRIER         0x02
#define SERIAL_STATE_RX_CARRIER         0x01

#define USB_CDC_LINE_CODING_STOP_BITS_1         0
#define USB_CDC_LINE_CODING_STOP_BITS_1_5       1
#define USB_CDC_LINE_CODING_STOP_BITS_2         2
 
#define USB_CDC_LINE_CODING_PARITY_NO           0
#define USB_CDC_LINE_CODING_PARITY_ODD          1
#define USB_CDC_LINE_CODING_PARITY_EVEN         2
#define USB_CDC_LINE_CODING_PARITY_MARK         3
#define USB_CDC_LINE_CODING_PARITY_SPACE        4
 
#define USB_CDC_LINE_CODING_DATA_BITS_5         5
#define USB_CDC_LINE_CODING_DATA_BITS_6         6
#define USB_CDC_LINE_CODING_DATA_BITS_7         7
#define USB_CDC_LINE_CODING_DATA_BITS_8         8

#define SET_ETHERNET_MULTICAST_FILTERS  0x40
#define SET_ETHERNET_PM_FILTER          0x41
#define GET_ETHERNET_PM_FILTER          0x42
#define SET_ETHERNET_PACKET_FILTER      0x43
#define GET_ETHERNET_STATISTIC          0x44

#define GET_NTB_PARAMETERS     0x80
#define GET_NET_ADDRESS        0x81
#define SET_NET_ADDRESS        0x82
#define GET_NTB_FORMAT         0x83
#define SET_NTB_FORMAT         0x84
#define GET_NTB_INPUT_SIZE     0x85
#define SET_NTB_INPUT_SIZE     0x86
#define GET_MAX_DATAGRAM_SIZE  0x87
#define SET_MAX_DATAGRAM_SIZE  0x88
#define GET_CRC_MODE           0x89
#define SET_CRC_MODE           0x8A

#define USB_CDC_NCM_NCAP_ETH_FILTER             BIT(0)
#define USB_CDC_NCM_NCAP_NET_ADDRESS            BIT(1)
#define USB_CDC_NCM_NCAP_ENCAP_COMMAND          BIT(2)
#define USB_CDC_NCM_NCAP_MAX_DATAGRAM_SIZE      BIT(3)
#define USB_CDC_NCM_NCAP_CRC_MODE               BIT(4)
#define USB_CDC_NCM_NCAP_NTB_INPUT_SIZE         BIT(5)

#define PACKET_TYPE_MULTICAST           0x10
#define PACKET_TYPE_BROADCAST           0x08
#define PACKET_TYPE_DIRECTED            0x04
#define PACKET_TYPE_ALL_MULTICAST       0x02
#define PACKET_TYPE_PROMISCUOUS         0x01


#define USB_CDC_ECM_STAT_RESERVED               0x00
#define USB_CDC_ECM_STAT_XMIT_OK                0x01
#define USB_CDC_ECM_STAT_RCV_OK                 0x02
#define USB_CDC_ECM_STAT_XMIT_ERROR             0x03
#define USB_CDC_ECM_STAT_RCV_ERROR              0x04
#define USB_CDC_ECM_STAT_RCV_NO_BUFFER          0x05
#define USB_CDC_ECM_STAT_DIRECTED_BYTES_XMIT    0x06
#define USB_CDC_ECM_STAT_DIRECTED_FRAMES_XMIT   0x07
#define USB_CDC_ECM_STAT_MULTICAST_BYTES_XMIT   0x08
#define USB_CDC_ECM_STAT_MULTICAST_FRAMES_XMIT  0x09
#define USB_CDC_ECM_STAT_BROADCAST_BYTES_XMIT   0x0A
#define USB_CDC_ECM_STAT_BROADCAST_FRAMES_XMIT  0x0B
#define USB_CDC_ECM_STAT_DIRECTED_BYTES_RCV     0x0C
#define USB_CDC_ECM_STAT_DIRECTED_FRAMES_RCV    0x0D
#define USB_CDC_ECM_STAT_MULTICAST_BYTES_RCV    0x0E
#define USB_CDC_ECM_STAT_MULTICAST_FRAMES_RCV   0x0F
#define USB_CDC_ECM_STAT_BROADCAST_BYTES_RCV    0x10
#define USB_CDC_ECM_STAT_BROADCAST_FRAMES_RCV   0x11
#define USB_CDC_ECM_STAT_RCV_CRC_ERROR          0x12
#define USB_CDC_ECM_STAT_TRANSMIT_QUEUE_LENGTH  0x13
#define USB_CDC_ECM_STAT_RCV_ERROR_ALIGNMENT    0x14
#define USB_CDC_ECM_STAT_XMIT_ONE_COLLISION     0x15
#define USB_CDC_ECM_STAT_XMIT_MORE_COLLISIONS   0x16
#define USB_CDC_ECM_STAT_XMIT_DEFERRED          0x17
#define USB_CDC_ECM_STAT_XMIT_MAX_COLLISIONS    0x18
#define USB_CDC_ECM_STAT_RCV_OVERRUN            0x19
#define USB_CDC_ECM_STAT_XMIT_UNDERRUN          0x1A
#define USB_CDC_ECM_STAT_XMIT_HEARTBEAT_FAILURE 0x1B
#define USB_CDC_ECM_STAT_XMIT_TIMES_CRS_LOST    0x1C
#define USB_CDC_ECM_STAT_XMIT_LATE_COLLISIONS   0x1D

struct cdc_header_descriptor {
        uint8_t bFunctionLength;
        uint8_t bDescriptorType;
        uint8_t bDescriptorSubtype;
        uint16_t bcdCDC;
} __packed;

struct cdc_union_descriptor {
        uint8_t bFunctionLength;
        uint8_t bDescriptorType;
        uint8_t bDescriptorSubtype;
        uint8_t bControlInterface;
        uint8_t bSubordinateInterface0;
} __packed;

struct cdc_cm_descriptor {
        uint8_t bFunctionLength;
        uint8_t bDescriptorType;
        uint8_t bDescriptorSubtype;
        uint8_t bmCapabilities;
        uint8_t bDataInterface;
} __packed;

struct cdc_acm_descriptor {
        uint8_t bFunctionLength;
        uint8_t bDescriptorType;
        uint8_t bDescriptorSubtype;
        uint8_t bmCapabilities;
} __packed;

struct cdc_acm_line_coding {
        uint32_t dwDTERate;
        uint8_t bCharFormat;
        uint8_t bParityType;
        uint8_t bDataBits;
} __packed;

struct cdc_acm_notification {
        uint8_t bmRequestType;
        uint8_t bNotificationType;
        uint16_t wValue;
        uint16_t wIndex;
        uint16_t wLength;
        uint16_t data;
} __packed;

struct cdc_ecm_descriptor {
        uint8_t bFunctionLength;
        uint8_t bDescriptorType;
        uint8_t bDescriptorSubtype;
        uint8_t iMACAddress;
        uint32_t bmEthernetStatistics;
        uint16_t wMaxSegmentSize;
        uint16_t wNumberMCFilters;
        uint8_t bNumberPowerFilters;
} __packed;

struct cdc_ncm_descriptor {
        uint8_t bFunctionLength;
        uint8_t bDescriptorType;
        uint8_t bDescriptorSubtype;
        uint16_t bcdNcmVersion;
        uint8_t bmNetworkCapabilities;
} __packed;
 
#endif /* ZEPHYR_INCLUDE_USB_CLASS_USB_CDC_H_ */