include/rtems/devzero.h

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