mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-08-26 14:08:26 +08:00
Joel Sherrill
21242c252a
* include/rtems/bspIo.h, include/rtems/concat.h, include/rtems/endian.h, include/rtems/fs.h, include/rtems/irq.h, include/rtems/pci.h, include/rtems/userenv.h, libblock/include/rtems/flashdisk.h, libblock/include/rtems/nvdisk-sram.h, libblock/include/rtems/nvdisk.h, libcsupport/include/clockdrv.h, libcsupport/include/console.h, libcsupport/include/iosupp.h, libcsupport/include/spurious.h, libcsupport/include/motorola/mc68230.h, libcsupport/include/rtems/assoc.h, libcsupport/include/rtems/error.h, libcsupport/include/rtems/framebuffer.h, libcsupport/include/rtems/gxx_wrappers.h, libcsupport/include/rtems/libcsupport.h, libcsupport/include/rtems/libio_.h, libcsupport/include/rtems/malloc.h, libcsupport/include/rtems/termiostypes.h, libcsupport/include/sys/statvfs.h, libcsupport/include/sys/termios.h, libcsupport/include/sys/utsname.h, libcsupport/include/zilog/z8036.h, libcsupport/include/zilog/z8530.h, libcsupport/include/zilog/z8536.h, libfs/src/imfs/imfs.h, libfs/src/pipe/pipe.h, libmisc/capture/capture-cli.h, libmisc/capture/capture.h, libmisc/cpuuse/cpuuse.h, libmisc/devnull/devnull.h, libmisc/devnull/devzero.h, libmisc/dumpbuf/dumpbuf.h, libmisc/fb/fb.h, libmisc/fb/mw_uid.h, libmisc/mouse/mouse_parser.h, libmisc/shell/shellconfig.h, libmisc/stringto/stringto.h, libmisc/untar/untar.h, libnetworking/memory.h, posix/include/aio.h, posix/include/mqueue.h, posix/include/semaphore.h, posix/include/rtems/posix/aio_misc.h, posix/include/rtems/posix/barrier.h, posix/include/rtems/posix/cond.h, posix/include/rtems/posix/config.h, posix/include/rtems/posix/key.h, posix/include/rtems/posix/mqueue.h, posix/include/rtems/posix/mutex.h, posix/include/rtems/posix/posixapi.h, posix/include/rtems/posix/priority.h, posix/include/rtems/posix/psignal.h, posix/include/rtems/posix/pthread.h, posix/include/rtems/posix/ptimer.h, posix/include/rtems/posix/rwlock.h, posix/include/rtems/posix/semaphore.h, posix/include/rtems/posix/sigset.h, posix/include/rtems/posix/spinlock.h, posix/include/rtems/posix/threadsup.h, posix/include/rtems/posix/time.h, posix/include/rtems/posix/timer.h, posix/inline/rtems/posix/barrier.inl, posix/inline/rtems/posix/cond.inl, posix/inline/rtems/posix/mqueue.inl, posix/inline/rtems/posix/mutex.inl, posix/inline/rtems/posix/priority.inl, posix/inline/rtems/posix/pthread.inl, posix/inline/rtems/posix/rwlock.inl, posix/inline/rtems/posix/semaphore.inl, posix/inline/rtems/posix/spinlock.inl, posix/inline/rtems/posix/timer.inl, rtems/mainpage.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/timer.h, rtems/inline/rtems/rtems/barrier.inl, rtems/inline/rtems/rtems/timer.inl, rtems/src/semtranslatereturncode.c, sapi/include/rtems/config.h, sapi/include/rtems/fatal.h, sapi/include/rtems/mptables.h, score/include/rtems/score/object.h, score/include/rtems/score/priority.h, score/inline/rtems/score/object.inl, score/inline/rtems/score/priority.inl: Add @file Doxygen directives and descriptions to files which originated with RTEMS. This improves the file list page generated by Doxygen.
80 lines
2.2 KiB
C
80 lines
2.2 KiB
C
/**
|
|
* @file rtems/bspIo.h
|
|
*
|
|
* This include file defines the interface to kernel print methods.
|
|
*/
|
|
|
|
/*
|
|
* COPYRIGHT (c) 1998 valette@crf.canon.fr
|
|
* COPYRIGHT (c) 2011 On-Line Applications Research Corporation.
|
|
*
|
|
* The license and distribution terms for this file may be
|
|
* found in the file LICENSE in this distribution or at
|
|
* http://www.rtems.com/license/LICENSE.
|
|
*
|
|
* $Id$
|
|
*/
|
|
#ifndef _RTEMS_BSPIO_H
|
|
#define _RTEMS_BSPIO_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* All the functions declared as extern after this comment
|
|
* MUST be implemented in each BSP. Using this function,
|
|
* this directory contains shared code that export higher level
|
|
* functionnality described after the next command.
|
|
*/
|
|
typedef void (*BSP_output_char_function_type) (char c);
|
|
typedef int (*BSP_polling_getchar_function_type) (void);
|
|
|
|
extern BSP_output_char_function_type BSP_output_char;
|
|
extern BSP_polling_getchar_function_type BSP_poll_char;
|
|
|
|
/*
|
|
* All the function declared as extern after this comment
|
|
* are available for each BSP by compiling and linking
|
|
* the files contained in this directory PROVIDED definition
|
|
* and initialisation of the previous variable are done.
|
|
*/
|
|
#include <stdarg.h>
|
|
|
|
/**
|
|
* This method polls for a key in the simplest possible fashion
|
|
* from whatever the debug console device is.
|
|
*
|
|
* @return If a character is available, it is returned. Otherwise
|
|
* this method returns -1.
|
|
*
|
|
* @note This method uses the BSP_poll_char pointer to a BSP
|
|
* provided method.
|
|
*/
|
|
extern int getchark(void);
|
|
extern void vprintk(const char *fmt, va_list ap);
|
|
extern void printk(const char *fmt, ...);
|
|
extern void putk(const char *s);
|
|
|
|
/*
|
|
* This routine is passed into RTEMS reporting functions
|
|
* that may have their output redirected. In particular,
|
|
* the cpu usage, period usage, and stack usage reporting
|
|
* functions use this. If the user provides their
|
|
* own "printf plugin", then they may redirect those reports
|
|
* as they see fit.
|
|
*/
|
|
extern int printk_plugin(void *context, const char *fmt, ...);
|
|
|
|
/*
|
|
* Type definition for function which can be plugged in to
|
|
* certain reporting routines to redirect the output
|
|
*/
|
|
typedef int (*rtems_printk_plugin_t)(void *, const char *format, ...);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|