acm.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Mesotic SAS
 *
 * 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/cdc.h"
#include "usb/usbus.h"
#include "tsrb.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE_EXP
#define CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE (1<<CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE_EXP)
#endif
#ifndef CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE
#define CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE (128)
#endif
 
#if IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_8)
#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE     (8)
#elif IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_16)
#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE    (16)
#elif IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_32)
#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE    (32)
#elif IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_64)
#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE    (64)
#endif
 
#ifndef CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE
#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE    (64)
#endif
#define USBUS_CDC_ACM_INT_EP_SIZE      (8)
 
#define USBUS_CDC_ACM_EP_IN_REQUIRED_NUMOF   2
 
#define USBUS_CDC_ACM_EP_OUT_REQUIRED_NUMOF  1
 
typedef enum {
    USBUS_CDC_ACM_LINE_STATE_DISCONNECTED,
 
    USBUS_CDC_ACM_LINE_STATE_DTE
} usbus_cdcacm_line_state_t;
 
typedef struct usbus_cdcacm_device usbus_cdcacm_device_t;
 
typedef void (*usbus_cdcacm_cb_t)(usbus_cdcacm_device_t *cdcacm,
                                  uint8_t *data, size_t len);
 
typedef int (*usbus_cdcacm_coding_cb_t)(usbus_cdcacm_device_t *cdcacm,
                                        uint32_t baud, uint8_t bits,
                                        uint8_t parity, uint8_t stop);
 
struct usbus_cdcacm_device {
    usbus_handler_t handler_ctrl;       
    usbus_interface_t iface_ctrl;       
    usbus_interface_t iface_data;       
    usbus_descr_gen_t cdcacm_descr;     
    usbus_cdcacm_cb_t cb;               
    usbus_cdcacm_coding_cb_t coding_cb; 
    tsrb_t tsrb;                        
    usbus_t *usbus;                     
    size_t occupied;                    
    usbus_cdcacm_line_state_t state;    
    event_t flush;                      
    usb_req_cdcacm_coding_t coding;     
    usbdev_ep_buf_t out_buf[CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE];
 
    usbdev_ep_buf_t in_buf[CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE];
};
 
void usbus_cdc_acm_init(usbus_t *usbus, usbus_cdcacm_device_t *cdcacm,
                        usbus_cdcacm_cb_t cb,
                        usbus_cdcacm_coding_cb_t coding_cb,
                        uint8_t *buf, size_t len);
 
size_t usbus_cdc_acm_submit(usbus_cdcacm_device_t *cdcacm,
                           const uint8_t *buf, size_t len);
 
void usbus_cdc_acm_flush(usbus_cdcacm_device_t *cdcacm);
 
void usbus_cdc_acm_set_coding_cb(usbus_cdcacm_device_t *cdcacm,
                                 usbus_cdcacm_coding_cb_t coding_cb);
 
#ifdef __cplusplus
}
#endif