adi_sense_platform.h

00001 /*
00002 Copyright (c) 2017 Analog Devices, Inc.
00003 
00004 All rights reserved.
00005 
00006 Redistribution and use in source and binary forms, with or without modification,
00007 are permitted provided that the following conditions are met:
00008   - Redistributions of source code must retain the above copyright notice,
00009     this list of conditions and the following disclaimer.
00010   - Redistributions in binary form must reproduce the above copyright notice,
00011     this list of conditions and the following disclaimer in the documentation
00012     and/or other materials provided with the distribution.
00013   - Modified versions of the software must be conspicuously marked as such.
00014   - This software is licensed solely and exclusively for use with processors
00015     manufactured by or for Analog Devices, Inc.
00016   - This software may not be combined or merged with other code in any manner
00017     that would cause the software to become subject to terms and conditions
00018     which differ from those listed here.
00019   - Neither the name of Analog Devices, Inc. nor the names of its
00020     contributors may be used to endorse or promote products derived
00021     from this software without specific prior written permission.
00022   - The use of this software may or may not infringe the patent rights of one
00023     or more patent holders.  This license does not release you from the
00024     requirement that you obtain separate licenses from these patent holders
00025     to use this software.
00026 
00027 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY
00028 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00029 TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00030 NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
00031 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
00032 (INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
00033 PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00034 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00035 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00036 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00037 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 */
00039 
00040 /*!
00041  ******************************************************************************
00042  * @file:
00043  * @brief:  mbed platform-specific type definitions for ADISENSE API.
00044  *-----------------------------------------------------------------------------
00045  */
00046 
00047 #ifndef __ADI_SENSE_PLATFORM_MBED_H__
00048 #define __ADI_SENSE_PLATFORM_MBED_H__
00049 
00050 /*! Maximum number of ADISENSE device instances supported on this platform */
00051 #define ADI_SENSE_PLATFORM_MAX_DEVICES 1
00052 
00053 typedef struct {
00054     int mosiPin;
00055     int misoPin;
00056     int sckPin;
00057     int csPin;
00058     int maxSpeedHz;
00059 } ADI_SENSE_PLATFORM_SPI_CONFIG;
00060 
00061 typedef struct {
00062     int resetPin;
00063     int errorPin;
00064     int alertPin;
00065     int datareadyPin;
00066 } ADI_SENSE_PLATFORM_GPIO_CONFIG;
00067 
00068 typedef struct {
00069     int txPin;
00070     int rxPin;
00071     int baudRate;
00072     bool disableLogs;
00073 } ADI_SENSE_PLATFORM_LOG_CONFIG;
00074 
00075 #endif /* __ADI_SENSE_PLATFORM_MBED_H__ */