Loading...
Searching...
No Matches
acm.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2018 Mesotic SAS
3 * SPDX-License-Identifier: LGPL-2.1-only
4 */
5
6#pragma once
7
20
39
40#include <stdbool.h>
41#include <stdint.h>
42#include "usb/cdc.h"
43#include "usb/usbus.h"
44#include "tsrb.h"
45
46#ifdef __cplusplus
47extern "C" {
48#endif
49
59#ifdef CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE_EXP
60#define CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE (1<<CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE_EXP)
61#endif
62#ifndef CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE
63#define CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE (128)
64#endif
65
69#if IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_8)
70#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE (8)
71#elif IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_16)
72#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE (16)
73#elif IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_32)
74#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE (32)
75#elif IS_ACTIVE(CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE_64)
76#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE (64)
77#endif
78
79#ifndef CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE
80#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE (64)
81#endif
83
87#define USBUS_CDC_ACM_INT_EP_SIZE (8)
88
92#define USBUS_CDC_ACM_EP_IN_REQUIRED_NUMOF 2
93
97#define USBUS_CDC_ACM_EP_OUT_REQUIRED_NUMOF 1
98
113
118
129 uint8_t *data, size_t len);
130
146 uint32_t baud, uint8_t bits,
147 uint8_t parity, uint8_t stop);
148
177
190 usbus_cdcacm_coding_cb_t coding_cb,
191 uint8_t *buf, size_t len);
192
203 const uint8_t *buf, size_t len);
204
211
221 usbus_cdcacm_coding_cb_t coding_cb);
222
223#ifdef __cplusplus
224}
225#endif
226
Definition for USB CDC interfaces.
#define usbdev_ep_buf_t
Instantiation type for usbdev endpoint buffers.
Definition usbdev.h:123
struct event event_t
event structure forward declaration
Definition event.h:132
struct tsrb tsrb_t
thread-safe ringbuffer struct
struct usbus_descr_gen usbus_descr_gen_t
USBUS descriptor generator.
struct usbus_interface usbus_interface_t
USBUS interface.
struct usbus_handler usbus_handler_t
USBUS event handler forward declaration.
Definition usbus.h:220
struct usbus usbus_t
USBUS context forward declaration.
Definition usbus.h:215
#define CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE
USB CDC ACM bulk endpoint size.
Definition acm.h:80
#define CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE
Buffer size for STDIN and STDOUT data to and from USB when using the USBUS_CDC_ACM_STDIO module.
Definition acm.h:63
usbus_cdcacm_line_state_t
CDC ACM line state as reported by the host computer.
Definition acm.h:102
void(* usbus_cdcacm_cb_t)(usbus_cdcacm_device_t *cdcacm, uint8_t *data, size_t len)
CDC ACM data callback.
Definition acm.h:128
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)
Initialize an USBUS CDC ACM interface.
void usbus_cdc_acm_set_coding_cb(usbus_cdcacm_device_t *cdcacm, usbus_cdcacm_coding_cb_t coding_cb)
Set the callback for control settings.
size_t usbus_cdc_acm_submit(usbus_cdcacm_device_t *cdcacm, const uint8_t *buf, size_t len)
Submit bytes to the CDC ACM handler.
void usbus_cdc_acm_flush(usbus_cdcacm_device_t *cdcacm)
Flush the buffer to the USB host.
int(* usbus_cdcacm_coding_cb_t)(usbus_cdcacm_device_t *cdcacm, uint32_t baud, uint8_t bits, uint8_t parity, uint8_t stop)
CDC ACM line coding callback.
Definition acm.h:145
struct usbus_cdcacm_device usbus_cdcacm_device_t
USBUS CDC ACM context struct forward declaration.
Definition acm.h:117
@ USBUS_CDC_ACM_LINE_STATE_DISCONNECTED
No DTE connected.
Definition acm.h:106
@ USBUS_CDC_ACM_LINE_STATE_DTE
DTE (e.g.
Definition acm.h:111
USB CDC ACM line coding setup content.
Definition cdc.h:278
USBUS CDC ACM context struct.
Definition acm.h:152
usbus_cdcacm_coding_cb_t coding_cb
Callback for ACM coding changes.
Definition acm.h:158
tsrb_t tsrb
TSRB for data to the host.
Definition acm.h:159
usbus_t * usbus
USBUS reference.
Definition acm.h:160
event_t flush
device2host forced flush event
Definition acm.h:164
usbus_cdcacm_line_state_t state
Current line state.
Definition acm.h:163
usbus_handler_t handler_ctrl
control handler
Definition acm.h:153
usb_req_cdcacm_coding_t coding
Current coding configuration.
Definition acm.h:165
usbus_interface_t iface_ctrl
CDC control interface.
Definition acm.h:154
size_t occupied
Number of bytes for the host.
Definition acm.h:161
usbus_interface_t iface_data
CDC data interface.
Definition acm.h:155
bool in_busy
IN transfer pending.
Definition acm.h:162
usbdev_ep_buf_t out_buf[CONFIG_USBUS_CDC_ACM_BULK_EP_SIZE]
Host to device data buffer.
Definition acm.h:170
usbus_cdcacm_cb_t cb
Callback for data handlers.
Definition acm.h:157
usbus_descr_gen_t cdcacm_descr
CDC descriptor generator.
Definition acm.h:156
usbdev_ep_buf_t in_buf[CONFIG_USBUS_CDC_ACM_STDIO_BUF_SIZE]
Device to host data buffer.
Definition acm.h:175
USBUS context struct.
Definition usbus.h:444
Thread-safe ringbuffer interface definition.
USBUS basic interface.