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
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, low priority (non hardware) IRQ number to claim for tud_task() background execution, default=31, advanced=true, group=pico_stdio_usb
43#ifndef PICO_STDIO_USB_LOW_PRIORITY_IRQ
44#define PICO_STDIO_USB_LOW_PRIORITY_IRQ 31
45#endif
46
47// 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, group=pico_stdio_usb
48#ifndef PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE
49#define PICO_STDIO_USB_ENABLE_RESET_VIA_BAUD_RATE 1
50#endif
51
52// 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
53#ifndef PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE
54#define PICO_STDIO_USB_RESET_MAGIC_BAUD_RATE 1200
55#endif
56
57// 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
58#ifndef PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS
59#define PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS 0
60#endif
61
62// 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
63#ifndef PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS
64#define PICO_STDIO_USB_POST_CONNECT_WAIT_DELAY_MS 50
65#endif
66
67// 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=29, group=pico_stdio_usb
68
69// 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
70#ifndef PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED
71#define PICO_STDIO_USB_RESET_BOOTSEL_FIXED_ACTIVITY_LED 0
72#endif
73
74// Any modes disabled here can't be re-enabled by picotool via VENDOR_INTERFACE.
75// 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
76#ifndef PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK
77#define PICO_STDIO_USB_RESET_BOOTSEL_INTERFACE_DISABLE_MASK 0u
78#endif
79
80// 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, group=pico_stdio_usb
81#ifndef PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE
82#define PICO_STDIO_USB_ENABLE_RESET_VIA_VENDOR_INTERFACE 1
83#endif
84
85// 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
86#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL
87#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_BOOTSEL 1
88#endif
89
90// 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
91#ifndef PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT
92#define PICO_STDIO_USB_RESET_INTERFACE_SUPPORT_RESET_TO_FLASH_BOOT 1
93#endif
94
95// PICO_CONFIG: PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS, delays in ms before rebooting via regular flash boot, default=100, group=pico_stdio_usb
96#ifndef PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS
97#define PICO_STDIO_USB_RESET_RESET_TO_FLASH_DELAY_MS 100
98#endif
99
100#ifdef __cplusplus
101extern "C" {
102#endif
103
104extern stdio_driver_t stdio_usb;
105
115bool stdio_usb_init(void);
116
122bool stdio_usb_connected(void);
123#ifdef __cplusplus
124}
125#endif
126
127#endif
bool stdio_usb_connected(void)
Check if there is an active stdio CDC connection to a host.
Definition: stdio_usb.c:126
bool stdio_usb_init(void)
Explicitly initialize USB stdio and add it to the current set of stdin drivers.
Definition: stdio_usb.c:91
Definition: driver.h:13