@web-font-path: "roboto-debian.css";
Raspberry Pi

Menu Toggle
Raspberry Pi By Raspberry Pi Ltd
Loading...
Searching...
No Matches
stdio_usb.h
1/*
2 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef _PICO_STDIO_USB_H
8#define _PICO_STDIO_USB_H
9
10#include "pico/stdio.h"
11
25
26// PICO_CONFIG: PICO_STDIO_USB_DEFAULT_CRLF, Default state of CR/LF translation for USB output, type=bool, default=PICO_STDIO_DEFAULT_CRLF, group=pico_stdio_usb
27#ifndef PICO_STDIO_USB_DEFAULT_CRLF
28#define PICO_STDIO_USB_DEFAULT_CRLF PICO_STDIO_DEFAULT_CRLF
29#endif
30
31// PICO_CONFIG: PICO_STDIO_USB_STDOUT_TIMEOUT_US, Number of microseconds to be blocked trying to write USB output before assuming the host has disappeared and discarding data, default=500000, group=pico_stdio_usb
32#ifndef PICO_STDIO_USB_STDOUT_TIMEOUT_US
33#define PICO_STDIO_USB_STDOUT_TIMEOUT_US 500000
34#endif
35
36// todo perhaps unnecessarily frequent?
37// PICO_CONFIG: PICO_STDIO_USB_TASK_INTERVAL_US, Period of microseconds between calling tud_task in the background, default=1000, advanced=true, group=pico_stdio_usb
38#ifndef PICO_STDIO_USB_TASK_INTERVAL_US
39#define PICO_STDIO_USB_TASK_INTERVAL_US 1000
40#endif
41
42// PICO_CONFIG: PICO_STDIO_USB_LOW_PRIORITY_IRQ, Explicit User IRQ number to claim for tud_task() background execution instead of letting the implementation pick a free one dynamically (deprecated), advanced=true, group=pico_stdio_usb
43#ifndef PICO_STDIO_USB_LOW_PRIORITY_IRQ
44// this variable is no longer set by default (one is claimed dynamically), but will be respected if specified
45#endif
46
47// PICO_CONFIG: PICO_STDIO_USB_ENABLE_IRQ_BACKGROUND_TASK, Enable/disable the use of a background task to call tud_task(), type=bool, default=1 if the application is not using tinyUSB directly, group=pico_stdio_usb
48#ifndef PICO_STDIO_USB_ENABLE_IRQ_BACKGROUND_TASK
49#if !LIB_TINYUSB_HOST && !LIB_TINYUSB_DEVICE
50#define PICO_STDIO_USB_ENABLE_IRQ_BACKGROUND_TASK 1
51#else
52#define PICO_STDIO_USB_ENABLE_IRQ_BACKGROUND_TASK 0
53#endif
54#endif
55
56// PICO_CONFIG: PICO_STDIO_USB_ENABLE_TINYUSB_INIT, Enable/disable calling tinyUSB tusb_init() during initialization, type=bool, default=1 if the application is not using tinyUSB directly, group=pico_stdio_usb
57#ifndef PICO_STDIO_USB_ENABLE_TINYUSB_INIT
58#if !LIB_TINYUSB_HOST && !LIB_TINYUSB_DEVICE
59#define PICO_STDIO_USB_ENABLE_TINYUSB_INIT 1
60#else
61#define PICO_STDIO_USB_ENABLE_TINYUSB_INIT 0
62#endif
63#endif
64
65// PICO_CONFIG: PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE, Enable/disable resetting into BOOTSEL mode if the host sets the baud rate to a magic value (PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE), type=bool, default=1 if application is not using TinyUSB directly, group=pico_stdio_usb
66#ifndef PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE
67#if !LIB_TINYUSB_HOST && !LIB_TINYUSB_DEVICE
68#define PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE 1
69#else
70#define PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE 0
71#endif
72#endif
73
74// PICO_CONFIG: PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE, Baud rate that if selected causes a reset into BOOTSEL mode (if PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE is set), default=1200, group=pico_stdio_usb
75#ifndef PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE
76#define PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE 1200
77#endif
78
79// PICO_CONFIG: PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS, Maximum number of milliseconds to wait during initialization for a CDC connection from the host (negative means indefinite) during initialization, default=0, group=pico_stdio_usb
80#ifndef PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS
81#define PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS 0
82#endif
83
84// PICO_CONFIG: PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS, Number of extra milliseconds to wait when using PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS after a host CDC connection is detected (some host terminals seem to sometimes lose transmissions sent right after connection), default=50, group=pico_stdio_usb
85#ifndef PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS
86#define PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS 50
87#endif
88
89// PICO_CONFIG: PICO_STDIO_USB_DEINIT_DELAY_MS, Number of milliseconds to wait before deinitializing stdio_usb, default=110, group=pico_stdio_usb
90#ifndef PICO_STDIO_USB_DEINIT_DELAY_MS
91#define PICO_STDIO_USB_DEINIT_DELAY_MS 110
92#endif
93
94// PICO_CONFIG: PICO_STDIO_USB_RESET_BOOTSEL_ACTIVITY_LED, Optionally define a pin to use as bootloader activity LED when BOOTSEL mode is entered via USB (either VIA_BAUD_RATE or VIA_VENDOR_INTERFACE), type=int, min=0, max=47 on RP2350B, 29 otherwise, group=pico_stdio_usb
95
96// PICO_CONFIG: PICO_STDIO_USB_RESET_BOOTSEL_ACTIVITY_LED_ACTIVE_LOW, Whether pin to use as bootloader activity LED when BOOTSEL mode is entered via USB (either VIA_BAUD_RATE or VIA_VENDOR_INTERFACE) is active low, type=bool, default=0, group=pico_stdio_usb
97#ifndef PICO_STDIO_USB_RESET_BOOTSEL_ACTIVITY_LED_ACTIVE_LOW
98#define PICO_STDIO_USB_RESET_BOOTSEL_ACTIVITY_LED_ACTIVE_LOW 0
99#endif
100
101// PICO_CONFIG: PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED, Whether the pin specified by PICO_STDIO_USB_RESET_BOOTSEL_ACTIVITY_LED is fixed or can be modified by picotool over the VENDOR USB interface, type=bool, default=0, group=pico_stdio_usb
102#ifndef PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED
103#define PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED 0
104#endif
105
106// Any modes disabled here can't be re-enabled by picotool via VENDOR_INTERFACE.
107// PICO_CONFIG: PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK, Optionally disable either the mass storage interface (bit 0) or the PICOBOOT interface (bit 1) when entering BOOTSEL mode via USB (either VIA_BAUD_RATE or VIA_VENDOR_INTERFACE), type=int, min=0, max=3, default=0, group=pico_stdio_usb
108#ifndef PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK
109#define PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK 0u
110#endif
111
112// PICO_CONFIG: PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE, Enable/disable resetting into BOOTSEL mode via an additional VENDOR USB interface - enables picotool based reset, type=bool, default=1 if application is not using TinyUSB directly, group=pico_stdio_usb
113#ifndef PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE
114#if !LIB_TINYUSB_HOST && !LIB_TINYUSB_DEVICE
115#define PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE 1
116#else
117#define PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE 0
118#endif
119#endif
120
121// PICO_CONFIG: PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL, If vendor reset interface is included allow rebooting to BOOTSEL mode, type=bool, default=1, group=pico_stdio_usb
122#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL
123#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL 1
124#endif
125
126// PICO_CONFIG: PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT, If vendor reset interface is included allow rebooting with regular flash boot, type=bool, default=1, group=pico_stdio_usb
127#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT
128#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT 1
129#endif
130
131// PICO_CONFIG: PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR, If vendor reset interface is included add support for Microsoft OS 2.0 Descriptor, type=bool, default=1, group=pico_stdio_usb
132#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR
133#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_MS_OS_20_DESCRIPTOR 1
134#endif
135
136// PICO_CONFIG: PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS, Delay in ms before rebooting via regular flash boot, default=100, group=pico_stdio_usb
137#ifndef PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS
138#define PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS 100
139#endif
140
141// PICO_CONFIG: PICO_STDIO_USB_USE_DEFAULT_DESCRIPTORS, Whether `pico_stdio_usb` provides the USB descriptors needed for USB communication, type=bool, default=1 if the application is not using tinyUSB directly, group=pico_stdio_usb
142#ifndef PICO_STDIO_USB_USE_DEFAULT_DESCRIPTORS
143#if !LIB_TINYUSB_HOST && !LIB_TINYUSB_DEVICE
144#define PICO_STDIO_USB_USE_DEFAULT_DESCRIPTORS 1
145#else
146#define PICO_STDIO_USB_USE_DEFAULT_DESCRIPTORS 0
147#endif
148#endif
149
150// PICO_CONFIG: PICO_STDIO_USB_CONNECTION_WITHOUT_DTR, Disable use of DTR for connection checking meaning connection is assumed to be valid, type=bool, default=0, group=pico_stdio_usb
151#ifndef PICO_STDIO_USB_CONNECTION_WITHOUT_DTR
152#define PICO_STDIO_USB_CONNECTION_WITHOUT_DTR 0
153#endif
154
155// PICO_CONFIG: PICO_STDIO_USB_DEVICE_SELF_POWERED, Set USB device as self powered device, type=bool, default=0, group=pico_stdio_usb
156#ifndef PICO_STDIO_USB_DEVICE_SELF_POWERED
157#define PICO_STDIO_USB_DEVICE_SELF_POWERED 0
158#endif
159
160// PICO_CONFIG: PICO_STDIO_USB_SUPPORT_CHARS_AVAILABLE_CALLBACK, Enable USB STDIO support for stdio_set_chars_available_callback. Can be disabled to make use of USB CDC RX callback elsewhere, type=bool, default=1, group=pico_stdio_usb
161#ifndef PICO_STDIO_USB_SUPPORT_CHARS_AVAILABLE_CALLBACK
162#define PICO_STDIO_USB_SUPPORT_CHARS_AVAILABLE_CALLBACK 1
163#endif
164
165#ifdef __cplusplus
166extern "C" {
167#endif
168
169extern stdio_driver_t stdio_usb;
170
180bool stdio_usb_init(void);
181
187bool stdio_usb_deinit(void);
188
194bool stdio_usb_connected(void);
195
196#if PICO_STDIO_USB_SUPPORT_CHARS_AVAILABLE_CALLBACK
205void stdio_usb_call_chars_available_callback(void);
206#endif
207
208#ifdef __cplusplus
209}
210#endif
211
212#endif
stdio_usb_call_chars_available_callback
void stdio_usb_call_chars_available_callback(void)
Explicitly calls the registered USB stdio chars_available_callback.
stdio_usb_deinit
bool stdio_usb_deinit(void)
Explicitly deinitialize USB stdio and remove it from the current set of stdin drivers.
stdio_usb_connected
bool stdio_usb_connected(void)
Check if there is an active stdio CDC connection to a host.
stdio_usb_init
bool stdio_usb_init(void)
Explicitly initialize USB stdio and add it to the current set of stdin drivers.
Definition stdio_usb.c:300