source: rtems/cpukit/include/rtems/bspIo.h @ 21242c2

4.115
Last change on this file since 21242c2 was 21242c2, checked in by Joel Sherrill <joel.sherrill@…>, on 06/24/11 at 17:52:58

2011-06-24 Joel Sherrill <joel.sherrill@…>

  • 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.
  • Property mode set to 100644
File size: 2.2 KB
Line 
1/**
2 * @file rtems/bspIo.h
3 *
4 * This include file defines the interface to kernel print methods.
5 */
6
7/*
8 *  COPYRIGHT (c) 1998 valette@crf.canon.fr
9 *  COPYRIGHT (c) 2011 On-Line Applications Research Corporation.
10 *
11 *  The license and distribution terms for this file may be
12 *  found in the file LICENSE in this distribution or at
13 *  http://www.rtems.com/license/LICENSE.
14 *
15 *  $Id$
16 */
17#ifndef _RTEMS_BSPIO_H
18#define _RTEMS_BSPIO_H
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
24/*
25 * All the functions declared as extern after this comment
26 * MUST be implemented in each BSP. Using this function,
27 * this directory contains shared code that export higher level
28 * functionnality described after the next command.
29 */
30typedef void    (*BSP_output_char_function_type)        (char c);
31typedef int     (*BSP_polling_getchar_function_type)    (void);
32
33extern  BSP_output_char_function_type           BSP_output_char;
34extern  BSP_polling_getchar_function_type       BSP_poll_char;
35
36/*
37 * All the function declared as extern after this comment
38 * are available for each BSP by compiling and linking
39 * the files contained in this directory PROVIDED definition
40 * and initialisation of the previous variable are done.
41 */
42#include <stdarg.h>
43
44/**
45 *  This method polls for a key in the simplest possible fashion
46 *  from whatever the debug console device is.
47 *
48 *  @return If a character is available, it is returned.  Otherwise
49 *          this method returns -1.
50 *
51 *  @note This method uses the BSP_poll_char pointer to a BSP
52 *        provided method.
53 */
54extern int getchark(void);
55extern void vprintk(const char *fmt, va_list ap);
56extern void printk(const char *fmt, ...);
57extern void putk(const char *s);
58
59/*
60 *  This routine is passed into RTEMS reporting functions
61 *  that may have their output redirected.  In particular,
62 *  the cpu usage, period usage, and stack usage reporting
63 *  functions use this.  If the user provides their
64 *  own "printf plugin", then they may redirect those reports
65 *  as they see fit.
66 */
67extern int printk_plugin(void *context, const char *fmt, ...);
68
69/*
70 *  Type definition for function which can be plugged in to
71 *  certain reporting routines to redirect the output
72 */
73typedef int (*rtems_printk_plugin_t)(void *, const char *format, ...);
74
75#ifdef __cplusplus
76}
77#endif
78
79#endif
Note: See TracBrowser for help on using the repository browser.