platform_drivers.h

00001 /***************************************************************************//**
00002  *   @file   platform_drivers.h
00003  *   @brief  Header file of Generic Platform Drivers.
00004  *   @author DBogdan (dragos.bogdan@analog.com)
00005 ********************************************************************************
00006  * Copyright 2017, 2019(c) Analog Devices, Inc.
00007  *
00008  * All rights reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions are met:
00012  *  - Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer.
00014  *  - Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *  - Neither the name of Analog Devices, Inc. nor the names of its
00019  *    contributors may be used to endorse or promote products derived
00020  *    from this software without specific prior written permission.
00021  *  - The use of this software may or may not infringe the patent rights
00022  *    of one or more patent holders.  This license does not release you
00023  *    from the requirement that you obtain separate licenses from these
00024  *    patent holders to use this software.
00025  *  - Use of the software either in source or binary form, must be run
00026  *    on or directly connected to an Analog Devices Inc. component.
00027  *
00028  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
00029  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00030  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00031  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
00032  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00033  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
00034  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 *******************************************************************************/
00039 
00040 #ifndef PLATFORM_DRIVERS_H_
00041 #define PLATFORM_DRIVERS_H_
00042 
00043 
00044 // Platform drivers needs to be C-compatible to work with other drivers
00045 #ifdef __cplusplus
00046 extern "C"
00047 {
00048 #endif //  _cplusplus
00049 
00050 
00051 /******************************************************************************/
00052 /********************** Macros and Constants Definitions **********************/
00053 /******************************************************************************/
00054 
00055 // spi_init(), i2c_init(), i2c_write() and i2c_read() function are already defined
00056 // in mbed-os libraries. To avoid this naming conflict, the functions are wrapped
00057 // with suffix _noos using macros.
00058 
00059 #define  spi_init(desc, init_param)         spi_init_noos(desc, init_param)
00060 
00061 #define  i2c_init(desc, init_param)                      i2c_init_noos(desc, init_param)
00062 #define  i2c_write(desc, data, bytes_number, stop_bits)  i2c_write_noos(desc, data, bytes_number, stop_bits)
00063 #define  i2c_read(desc, data, bytes_number, stop_bits)   i2c_read_noos(desc, data, bytes_number, stop_bits)
00064 
00065 /******************************************************************************/
00066 /***************************** Include Files **********************************/
00067 /******************************************************************************/
00068 
00069 #include "delay.h "
00070 #include "error.h "
00071 #include "gpio.h "
00072 #include "i2c.h "
00073 #include "spi.h "
00074 
00075 
00076 #ifdef __cplusplus  // Closing extern c
00077 }
00078 #endif //  _cplusplus
00079 
00080 #endif // PLATFORM_DRIVERS_H_