From 63094205d7f148a3775685fb51f680b5297bc589 Mon Sep 17 00:00:00 2001 From: Michal Sieron Date: Tue, 17 Aug 2021 09:27:33 +0200 Subject: [PATCH] Add comment documenting libc/iob.c --- litex/soc/software/libc/iob.c | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/litex/soc/software/libc/iob.c b/litex/soc/software/libc/iob.c index 203cdf527..bf05cd16f 100644 --- a/litex/soc/software/libc/iob.c +++ b/litex/soc/software/libc/iob.c @@ -1,3 +1,19 @@ +/* Most of the code here is ported from console.c + * with slightly changed function signatures and + * names. Picolibc requires providing __iob array + * which contains stdin, stdout and stderr files. + * To simpify things, we can create one file + * which can be both read from and written to, + * and assign it to all three of them. + * + * It does mean, that in future it is possible to + * provide stderr for example which could be non- + * blocking for example. + * + * For more information on __iob and how to create + * it look into picolibc/doc/os.md. + */ + #include #include