stdio.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _PICO_STDIO_H
#define _PICO_STDIO_H
 
#include "pico.h"
 
// PICO_CONFIG: PICO_STDOUT_MUTEX, Enable/disable mutex around stdout, type=bool, default=1, group=pico_stdio
#ifndef PICO_STDOUT_MUTEX
#define PICO_STDOUT_MUTEX 1
#endif
 
// PICO_CONFIG: PICO_STDIO_ENABLE_CRLF_SUPPORT, Enable/disable CR/LF output conversion support, type=bool, default=1, group=pico_stdio
#ifndef PICO_STDIO_ENABLE_CRLF_SUPPORT
#define PICO_STDIO_ENABLE_CRLF_SUPPORT 1
#endif
 
// PICO_CONFIG: PICO_STDIO_DEFAULT_CRLF, Default for CR/LF conversion enabled on all stdio outputs, type=bool, default=1, depends=PICO_STDIO_ENABLE_CRLF_SUPPORT, group=pico_stdio
#ifndef PICO_STDIO_DEFAULT_CRLF
#define PICO_STDIO_DEFAULT_CRLF 1
#endif
 
// PICO_CONFIG: PICO_STDIO_STACK_BUFFER_SIZE, Define printf buffer size (on stack)... this is just a working buffer not a max output size, min=0, max=512, default=128, group=pico_stdio
#ifndef PICO_STDIO_STACK_BUFFER_SIZE
#define PICO_STDIO_STACK_BUFFER_SIZE 128
#endif
 
// PICO_CONFIG: PICO_STDIO_DEADLOCK_TIMEOUT_MS, Time after which to assume stdio_usb is deadlocked by use in IRQ and give up, type=int, default=1000, group=pico_stdio
#ifndef PICO_STDIO_DEADLOCK_TIMEOUT_MS
#define PICO_STDIO_DEADLOCK_TIMEOUT_MS 1000
#endif
 
// PICO_CONFIG: PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS, Directly replace common stdio functions such as putchar from the C-library to avoid pulling in lots of c library code for simple output, type=bool, default=1, advanced=true, group=pico_stdio
#ifndef PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS
#define PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS 1
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdarg.h>
 
typedef struct stdio_driver stdio_driver_t;
 
bool stdio_init_all(void);
 
bool stdio_deinit_all(void);
 
void stdio_flush(void);
 
int stdio_getchar_timeout_us(uint32_t timeout_us);
 
static inline int getchar_timeout_us(uint32_t timeout_us) {
    return stdio_getchar_timeout_us(timeout_us);
}
 
void stdio_set_driver_enabled(stdio_driver_t *driver, bool enabled);
 
void stdio_filter_driver(stdio_driver_t *driver);
 
void stdio_set_translate_crlf(stdio_driver_t *driver, bool translate);
 
int stdio_putchar_raw(int c);
 
static inline int putchar_raw(int c) {
    return stdio_putchar_raw(c);
}
 
int stdio_puts_raw(const char *s);
 
static inline int puts_raw(const char *s) {
    return stdio_puts_raw(s);
}
 
void stdio_set_chars_available_callback(void (*fn)(void*), void *param);
 
int stdio_get_until(char *buf, int len, absolute_time_t until);
 
int stdio_put_string(const char *s, int len, bool newline, bool cr_translation);
 
int stdio_getchar(void);
 
int stdio_putchar(int);
 
int stdio_puts(const char *s);
 
int stdio_vprintf(const char *format, va_list va);
 
int __printflike(1, 0) stdio_printf(const char* format, ...);
 
#ifdef __cplusplus
}
#endif
 
#endif