include/libchip/i2c-sc620.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  * Copyright (c) 2013 embedded brains GmbH & Co. KG
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027
0028 #ifndef I2C_SC620_H
0029 #define I2C_SC620_H
0030
0031 #include <rtems/libi2c.h>
0032
0033 #ifdef __cplusplus
0034 extern "C" {
0035 #endif /* __cplusplus */
0036
0037 /**
0038  * @brief I2C driver for SEMTECH SC620 octal LED driver.
0039  *
0040  * A write() must use two character buffer.  The buffer[0] value specifies the
0041  * register and the buffer[1] value specifies the register data.
0042  *
0043  * A read() must use a one character buffer.  The buffer[0] value specifies the
0044  * register on function entry.  The buffer[0] value contains the register value
0045  * after a successful operation.
0046  */
0047 extern rtems_libi2c_drv_t i2c_sc620_driver;
0048
0049 #ifdef __cplusplus
0050 }
0051 #endif /* __cplusplus */
0052
0053 #endif /* I2C_SC620_H */