include/rtems/deviceio.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @brief Operations on IMFS Device Nodes
0007  */
0008
0009 /*
0010  *  COPYRIGHT (c) 1989-2012.
0011  *  On-Line Applications Research Corporation (OAR).
0012  *
0013  * Redistribution and use in source and binary forms, with or without
0014  * modification, are permitted provided that the following conditions
0015  * are met:
0016  * 1. Redistributions of source code must retain the above copyright
0017  *    notice, this list of conditions and the following disclaimer.
0018  * 2. Redistributions in binary form must reproduce the above copyright
0019  *    notice, this list of conditions and the following disclaimer in the
0020  *    documentation and/or other materials provided with the distribution.
0021  *
0022  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0023  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0024  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0025  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0026  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0027  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0028  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0029  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0030  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0031  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0032  * POSSIBILITY OF SUCH DAMAGE.
0033  */
0034
0035 #ifndef _RTEMS_DEVICEIO_H
0036 #define _RTEMS_DEVICEIO_H
0037
0038 #include <rtems/libio.h>
0039
0040 /**
0041  *  @defgroup IMFSDevices IMFS Device IO Handler
0042  *
0043  *  @ingroup IMFS
0044  *
0045  *  This contains the interface to device drivers using the RTEMS Classic API.
0046  */
0047 /**@{*/
0048
0049 #ifdef __cplusplus
0050 extern "C" {
0051 #endif /* __cplusplus */
0052
0053 /**
0054  * @brief IMFS device node handlers.
0055  *
0056  * IMFS Device Node Handlers
0057  *
0058  * This file contains the set of handlers used to map operations on
0059  * IMFS device nodes onto calls to the RTEMS Classic API IO Manager.
0060  */
0061 int rtems_deviceio_open(
0062   rtems_libio_t *iop,
0063   const char *path,
0064   int oflag,
0065   mode_t mode,
0066   rtems_device_major_number major,
0067   rtems_device_minor_number minor
0068 );
0069
0070 int rtems_deviceio_close(
0071   rtems_libio_t *iop,
0072   rtems_device_major_number major,
0073   rtems_device_minor_number minor
0074 );
0075
0076 ssize_t rtems_deviceio_read(
0077   rtems_libio_t *iop,
0078   void *buf,
0079   size_t nbyte,
0080   rtems_device_major_number major,
0081   rtems_device_minor_number minor
0082 );
0083
0084 ssize_t rtems_deviceio_write(
0085   rtems_libio_t *iop,
0086   const void *buf,
0087   size_t nbyte,
0088   rtems_device_major_number major,
0089   rtems_device_minor_number minor
0090 );
0091
0092 int rtems_deviceio_control(
0093   rtems_libio_t *iop,
0094   ioctl_command_t command,
0095   void *buffer,
0096   rtems_device_major_number major,
0097   rtems_device_minor_number minor
0098 );
0099
0100 #ifdef __cplusplus
0101 }
0102 #endif
0103 /* __cplusplus */
0104
0105 /**@}*/
0106
0107 #endif /* _RTEMS_DEVICEIO_H */