include/rtems/print.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSPrintSupport
0007  *
0008  * @brief User print interface to the bspIO print plug in.
0009  *
0010  * This include file defines the user interface to kernel print methods.
0011  */
0012
0013 /*
0014  *  Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
0015  *  All rights reserved.
0016  *
0017  * Redistribution and use in source and binary forms, with or without
0018  * modification, are permitted provided that the following conditions
0019  * are met:
0020  * 1. Redistributions of source code must retain the above copyright
0021  *    notice, this list of conditions and the following disclaimer.
0022  * 2. Redistributions in binary form must reproduce the above copyright
0023  *    notice, this list of conditions and the following disclaimer in the
0024  *    documentation and/or other materials provided with the distribution.
0025  *
0026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0036  * POSSIBILITY OF SUCH DAMAGE.
0037  */
0038
0039 #ifndef _RTEMS_PRINT_H
0040 #define _RTEMS_PRINT_H
0041
0042 #include <rtems/score/basedefs.h>
0043
0044 #include <stdarg.h>
0045
0046 #ifdef __cplusplus
0047 extern "C" {
0048 #endif
0049
0050 typedef struct rtems_printer rtems_printer;
0051
0052 /**
0053  * @defgroup RTEMSPrintSupport RTEMS Print Support
0054  *
0055  * @ingroup RTEMSAPIPrintSupport
0056  *
0057  * This module contains all methods and support related to providing the user
0058  * with an interface to the kernel level print support.
0059  *
0060  * @{
0061  */
0062
0063 /**
0064  * @brief Print to the kernel plugin handler. This has to be a macro because
0065  * there is no vprint version of the plug in handlers.
0066  *
0067  * @param[in] printer Pointer to the printer structure.
0068  * @param[in] fmt Print format string.
0069  * @param[in] ... Print variable argument list.
0070  *
0071  * @return int Number of characters printed.
0072  */
0073 extern int rtems_printf(const rtems_printer *printer,
0074                         const char          *format,
0075                         ...) RTEMS_PRINTFLIKE(2, 3);
0076
0077 /**
0078  * @brief Print to the kernel plugin handler. This has to be a macro because
0079  * there is no vprint version of the plug in handlers.
0080  *
0081  * @param[in] printer Pointer to the printer structure.
0082  * @param[in] fmt Print format string.
0083  * @param[in] ap Print variable argument list pointer.
0084  *
0085  * @return int Number of characters printed.
0086  */
0087 extern int rtems_vprintf(const rtems_printer *printer,
0088                          const char          *format,
0089                          va_list              ap);
0090
0091 /** @} */
0092
0093 #ifdef __cplusplus
0094 }
0095 #endif
0096
0097 #endif /* _RTEMS_PRINT_H */