Pratyush Mallick / Mbed OS testing

this is testing

app/noos_mbed/include/i2c.h@0:3afcd581558d, 2021-01-14 (annotated)

Committer:
pmallick
Date:
Thu Jan 14 18:54:16 2021 +0530
Revision:
0:3afcd581558d
this is testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pmallick 0:3afcd581558d 1 /***************************************************************************//**
pmallick 0:3afcd581558d 2 * @file i2c.h
pmallick 0:3afcd581558d 3 * @brief Header file of I2C Interface
pmallick 0:3afcd581558d 4 * @author DBogdan (dragos.bogdan@analog.com)
pmallick 0:3afcd581558d 5 ********************************************************************************
pmallick 0:3afcd581558d 6 * Copyright 2019(c) Analog Devices, Inc.
pmallick 0:3afcd581558d 7 *
pmallick 0:3afcd581558d 8 * All rights reserved.
pmallick 0:3afcd581558d 9 *
pmallick 0:3afcd581558d 10 * Redistribution and use in source and binary forms, with or without
pmallick 0:3afcd581558d 11 * modification, are permitted provided that the following conditions are met:
pmallick 0:3afcd581558d 12 * - Redistributions of source code must retain the above copyright
pmallick 0:3afcd581558d 13 * notice, this list of conditions and the following disclaimer.
pmallick 0:3afcd581558d 14 * - Redistributions in binary form must reproduce the above copyright
pmallick 0:3afcd581558d 15 * notice, this list of conditions and the following disclaimer in
pmallick 0:3afcd581558d 16 * the documentation and/or other materials provided with the
pmallick 0:3afcd581558d 17 * distribution.
pmallick 0:3afcd581558d 18 * - Neither the name of Analog Devices, Inc. nor the names of its
pmallick 0:3afcd581558d 19 * contributors may be used to endorse or promote products derived
pmallick 0:3afcd581558d 20 * from this software without specific prior written permission.
pmallick 0:3afcd581558d 21 * - The use of this software may or may not infringe the patent rights
pmallick 0:3afcd581558d 22 * of one or more patent holders. This license does not release you
pmallick 0:3afcd581558d 23 * from the requirement that you obtain separate licenses from these
pmallick 0:3afcd581558d 24 * patent holders to use this software.
pmallick 0:3afcd581558d 25 * - Use of the software either in source or binary form, must be run
pmallick 0:3afcd581558d 26 * on or directly connected to an Analog Devices Inc. component.
pmallick 0:3afcd581558d 27 *
pmallick 0:3afcd581558d 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
pmallick 0:3afcd581558d 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
pmallick 0:3afcd581558d 30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
pmallick 0:3afcd581558d 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
pmallick 0:3afcd581558d 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
pmallick 0:3afcd581558d 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
pmallick 0:3afcd581558d 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
pmallick 0:3afcd581558d 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
pmallick 0:3afcd581558d 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
pmallick 0:3afcd581558d 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
pmallick 0:3afcd581558d 38 *******************************************************************************/
pmallick 0:3afcd581558d 39
pmallick 0:3afcd581558d 40 #ifndef I2C_H_
pmallick 0:3afcd581558d 41 #define I2C_H_
pmallick 0:3afcd581558d 42
pmallick 0:3afcd581558d 43 /******************************************************************************/
pmallick 0:3afcd581558d 44 /***************************** Include Files **********************************/
pmallick 0:3afcd581558d 45 /******************************************************************************/
pmallick 0:3afcd581558d 46
pmallick 0:3afcd581558d 47 #include <stdint.h>
pmallick 0:3afcd581558d 48
pmallick 0:3afcd581558d 49 /******************************************************************************/
pmallick 0:3afcd581558d 50 /*************************** Types Declarations *******************************/
pmallick 0:3afcd581558d 51 /******************************************************************************/
pmallick 0:3afcd581558d 52
pmallick 0:3afcd581558d 53 /**
pmallick 0:3afcd581558d 54 * @struct i2c_platform_ops
pmallick 0:3afcd581558d 55 * @brief Structure holding I2C function pointers that point to the platform
pmallick 0:3afcd581558d 56 * specific function
pmallick 0:3afcd581558d 57 */
pmallick 0:3afcd581558d 58 struct i2c_platform_ops ;
pmallick 0:3afcd581558d 59
pmallick 0:3afcd581558d 60 /**
pmallick 0:3afcd581558d 61 * @struct i2c_init_param
pmallick 0:3afcd581558d 62 * @brief Structure holding the parameters for I2C initialization.
pmallick 0:3afcd581558d 63 */
pmallick 0:3afcd581558d 64 typedef struct i2c_init_param {
pmallick 0:3afcd581558d 65 /** I2C maximum transfer speed supported */
pmallick 0:3afcd581558d 66 uint32_t max_speed_hz;
pmallick 0:3afcd581558d 67 /** Slave address */
pmallick 0:3afcd581558d 68 uint8_t slave_address;
pmallick 0:3afcd581558d 69 /** I2C platform specific functions */
pmallick 0:3afcd581558d 70 const struct i2c_platform_ops *platform_ops;
pmallick 0:3afcd581558d 71 /** I2C extra parameters (device specific parameters) */
pmallick 0:3afcd581558d 72 void *extra;
pmallick 0:3afcd581558d 73 } i2c_init_param;
pmallick 0:3afcd581558d 74
pmallick 0:3afcd581558d 75 /**
pmallick 0:3afcd581558d 76 * @struct i2c_desc
pmallick 0:3afcd581558d 77 * @brief Structure holding I2C descriptor
pmallick 0:3afcd581558d 78 */
pmallick 0:3afcd581558d 79 typedef struct i2c_desc {
pmallick 0:3afcd581558d 80 /** I2C maximum transfer speed supported */
pmallick 0:3afcd581558d 81 uint32_t max_speed_hz;
pmallick 0:3afcd581558d 82 /** Slave address */
pmallick 0:3afcd581558d 83 uint8_t slave_address;
pmallick 0:3afcd581558d 84 /** I2C platform specific functions */
pmallick 0:3afcd581558d 85 const struct i2c_platform_ops *platform_ops;
pmallick 0:3afcd581558d 86 /** I2C extra parameters (device specific parameters) */
pmallick 0:3afcd581558d 87 void *extra;
pmallick 0:3afcd581558d 88 } i2c_desc;
pmallick 0:3afcd581558d 89
pmallick 0:3afcd581558d 90 /**
pmallick 0:3afcd581558d 91 * @struct i2c_platform_ops
pmallick 0:3afcd581558d 92 * @brief Structure holding i2c function pointers that point to the platform
pmallick 0:3afcd581558d 93 * specific function
pmallick 0:3afcd581558d 94 */
pmallick 0:3afcd581558d 95 struct i2c_platform_ops {
pmallick 0:3afcd581558d 96 /** i2c initialization function pointer */
pmallick 0:3afcd581558d 97 int32_t (*i2c_ops_init)(struct i2c_desc **, const struct i2c_init_param *);
pmallick 0:3afcd581558d 98 /** i2c write function pointer */
pmallick 0:3afcd581558d 99 int32_t (*i2c_ops_write)(struct i2c_desc *, uint8_t *, uint8_t, uint8_t);
pmallick 0:3afcd581558d 100 /** i2c write function pointer */
pmallick 0:3afcd581558d 101 int32_t (*i2c_ops_read)(struct i2c_desc *, uint8_t *, uint8_t, uint8_t);
pmallick 0:3afcd581558d 102 /** i2c remove function pointer */
pmallick 0:3afcd581558d 103 int32_t (*i2c_ops_remove)(struct i2c_desc *);
pmallick 0:3afcd581558d 104 };
pmallick 0:3afcd581558d 105
pmallick 0:3afcd581558d 106 /******************************************************************************/
pmallick 0:3afcd581558d 107 /************************ Functions Declarations ******************************/
pmallick 0:3afcd581558d 108 /******************************************************************************/
pmallick 0:3afcd581558d 109
pmallick 0:3afcd581558d 110 /* Initialize the I2C communication peripheral. */
pmallick 0:3afcd581558d 111 int32_t i2c_init(struct i2c_desc **desc,
pmallick 0:3afcd581558d 112 const struct i2c_init_param *param);
pmallick 0:3afcd581558d 113
pmallick 0:3afcd581558d 114 /* Free the resources allocated by i2c_init(). */
pmallick 0:3afcd581558d 115 int32_t i2c_remove(struct i2c_desc *desc);
pmallick 0:3afcd581558d 116
pmallick 0:3afcd581558d 117 /* Write data to a slave device. */
pmallick 0:3afcd581558d 118 int32_t i2c_write(struct i2c_desc *desc,
pmallick 0:3afcd581558d 119 uint8_t *data,
pmallick 0:3afcd581558d 120 uint8_t bytes_number,
pmallick 0:3afcd581558d 121 uint8_t stop_bit);
pmallick 0:3afcd581558d 122
pmallick 0:3afcd581558d 123 /* Read data from a slave device. */
pmallick 0:3afcd581558d 124 int32_t i2c_read(struct i2c_desc *desc,
pmallick 0:3afcd581558d 125 uint8_t *data,
pmallick 0:3afcd581558d 126 uint8_t bytes_number,
pmallick 0:3afcd581558d 127 uint8_t stop_bit);
pmallick 0:3afcd581558d 128
pmallick 0:3afcd581558d 129 #endif // I2C_H_