niosvc10lp/include/system_device_driver.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  *
0005  * Copyright (C) 2024 Kevin Kirspel
0006  *
0007  * Redistribution and use in source and binary forms, with or without
0008  * modification, are permitted provided that the following conditions
0009  * are met:
0010  * 1. Redistributions of source code must retain the above copyright
0011  *    notice, this list of conditions and the following disclaimer.
0012  * 2. Redistributions in binary form must reproduce the above copyright
0013  *    notice, this list of conditions and the following disclaimer in the
0014  *    documentation and/or other materials provided with the distribution.
0015  *
0016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
0017  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0018  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0019  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
0020  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
0021  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
0022  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
0023  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
0024  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
0025  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
0026  * SUCH DAMAGE.
0027  */
0028
0029 #ifndef _SYSTEM_DRIVER_H
0030 #define _SYSTEM_DRIVER_H
0031
0032 /* Definitions */
0033 /* IOCTL Definitions */
0034 #define IOCTL_SYSTEM_SOFTWARE_VERSION        0x00
0035 #define IOCTL_SYSTEM_RESET                   0x01
0036
0037 #define VERSION_SIZE                         20
0038
0039 /* Global Structure definitions */
0040 typedef struct SystemControlStruct
0041 {
0042   char version[VERSION_SIZE];
0043 }system_control_t;
0044
0045 #ifdef __cplusplus
0046 extern "C" {
0047 #endif
0048
0049 #define SYSTEM_DRIVER_TABLE_ENTRY \
0050   { system_initialize, system_open, system_close, \
0051     system_read, system_write, system_control }
0052
0053 rtems_device_driver system_initialize(
0054   rtems_device_major_number,
0055   rtems_device_minor_number,
0056   void *
0057 );
0058
0059 rtems_device_driver system_open(
0060   rtems_device_major_number,
0061   rtems_device_minor_number,
0062   void *
0063 );
0064
0065 rtems_device_driver system_close(
0066   rtems_device_major_number,
0067   rtems_device_minor_number,
0068   void *
0069 );
0070
0071 rtems_device_driver system_read(
0072   rtems_device_major_number,
0073   rtems_device_minor_number,
0074   void *
0075 );
0076
0077 rtems_device_driver system_write(
0078   rtems_device_major_number,
0079   rtems_device_minor_number,
0080   void *
0081 );
0082
0083 rtems_device_driver system_control(
0084   rtems_device_major_number,
0085   rtems_device_minor_number,
0086   void *
0087 );
0088
0089 #ifdef __cplusplus
0090 }
0091 #endif
0092
0093 #endif
0094 /* end of include file */
0095