RTEMS 6.1-rc1
bspIo.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-2-Clause */
2
12/*
13 * Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG
14 * Copyright (C) 2015 On-Line Applications Research Corporation (OAR)
15 *
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38/*
39 * This file is part of the RTEMS quality process and was automatically
40 * generated. If you find something that needs to be fixed or
41 * worded better please post a report or patch to an RTEMS mailing list
42 * or raise a bug report:
43 *
44 * https://www.rtems.org/bugs.html
45 *
46 * For information on updating and regenerating please refer to the How-To
47 * section in the Software Requirements Engineering chapter of the
48 * RTEMS Software Engineering manual. The manual is provided as a part of
49 * a release. For development sources please refer to the online
50 * documentation at:
51 *
52 * https://docs.rtems.org
53 */
54
55/* Generated from spec:/rtems/io/if/header-3 */
56
57#ifndef _RTEMS_BSPIO_H
58#define _RTEMS_BSPIO_H
59
60#include <stdarg.h>
61#include <rtems/score/basedefs.h>
62
63#ifdef __cplusplus
64extern "C" {
65#endif
66
67/* Generated from spec:/rtems/io/if/group-3 */
68
86/* Generated from spec:/rtems/io/if/bsp-output-char-function-type */
87
93typedef void ( *BSP_output_char_function_type )( char );
94
95/* Generated from spec:/rtems/io/if/bsp-output-char */
96
109extern BSP_output_char_function_type BSP_output_char;
110
111/* Generated from spec:/rtems/io/if/putc */
112
137void rtems_putc( char c );
138
139/* Generated from spec:/rtems/io/if/put-char */
140
162void rtems_put_char( int c, void *unused );
163
164/* Generated from spec:/rtems/io/if/putk */
165
196int putk( const char *s );
197
198/* Generated from spec:/rtems/io/if/printk */
199
234RTEMS_PRINTFLIKE( 1, 2 ) int printk( const char *fmt, ... );
235
236/* Generated from spec:/rtems/io/if/vprintk */
237
272int vprintk( const char *fmt, va_list ap );
273
274/* Generated from spec:/rtems/io/if/printk-printer */
275
312int rtems_printk_printer( void *unused, const char *fmt, va_list ap );
313
314/* Generated from spec:/rtems/io/if/bsp-polling-getchar-function-type */
315
321typedef int (* BSP_polling_getchar_function_type )( void );
322
323/* Generated from spec:/rtems/io/if/bsp-poll-char */
324
337extern BSP_polling_getchar_function_type BSP_poll_char;
338
339/* Generated from spec:/rtems/io/if/getchark */
340
367int getchark( void );
368
369#ifdef __cplusplus
370}
371#endif
372
373#endif /* _RTEMS_BSPIO_H */
basedefs.h
This header file provides basic definitions used by the API and the implementation.
BSP_polling_getchar_function_type
int(* BSP_polling_getchar_function_type)(void)
Polled character input functions shall have this type.
Definition: bspIo.h:321
putk
int putk(const char *s)
Outputs the characters of the string and a newline character to the kernel character output device.
Definition: putk.c:46
vprintk
int vprintk(const char *fmt, va_list ap)
Outputs the characters defined by the format string and the variable argument list to the kernel char...
Definition: vprintk.c:43
BSP_output_char
BSP_output_char_function_type BSP_output_char
This function pointer references the kernel character output implementation.
Definition: console.c:67
RTEMS_PRINTFLIKE
RTEMS_PRINTFLIKE(1, 2) int printk(const char *fmt
Outputs the characters defined by the format string and the arguments to the kernel character output ...
rtems_putc
void rtems_putc(char c)
Outputs the character to the kernel character output device.
Definition: rtems_putc.c:42
rtems_printk_printer
int rtems_printk_printer(void *unused, const char *fmt, va_list ap)
Outputs the characters defined by the format string and the variable argument list to the kernel char...
Definition: printk_plugin.c:46
BSP_output_char_function_type
void(* BSP_output_char_function_type)(char)
Polled character output functions shall have this type.
Definition: bspIo.h:93
rtems_put_char
void rtems_put_char(int c, void *unused)
Puts the character using rtems_putc()
Definition: rtems_put_char.c:42
getchark
int getchark(void)
Tries to dequeue a character from the kernel character input device.
Definition: getchark.c:43
BSP_poll_char
BSP_polling_getchar_function_type BSP_poll_char
This function pointer may reference the kernel character input implementation.
Definition: console.c:69
printk
int printk(const char *fmt,...)
Definition: printk.c:36
Generated by doxygen 1.9.4