spi_extra.h

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