include/bsp/i2cdrv.h

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