i2c_extra.h

00001 /***************************************************************************//**
00002  *   @file     i2c_extra.h
00003  *   @brief:   Header containing extra types required for I2C interface
00004 ********************************************************************************
00005  * Copyright (c) 2021 Analog Devices, Inc.
00006  * All rights reserved.
00007  *
00008  * This software is proprietary to Analog Devices, Inc. and its licensors.
00009  * By using this software you agree to the terms of the associated
00010  * Analog Devices Software License Agreement.
00011 *******************************************************************************/
00012 
00013 #ifndef I2C_EXTRA_H
00014 #define I2C_EXTRA_H
00015 
00016 // Platform support needs to be C-compatible to work with other drivers
00017 #ifdef __cplusplus
00018 extern "C"
00019 {
00020 #endif
00021 
00022 /******************************************************************************/
00023 /***************************** Include Files **********************************/
00024 /******************************************************************************/
00025 #include <stdio.h>
00026 
00027 /******************************************************************************/
00028 /********************** Macros and Constants Definitions **********************/
00029 /******************************************************************************/
00030 
00031 /******************************************************************************/
00032 /********************** Variables and User defined data types *****************/
00033 /******************************************************************************/
00034 
00035 /*
00036  * Note: The structure members are not strongly typed, as this file is included
00037  *       in application specific '.c' files. The mbed code structure does not
00038  *       allow inclusion of mbed driver files (e.g. mbed.h) into '.c' files.
00039  *       All the members are hence typecasted to mbed specific type during
00040  *       i2c init and read/write operations.
00041  **/
00042 
00043 /**
00044 * @struct mbed_i2c_init_param
00045 * @brief Structure holding the I2C init parameters for mbed platform.
00046 */
00047 typedef struct mbed_i2c_init_param {
00048     uint8_t i2c_sda_pin;    // I2C SDA pin (PinName)
00049     uint8_t i2c_scl_pin;    // I2C SCL pin (PinName)
00050 } mbed_i2c_init_param;
00051 
00052 /**
00053 * @struct mbed_i2c_desc
00054 * @brief I2C specific descriptor for the mbed platform.
00055 */
00056 typedef struct mbed_i2c_desc {
00057     void *i2c_port;         // I2C port instance (mbed::I2C)
00058 } mbed_i2c_desc;
00059 
00060 
00061 /******************************************************************************/
00062 /************************ Functions Declarations ******************************/
00063 /******************************************************************************/
00064 
00065 
00066 #ifdef __cplusplus // Closing extern c
00067 }
00068 #endif
00069 
00070 #endif /* I2C_EXTRA_H */