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