admw_spi.h

00001 /*
00002 Copyright 2019 (c) Analog Devices, Inc.
00003 
00004 All rights reserved.
00005 
00006 Redistribution and use in source and binary forms, with or without
00007 modification, are permitted provided that the following conditions are met:
00008   - Redistributions of source code must retain the above copyright
00009     notice, this list of conditions and the following disclaimer.
00010   - Redistributions in binary form must reproduce the above copyright
00011     notice, this list of conditions and the following disclaimer in
00012     the documentation and/or other materials provided with the
00013     distribution.
00014   - Neither the name of Analog Devices, Inc. nor the names of its
00015     contributors may be used to endorse or promote products derived
00016     from this software without specific prior written permission.
00017   - The use of this software may or may not infringe the patent rights
00018     of one or more patent holders. This license does not release you
00019     from the requirement that you obtain separate licenses from these
00020     patent holders to use this software.
00021   - Use of the software either in source or binary form, must be run
00022     on or directly connected to an Analog Devices Inc. component.
00023 
00024 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
00025 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00026 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00027 IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
00028 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00029 LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
00030 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034 */
00035 
00036 /*!
00037  ******************************************************************************
00038  * @file:   admw_spi.h
00039  * @brief:  ADMW OS-dependent wrapper layer for SPI interface
00040  *-----------------------------------------------------------------------------
00041  */
00042 
00043 #ifndef __ADMW_SPI_H__
00044 #define __ADMW_SPI_H__
00045 
00046 #include "inc/admw_types.h"
00047 #include "inc/admw_platform.h"
00048 
00049 /*! @ingroup ADMW_Host */
00050 
00051 /*! @addtogroup ADMW_Spi ADMW Host SPI interface functions
00052  *  @{
00053  */
00054 
00055 /*! A handle used in all API functions to identify the SPI interface context */
00056 typedef void * ADMW_SPI_HANDLE ;
00057 
00058 #ifdef __cplusplus
00059 extern "C"
00060 {
00061 #endif
00062 
00063 /*!
00064  * @brief Open the SPI interface and allocate resources
00065  *
00066  * @param[in]  pConfig  Pointer to platform-specific SPI interface details
00067  * @param[out] phDevice Pointer to return a SPI interface context handle
00068  *
00069  * @return Status
00070  *         - #ADMW_SUCCESS Call completed successfully
00071  *         - #ADMW_NO_MEM  Failed to allocate memory for interface context
00072  */
00073 ADMW_RESULT  admw_SpiOpen(
00074     ADMW_PLATFORM_SPI_CONFIG * pConfig,
00075     ADMW_SPI_HANDLE           * phDevice);
00076 
00077 /*!
00078  * @brief Close SPI interface and free resources
00079  *
00080  * @param[in] hDevice SPI interface context handle (@ref admw_SpiOpen)
00081  */
00082 void admw_SpiClose(
00083     ADMW_SPI_HANDLE             hDevice);
00084 
00085 /*!
00086  * @brief Transfer data to slave device
00087  *
00088  * @param[in] hDevice SPI interface context handle (@ref admw_SpiOpen)
00089  * @param[in] pTxData Transmit data buffer, or NULL for read-only transfers
00090  * @param[in] pRxData Receive  data buffer, or NULL for write-only transfers
00091  * @param[in] nLength Number of bytes to transfer
00092  * @param[in] bCsHold Leave the chip-select asserted when the transfer is done
00093  *
00094  * @return Status
00095  *         - #ADMW_SUCCESS Call completed successfully
00096  *         - #ADMW_FAILURE Failed to complete SPI transfer
00097  */
00098 ADMW_RESULT  admw_SpiTransfer(
00099     ADMW_SPI_HANDLE             hDevice,
00100     void                          * pTxData,
00101     void                          * pRxData,
00102     unsigned                        nLength,
00103     bool                            bCsHold);
00104 
00105 ADMW_RESULT  admw_SpiReceive(
00106     ADMW_SPI_HANDLE  hDevice,
00107     void *pTxData,
00108     void *pRxData,
00109     unsigned nLength,
00110     bool bCsHold);
00111 #ifdef __cplusplus
00112 }
00113 #endif
00114 
00115 /*!
00116  * @}
00117  */
00118 
00119 #endif /* __ADMW_API_H__ */