include/bsp/rtd316.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsI386
0007  *
0008  * @brief RTD316 driver interface defintions.
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 1989-2014.
0013  *  On-Line Applications Research Corporation (OAR).
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 _BSP_RTD_316_h
0038 #define _BSP_RTD_316_h
0039
0040 #ifdef __cplusplus
0041 extern "C" {
0042 #endif
0043
0044 /**
0045  *  This macro defines the standard device driver table entry for
0046  *  a console device driver.
0047  */
0048 #define RTD316_DRIVER_TABLE_ENTRY \
0049   { rtd316_initialize, NULL, NULL, NULL, NULL, NULL }
0050
0051 /**
0052  *  @brief RTD316 Initialization Entry Point
0053  *
0054  *  This method initializes the RTD316 device driver.
0055  *
0056  *  @param[in] major is the device driver major number
0057  *  @param[in] minor is the device driver minor number
0058  *  @param[in] arg is the parameters to this call
0059  *
0060  *  @return This method returns RTEMS_SUCCESSFUL when
0061  *          the device driver is successfully initialized.
0062  */
0063 rtems_device_driver rtd316_initialize(
0064   rtems_device_major_number  major,
0065   rtems_device_minor_number  minor,
0066   void                      *arg
0067 );
0068
0069 /**
0070  *  @brief RTD316 Obtain Register Helper
0071  *
0072  *  This method is used to read registers on the RTD316.
0073  *
0074  *  @param[in] addr is the base address
0075  *  @param[in] reg is the register number
0076  *
0077  *  @return This method returns the value of the register.
0078  */
0079 uint8_t rtd316_com_get_register(uintptr_t addr, uint8_t reg);
0080
0081 /**
0082  *  @brief RTD316 Set Register Helper
0083  *
0084  *  This method is used to set registers on the RTD316.
0085  *
0086  *  @param[in] addr is the base address
0087  *  @param[in] reg is the register number
0088  */
0089 void rtd316_com_set_register(uintptr_t addr,uint8_t reg, uint8_t val);
0090
0091 #ifdef __cplusplus
0092 }
0093 #endif
0094
0095 #endif
0096 /* end of include file */