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