Sean Wilson
/
AdiSense1000_V21
AdiSense1000_V21 MBED API
Fork of AdiSense1000 by
inc/adi_sense_spi.h
- Committer:
- kevin1990
- Date:
- 2017-10-20
- Revision:
- 7:4dbae381f693
File content as of revision 7:4dbae381f693:
/*! ****************************************************************************** * @file: adi_sense_spi.h * @brief: ADI Sense OS-dependent wrapper layer for SPI interface *----------------------------------------------------------------------------- */ /* Copyright (c) 2017 Emutex Ltd. / Analog Devices, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - Modified versions of the software must be conspicuously marked as such. - This software is licensed solely and exclusively for use with processors manufactured by or for Analog Devices, Inc. - This software may not be combined or merged with other code in any manner that would cause the software to become subject to terms and conditions which differ from those listed here. - Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software. THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef __ADI_SENSE_SPI_H__ #define __ADI_SENSE_SPI_H__ #include "inc/adi_sense_types.h" #include "inc/adi_sense_platform.h" /*! @ingroup ADI_Sense_Host */ /*! @addtogroup ADI_Sense_Spi ADI Sense Host SPI interface functions * @{ */ /*! A handle used in all API functions to identify the SPI interface context */ typedef void * ADI_SENSE_SPI_HANDLE; #ifdef __cplusplus extern "C" { #endif /*! * @brief Open the SPI interface and allocate resources * * @param[in] pConfig Pointer to platform-specific SPI interface details * @param[out] phDevice Pointer to return a SPI interface context handle * * @return Status * - #ADI_SENSE_SUCCESS Call completed successfully * - #ADI_SENSE_NO_MEM Failed to allocate memory for interface context */ ADI_SENSE_RESULT adi_sense_SpiOpen( ADI_SENSE_PLATFORM_SPI_CONFIG * pConfig, ADI_SENSE_SPI_HANDLE * phDevice); /*! * @brief Close SPI interface and free resources * * @param[in] hDevice SPI interface context handle (@ref adi_sense_SpiOpen) */ void adi_sense_SpiClose( ADI_SENSE_SPI_HANDLE hDevice); /*! * @brief Transfer data to slave device * * @param[in] hDevice SPI interface context handle (@ref adi_sense_SpiOpen) * @param[in] pTxData Transmit data buffer, or NULL for read-only transfers * @param[in] pRxData Receive data buffer, or NULL for write-only transfers * @param[in] nLength Number of bytes to transfer * @param[in] bCsHold Leave the chip-select asserted when the transfer is done * * @return Status * - #ADI_SENSE_SUCCESS Call completed successfully * - #ADI_SENSE_FAILURE Failed to complete SPI transfer */ ADI_SENSE_RESULT adi_sense_SpiTransfer( ADI_SENSE_SPI_HANDLE hDevice, void * pTxData, void * pRxData, unsigned nLength, bool bCsHold); #ifdef __cplusplus } #endif /*! * @} */ #endif /* __ADI_SENSE_SPI_H__ */