Changeset a575af8 in rtems


Ignore:
Timestamp:
Mar 10, 2015, 9:55:58 PM (4 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
a2fe43b
Parents:
bdf23b6c
git-author:
Joel Sherrill <joel.sherrill@…> (03/10/15 21:55:58)
git-committer:
Joel Sherrill <joel.sherrill@…> (03/11/15 21:18:29)
Message:

cpukit/include/rtems/bspIo.h: Add Doxygen comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/bspIo.h

    rbdf23b6c ra575af8  
    1515 *  http://www.rtems.org/license/LICENSE.
    1616 */
     17
    1718#ifndef _RTEMS_BSPIO_H
    1819#define _RTEMS_BSPIO_H
     
    2223#endif
    2324
    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.
     25/**
     26 * @defgroup BSPIO Kernel Print Support
     27 *
     28 * This module contains all methods and support related to providing
     29 * kernel level print support.
     30 *
     31 * The following variables below are declared as extern and
     32 * MUST be declared and initialized in each BSP. Using this indirect
     33 * function, the functionality in this group is tailored for the BSP.
     34 *
     35 *  - BSP_output_char
     36 *  - BSP_poll_char
     37 */
     38
     39/**
     40 * This type defines the prototype for the BSP provided method to
     41 * print a single character. It is assumed to be polled.
    2942 */
    3043typedef void    (*BSP_output_char_function_type)        (char c);
     44
     45/**
     46 * This type defines the prototype for the BSP provided method to
     47 * input a single character. It is assumed to be polled.
     48 */
    3149typedef int     (*BSP_polling_getchar_function_type)    (void);
    3250
     51/**
     52 * This variable points to the BSP provided method to output a
     53 * character for the purposes of debug output.
     54 */
    3355extern  BSP_output_char_function_type           BSP_output_char;
     56
     57/**
     58 * This variable points to the BSP provided method to input a
     59 * character for the purposes of debug input.
     60 */
    3461extern  BSP_polling_getchar_function_type       BSP_poll_char;
    3562
    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  */
    4263#include <stdarg.h>
    4364
    4465/**
    45  *  This method polls for a key in the simplest possible fashion
    46  *  from whatever the debug console device is.
     66 * @brief Get Character (kernel I/O)
    4767 *
    48  *  @return If a character is available, it is returned.  Otherwise
    49  *          this method returns -1.
     68 * This method polls for a key in the simplest possible fashion
     69 * from whatever the debug console device is.
    5070 *
    51  *  @note This method uses the BSP_poll_char pointer to a BSP
    52  *        provided method.
     71 * @return If a character is available, it is returned.  Otherwise
     72 *         this method returns -1.
     73 *
     74 * @note This method uses the BSP_poll_char pointer to a BSP
     75 *       provided method.
    5376 */
    5477extern int getchark(void);
     78
     79/**
     80 * @brief Variable Argument printk()
     81 *
     82 * This method allows the user to access printk() functionality
     83 * with a va_list style argument.
     84 *
     85 * @param[in] fmt is a printf()-style format string
     86 * @param[in] ap is a va_list pointer to arguments
     87 */
    5588extern void vprintk(const char *fmt, va_list ap);
     89
     90/**
     91 * @brief Kernel Print
     92 *
     93 * This method allows the user to perform a debug printk().
     94 *
     95 * @param[in] fmt is a printf()-style format string
     96 */
    5697extern void printk(const char *fmt, ...);
     98
     99/**
     100 * @brief Kernel Put String
     101 *
     102 * This method allows the user to perform a debug puts().
     103 *
     104 * @param[in] s is the string to print
     105 */
    57106extern void putk(const char *s);
     107
     108/**
     109 * @brief Kernel Put Character
     110 *
     111 * This method allows the user to perform a debug putc().
     112 *
     113 * @param[in] c is the character to print
     114 */
    58115extern void rtems_putc(char c);
    59116
    60 /*
    61  *  This routine is passed into RTEMS reporting functions
    62  *  that may have their output redirected.  In particular,
    63  *  the cpu usage, period usage, and stack usage reporting
    64  *  functions use this.  If the user provides their
    65  *  own "printf plugin", then they may redirect those reports
    66  *  as they see fit.
     117/**
     118 * Type definition for function which can be plugged in to
     119 * certain reporting routines to redirect the output.
     120 *
     121 * Methods following this prototype may be passed into RTEMS reporting
     122 * functions that allow their output to be redirected.  In particular,
     123 * the cpu usage, period usage, and stack usage reporting
     124 * functions use this.
     125 *
     126 * If the user provides their own "printf plugin", then they may
     127 * redirect those reports as they see fit.
     128 */
     129typedef int (*rtems_printk_plugin_t)(void *, const char *format, ...);
     130
     131/**
     132 * @brief Reporting Methods printk() Plugin
     133 *
     134 * @param[in] context points to a user defined context.
     135 * @param[in] fmt is a printf()-style format string
     136 *
     137 * @return The number of characters printed.
    67138 */
    68139extern int printk_plugin(void *context, const char *fmt, ...);
    69140
     141/**
     142 * @brief Reporting Methods printf() Plugin
     143 *
     144 * This is a standard plug-in to support using printf() for output
     145 * instead of printk().
     146 *
     147 * @param[in] context points to a user defined context.
     148 * @param[in] fmt is a printf()-style format string
     149 *
     150 * @return The number of characters printed.
     151 */
    70152extern int rtems_printf_plugin(void *context, const char *fmt, ...);
    71153
    72 /*
    73  *  Type definition for function which can be plugged in to
    74  *  certain reporting routines to redirect the output
    75  */
    76 typedef int (*rtems_printk_plugin_t)(void *, const char *format, ...);
     154/**@}*/
    77155
    78156#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.