Vybhav Kadaba / Mbed OS EV-PRO-MW1001_MWARE1832

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

inc/adi_sense_spi.h@0:85855ecd3257, 2019-04-01 (annotated)

Committer:
ADIJake
Date:
Mon Apr 01 11:09:52 2019 +0000
Revision:
0:85855ecd3257
Initial Commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ADIJake 0:85855ecd3257 1 /*
ADIJake 0:85855ecd3257 2 Copyright 2017 (c) Analog Devices, Inc.
ADIJake 0:85855ecd3257 3
ADIJake 0:85855ecd3257 4 All rights reserved.
ADIJake 0:85855ecd3257 5
ADIJake 0:85855ecd3257 6 Redistribution and use in source and binary forms, with or without
ADIJake 0:85855ecd3257 7 modification, are permitted provided that the following conditions are met:
ADIJake 0:85855ecd3257 8 - Redistributions of source code must retain the above copyright
ADIJake 0:85855ecd3257 9 notice, this list of conditions and the following disclaimer.
ADIJake 0:85855ecd3257 10 - Redistributions in binary form must reproduce the above copyright
ADIJake 0:85855ecd3257 11 notice, this list of conditions and the following disclaimer in
ADIJake 0:85855ecd3257 12 the documentation and/or other materials provided with the
ADIJake 0:85855ecd3257 13 distribution.
ADIJake 0:85855ecd3257 14 - Neither the name of Analog Devices, Inc. nor the names of its
ADIJake 0:85855ecd3257 15 contributors may be used to endorse or promote products derived
ADIJake 0:85855ecd3257 16 from this software without specific prior written permission.
ADIJake 0:85855ecd3257 17 - The use of this software may or may not infringe the patent rights
ADIJake 0:85855ecd3257 18 of one or more patent holders. This license does not release you
ADIJake 0:85855ecd3257 19 from the requirement that you obtain separate licenses from these
ADIJake 0:85855ecd3257 20 patent holders to use this software.
ADIJake 0:85855ecd3257 21 - Use of the software either in source or binary form, must be run
ADIJake 0:85855ecd3257 22 on or directly connected to an Analog Devices Inc. component.
ADIJake 0:85855ecd3257 23
ADIJake 0:85855ecd3257 24 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
ADIJake 0:85855ecd3257 25 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
ADIJake 0:85855ecd3257 26 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
ADIJake 0:85855ecd3257 27 IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
ADIJake 0:85855ecd3257 28 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
ADIJake 0:85855ecd3257 29 LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
ADIJake 0:85855ecd3257 30 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
ADIJake 0:85855ecd3257 31 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
ADIJake 0:85855ecd3257 32 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
ADIJake 0:85855ecd3257 33 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
ADIJake 0:85855ecd3257 34 */
ADIJake 0:85855ecd3257 35
ADIJake 0:85855ecd3257 36 /*!
ADIJake 0:85855ecd3257 37 ******************************************************************************
ADIJake 0:85855ecd3257 38 * @file: adi_sense_spi.h
ADIJake 0:85855ecd3257 39 * @brief: ADISENSE OS-dependent wrapper layer for SPI interface
ADIJake 0:85855ecd3257 40 *-----------------------------------------------------------------------------
ADIJake 0:85855ecd3257 41 */
ADIJake 0:85855ecd3257 42
ADIJake 0:85855ecd3257 43 #ifndef __ADI_SENSE_SPI_H__
ADIJake 0:85855ecd3257 44 #define __ADI_SENSE_SPI_H__
ADIJake 0:85855ecd3257 45
ADIJake 0:85855ecd3257 46 #include "inc/adi_sense_types.h"
ADIJake 0:85855ecd3257 47 #include "inc/adi_sense_platform.h"
ADIJake 0:85855ecd3257 48
ADIJake 0:85855ecd3257 49 /*! @ingroup ADISENSE_Host */
ADIJake 0:85855ecd3257 50
ADIJake 0:85855ecd3257 51 /*! @addtogroup ADISENSE_Spi ADISENSE Host SPI interface functions
ADIJake 0:85855ecd3257 52 * @{
ADIJake 0:85855ecd3257 53 */
ADIJake 0:85855ecd3257 54
ADIJake 0:85855ecd3257 55 /*! A handle used in all API functions to identify the SPI interface context */
ADIJake 0:85855ecd3257 56 typedef void * ADI_SENSE_SPI_HANDLE;
ADIJake 0:85855ecd3257 57
ADIJake 0:85855ecd3257 58 #ifdef __cplusplus
ADIJake 0:85855ecd3257 59 extern "C"
ADIJake 0:85855ecd3257 60 {
ADIJake 0:85855ecd3257 61 #endif
ADIJake 0:85855ecd3257 62
ADIJake 0:85855ecd3257 63 /*!
ADIJake 0:85855ecd3257 64 * @brief Open the SPI interface and allocate resources
ADIJake 0:85855ecd3257 65 *
ADIJake 0:85855ecd3257 66 * @param[in] pConfig Pointer to platform-specific SPI interface details
ADIJake 0:85855ecd3257 67 * @param[out] phDevice Pointer to return a SPI interface context handle
ADIJake 0:85855ecd3257 68 *
ADIJake 0:85855ecd3257 69 * @return Status
ADIJake 0:85855ecd3257 70 * - #ADI_SENSE_SUCCESS Call completed successfully
ADIJake 0:85855ecd3257 71 * - #ADI_SENSE_NO_MEM Failed to allocate memory for interface context
ADIJake 0:85855ecd3257 72 */
ADIJake 0:85855ecd3257 73 ADI_SENSE_RESULT adi_sense_SpiOpen(
ADIJake 0:85855ecd3257 74 ADI_SENSE_PLATFORM_SPI_CONFIG * pConfig,
ADIJake 0:85855ecd3257 75 ADI_SENSE_SPI_HANDLE * phDevice);
ADIJake 0:85855ecd3257 76
ADIJake 0:85855ecd3257 77 /*!
ADIJake 0:85855ecd3257 78 * @brief Close SPI interface and free resources
ADIJake 0:85855ecd3257 79 *
ADIJake 0:85855ecd3257 80 * @param[in] hDevice SPI interface context handle (@ref adi_sense_SpiOpen)
ADIJake 0:85855ecd3257 81 */
ADIJake 0:85855ecd3257 82 void adi_sense_SpiClose(
ADIJake 0:85855ecd3257 83 ADI_SENSE_SPI_HANDLE hDevice);
ADIJake 0:85855ecd3257 84
ADIJake 0:85855ecd3257 85 /*!
ADIJake 0:85855ecd3257 86 * @brief Transfer data to slave device
ADIJake 0:85855ecd3257 87 *
ADIJake 0:85855ecd3257 88 * @param[in] hDevice SPI interface context handle (@ref adi_sense_SpiOpen)
ADIJake 0:85855ecd3257 89 * @param[in] pTxData Transmit data buffer, or NULL for read-only transfers
ADIJake 0:85855ecd3257 90 * @param[in] pRxData Receive data buffer, or NULL for write-only transfers
ADIJake 0:85855ecd3257 91 * @param[in] nLength Number of bytes to transfer
ADIJake 0:85855ecd3257 92 * @param[in] bCsHold Leave the chip-select asserted when the transfer is done
ADIJake 0:85855ecd3257 93 *
ADIJake 0:85855ecd3257 94 * @return Status
ADIJake 0:85855ecd3257 95 * - #ADI_SENSE_SUCCESS Call completed successfully
ADIJake 0:85855ecd3257 96 * - #ADI_SENSE_FAILURE Failed to complete SPI transfer
ADIJake 0:85855ecd3257 97 */
ADIJake 0:85855ecd3257 98 ADI_SENSE_RESULT adi_sense_SpiTransfer(
ADIJake 0:85855ecd3257 99 ADI_SENSE_SPI_HANDLE hDevice,
ADIJake 0:85855ecd3257 100 void * pTxData,
ADIJake 0:85855ecd3257 101 void * pRxData,
ADIJake 0:85855ecd3257 102 unsigned nLength,
ADIJake 0:85855ecd3257 103 bool bCsHold);
ADIJake 0:85855ecd3257 104
ADIJake 0:85855ecd3257 105 #ifdef __cplusplus
ADIJake 0:85855ecd3257 106 }
ADIJake 0:85855ecd3257 107 #endif
ADIJake 0:85855ecd3257 108
ADIJake 0:85855ecd3257 109 /*!
ADIJake 0:85855ecd3257 110 * @}
ADIJake 0:85855ecd3257 111 */
ADIJake 0:85855ecd3257 112
ADIJake 0:85855ecd3257 113 #endif /* __ADI_SENSE_SPI_H__ */
ADIJake 0:85855ecd3257 114