Mistake on this page?
Report an issue in GitHub or email us
mbed_retarget.h
1 /*
2  * mbed Microcontroller Library
3  * Copyright (c) 2006-2019 ARM Limited
4  * SPDX-License-Identifier: Apache-2.0
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  */
19 
20 #ifndef RETARGET_H
21 #define RETARGET_H
22 
23 #if __cplusplus
24 #include <cstdio>
25 #else
26 #include <stdio.h>
27 #endif //__cplusplus
28 #include <stdint.h>
29 #include <stddef.h>
30 
31 /* Include logic for errno so we can get errno defined but not bring in error_t,
32  * including errno here prevents an include later, which would redefine our
33  * error codes
34  */
35 #ifndef __error_t_defined
36 #define __error_t_defined 1
37 #endif
38 #include <errno.h>
39 
40 #if defined __has_include
41 # if __has_include (<sys/stat.h>)
42 # include <sys/stat.h>
43 # define HAVE_SYS_STAT_H
44 # endif
45 #endif
46 
47 /* We can get the following standard types from sys/types for gcc, but we
48  * need to define the types ourselves for the other compilers that normally
49  * target embedded systems */
50 typedef signed int ssize_t; ///< Signed size type, usually encodes negative errors
51 typedef signed long off_t; ///< Offset in a data stream
52 typedef unsigned int nfds_t; ///< Number of file descriptors
53 typedef unsigned long long fsblkcnt_t; ///< Count of file system blocks
54 #if defined(__ARMCC_VERSION) || !defined(__GNUC__)
55 typedef unsigned int mode_t; ///< Mode for opening files
56 typedef unsigned int dev_t; ///< Device ID type
57 typedef unsigned long ino_t; ///< File serial number
58 typedef unsigned int nlink_t; ///< Number of links to a file
59 typedef unsigned int uid_t; ///< User ID
60 typedef unsigned int gid_t; ///< Group ID
61 #endif
62 
63 /* Flags for open() and fcntl(GETFL/SETFL)
64  * At present, fcntl only supports reading and writing O_NONBLOCK
65  */
66 #define O_RDONLY 0 ///< Open for reading
67 #define O_WRONLY 1 ///< Open for writing
68 #define O_RDWR 2 ///< Open for reading and writing
69 #define O_NONBLOCK 0x0004 ///< Non-blocking mode
70 #define O_APPEND 0x0008 ///< Set file offset to end of file prior to each write
71 #define O_CREAT 0x0200 ///< Create file if it does not exist
72 #define O_TRUNC 0x0400 ///< Truncate file to zero length
73 #define O_EXCL 0x0800 ///< Fail if file exists
74 #define O_BINARY 0x8000 ///< Open file in binary mode
75 
76 #define O_ACCMODE (O_RDONLY|O_WRONLY|O_RDWR)
77 
78 #define NAME_MAX 255 ///< Maximum size of a name in a file path
79 
80 #define STDIN_FILENO 0
81 #define STDOUT_FILENO 1
82 #define STDERR_FILENO 2
83 
84 #include <time.h>
85 
86 /** \addtogroup platform-public-api */
87 /** @{*/
88 
89 #if !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
90 /**
91  * \defgroup platform_retarget Retarget functions
92  * @{
93  */
94 
95 /* DIR declarations must also be here */
96 #if __cplusplus
97 namespace mbed {
98 class FileHandle;
99 class DirHandle;
100 
101 /** Targets may implement this to change stdin, stdout, stderr.
102  *
103  * If the application hasn't provided mbed_override_console, this is called
104  * to give the target a chance to specify a FileHandle for the console.
105  *
106  * If this is not provided or returns NULL, the console will be:
107  * - BufferedSerial if configuration option "platform.stdio-buffered-serial" is
108  * true and the target has DEVICE_SERIAL;
109  * - Raw HAL serial via serial_getc and serial_putc if
110  * "platform.stdio-buffered-serial" is false and the target has DEVICE_SERIAL;
111  * - stdout/stderr will be a sink and stdin will input a stream of 0s if the
112  * target does not have DEVICE_SERIAL.
113  *
114  * @param fd file descriptor - STDIN_FILENO, STDOUT_FILENO or STDERR_FILENO
115  * @return pointer to FileHandle to override normal stream otherwise NULL
116  */
117 FileHandle *mbed_target_override_console(int fd);
118 
119 /** Applications may implement this to change stdin, stdout, stderr.
120  *
121  * This hook gives the application a chance to specify a custom FileHandle
122  * for the console.
123  *
124  * If this is not provided or returns NULL, the console will be specified
125  * by mbed_target_override_console, else will default to serial - see
126  * mbed_target_override_console for more details.
127  *
128  * Example using BufferedSerial:
129  * @code
130  * FileHandle *mbed::mbed_override_console(int) {
131  * static BufferedSerial my_serial(D0, D1);
132  * return &my_serial;
133  * }
134  * @endcode
135  *
136  * Example using SingleWireOutput:
137  * @code
138  * FileHandle *mbed::mbed_override_console(int) {
139  * static SerialWireOutput swo;
140  * return &swo;
141  * }
142  * @endcode
143  *
144  * Example using arm semihosting:
145  * @code
146  * FileHandle *mbed::mbed_override_console(int fileno) {
147  * static LocalFileSystem fs("host");
148  * if (fileno == STDIN_FILENO) {
149  * static FileHandle *in_terminal;
150  * static int in_open_result = fs.open(&in_terminal, ":tt", O_RDONLY);
151  * return in_terminal;
152  * } else {
153  * static FileHandle *out_terminal;
154  * static int out_open_result = fs.open(&out_terminal, ":tt", O_WRONLY);
155  * return out_terminal;
156  * }
157  * }
158  * @endcode
159  *
160  * @param fd file descriptor - STDIN_FILENO, STDOUT_FILENO or STDERR_FILENO
161  * @return pointer to FileHandle to override normal stream otherwise NULL
162  */
163 FileHandle *mbed_override_console(int fd);
164 
165 /** Look up the Mbed file handle corresponding to a file descriptor
166  *
167  * This conversion function permits an application to find the underlying
168  * FileHandle object corresponding to a POSIX file descriptor.
169  *
170  * This allows access to specialized behavior only available via the
171  * FileHandle API.
172  *
173  * Example of saving power by disabling console input - for buffered serial,
174  * this would release the RX interrupt handler, which would release the
175  * deep sleep lock.
176  * @code
177  * mbed_file_handle(STDIN_FILENO)->enable_input(false);
178  * @endcode
179  *
180  * @param fd file descriptor
181  * @return FileHandle pointer
182  * NULL if descriptor does not correspond to a FileHandle (only
183  * possible if it's not open with current implementation).
184  */
185 FileHandle *mbed_file_handle(int fd);
186 }
187 #endif
188 typedef struct DIR_impl DIR;
189 #endif // !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
190 
191 /* The intent of this section is to unify the errno error values to match
192  * the POSIX definitions for the GCC_ARM, ARMCC and IAR compilers. This is
193  * necessary because the ARMCC/IAR errno.h, or sys/stat.h are missing some
194  * symbol definitions used by the POSIX filesystem API to return errno codes.
195  * Note also that ARMCC errno.h defines some symbol values differently from
196  * the GCC_ARM/IAR/standard POSIX definitions. The definitions guard against
197  * this and future changes by changing the symbol definition as shown below.
198  */
199 #undef EPERM
200 #define EPERM 1 /* Operation not permitted */
201 #undef ENOENT
202 #define ENOENT 2 /* No such file or directory */
203 #undef ESRCH
204 #define ESRCH 3 /* No such process */
205 #undef EINTR
206 #define EINTR 4 /* Interrupted system call */
207 #undef EIO
208 #define EIO 5 /* I/O error */
209 #undef ENXIO
210 #define ENXIO 6 /* No such device or address */
211 #undef E2BIG
212 #define E2BIG 7 /* Argument list too long */
213 #undef ENOEXEC
214 #define ENOEXEC 8 /* Exec format error */
215 #undef EBADF
216 #define EBADF 9 /* Bad file number */
217 #undef ECHILD
218 #define ECHILD 10 /* No child processes */
219 #undef EAGAIN
220 #define EAGAIN 11 /* Try again */
221 #undef ENOMEM
222 #define ENOMEM 12 /* Out of memory */
223 #undef EACCES
224 #define EACCES 13 /* Permission denied */
225 #undef EFAULT
226 #define EFAULT 14 /* Bad address */
227 #undef ENOTBLK
228 #define ENOTBLK 15 /* Block device required */
229 #undef EBUSY
230 #define EBUSY 16 /* Device or resource busy */
231 #undef EEXIST
232 #define EEXIST 17 /* File exists */
233 #undef EXDEV
234 #define EXDEV 18 /* Cross-device link */
235 #undef ENODEV
236 #define ENODEV 19 /* No such device */
237 #undef ENOTDIR
238 #define ENOTDIR 20 /* Not a directory */
239 #undef EISDIR
240 #define EISDIR 21 /* Is a directory */
241 #undef EINVAL
242 #define EINVAL 22 /* Invalid argument */
243 #undef ENFILE
244 #define ENFILE 23 /* File table overflow */
245 #undef EMFILE
246 #define EMFILE 24 /* Too many open files */
247 #undef ENOTTY
248 #define ENOTTY 25 /* Not a typewriter */
249 #undef ETXTBSY
250 #define ETXTBSY 26 /* Text file busy */
251 #undef EFBIG
252 #define EFBIG 27 /* File too large */
253 #undef ENOSPC
254 #define ENOSPC 28 /* No space left on device */
255 #undef ESPIPE
256 #define ESPIPE 29 /* Illegal seek */
257 #undef EROFS
258 #define EROFS 30 /* Read-only file system */
259 #undef EMLINK
260 #define EMLINK 31 /* Too many links */
261 #undef EPIPE
262 #define EPIPE 32 /* Broken pipe */
263 #undef EDOM
264 #define EDOM 33 /* Math argument out of domain of func */
265 #undef ERANGE
266 #define ERANGE 34 /* Math result not representable */
267 #undef EDEADLK
268 #define EDEADLK 35 /* Resource deadlock would occur */
269 #undef ENAMETOOLONG
270 #define ENAMETOOLONG 36 /* File name too long */
271 #undef ENOLCK
272 #define ENOLCK 37 /* No record locks available */
273 #undef ENOSYS
274 #define ENOSYS 38 /* Function not implemented */
275 #undef ENOTEMPTY
276 #define ENOTEMPTY 39 /* Directory not empty */
277 #undef ELOOP
278 #define ELOOP 40 /* Too many symbolic links encountered */
279 #undef EWOULDBLOCK
280 #define EWOULDBLOCK EAGAIN /* Operation would block */
281 #undef ENOMSG
282 #define ENOMSG 42 /* No message of desired type */
283 #undef EIDRM
284 #define EIDRM 43 /* Identifier removed */
285 #undef ECHRNG
286 #define ECHRNG 44 /* Channel number out of range */
287 #undef EL2NSYNC
288 #define EL2NSYNC 45 /* Level 2 not synchronized */
289 #undef EL3HLT
290 #define EL3HLT 46 /* Level 3 halted */
291 #undef EL3RST
292 #define EL3RST 47 /* Level 3 reset */
293 #undef ELNRNG
294 #define ELNRNG 48 /* Link number out of range */
295 #undef EUNATCH
296 #define EUNATCH 49 /* Protocol driver not attached */
297 #undef ENOCSI
298 #define ENOCSI 50 /* No CSI structure available */
299 #undef EL2HLT
300 #define EL2HLT 51 /* Level 2 halted */
301 #undef EBADE
302 #define EBADE 52 /* Invalid exchange */
303 #undef EBADR
304 #define EBADR 53 /* Invalid request descriptor */
305 #undef EXFULL
306 #define EXFULL 54 /* Exchange full */
307 #undef ENOANO
308 #define ENOANO 55 /* No anode */
309 #undef EBADRQC
310 #define EBADRQC 56 /* Invalid request code */
311 #undef EBADSLT
312 #define EBADSLT 57 /* Invalid slot */
313 #undef EDEADLOCK
314 #define EDEADLOCK EDEADLK /* Resource deadlock would occur */
315 #undef EBFONT
316 #define EBFONT 59 /* Bad font file format */
317 #undef ENOSTR
318 #define ENOSTR 60 /* Device not a stream */
319 #undef ENODATA
320 #define ENODATA 61 /* No data available */
321 #undef ETIME
322 #define ETIME 62 /* Timer expired */
323 #undef ENOSR
324 #define ENOSR 63 /* Out of streams resources */
325 #undef ENONET
326 #define ENONET 64 /* Machine is not on the network */
327 #undef ENOPKG
328 #define ENOPKG 65 /* Package not installed */
329 #undef EREMOTE
330 #define EREMOTE 66 /* Object is remote */
331 #undef ENOLINK
332 #define ENOLINK 67 /* Link has been severed */
333 #undef EADV
334 #define EADV 68 /* Advertise error */
335 #undef ESRMNT
336 #define ESRMNT 69 /* Srmount error */
337 #undef ECOMM
338 #define ECOMM 70 /* Communication error on send */
339 #undef EPROTO
340 #define EPROTO 71 /* Protocol error */
341 #undef EMULTIHOP
342 #define EMULTIHOP 72 /* Multihop attempted */
343 #undef EDOTDOT
344 #define EDOTDOT 73 /* RFS specific error */
345 #undef EBADMSG
346 #define EBADMSG 74 /* Not a data message */
347 #undef EOVERFLOW
348 #define EOVERFLOW 75 /* Value too large for defined data type */
349 #undef ENOTUNIQ
350 #define ENOTUNIQ 76 /* Name not unique on network */
351 #undef EBADFD
352 #define EBADFD 77 /* File descriptor in bad state */
353 #undef EREMCHG
354 #define EREMCHG 78 /* Remote address changed */
355 #undef ELIBACC
356 #define ELIBACC 79 /* Can not access a needed shared library */
357 #undef ELIBBAD
358 #define ELIBBAD 80 /* Accessing a corrupted shared library */
359 #undef ELIBSCN
360 #define ELIBSCN 81 /* .lib section in a.out corrupted */
361 #undef ELIBMAX
362 #define ELIBMAX 82 /* Attempting to link in too many shared libraries */
363 #undef ELIBEXEC
364 #define ELIBEXEC 83 /* Cannot exec a shared library directly */
365 #undef EILSEQ
366 #define EILSEQ 84 /* Illegal byte sequence */
367 #undef ERESTART
368 #define ERESTART 85 /* Interrupted system call should be restarted */
369 #undef ESTRPIPE
370 #define ESTRPIPE 86 /* Streams pipe error */
371 #undef EUSERS
372 #define EUSERS 87 /* Too many users */
373 #undef ENOTSOCK
374 #define ENOTSOCK 88 /* Socket operation on non-socket */
375 #undef EDESTADDRREQ
376 #define EDESTADDRREQ 89 /* Destination address required */
377 #undef EMSGSIZE
378 #define EMSGSIZE 90 /* Message too long */
379 #undef EPROTOTYPE
380 #define EPROTOTYPE 91 /* Protocol wrong type for socket */
381 #undef ENOPROTOOPT
382 #define ENOPROTOOPT 92 /* Protocol not available */
383 #undef EPROTONOSUPPORT
384 #define EPROTONOSUPPORT 93 /* Protocol not supported */
385 #undef ESOCKTNOSUPPORT
386 #define ESOCKTNOSUPPORT 94 /* Socket type not supported */
387 #undef EOPNOTSUPP
388 #define EOPNOTSUPP 95 /* Operation not supported on transport endpoint */
389 #undef EPFNOSUPPORT
390 #define EPFNOSUPPORT 96 /* Protocol family not supported */
391 #undef EAFNOSUPPORT
392 #define EAFNOSUPPORT 97 /* Address family not supported by protocol */
393 #undef EADDRINUSE
394 #define EADDRINUSE 98 /* Address already in use */
395 #undef EADDRNOTAVAIL
396 #define EADDRNOTAVAIL 99 /* Cannot assign requested address */
397 #undef ENETDOWN
398 #define ENETDOWN 100 /* Network is down */
399 #undef ENETUNREACH
400 #define ENETUNREACH 101 /* Network is unreachable */
401 #undef ENETRESET
402 #define ENETRESET 102 /* Network dropped connection because of reset */
403 #undef ECONNABORTED
404 #define ECONNABORTED 103 /* Software caused connection abort */
405 #undef ECONNRESET
406 #define ECONNRESET 104 /* Connection reset by peer */
407 #undef ENOBUFS
408 #define ENOBUFS 105 /* No buffer space available */
409 #undef EISCONN
410 #define EISCONN 106 /* Transport endpoint is already connected */
411 #undef ENOTCONN
412 #define ENOTCONN 107 /* Transport endpoint is not connected */
413 #undef ESHUTDOWN
414 #define ESHUTDOWN 108 /* Cannot send after transport endpoint shutdown */
415 #undef ETOOMANYREFS
416 #define ETOOMANYREFS 109 /* Too many references: cannot splice */
417 #undef ETIMEDOUT
418 #define ETIMEDOUT 110 /* Connection timed out */
419 #undef ECONNREFUSED
420 #define ECONNREFUSED 111 /* Connection refused */
421 #undef EHOSTDOWN
422 #define EHOSTDOWN 112 /* Host is down */
423 #undef EHOSTUNREACH
424 #define EHOSTUNREACH 113 /* No route to host */
425 #undef EALREADY
426 #define EALREADY 114 /* Operation already in progress */
427 #undef EINPROGRESS
428 #define EINPROGRESS 115 /* Operation now in progress */
429 #undef ESTALE
430 #define ESTALE 116 /* Stale NFS file handle */
431 #undef EUCLEAN
432 #define EUCLEAN 117 /* Structure needs cleaning */
433 #undef ENOTNAM
434 #define ENOTNAM 118 /* Not a XENIX named type file */
435 #undef ENAVAIL
436 #define ENAVAIL 119 /* No XENIX semaphores available */
437 #undef EISNAM
438 #define EISNAM 120 /* Is a named type file */
439 #undef EREMOTEIO
440 #define EREMOTEIO 121 /* Remote I/O error */
441 #undef EDQUOT
442 #define EDQUOT 122 /* Quota exceeded */
443 #undef ENOMEDIUM
444 #define ENOMEDIUM 123 /* No medium found */
445 #undef EMEDIUMTYPE
446 #define EMEDIUMTYPE 124 /* Wrong medium type */
447 #undef ECANCELED
448 #define ECANCELED 125 /* Operation Canceled */
449 #undef ENOKEY
450 #define ENOKEY 126 /* Required key not available */
451 #undef EKEYEXPIRED
452 #define EKEYEXPIRED 127 /* Key has expired */
453 #undef EKEYREVOKED
454 #define EKEYREVOKED 128 /* Key has been revoked */
455 #undef EKEYREJECTED
456 #define EKEYREJECTED 129 /* Key was rejected by service */
457 #undef EOWNERDEAD
458 #define EOWNERDEAD 130 /* Owner died */
459 #undef ENOTRECOVERABLE
460 #define ENOTRECOVERABLE 131 /* State not recoverable */
461 
462 /* Missing stat.h defines.
463  * The following are sys/stat.h definitions not currently present in the ARMCC
464  * errno.h. Note, ARMCC errno.h defines some symbol values differing from
465  * GCC_ARM/IAR/standard POSIX definitions. Guard against this and future
466  * changes by changing the symbol definition for filesystem use.
467  */
468 #define _IFMT 0170000 //< type of file
469 #define _IFSOCK 0140000 //< socket
470 #define _IFLNK 0120000 //< symbolic link
471 #define _IFREG 0100000 //< regular
472 #define _IFBLK 0060000 //< block special
473 #define _IFDIR 0040000 //< directory
474 #define _IFCHR 0020000 //< character special
475 #define _IFIFO 0010000 //< fifo special
476 
477 #define S_IFMT _IFMT //< type of file
478 #define S_IFSOCK _IFSOCK //< socket
479 #define S_IFLNK _IFLNK //< symbolic link
480 #define S_IFREG _IFREG //< regular
481 #define S_IFBLK _IFBLK //< block special
482 #define S_IFDIR _IFDIR //< directory
483 #define S_IFCHR _IFCHR //< character special
484 #define S_IFIFO _IFIFO //< fifo special
485 
486 #define S_IRWXU (S_IRUSR | S_IWUSR | S_IXUSR)
487 #define S_IRUSR 0000400 ///< read permission, owner
488 #define S_IWUSR 0000200 ///< write permission, owner
489 #define S_IXUSR 0000100 ///< execute/search permission, owner
490 #define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
491 #define S_IRGRP 0000040 ///< read permission, group
492 #define S_IWGRP 0000020 ///< write permission, group
493 #define S_IXGRP 0000010 ///< execute/search permission, group
494 #define S_IRWXO (S_IROTH | S_IWOTH | S_IXOTH)
495 #define S_IROTH 0000004 ///< read permission, other
496 #define S_IWOTH 0000002 ///< write permission, other
497 #define S_IXOTH 0000001 ///< execute/search permission, other
498 
499 #ifndef HAVE_SYS_STAT_H
500 
501 /* Refer to sys/stat standard
502  * Note: Not all fields may be supported by the underlying filesystem
503  */
504 struct stat {
505  dev_t st_dev; ///< Device ID containing file
506  ino_t st_ino; ///< File serial number
507  mode_t st_mode; ///< Mode of file
508  nlink_t st_nlink; ///< Number of links to file
509 
510  uid_t st_uid; ///< User ID
511  gid_t st_gid; ///< Group ID
512 
513  off_t st_size; ///< Size of file in bytes
514 
515  time_t st_atime; ///< Time of last access
516  time_t st_mtime; ///< Time of last data modification
517  time_t st_ctime; ///< Time of last status change
518 };
519 
520 #endif
521 
522 struct statvfs {
523  unsigned long f_bsize; ///< Filesystem block size
524  unsigned long f_frsize; ///< Fragment size (block size)
525 
526  fsblkcnt_t f_blocks; ///< Number of blocks
527  fsblkcnt_t f_bfree; ///< Number of free blocks
528  fsblkcnt_t f_bavail; ///< Number of free blocks for unprivileged users
529 
530  unsigned long f_fsid; ///< Filesystem ID
531 
532  unsigned long f_namemax; ///< Maximum filename length
533 };
534 
535 /* The following are dirent.h definitions are declared here to guarantee
536  * consistency where structure may be different with different toolchains
537  */
538 struct dirent {
539  char d_name[NAME_MAX + 1]; ///< Name of file
540  uint8_t d_type; ///< Type of file
541 };
542 
543 enum {
544  DT_UNKNOWN, ///< The file type could not be determined.
545  DT_FIFO, ///< This is a named pipe (FIFO).
546  DT_CHR, ///< This is a character device.
547  DT_DIR, ///< This is a directory.
548  DT_BLK, ///< This is a block device.
549  DT_REG, ///< This is a regular file.
550  DT_LNK, ///< This is a symbolic link.
551  DT_SOCK, ///< This is a UNIX domain socket.
552 };
553 
554 /* fcntl.h defines */
555 #define F_GETFL 3
556 #define F_SETFL 4
557 
558 struct pollfd {
559  int fd;
560  short events;
561  short revents;
562 };
563 
564 /* POSIX-compatible I/O functions */
565 #if __cplusplus
566 extern "C" {
567 #endif
568 #if !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
569  int open(const char *path, int oflag, ...);
570 #ifndef __IAR_SYSTEMS_ICC__ /* IAR provides fdopen itself */
571 #if __cplusplus
572  std::FILE *fdopen(int fildes, const char *mode);
573 #else
574  FILE *fdopen(int fildes, const char *mode);
575 #endif
576 #endif
577 #endif // !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
578  ssize_t write(int fildes, const void *buf, size_t nbyte);
579  ssize_t read(int fildes, void *buf, size_t nbyte);
580  int fsync(int fildes);
581  int isatty(int fildes);
582 #if !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
583  off_t lseek(int fildes, off_t offset, int whence);
584  int ftruncate(int fildes, off_t length);
585  int fstat(int fildes, struct stat *st);
586  int fcntl(int fildes, int cmd, ...);
587  int poll(struct pollfd fds[], nfds_t nfds, int timeout);
588  int close(int fildes);
589  int stat(const char *path, struct stat *st);
590  int statvfs(const char *path, struct statvfs *buf);
591  DIR *opendir(const char *);
592  struct dirent *readdir(DIR *);
593  int closedir(DIR *);
594  void rewinddir(DIR *);
595  long telldir(DIR *);
596  void seekdir(DIR *, long);
597  int mkdir(const char *name, mode_t n);
598 #endif // !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
599 #if __cplusplus
600 } // extern "C"
601 
602 namespace mbed {
603 #if !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
604 /** This call is an analogue to POSIX fdopen().
605  *
606  * It associates a C stream to an already-opened FileHandle, to allow you to
607  * use C printf/scanf/fwrite etc. The provided FileHandle must remain open -
608  * it will be closed by the C library when fclose(FILE) is called.
609  *
610  * The net effect is fdopen(bind_to_fd(fh), mode), with error handling.
611  *
612  * @param fh a pointer to an opened FileHandle
613  * @param mode operation upon the file descriptor, e.g., "w+"
614  *
615  * @returns a pointer to FILE
616  */
617 std::FILE *fdopen(mbed::FileHandle *fh, const char *mode);
618 
619 /** Bind an mbed FileHandle to a POSIX file descriptor
620  *
621  * This is similar to fdopen, but only operating at the POSIX layer - it
622  * associates a POSIX integer file descriptor with a FileHandle, to allow you
623  * to use POSIX read/write calls etc. The provided FileHandle must remain open -
624  * it will be closed when close(int) is called.
625  *
626  * @param fh a pointer to an opened FileHandle
627  *
628  * @return an integer file descriptor, or negative if no descriptors available
629  */
630 int bind_to_fd(mbed::FileHandle *fh);
631 
632 #else
633 /** Targets may implement this to override how to write to the console.
634  *
635  * If the target has provided minimal_console_putc, this is called
636  * to give the target a chance to specify an alternative minimal console.
637  *
638  * If this is not provided, serial_putc will be used if
639  * `target.console-uart` is `true`, else there will not be an output.
640  *
641  * @param c The char to write
642  * @return The written char
643  */
644 int minimal_console_putc(int c);
645 
646 /** Targets may implement this to override how to read from the console.
647  *
648  * If the target has provided minimal_console_getc, this is called
649  * to give the target a chance to specify an alternative minimal console.
650  *
651  * If this is not provided, serial_getc will be used if
652  * `target.console-uart` is `true`, else no input would be captured.
653  *
654  * @return The char read from the serial port
655  */
656 int minimal_console_getc();
657 #endif // !MBED_CONF_PLATFORM_STDIO_MINIMAL_CONSOLE_ONLY
658 
659 } // namespace mbed
660 
661 #endif // __cplusplus
662 
663 /**@}*/
664 
665 /**@}*/
666 
667 #endif /* RETARGET_H */
This is a character device.
uid_t st_uid
User ID.
fsblkcnt_t f_bfree
Number of free blocks.
This is a symbolic link.
This file is a posix/stdc wrapper for lwip/errno.h.
Class FileHandle.
Definition: FileHandle.h:46
This is a named pipe (FIFO).
fsblkcnt_t f_blocks
Number of blocks.
dev_t st_dev
Device ID containing file.
gid_t st_gid
Group ID.
unsigned long f_fsid
Filesystem ID.
mode_t st_mode
Mode of file.
nlink_t st_nlink
Number of links to file.
The file type could not be determined.
This is a UNIX domain socket.
ino_t st_ino
File serial number.
time_t st_ctime
Time of last status change.
time_t st_atime
Time of last access.
fsblkcnt_t f_bavail
Number of free blocks for unprivileged users.
unsigned long f_namemax
Maximum filename length.
time_t st_mtime
Time of last data modification.
This is a directory.
This is a regular file.
Definition: ATHandler.h:46
This is a block device.
unsigned long f_frsize
Fragment size (block size)
unsigned long f_bsize
Filesystem block size.
off_t st_size
Size of file in bytes.
uint8_t d_type
Type of file.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.