Enda Kilgarriff / platform_drivers

Update platform drivers

inc/i2c.h@8:70fc373a5f46, 2020-02-26 (annotated)

Committer:
mahphalke
Date:
Wed Feb 26 06:09:13 2020 +0000
Revision:
8:70fc373a5f46
Structured platform drivers similar to github version by splitting functionality from single file into multiple modules.

Who changed what in which revision?

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