include/rtems/devnull.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @brief RTEMS /dev/null Device Driver
0007  *
0008  * This include file defines the interface to the RTEMS /dev/null
0009  * device driver.
0010  */
0011
0012 /*
0013  *  Author: Ralf Corsepius (corsepiu@faw.uni-ulm.de)
0014  *
0015  *  COPYRIGHT (c) 1989-2000.
0016  *  On-Line Applications Research Corporation (OAR).
0017  *
0018  * Redistribution and use in source and binary forms, with or without
0019  * modification, are permitted provided that the following conditions
0020  * are met:
0021  * 1. Redistributions of source code must retain the above copyright
0022  *    notice, this list of conditions and the following disclaimer.
0023  * 2. Redistributions in binary form must reproduce the above copyright
0024  *    notice, this list of conditions and the following disclaimer in the
0025  *    documentation and/or other materials provided with the distribution.
0026  *
0027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0028  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0029  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0030  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0031  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0032  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0033  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0034  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0035  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0036  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0037  * POSSIBILITY OF SUCH DAMAGE.
0038  */
0039
0040 #ifndef _RTEMS_DEVNULL_H
0041 #define _RTEMS_DEVNULL_H
0042
0043 #include <rtems/io.h>
0044
0045 /**
0046  *  @defgroup libmisc_devnull Null Device Driver
0047  *
0048  *  @ingroup RTEMSDeviceDrivers
0049  */
0050 /**@{*/
0051
0052 #ifdef __cplusplus
0053 extern "C" {
0054 #endif
0055
0056 #define DEVNULL_DRIVER_TABLE_ENTRY \
0057   { null_initialize, null_open, null_close, null_read, \
0058     null_write, null_control }
0059
0060 #define NULL_SUCCESSFUL RTEMS_SUCCESSFUL
0061
0062 rtems_device_driver null_initialize(
0063   rtems_device_major_number,
0064   rtems_device_minor_number,
0065   void *
0066 );
0067
0068 rtems_device_driver null_open(
0069   rtems_device_major_number,
0070   rtems_device_minor_number,
0071   void *
0072 );
0073
0074 rtems_device_driver null_close(
0075   rtems_device_major_number,
0076   rtems_device_minor_number,
0077   void *
0078 );
0079
0080 rtems_device_driver null_read(
0081   rtems_device_major_number,
0082   rtems_device_minor_number,
0083   void *
0084 );
0085
0086 rtems_device_driver null_write(
0087   rtems_device_major_number,
0088   rtems_device_minor_number,
0089   void *
0090 );
0091
0092 rtems_device_driver null_control(
0093   rtems_device_major_number,
0094   rtems_device_minor_number,
0095   void *
0096 );
0097
0098 #ifdef __cplusplus
0099 }
0100 #endif
0101 /**@}*/
0102 #endif
0103 /* end of include file */