tusb_cdc_acm.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020-2022 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "freertos/timers.h"
#include "tusb.h"
#include "tinyusb.h"

typedef enum {
    TINYUSB_CDC_ACM_0 = 0x0,
    TINYUSB_CDC_ACM_1,
    TINYUSB_CDC_ACM_MAX
} tinyusb_cdcacm_itf_t;
 
/* Callbacks and events
   ********************************************************************* */

typedef struct {
    char wanted_char; 
} cdcacm_event_rx_wanted_char_data_t;

typedef struct {
    bool dtr; 
    bool rts; 
} cdcacm_event_line_state_changed_data_t;

typedef struct {
    cdc_line_coding_t const *p_line_coding; 
} cdcacm_event_line_coding_changed_data_t;

typedef enum {
    CDC_EVENT_RX,
    CDC_EVENT_RX_WANTED_CHAR,
    CDC_EVENT_LINE_STATE_CHANGED,
    CDC_EVENT_LINE_CODING_CHANGED
} cdcacm_event_type_t;

typedef struct {
    cdcacm_event_type_t type; 
    union {
        cdcacm_event_rx_wanted_char_data_t rx_wanted_char_data; 
        cdcacm_event_line_state_changed_data_t line_state_changed_data; 
        cdcacm_event_line_coding_changed_data_t line_coding_changed_data; 
    };
} cdcacm_event_t;

typedef void(*tusb_cdcacm_callback_t)(int itf, cdcacm_event_t *event);
 
/*********************************************************************** Callbacks and events*/
/* Other structs
   ********************************************************************* */

typedef struct {
    tinyusb_usbdev_t usb_dev; 
    tinyusb_cdcacm_itf_t cdc_port;  
    size_t rx_unread_buf_sz; 
    tusb_cdcacm_callback_t callback_rx;  
    tusb_cdcacm_callback_t callback_rx_wanted_char; 
    tusb_cdcacm_callback_t callback_line_state_changed; 
    tusb_cdcacm_callback_t callback_line_coding_changed; 
} tinyusb_config_cdcacm_t;
 
/*********************************************************************** Other structs*/
/* Public functions
   ********************************************************************* */
esp_err_t tusb_cdc_acm_init(const tinyusb_config_cdcacm_t *cfg);
 

esp_err_t tinyusb_cdcacm_register_callback(tinyusb_cdcacm_itf_t itf,
        cdcacm_event_type_t event_type,
        tusb_cdcacm_callback_t callback);
 

esp_err_t tinyusb_cdcacm_unregister_callback(tinyusb_cdcacm_itf_t itf, cdcacm_event_type_t event_type);
 

size_t tinyusb_cdcacm_write_queue_char(tinyusb_cdcacm_itf_t itf, char ch);
 

size_t tinyusb_cdcacm_write_queue(tinyusb_cdcacm_itf_t itf, const uint8_t *in_buf, size_t in_size);

esp_err_t tinyusb_cdcacm_write_flush(tinyusb_cdcacm_itf_t itf, uint32_t timeout_ticks);

esp_err_t tinyusb_cdcacm_read(tinyusb_cdcacm_itf_t itf, uint8_t *out_buf, size_t out_buf_sz, size_t *rx_data_size);
 

bool tusb_cdc_acm_initialized(tinyusb_cdcacm_itf_t itf);
 
/*********************************************************************** Public functions*/
 
#ifdef __cplusplus
}
#endif