i2c.h

00001 /***************************************************************************//**
00002  *   @file   i2c.h
00003  *   @author DBogdan (dragos.bogdan@analog.com)
00004 ********************************************************************************
00005  * Copyright 2019(c) Analog Devices, Inc.
00006  *
00007  * All rights reserved.
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions are met:
00011  *  - Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *  - Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in
00015  *    the documentation and/or other materials provided with the
00016  *    distribution.
00017  *  - Neither the name of Analog Devices, Inc. nor the names of its
00018  *    contributors may be used to endorse or promote products derived
00019  *    from this software without specific prior written permission.
00020  *  - The use of this software may or may not infringe the patent rights
00021  *    of one or more patent holders.  This license does not release you
00022  *    from the requirement that you obtain separate licenses from these
00023  *    patent holders to use this software.
00024  *  - Use of the software either in source or binary form, must be run
00025  *    on or directly connected to an Analog Devices Inc. component.
00026  *
00027  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
00028  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00029  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00030  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
00031  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
00033  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00034  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00035  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 *******************************************************************************/
00038 
00039 #ifndef I2C_H_
00040 #define I2C_H_
00041 
00042 /******************************************************************************/
00043 /***************************** Include Files **********************************/
00044 /******************************************************************************/
00045 
00046 #include <stdint.h>
00047 
00048 /******************************************************************************/
00049 /*************************** Types Declarations *******************************/
00050 /******************************************************************************/
00051 
00052 typedef enum i2c_transfer_mode {
00053     i2c_general_call =  0x01,
00054     i2c_repeated_start =    0x02,
00055     i2c_10_bit_transfer =   0x04
00056 } i2c_transfer_mode;
00057 
00058 typedef struct i2c_init_param {
00059     uint32_t    max_speed_hz;
00060     uint8_t     slave_address;
00061     void        *extra;
00062 } i2c_init_param;
00063 
00064 typedef struct i2c_desc {
00065     uint32_t    max_speed_hz;
00066     uint8_t     slave_address;
00067     void        *extra;
00068 } i2c_desc;
00069 
00070 /******************************************************************************/
00071 /************************ Functions Declarations ******************************/
00072 /******************************************************************************/
00073 
00074 /* Initialize the I2C communication peripheral. */
00075 int32_t i2c_init(struct i2c_desc **desc,
00076          const struct i2c_init_param *param);
00077 
00078 /* Free the resources allocated by i2c_init(). */
00079 int32_t i2c_remove(struct i2c_desc *desc);
00080 
00081 /* Write data to a slave device. */
00082 int32_t i2c_write(struct i2c_desc *desc,
00083           uint8_t *data,
00084           uint8_t bytes_number,
00085           uint8_t option);
00086 
00087 /* Read data from a slave device. */
00088 int32_t i2c_read(struct i2c_desc *desc,
00089          uint8_t *data,
00090          uint8_t bytes_number,
00091          uint8_t option);
00092 
00093 #endif // I2C_H_