summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/dev/io.h
blob: b8bcde7af405af64408a65eeaa51d1a4743b432b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSDeviceIO
 *
 * @brief This header file provides the interfaces of the
 *   @ref RTEMSDeviceIO.
 */

/*
 * Copyright (C) 2017, 2023 embedded brains GmbH & Co. KG
 *
 * 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.
 *
 * 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 _RTEMS_DEV_IO_H
#define _RTEMS_DEV_IO_H

#include <rtems/score/basedefs.h>

#include <stdarg.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**
 * @defgroup RTEMSDeviceIO Device I/O Support
 *
 * @ingroup RTEMSDeviceDrivers
 *
 * @brief This group contains the Device I/O Support API and implementation.
 *
 * @{
 */

/**
 * @brief This type defines the put character handler.
 *
 * @param c is the character to put.
 *
 * @param arg is the user-provided argument.
 */
typedef void ( *IO_Put_char )( int c, void *arg );

/**
 * @brief Prints characters using the put character handler according to the
 *   format string.
 *
 * @param put_char is the put character handler.
 *
 * @param arg is the user-provided argument for the put character handler.
 *
 * @param fmt is the printf()-style format string.
 *
 * @param ... is the list of parameters required by the format string.
 *
 * @return Returns the count of put characters.
 */
int _IO_Printf(
  IO_Put_char  put_char,
  void        *arg,
  char const  *fmt,
  ...
) RTEMS_PRINTFLIKE( 3, 4 );

/**
 * @brief Prints characters using the put character handler according to the
 *   format string.
 *
 * @param put_char is the put character handler.
 *
 * @param arg is the user-provided argument for the put character handler.
 *
 * @param fmt is the printf()-style format string.
 *
 * @param ap is the argument list required by the format string.
 *
 * @return Returns the count of put characters.
 */
int _IO_Vprintf(
  IO_Put_char  put_char,
  void        *arg,
  char const  *fmt,
  va_list      ap
);

/**
 * @brief Issues a couple of no-operation instructions.
 *
 * This function may be used to burn a couple of processor cycles with minimum
 * impact on the system bus.  It may be used in busy wait loops.
 */
void _IO_Relax( void );

/** @} */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _RTEMS_DEV_IO_H */