Enda Kilgarriff / platform_drivers

Update platform drivers

src/i2c_extra.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_extra.h
mahphalke 8:70fc373a5f46 3 * @brief: Header containing extra types required for I2C interface
mahphalke 8:70fc373a5f46 4 ********************************************************************************
mahphalke 8:70fc373a5f46 5 * Copyright (c) 2020 Analog Devices, Inc.
mahphalke 8:70fc373a5f46 6 *
mahphalke 8:70fc373a5f46 7 * All rights reserved.
mahphalke 8:70fc373a5f46 8 *
mahphalke 8:70fc373a5f46 9 * This software is proprietary to Analog Devices, Inc. and its licensors.
mahphalke 8:70fc373a5f46 10 * By using this software you agree to the terms of the associated
mahphalke 8:70fc373a5f46 11 * Analog Devices Software License Agreement.
mahphalke 8:70fc373a5f46 12 *******************************************************************************/
mahphalke 8:70fc373a5f46 13
mahphalke 8:70fc373a5f46 14 #ifndef I2C_EXTRA_H
mahphalke 8:70fc373a5f46 15 #define I2C_EXTRA_H
mahphalke 8:70fc373a5f46 16
mahphalke 8:70fc373a5f46 17
mahphalke 8:70fc373a5f46 18 // Platform support needs to be C-compatible to work with other drivers
mahphalke 8:70fc373a5f46 19 #ifdef __cplusplus
mahphalke 8:70fc373a5f46 20 extern "C"
mahphalke 8:70fc373a5f46 21 {
mahphalke 8:70fc373a5f46 22 #endif
mahphalke 8:70fc373a5f46 23
mahphalke 8:70fc373a5f46 24 /******************************************************************************/
mahphalke 8:70fc373a5f46 25 /***************************** Include Files **********************************/
mahphalke 8:70fc373a5f46 26 /******************************************************************************/
mahphalke 8:70fc373a5f46 27 #include <stdio.h>
mahphalke 8:70fc373a5f46 28
mahphalke 8:70fc373a5f46 29 /******************************************************************************/
mahphalke 8:70fc373a5f46 30 /********************** Macros and Constants Definitions **********************/
mahphalke 8:70fc373a5f46 31 /******************************************************************************/
mahphalke 8:70fc373a5f46 32
mahphalke 8:70fc373a5f46 33 /******************************************************************************/
mahphalke 8:70fc373a5f46 34 /********************** Variables and User defined data types *****************/
mahphalke 8:70fc373a5f46 35 /******************************************************************************/
mahphalke 8:70fc373a5f46 36
mahphalke 8:70fc373a5f46 37 /*
mahphalke 8:70fc373a5f46 38 * Note: The structure members are not strongly typed, as this file is included
mahphalke 8:70fc373a5f46 39 * in application specific '.c' files. The mbed code structure does not
mahphalke 8:70fc373a5f46 40 * allow inclusion of mbed driver files (e.g. mbed.h) into '.c' files.
mahphalke 8:70fc373a5f46 41 * All the members are hence typecasted to mbed specific type during
mahphalke 8:70fc373a5f46 42 * i2c init and read/write operations.
mahphalke 8:70fc373a5f46 43 **/
mahphalke 8:70fc373a5f46 44
mahphalke 8:70fc373a5f46 45 /**
mahphalke 8:70fc373a5f46 46 * @struct mbed_i2c_init_param
mahphalke 8:70fc373a5f46 47 * @brief Structure holding the I2C init parameters for mbed platform.
mahphalke 8:70fc373a5f46 48 */
mahphalke 8:70fc373a5f46 49 typedef struct mbed_i2c_init_param {
mahphalke 8:70fc373a5f46 50 uint8_t i2c_sda_pin; // I2C SDA pin (PinName)
mahphalke 8:70fc373a5f46 51 uint8_t i2c_scl_pin; // I2C SCL pin (PinName)
mahphalke 8:70fc373a5f46 52 } mbed_i2c_init_param;
mahphalke 8:70fc373a5f46 53
mahphalke 8:70fc373a5f46 54 /**
mahphalke 8:70fc373a5f46 55 * @struct mbed_i2c_desc
mahphalke 8:70fc373a5f46 56 * @brief I2C specific descriptor for the mbed platform.
mahphalke 8:70fc373a5f46 57 */
mahphalke 8:70fc373a5f46 58 typedef struct mbed_i2c_desc {
mahphalke 8:70fc373a5f46 59 void *i2c_port; // I2C port instance (mbed::I2C)
mahphalke 8:70fc373a5f46 60 } mbed_i2c_desc;
mahphalke 8:70fc373a5f46 61
mahphalke 8:70fc373a5f46 62
mahphalke 8:70fc373a5f46 63 /******************************************************************************/
mahphalke 8:70fc373a5f46 64 /************************ Functions Declarations ******************************/
mahphalke 8:70fc373a5f46 65 /******************************************************************************/
mahphalke 8:70fc373a5f46 66
mahphalke 8:70fc373a5f46 67
mahphalke 8:70fc373a5f46 68 #ifdef __cplusplus // Closing extern c
mahphalke 8:70fc373a5f46 69 }
mahphalke 8:70fc373a5f46 70 #endif
mahphalke 8:70fc373a5f46 71
mahphalke 8:70fc373a5f46 72 #endif /* I2C_EXTRA_H */