06d83c6261
Atmel toolchain AVR compiler provides a transparent in-flash object support using __flash and __memx symbols. The former indicates to compiler that this is a flash-based object. The later used with pointer indicates that the referenced object may reside either in flash or in RAM. The compiler automatically makes 32-bit pointer with flag indicating whether referenced object is in flash or RAM and generates code to access either in run-time. Thus, any function that accepts __memx object can transparently work with RAM and flash objects. For platforms with a Harvard architecture and a very small RAM like AVR this allows to move all constant strings used in trace messages to flash in the instruction address space, releasing resources for other things. This change introduces IOBJ and IPTR type qualifiers. The 'I' indicates that the object may like in instruction space on a Harvard architecture machine. For platforms that do not have __flash and __memx or similar symbols IOBJ and IPTR are empty, making the types equivalent to, for example, 'const char' and 'const char*'. For Atmel compiler these will become 'const __flash char' and 'const __memx char*'. All printf() functions and syslog() functions are changed so that the qualifier is used with the format parameter. From: Dimitry Kloper <dikloper@cisco.com>
204 lines
6.9 KiB
C
204 lines
6.9 KiB
C
/****************************************************************************
|
|
* include/stdio.h
|
|
*
|
|
* Copyright (C) 2007-2009, 2011, 2013-2015 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_STDIO_H
|
|
#define __INCLUDE_STDIO_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <sys/types.h>
|
|
#include <stdarg.h>
|
|
#include <sched.h>
|
|
#include <semaphore.h>
|
|
#include <time.h>
|
|
|
|
#include <nuttx/fs/fs.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* File System Definitions **************************************************/
|
|
|
|
#define FILENAME_MAX _POSIX_NAME_MAX
|
|
|
|
/* The size of the I/O buffers */
|
|
|
|
#if CONFIG_STDIO_BUFFER_SIZE > 0
|
|
# define BUFSIZ CONFIG_STDIO_BUFFER_SIZE
|
|
#endif
|
|
|
|
/* File system error values */
|
|
|
|
#define EOF (-1)
|
|
|
|
/* The first three _iob entries are reserved for standard I/O */
|
|
|
|
#define stdin (&sched_getstreams()->sl_streams[0])
|
|
#define stdout (&sched_getstreams()->sl_streams[1])
|
|
#define stderr (&sched_getstreams()->sl_streams[2])
|
|
|
|
/* These APIs are not implemented and/or can be synthesized from
|
|
* supported APIs.
|
|
*/
|
|
|
|
#define putc(c,s) fputc((c),(s))
|
|
#define putchar(c) fputc(c, stdout)
|
|
#define getc(s) fgetc(s)
|
|
#define getchar() fgetc(stdin)
|
|
#define rewind(s) ((void)fseek((s),0,SEEK_SET))
|
|
|
|
/* Path to the directory where temporary files can be created */
|
|
|
|
#ifndef CONFIG_LIBC_TMPDIR
|
|
# define CONFIG_LIBC_TMPDIR "/tmp"
|
|
#endif
|
|
|
|
#define P_tmpdir CONFIG_LIBC_TMPDIR
|
|
|
|
/* Maximum size of character array to hold tmpnam() output. */
|
|
|
|
#ifndef CONFIG_LIBC_MAX_TMPFILE
|
|
# define CONFIG_LIBC_MAX_TMPFILE 32
|
|
#endif
|
|
|
|
#define L_tmpnam CONFIG_LIBC_MAX_TMPFILE
|
|
|
|
/* The maximum number of unique temporary file names that can be generated */
|
|
|
|
#define TMP_MAX 56800235584ull
|
|
|
|
/****************************************************************************
|
|
* Public Type Definitions
|
|
****************************************************************************/
|
|
|
|
/* Streams */
|
|
|
|
typedef struct file_struct FILE;
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/* ANSI-like File System Interfaces */
|
|
|
|
/* Operations on streams (FILE) */
|
|
|
|
void clearerr(register FILE *stream);
|
|
int fclose(FAR FILE *stream);
|
|
int fflush(FAR FILE *stream);
|
|
int feof(FAR FILE *stream);
|
|
int ferror(FAR FILE *stream);
|
|
int fileno(FAR FILE *stream);
|
|
int fgetc(FAR FILE *stream);
|
|
int fgetpos(FAR FILE *stream, FAR fpos_t *pos);
|
|
char *fgets(FAR char *s, int n, FAR FILE *stream);
|
|
FAR FILE *fopen(FAR const char *path, FAR const char *type);
|
|
int fprintf(FAR FILE *stream, FAR const IPTR char *format, ...);
|
|
int fputc(int c, FAR FILE *stream);
|
|
int fputs(FAR const char *s, FAR FILE *stream);
|
|
size_t fread(FAR void *ptr, size_t size, size_t n_items, FAR FILE *stream);
|
|
FAR FILE *freopen(FAR const char *path, FAR const char *mode,
|
|
FAR FILE *stream);
|
|
int fseek(FAR FILE *stream, long int offset, int whence);
|
|
int fsetpos(FAR FILE *stream, FAR fpos_t *pos);
|
|
long ftell(FAR FILE *stream);
|
|
size_t fwrite(FAR const void *ptr, size_t size, size_t n_items,
|
|
FAR FILE *stream);
|
|
FAR char *gets(FAR char *s);
|
|
FAR char *gets_s(FAR char *s, rsize_t n);
|
|
int ungetc(int c, FAR FILE *stream);
|
|
|
|
/* Operations on the stdout stream, buffers, paths, and the whole printf-family */
|
|
|
|
int printf(FAR const IPTR char *format, ...);
|
|
int puts(FAR const char *s);
|
|
int rename(FAR const char *oldpath, FAR const char *newpath);
|
|
int sprintf(FAR char *buf, FAR const IPTR char *format, ...);
|
|
int asprintf (FAR char **ptr, FAR const IPTR char *fmt, ...);
|
|
int snprintf(FAR char *buf, size_t size,
|
|
FAR const IPTR char *format, ...);
|
|
int sscanf(FAR const char *buf, FAR const char *fmt, ...);
|
|
void perror(FAR const char *s);
|
|
|
|
int vprintf(FAR const IPTR FAR char *format, va_list ap);
|
|
int vfprintf(FAR FILE *stream, FAR const IPTR char *format,
|
|
va_list ap);
|
|
int vsprintf(FAR char *buf, FAR const IPTR char *format, va_list ap);
|
|
int vasprintf(FAR char **ptr, FAR const IPTR char *fmt, va_list ap);
|
|
int vsnprintf(FAR char *buf, size_t size, FAR const IPTR char *format,
|
|
va_list ap);
|
|
int vsscanf(FAR const char *buf, FAR const char *s, va_list ap);
|
|
|
|
/* Operations on file descriptors including:
|
|
*
|
|
* POSIX-like File System Interfaces (fdopen), and
|
|
* Extensions from the Open Group Technical Standard, 2006, Extended API Set
|
|
* Part 1 (dprintf and vdprintf)
|
|
*/
|
|
|
|
FAR FILE *fdopen(int fd, FAR const char *type);
|
|
int dprintf(int fd, FAR const IPTR char *fmt, ...);
|
|
int vdprintf(int fd, FAR const IPTR char *fmt, va_list ap);
|
|
|
|
/* Operations on paths */
|
|
|
|
FAR char *tmpnam(FAR char *s);
|
|
FAR char *tempnam(FAR const char *dir, FAR const char *pfx);
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_STDIO_H */
|