Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
/*
* Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#include <string.h>
#include <stdio.h>
#include <stdarg.h>
#include "pico.h"
#if LIB_PICO_PRINTF_PICO
#include "pico/printf.h"
#endif
#include "pico/stdio.h"
#include "pico/stdio/driver.h"
#include "pico/time.h"
#if PICO_STDOUT_MUTEX
#include "pico/mutex.h"
#endif
#if LIB_PICO_STDIO_UART
#include "pico/stdio_uart.h"
#endif
#if LIB_PICO_STDIO_USB
#include "pico/stdio_usb.h"
#endif
#if LIB_PICO_STDIO_SEMIHOSTING
#include "pico/stdio_semihosting.h"
#endif
#if LIB_PICO_STDIO_RTT
#include "pico/stdio_rtt.h"
#endif
static stdio_driver_t *drivers;
static stdio_driver_t *filter;
#if PICO_STDOUT_MUTEX
auto_init_mutex(print_mutex);
bool stdout_serialize_begin(void) {
return mutex_try_enter_block_until(&print_mutex, make_timeout_time_ms(PICO_STDIO_DEADLOCK_TIMEOUT_MS));
}
void stdout_serialize_end(void) {
mutex_exit(&print_mutex);
}
#else
static bool stdout_serialize_begin(void) {
return true;
}
static void stdout_serialize_end(void) {
}
#endif
static void stdio_out_chars_no_crlf(stdio_driver_t *driver, const char *s, int len) {
driver->out_chars(s, len);
}
static void stdio_out_chars_crlf(stdio_driver_t *driver, const char *s, int len) {
#if PICO_STDIO_ENABLE_CRLF_SUPPORT
if (!driver->crlf_enabled) {
driver->out_chars(s, len);
return;
}
int first_of_chunk = 0;
static const char crlf_str[] = {'\r', '\n'};
for (int i = 0; i < len; i++) {
bool prev_char_was_cr = i > 0 ? s[i - 1] == '\r' : driver->last_ended_with_cr;
if (s[i] == '\n' && !prev_char_was_cr) {
if (i > first_of_chunk) {
driver->out_chars(&s[first_of_chunk], i - first_of_chunk);
}
driver->out_chars(crlf_str, 2);
first_of_chunk = i + 1;
}
}
if (first_of_chunk < len) {
driver->out_chars(&s[first_of_chunk], len - first_of_chunk);
}
if (len > 0) {
driver->last_ended_with_cr = s[len - 1] == '\r';
}
#else
driver->out_chars(s, len);
#endif
}
int stdio_put_string(const char *s, int len, bool newline, bool cr_translation) {
bool serialized = stdout_serialize_begin();
if (!serialized) {
#if PICO_STDIO_IGNORE_NESTED_STDOUT
return 0;
#endif
}
if (len == -1) len = (int)strlen(s);
void (*out_func)(stdio_driver_t *, const char *, int) = cr_translation ? stdio_out_chars_crlf : stdio_out_chars_no_crlf;
for (stdio_driver_t *driver = drivers; driver; driver = driver->next) {
if (!driver->out_chars) continue;
if (filter && filter != driver) continue;
out_func(driver, s, len);
if (newline) {
const char c = '\n';
out_func(driver, &c, 1);
}
}
if (serialized) {
stdout_serialize_end();
}
return len;
}
int stdio_get_until(char *buf, int len, absolute_time_t until) {
do {
// todo round robin might be nice on each call, but then again hopefully
// no source will starve the others
for (stdio_driver_t *driver = drivers; driver; driver = driver->next) {
if (filter && filter != driver) continue;
if (driver->in_chars) {
int read = driver->in_chars(buf, len);
if (read > 0) {
return read;
}
}
}
if (time_reached(until)) {
return PICO_ERROR_TIMEOUT;
}
// we sleep here in case the in_chars methods acquire mutexes or disable IRQs and
// potentially starve out what they are waiting on (have seen this with USB)
busy_wait_us(1);
} while (true);
}
int stdio_putchar_raw(int c) {
char cc = (char)c;
stdio_put_string(&cc, 1, false, false);
return c;
}
int stdio_puts_raw(const char *s) {
int len = (int)strlen(s);
stdio_put_string(s, len, true, false);
stdio_flush();
return len;
}
void stdio_set_driver_enabled(stdio_driver_t *driver, bool enable) {
stdio_driver_t **prev = &drivers;
while (*prev) {
if (*prev == driver) {
if (!enable) {
*prev = driver->next;
driver->next = NULL;
}
return;
}
prev = &(*prev)->next;
}
if (enable) {
*prev = driver;
}
}
void stdio_flush(void) {
for (stdio_driver_t *d = drivers; d; d = d->next) {
if (d->out_flush) d->out_flush();
}
}
#if LIB_PICO_PRINTF_PICO
typedef struct stdio_stack_buffer {
int used;
char buf[PICO_STDIO_STACK_BUFFER_SIZE];
} stdio_stack_buffer_t;
static void stdio_stack_buffer_flush(stdio_stack_buffer_t *buffer) {
if (buffer->used) {
for (stdio_driver_t *d = drivers; d; d = d->next) {
if (!d->out_chars) continue;
if (filter && filter != d) continue;
stdio_out_chars_crlf(d, buffer->buf, buffer->used);
}
buffer->used = 0;
}
}
static void stdio_buffered_printer(char c, void *arg) {
stdio_stack_buffer_t *buffer = (stdio_stack_buffer_t *)arg;
if (buffer->used == PICO_STDIO_STACK_BUFFER_SIZE) {
stdio_stack_buffer_flush(buffer);
}
buffer->buf[buffer->used++] = c;
}
#endif
bool stdio_init_all(void) {
// todo add explicit custom, or registered although you can call stdio_enable_driver explicitly anyway
// These are well known ones
bool rc = false;
#if LIB_PICO_STDIO_UART
stdio_uart_init();
rc = true;
#endif
#if LIB_PICO_STDIO_SEMIHOSTING
stdio_semihosting_init();
rc = true;
#endif
#if LIB_PICO_STDIO_RTT
stdio_rtt_init();
rc = true;
#endif
#if LIB_PICO_STDIO_USB
rc |= stdio_usb_init();
#endif
return rc;
}
bool stdio_deinit_all(void) {
// todo add explicit custom, or registered although you can call stdio_enable_driver explicitly anyway
// These are well known ones
// First flush, to make sure everything is printed
stdio_flush();
bool rc = false;
#if LIB_PICO_STDIO_UART
stdio_uart_deinit();
rc = true;
#endif
#if LIB_PICO_STDIO_SEMIHOSTING
stdio_semihosting_deinit();
rc = true;
#endif
#if LIB_PICO_STDIO_RTT
stdio_rtt_deinit();
rc = true;
#endif
#if LIB_PICO_STDIO_USB
rc = stdio_usb_deinit();
#endif
return rc;
}
int stdio_getchar_timeout_us(uint32_t timeout_us) {
char buf[1];
int rc = stdio_get_until(buf, sizeof(buf), make_timeout_time_us(timeout_us));
if (rc < 0) return rc;
assert(rc);
return (uint8_t)buf[0];
}
void stdio_filter_driver(stdio_driver_t *driver) {
filter = driver;
}
void stdio_set_translate_crlf(stdio_driver_t *driver, bool enabled) {
#if PICO_STDIO_ENABLE_CRLF_SUPPORT
if (enabled && !driver->crlf_enabled) {
driver->last_ended_with_cr = false;
}
driver->crlf_enabled = enabled;
#else
// Suppress -Wunused-parameter
(void)driver;
(void)enabled;
panic_unsupported();
#endif
}
void stdio_set_chars_available_callback(void (*fn)(void*), void *param) {
for (stdio_driver_t *s = drivers; s; s = s->next) {
if (s->set_chars_available_callback) s->set_chars_available_callback(fn, param);
}
}
#if PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS
#define PRIMARY_STDIO_FUNC(x) WRAPPER_FUNC(x)
#else
#define PRIMARY_STDIO_FUNC(x) stdio_ ## x
#endif
int PRIMARY_STDIO_FUNC(getchar)(void) {
char buf[1];
int len = stdio_get_until(buf, 1, at_the_end_of_time);
if (len < 0) return len;
assert(len == 1);
return (uint8_t)buf[0];
}
int PRIMARY_STDIO_FUNC(putchar)(int c) {
char cc = (char)c;
stdio_put_string(&cc, 1, false, true);
return c;
}
int PRIMARY_STDIO_FUNC(puts)(const char *s) {
int len = (int)strlen(s);
stdio_put_string(s, len, true, true);
stdio_flush();
return len;
}
int REAL_FUNC(vprintf)(const char *format, va_list va);
int PRIMARY_STDIO_FUNC(vprintf)(const char *format, va_list va) {
bool serialzed = stdout_serialize_begin();
if (!serialzed) {
#if PICO_STDIO_IGNORE_NESTED_STDOUT
return 0;
#endif
}
int ret;
#if LIB_PICO_PRINTF_PICO
struct stdio_stack_buffer buffer;
buffer.used = 0;
ret = vfctprintf(stdio_buffered_printer, &buffer, format, va);
stdio_stack_buffer_flush(&buffer);
stdio_flush();
#elif LIB_PICO_PRINTF_NONE
((void)format);
((void)va);
extern void printf_none_assert(void);
printf_none_assert();
ret = 0;
#else
ret = REAL_FUNC(vprintf)(format, va);
#endif
if (serialzed) {
stdout_serialize_end();
}
return ret;
}
int __printflike(1, 0) PRIMARY_STDIO_FUNC(printf)(const char* format, ...)
{
va_list va;
va_start(va, format);
int ret = vprintf(format, va);
va_end(va);
return ret;
}
#if PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS
// define the stdio_ versions to be the same as our wrappers
int stdio_getchar(void) __attribute__((alias(__XSTRING(WRAPPER_FUNC(getchar)))));
int stdio_putchar(int) __attribute__((alias(__XSTRING(WRAPPER_FUNC(putchar)))));
int stdio_puts(const char *s) __attribute__((alias(__XSTRING(WRAPPER_FUNC(puts)))));
int stdio_vprintf(const char *format, va_list va) __attribute__((alias(__XSTRING(WRAPPER_FUNC(vprintf)))));
int __printflike(1, 0) stdio_printf(const char* format, ...) __attribute__((alias(__XSTRING(WRAPPER_FUNC(printf)))));
#else
// todo there is no easy way to avoid the wrapper functions since they are in the CMake, so lets just forward for now
int REAL_FUNC(getchar)(void);
int REAL_FUNC(putchar)(int);
int REAL_FUNC(puts)(const char *s);
int __printflike(1, 0) REAL_FUNC(printf)(const char* format, ...);
int WRAPPER_FUNC(getchar)(void) {
return REAL_FUNC(getchar)();
}
int WRAPPER_FUNC(putchar)(int c) {
return REAL_FUNC(putchar)(c);
}
int WRAPPER_FUNC(puts)(const char *s) {
return REAL_FUNC(puts)(s);
}
int WRAPPER_FUNC(vprintf)(const char *format, va_list va) {
return REAL_FUNC(vprintf)(format, va);
}
int __printflike(1, 0) WRAPPER_FUNC(printf)(const char* format, ...) {
va_list va;
va_start(va, format);
int ret = REAL_FUNC(vprintf)(format, va);
va_end(va);
return ret;
}
#endif
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.