mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_flexio_spi.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #ifndef _FSL_FLEXIO_SPI_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_FLEXIO_SPI_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include "fsl_common.h"
AnnaBridge 189:f392fc9709a3 35 #include "fsl_flexio.h"
AnnaBridge 189:f392fc9709a3 36
AnnaBridge 189:f392fc9709a3 37 /*!
AnnaBridge 189:f392fc9709a3 38 * @addtogroup flexio_spi
AnnaBridge 189:f392fc9709a3 39 * @{
AnnaBridge 189:f392fc9709a3 40 */
AnnaBridge 189:f392fc9709a3 41
AnnaBridge 189:f392fc9709a3 42 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 43 * Definitions
AnnaBridge 189:f392fc9709a3 44 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 47 /*@{*/
AnnaBridge 189:f392fc9709a3 48 /*! @brief FlexIO SPI driver version 2.1.0. */
AnnaBridge 189:f392fc9709a3 49 #define FSL_FLEXIO_SPI_DRIVER_VERSION (MAKE_VERSION(2, 1, 0))
AnnaBridge 189:f392fc9709a3 50 /*@}*/
AnnaBridge 189:f392fc9709a3 51
AnnaBridge 189:f392fc9709a3 52 #ifndef FLEXIO_SPI_DUMMYDATA
AnnaBridge 189:f392fc9709a3 53 /*! @brief FlexIO SPI dummy transfer data, the data is sent while txData is NULL. */
AnnaBridge 189:f392fc9709a3 54 #define FLEXIO_SPI_DUMMYDATA (0xFFFFU)
AnnaBridge 189:f392fc9709a3 55 #endif
AnnaBridge 189:f392fc9709a3 56
AnnaBridge 189:f392fc9709a3 57 /*! @brief Error codes for the FlexIO SPI driver. */
AnnaBridge 189:f392fc9709a3 58 enum _flexio_spi_status
AnnaBridge 189:f392fc9709a3 59 {
AnnaBridge 189:f392fc9709a3 60 kStatus_FLEXIO_SPI_Busy = MAKE_STATUS(kStatusGroup_FLEXIO_SPI, 1), /*!< FlexIO SPI is busy. */
AnnaBridge 189:f392fc9709a3 61 kStatus_FLEXIO_SPI_Idle = MAKE_STATUS(kStatusGroup_FLEXIO_SPI, 2), /*!< SPI is idle */
AnnaBridge 189:f392fc9709a3 62 kStatus_FLEXIO_SPI_Error = MAKE_STATUS(kStatusGroup_FLEXIO_SPI, 3), /*!< FlexIO SPI error. */
AnnaBridge 189:f392fc9709a3 63 };
AnnaBridge 189:f392fc9709a3 64
AnnaBridge 189:f392fc9709a3 65 /*! @brief FlexIO SPI clock phase configuration. */
AnnaBridge 189:f392fc9709a3 66 typedef enum _flexio_spi_clock_phase
AnnaBridge 189:f392fc9709a3 67 {
AnnaBridge 189:f392fc9709a3 68 kFLEXIO_SPI_ClockPhaseFirstEdge = 0x0U, /*!< First edge on SPSCK occurs at the middle of the first
AnnaBridge 189:f392fc9709a3 69 * cycle of a data transfer. */
AnnaBridge 189:f392fc9709a3 70 kFLEXIO_SPI_ClockPhaseSecondEdge = 0x1U, /*!< First edge on SPSCK occurs at the start of the
AnnaBridge 189:f392fc9709a3 71 * first cycle of a data transfer. */
AnnaBridge 189:f392fc9709a3 72 } flexio_spi_clock_phase_t;
AnnaBridge 189:f392fc9709a3 73
AnnaBridge 189:f392fc9709a3 74 /*! @brief FlexIO SPI data shifter direction options. */
AnnaBridge 189:f392fc9709a3 75 typedef enum _flexio_spi_shift_direction
AnnaBridge 189:f392fc9709a3 76 {
AnnaBridge 189:f392fc9709a3 77 kFLEXIO_SPI_MsbFirst = 0, /*!< Data transfers start with most significant bit. */
AnnaBridge 189:f392fc9709a3 78 kFLEXIO_SPI_LsbFirst = 1, /*!< Data transfers start with least significant bit. */
AnnaBridge 189:f392fc9709a3 79 } flexio_spi_shift_direction_t;
AnnaBridge 189:f392fc9709a3 80
AnnaBridge 189:f392fc9709a3 81 /*! @brief FlexIO SPI data length mode options. */
AnnaBridge 189:f392fc9709a3 82 typedef enum _flexio_spi_data_bitcount_mode
AnnaBridge 189:f392fc9709a3 83 {
AnnaBridge 189:f392fc9709a3 84 kFLEXIO_SPI_8BitMode = 0x08U, /*!< 8-bit data transmission mode. */
AnnaBridge 189:f392fc9709a3 85 kFLEXIO_SPI_16BitMode = 0x10U, /*!< 16-bit data transmission mode. */
AnnaBridge 189:f392fc9709a3 86 } flexio_spi_data_bitcount_mode_t;
AnnaBridge 189:f392fc9709a3 87
AnnaBridge 189:f392fc9709a3 88 /*! @brief Define FlexIO SPI interrupt mask. */
AnnaBridge 189:f392fc9709a3 89 enum _flexio_spi_interrupt_enable
AnnaBridge 189:f392fc9709a3 90 {
AnnaBridge 189:f392fc9709a3 91 kFLEXIO_SPI_TxEmptyInterruptEnable = 0x1U, /*!< Transmit buffer empty interrupt enable. */
AnnaBridge 189:f392fc9709a3 92 kFLEXIO_SPI_RxFullInterruptEnable = 0x2U, /*!< Receive buffer full interrupt enable. */
AnnaBridge 189:f392fc9709a3 93 };
AnnaBridge 189:f392fc9709a3 94
AnnaBridge 189:f392fc9709a3 95 /*! @brief Define FlexIO SPI status mask. */
AnnaBridge 189:f392fc9709a3 96 enum _flexio_spi_status_flags
AnnaBridge 189:f392fc9709a3 97 {
AnnaBridge 189:f392fc9709a3 98 kFLEXIO_SPI_TxBufferEmptyFlag = 0x1U, /*!< Transmit buffer empty flag. */
AnnaBridge 189:f392fc9709a3 99 kFLEXIO_SPI_RxBufferFullFlag = 0x2U, /*!< Receive buffer full flag. */
AnnaBridge 189:f392fc9709a3 100 };
AnnaBridge 189:f392fc9709a3 101
AnnaBridge 189:f392fc9709a3 102 /*! @brief Define FlexIO SPI DMA mask. */
AnnaBridge 189:f392fc9709a3 103 enum _flexio_spi_dma_enable
AnnaBridge 189:f392fc9709a3 104 {
AnnaBridge 189:f392fc9709a3 105 kFLEXIO_SPI_TxDmaEnable = 0x1U, /*!< Tx DMA request source */
AnnaBridge 189:f392fc9709a3 106 kFLEXIO_SPI_RxDmaEnable = 0x2U, /*!< Rx DMA request source */
AnnaBridge 189:f392fc9709a3 107 kFLEXIO_SPI_DmaAllEnable = 0x3U, /*!< All DMA request source*/
AnnaBridge 189:f392fc9709a3 108 };
AnnaBridge 189:f392fc9709a3 109
AnnaBridge 189:f392fc9709a3 110 /*! @brief Define FlexIO SPI transfer flags. */
AnnaBridge 189:f392fc9709a3 111 enum _flexio_spi_transfer_flags
AnnaBridge 189:f392fc9709a3 112 {
AnnaBridge 189:f392fc9709a3 113 kFLEXIO_SPI_8bitMsb = 0x1U, /*!< FlexIO SPI 8-bit MSB first */
AnnaBridge 189:f392fc9709a3 114 kFLEXIO_SPI_8bitLsb = 0x2U, /*!< FlexIO SPI 8-bit LSB first */
AnnaBridge 189:f392fc9709a3 115 kFLEXIO_SPI_16bitMsb = 0x9U, /*!< FlexIO SPI 16-bit MSB first */
AnnaBridge 189:f392fc9709a3 116 kFLEXIO_SPI_16bitLsb = 0xaU, /*!< FlexIO SPI 16-bit LSB first */
AnnaBridge 189:f392fc9709a3 117 };
AnnaBridge 189:f392fc9709a3 118
AnnaBridge 189:f392fc9709a3 119 /*! @brief Define FlexIO SPI access structure typedef. */
AnnaBridge 189:f392fc9709a3 120 typedef struct _flexio_spi_type
AnnaBridge 189:f392fc9709a3 121 {
AnnaBridge 189:f392fc9709a3 122 FLEXIO_Type *flexioBase; /*!< FlexIO base pointer. */
AnnaBridge 189:f392fc9709a3 123 uint8_t SDOPinIndex; /*!< Pin select for data output. */
AnnaBridge 189:f392fc9709a3 124 uint8_t SDIPinIndex; /*!< Pin select for data input. */
AnnaBridge 189:f392fc9709a3 125 uint8_t SCKPinIndex; /*!< Pin select for clock. */
AnnaBridge 189:f392fc9709a3 126 uint8_t CSnPinIndex; /*!< Pin select for enable. */
AnnaBridge 189:f392fc9709a3 127 uint8_t shifterIndex[2]; /*!< Shifter index used in FlexIO SPI. */
AnnaBridge 189:f392fc9709a3 128 uint8_t timerIndex[2]; /*!< Timer index used in FlexIO SPI. */
AnnaBridge 189:f392fc9709a3 129 } FLEXIO_SPI_Type;
AnnaBridge 189:f392fc9709a3 130
AnnaBridge 189:f392fc9709a3 131 /*! @brief Define FlexIO SPI master configuration structure. */
AnnaBridge 189:f392fc9709a3 132 typedef struct _flexio_spi_master_config
AnnaBridge 189:f392fc9709a3 133 {
AnnaBridge 189:f392fc9709a3 134 bool enableMaster; /*!< Enable/disable FlexIO SPI master after configuration. */
AnnaBridge 189:f392fc9709a3 135 bool enableInDoze; /*!< Enable/disable FlexIO operation in doze mode. */
AnnaBridge 189:f392fc9709a3 136 bool enableInDebug; /*!< Enable/disable FlexIO operation in debug mode. */
AnnaBridge 189:f392fc9709a3 137 bool enableFastAccess; /*!< Enable/disable fast access to FlexIO registers,
AnnaBridge 189:f392fc9709a3 138 fast access requires the FlexIO clock to be at least
AnnaBridge 189:f392fc9709a3 139 twice the frequency of the bus clock. */
AnnaBridge 189:f392fc9709a3 140 uint32_t baudRate_Bps; /*!< Baud rate in Bps. */
AnnaBridge 189:f392fc9709a3 141 flexio_spi_clock_phase_t phase; /*!< Clock phase. */
AnnaBridge 189:f392fc9709a3 142 flexio_spi_data_bitcount_mode_t dataMode; /*!< 8bit or 16bit mode. */
AnnaBridge 189:f392fc9709a3 143 } flexio_spi_master_config_t;
AnnaBridge 189:f392fc9709a3 144
AnnaBridge 189:f392fc9709a3 145 /*! @brief Define FlexIO SPI slave configuration structure. */
AnnaBridge 189:f392fc9709a3 146 typedef struct _flexio_spi_slave_config
AnnaBridge 189:f392fc9709a3 147 {
AnnaBridge 189:f392fc9709a3 148 bool enableSlave; /*!< Enable/disable FlexIO SPI slave after configuration. */
AnnaBridge 189:f392fc9709a3 149 bool enableInDoze; /*!< Enable/disable FlexIO operation in doze mode. */
AnnaBridge 189:f392fc9709a3 150 bool enableInDebug; /*!< Enable/disable FlexIO operation in debug mode. */
AnnaBridge 189:f392fc9709a3 151 bool enableFastAccess; /*!< Enable/disable fast access to FlexIO registers,
AnnaBridge 189:f392fc9709a3 152 fast access requires the FlexIO clock to be at least
AnnaBridge 189:f392fc9709a3 153 twice the frequency of the bus clock. */
AnnaBridge 189:f392fc9709a3 154 flexio_spi_clock_phase_t phase; /*!< Clock phase. */
AnnaBridge 189:f392fc9709a3 155 flexio_spi_data_bitcount_mode_t dataMode; /*!< 8bit or 16bit mode. */
AnnaBridge 189:f392fc9709a3 156 } flexio_spi_slave_config_t;
AnnaBridge 189:f392fc9709a3 157
AnnaBridge 189:f392fc9709a3 158 /*! @brief Define FlexIO SPI transfer structure. */
AnnaBridge 189:f392fc9709a3 159 typedef struct _flexio_spi_transfer
AnnaBridge 189:f392fc9709a3 160 {
AnnaBridge 189:f392fc9709a3 161 uint8_t *txData; /*!< Send buffer. */
AnnaBridge 189:f392fc9709a3 162 uint8_t *rxData; /*!< Receive buffer. */
AnnaBridge 189:f392fc9709a3 163 size_t dataSize; /*!< Transfer bytes. */
AnnaBridge 189:f392fc9709a3 164 uint8_t flags; /*!< FlexIO SPI control flag, MSB first or LSB first. */
AnnaBridge 189:f392fc9709a3 165 } flexio_spi_transfer_t;
AnnaBridge 189:f392fc9709a3 166
AnnaBridge 189:f392fc9709a3 167 /*! @brief typedef for flexio_spi_master_handle_t in advance. */
AnnaBridge 189:f392fc9709a3 168 typedef struct _flexio_spi_master_handle flexio_spi_master_handle_t;
AnnaBridge 189:f392fc9709a3 169
AnnaBridge 189:f392fc9709a3 170 /*! @brief Slave handle is the same with master handle. */
AnnaBridge 189:f392fc9709a3 171 typedef flexio_spi_master_handle_t flexio_spi_slave_handle_t;
AnnaBridge 189:f392fc9709a3 172
AnnaBridge 189:f392fc9709a3 173 /*! @brief FlexIO SPI master callback for finished transmit */
AnnaBridge 189:f392fc9709a3 174 typedef void (*flexio_spi_master_transfer_callback_t)(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 175 flexio_spi_master_handle_t *handle,
AnnaBridge 189:f392fc9709a3 176 status_t status,
AnnaBridge 189:f392fc9709a3 177 void *userData);
AnnaBridge 189:f392fc9709a3 178
AnnaBridge 189:f392fc9709a3 179 /*! @brief FlexIO SPI slave callback for finished transmit */
AnnaBridge 189:f392fc9709a3 180 typedef void (*flexio_spi_slave_transfer_callback_t)(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 181 flexio_spi_slave_handle_t *handle,
AnnaBridge 189:f392fc9709a3 182 status_t status,
AnnaBridge 189:f392fc9709a3 183 void *userData);
AnnaBridge 189:f392fc9709a3 184
AnnaBridge 189:f392fc9709a3 185 /*! @brief Define FlexIO SPI handle structure. */
AnnaBridge 189:f392fc9709a3 186 struct _flexio_spi_master_handle
AnnaBridge 189:f392fc9709a3 187 {
AnnaBridge 189:f392fc9709a3 188 uint8_t *txData; /*!< Transfer buffer. */
AnnaBridge 189:f392fc9709a3 189 uint8_t *rxData; /*!< Receive buffer. */
AnnaBridge 189:f392fc9709a3 190 size_t transferSize; /*!< Total bytes to be transferred. */
AnnaBridge 189:f392fc9709a3 191 volatile size_t txRemainingBytes; /*!< Send data remaining in bytes. */
AnnaBridge 189:f392fc9709a3 192 volatile size_t rxRemainingBytes; /*!< Receive data remaining in bytes. */
AnnaBridge 189:f392fc9709a3 193 volatile uint32_t state; /*!< FlexIO SPI internal state. */
AnnaBridge 189:f392fc9709a3 194 uint8_t bytePerFrame; /*!< SPI mode, 2bytes or 1byte in a frame */
AnnaBridge 189:f392fc9709a3 195 flexio_spi_shift_direction_t direction; /*!< Shift direction. */
AnnaBridge 189:f392fc9709a3 196 flexio_spi_master_transfer_callback_t callback; /*!< FlexIO SPI callback. */
AnnaBridge 189:f392fc9709a3 197 void *userData; /*!< Callback parameter. */
AnnaBridge 189:f392fc9709a3 198 };
AnnaBridge 189:f392fc9709a3 199
AnnaBridge 189:f392fc9709a3 200 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 201 * API
AnnaBridge 189:f392fc9709a3 202 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 203
AnnaBridge 189:f392fc9709a3 204 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 205 extern "C" {
AnnaBridge 189:f392fc9709a3 206 #endif /*_cplusplus*/
AnnaBridge 189:f392fc9709a3 207
AnnaBridge 189:f392fc9709a3 208 /*!
AnnaBridge 189:f392fc9709a3 209 * @name FlexIO SPI Configuration
AnnaBridge 189:f392fc9709a3 210 * @{
AnnaBridge 189:f392fc9709a3 211 */
AnnaBridge 189:f392fc9709a3 212
AnnaBridge 189:f392fc9709a3 213 /*!
AnnaBridge 189:f392fc9709a3 214 * @brief Ungates the FlexIO clock, resets the FlexIO module, configures the FlexIO SPI master hardware,
AnnaBridge 189:f392fc9709a3 215 * and configures the FlexIO SPI with FlexIO SPI master configuration. The
AnnaBridge 189:f392fc9709a3 216 * configuration structure can be filled by the user, or be set with default values
AnnaBridge 189:f392fc9709a3 217 * by the FLEXIO_SPI_MasterGetDefaultConfig().
AnnaBridge 189:f392fc9709a3 218 *
AnnaBridge 189:f392fc9709a3 219 * @note FlexIO SPI master only support CPOL = 0, which means clock inactive low.
AnnaBridge 189:f392fc9709a3 220 *
AnnaBridge 189:f392fc9709a3 221 * Example
AnnaBridge 189:f392fc9709a3 222 @code
AnnaBridge 189:f392fc9709a3 223 FLEXIO_SPI_Type spiDev = {
AnnaBridge 189:f392fc9709a3 224 .flexioBase = FLEXIO,
AnnaBridge 189:f392fc9709a3 225 .SDOPinIndex = 0,
AnnaBridge 189:f392fc9709a3 226 .SDIPinIndex = 1,
AnnaBridge 189:f392fc9709a3 227 .SCKPinIndex = 2,
AnnaBridge 189:f392fc9709a3 228 .CSnPinIndex = 3,
AnnaBridge 189:f392fc9709a3 229 .shifterIndex = {0,1},
AnnaBridge 189:f392fc9709a3 230 .timerIndex = {0,1}
AnnaBridge 189:f392fc9709a3 231 };
AnnaBridge 189:f392fc9709a3 232 flexio_spi_master_config_t config = {
AnnaBridge 189:f392fc9709a3 233 .enableMaster = true,
AnnaBridge 189:f392fc9709a3 234 .enableInDoze = false,
AnnaBridge 189:f392fc9709a3 235 .enableInDebug = true,
AnnaBridge 189:f392fc9709a3 236 .enableFastAccess = false,
AnnaBridge 189:f392fc9709a3 237 .baudRate_Bps = 500000,
AnnaBridge 189:f392fc9709a3 238 .phase = kFLEXIO_SPI_ClockPhaseFirstEdge,
AnnaBridge 189:f392fc9709a3 239 .direction = kFLEXIO_SPI_MsbFirst,
AnnaBridge 189:f392fc9709a3 240 .dataMode = kFLEXIO_SPI_8BitMode
AnnaBridge 189:f392fc9709a3 241 };
AnnaBridge 189:f392fc9709a3 242 FLEXIO_SPI_MasterInit(&spiDev, &config, srcClock_Hz);
AnnaBridge 189:f392fc9709a3 243 @endcode
AnnaBridge 189:f392fc9709a3 244 *
AnnaBridge 189:f392fc9709a3 245 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 246 * @param masterConfig Pointer to the flexio_spi_master_config_t structure.
AnnaBridge 189:f392fc9709a3 247 * @param srcClock_Hz FlexIO source clock in Hz.
AnnaBridge 189:f392fc9709a3 248 */
AnnaBridge 189:f392fc9709a3 249 void FLEXIO_SPI_MasterInit(FLEXIO_SPI_Type *base, flexio_spi_master_config_t *masterConfig, uint32_t srcClock_Hz);
AnnaBridge 189:f392fc9709a3 250
AnnaBridge 189:f392fc9709a3 251 /*!
AnnaBridge 189:f392fc9709a3 252 * @brief Gates the FlexIO clock.
AnnaBridge 189:f392fc9709a3 253 *
AnnaBridge 189:f392fc9709a3 254 * @param base Pointer to the FLEXIO_SPI_Type.
AnnaBridge 189:f392fc9709a3 255 */
AnnaBridge 189:f392fc9709a3 256 void FLEXIO_SPI_MasterDeinit(FLEXIO_SPI_Type *base);
AnnaBridge 189:f392fc9709a3 257
AnnaBridge 189:f392fc9709a3 258 /*!
AnnaBridge 189:f392fc9709a3 259 * @brief Gets the default configuration to configure the FlexIO SPI master. The configuration
AnnaBridge 189:f392fc9709a3 260 * can be used directly by calling the FLEXIO_SPI_MasterConfigure().
AnnaBridge 189:f392fc9709a3 261 * Example:
AnnaBridge 189:f392fc9709a3 262 @code
AnnaBridge 189:f392fc9709a3 263 flexio_spi_master_config_t masterConfig;
AnnaBridge 189:f392fc9709a3 264 FLEXIO_SPI_MasterGetDefaultConfig(&masterConfig);
AnnaBridge 189:f392fc9709a3 265 @endcode
AnnaBridge 189:f392fc9709a3 266 * @param masterConfig Pointer to the flexio_spi_master_config_t structure.
AnnaBridge 189:f392fc9709a3 267 */
AnnaBridge 189:f392fc9709a3 268 void FLEXIO_SPI_MasterGetDefaultConfig(flexio_spi_master_config_t *masterConfig);
AnnaBridge 189:f392fc9709a3 269
AnnaBridge 189:f392fc9709a3 270 /*!
AnnaBridge 189:f392fc9709a3 271 * @brief Ungates the FlexIO clock, resets the FlexIO module, configures the FlexIO SPI slave hardware
AnnaBridge 189:f392fc9709a3 272 * configuration, and configures the FlexIO SPI with FlexIO SPI slave configuration. The
AnnaBridge 189:f392fc9709a3 273 * configuration structure can be filled by the user, or be set with default values
AnnaBridge 189:f392fc9709a3 274 * by the FLEXIO_SPI_SlaveGetDefaultConfig().
AnnaBridge 189:f392fc9709a3 275 *
AnnaBridge 189:f392fc9709a3 276 * @note Only one timer is needed in the FlexIO SPI slave. As a result, the second timer index is ignored.
AnnaBridge 189:f392fc9709a3 277 * FlexIO SPI slave only support CPOL = 0, which means clock inactive low.
AnnaBridge 189:f392fc9709a3 278 * Example
AnnaBridge 189:f392fc9709a3 279 @code
AnnaBridge 189:f392fc9709a3 280 FLEXIO_SPI_Type spiDev = {
AnnaBridge 189:f392fc9709a3 281 .flexioBase = FLEXIO,
AnnaBridge 189:f392fc9709a3 282 .SDOPinIndex = 0,
AnnaBridge 189:f392fc9709a3 283 .SDIPinIndex = 1,
AnnaBridge 189:f392fc9709a3 284 .SCKPinIndex = 2,
AnnaBridge 189:f392fc9709a3 285 .CSnPinIndex = 3,
AnnaBridge 189:f392fc9709a3 286 .shifterIndex = {0,1},
AnnaBridge 189:f392fc9709a3 287 .timerIndex = {0}
AnnaBridge 189:f392fc9709a3 288 };
AnnaBridge 189:f392fc9709a3 289 flexio_spi_slave_config_t config = {
AnnaBridge 189:f392fc9709a3 290 .enableSlave = true,
AnnaBridge 189:f392fc9709a3 291 .enableInDoze = false,
AnnaBridge 189:f392fc9709a3 292 .enableInDebug = true,
AnnaBridge 189:f392fc9709a3 293 .enableFastAccess = false,
AnnaBridge 189:f392fc9709a3 294 .phase = kFLEXIO_SPI_ClockPhaseFirstEdge,
AnnaBridge 189:f392fc9709a3 295 .direction = kFLEXIO_SPI_MsbFirst,
AnnaBridge 189:f392fc9709a3 296 .dataMode = kFLEXIO_SPI_8BitMode
AnnaBridge 189:f392fc9709a3 297 };
AnnaBridge 189:f392fc9709a3 298 FLEXIO_SPI_SlaveInit(&spiDev, &config);
AnnaBridge 189:f392fc9709a3 299 @endcode
AnnaBridge 189:f392fc9709a3 300 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 301 * @param slaveConfig Pointer to the flexio_spi_slave_config_t structure.
AnnaBridge 189:f392fc9709a3 302 */
AnnaBridge 189:f392fc9709a3 303 void FLEXIO_SPI_SlaveInit(FLEXIO_SPI_Type *base, flexio_spi_slave_config_t *slaveConfig);
AnnaBridge 189:f392fc9709a3 304
AnnaBridge 189:f392fc9709a3 305 /*!
AnnaBridge 189:f392fc9709a3 306 * @brief Gates the FlexIO clock.
AnnaBridge 189:f392fc9709a3 307 *
AnnaBridge 189:f392fc9709a3 308 * @param base Pointer to the FLEXIO_SPI_Type.
AnnaBridge 189:f392fc9709a3 309 */
AnnaBridge 189:f392fc9709a3 310 void FLEXIO_SPI_SlaveDeinit(FLEXIO_SPI_Type *base);
AnnaBridge 189:f392fc9709a3 311
AnnaBridge 189:f392fc9709a3 312 /*!
AnnaBridge 189:f392fc9709a3 313 * @brief Gets the default configuration to configure the FlexIO SPI slave. The configuration
AnnaBridge 189:f392fc9709a3 314 * can be used directly for calling the FLEXIO_SPI_SlaveConfigure().
AnnaBridge 189:f392fc9709a3 315 * Example:
AnnaBridge 189:f392fc9709a3 316 @code
AnnaBridge 189:f392fc9709a3 317 flexio_spi_slave_config_t slaveConfig;
AnnaBridge 189:f392fc9709a3 318 FLEXIO_SPI_SlaveGetDefaultConfig(&slaveConfig);
AnnaBridge 189:f392fc9709a3 319 @endcode
AnnaBridge 189:f392fc9709a3 320 * @param slaveConfig Pointer to the flexio_spi_slave_config_t structure.
AnnaBridge 189:f392fc9709a3 321 */
AnnaBridge 189:f392fc9709a3 322 void FLEXIO_SPI_SlaveGetDefaultConfig(flexio_spi_slave_config_t *slaveConfig);
AnnaBridge 189:f392fc9709a3 323
AnnaBridge 189:f392fc9709a3 324 /*@}*/
AnnaBridge 189:f392fc9709a3 325
AnnaBridge 189:f392fc9709a3 326 /*!
AnnaBridge 189:f392fc9709a3 327 * @name Status
AnnaBridge 189:f392fc9709a3 328 * @{
AnnaBridge 189:f392fc9709a3 329 */
AnnaBridge 189:f392fc9709a3 330
AnnaBridge 189:f392fc9709a3 331 /*!
AnnaBridge 189:f392fc9709a3 332 * @brief Gets FlexIO SPI status flags.
AnnaBridge 189:f392fc9709a3 333 *
AnnaBridge 189:f392fc9709a3 334 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 335 * @return status flag; Use the status flag to AND the following flag mask and get the status.
AnnaBridge 189:f392fc9709a3 336 * @arg kFLEXIO_SPI_TxEmptyFlag
AnnaBridge 189:f392fc9709a3 337 * @arg kFLEXIO_SPI_RxEmptyFlag
AnnaBridge 189:f392fc9709a3 338 */
AnnaBridge 189:f392fc9709a3 339
AnnaBridge 189:f392fc9709a3 340 uint32_t FLEXIO_SPI_GetStatusFlags(FLEXIO_SPI_Type *base);
AnnaBridge 189:f392fc9709a3 341
AnnaBridge 189:f392fc9709a3 342 /*!
AnnaBridge 189:f392fc9709a3 343 * @brief Clears FlexIO SPI status flags.
AnnaBridge 189:f392fc9709a3 344 *
AnnaBridge 189:f392fc9709a3 345 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 346 * @param mask status flag
AnnaBridge 189:f392fc9709a3 347 * The parameter can be any combination of the following values:
AnnaBridge 189:f392fc9709a3 348 * @arg kFLEXIO_SPI_TxEmptyFlag
AnnaBridge 189:f392fc9709a3 349 * @arg kFLEXIO_SPI_RxEmptyFlag
AnnaBridge 189:f392fc9709a3 350 */
AnnaBridge 189:f392fc9709a3 351
AnnaBridge 189:f392fc9709a3 352 void FLEXIO_SPI_ClearStatusFlags(FLEXIO_SPI_Type *base, uint32_t mask);
AnnaBridge 189:f392fc9709a3 353
AnnaBridge 189:f392fc9709a3 354 /*@}*/
AnnaBridge 189:f392fc9709a3 355
AnnaBridge 189:f392fc9709a3 356 /*!
AnnaBridge 189:f392fc9709a3 357 * @name Interrupts
AnnaBridge 189:f392fc9709a3 358 * @{
AnnaBridge 189:f392fc9709a3 359 */
AnnaBridge 189:f392fc9709a3 360
AnnaBridge 189:f392fc9709a3 361 /*!
AnnaBridge 189:f392fc9709a3 362 * @brief Enables the FlexIO SPI interrupt.
AnnaBridge 189:f392fc9709a3 363 *
AnnaBridge 189:f392fc9709a3 364 * This function enables the FlexIO SPI interrupt.
AnnaBridge 189:f392fc9709a3 365 *
AnnaBridge 189:f392fc9709a3 366 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 367 * @param mask interrupt source. The parameter can be any combination of the following values:
AnnaBridge 189:f392fc9709a3 368 * @arg kFLEXIO_SPI_RxFullInterruptEnable
AnnaBridge 189:f392fc9709a3 369 * @arg kFLEXIO_SPI_TxEmptyInterruptEnable
AnnaBridge 189:f392fc9709a3 370 */
AnnaBridge 189:f392fc9709a3 371 void FLEXIO_SPI_EnableInterrupts(FLEXIO_SPI_Type *base, uint32_t mask);
AnnaBridge 189:f392fc9709a3 372
AnnaBridge 189:f392fc9709a3 373 /*!
AnnaBridge 189:f392fc9709a3 374 * @brief Disables the FlexIO SPI interrupt.
AnnaBridge 189:f392fc9709a3 375 *
AnnaBridge 189:f392fc9709a3 376 * This function disables the FlexIO SPI interrupt.
AnnaBridge 189:f392fc9709a3 377 *
AnnaBridge 189:f392fc9709a3 378 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 379 * @param mask interrupt source The parameter can be any combination of the following values:
AnnaBridge 189:f392fc9709a3 380 * @arg kFLEXIO_SPI_RxFullInterruptEnable
AnnaBridge 189:f392fc9709a3 381 * @arg kFLEXIO_SPI_TxEmptyInterruptEnable
AnnaBridge 189:f392fc9709a3 382 */
AnnaBridge 189:f392fc9709a3 383 void FLEXIO_SPI_DisableInterrupts(FLEXIO_SPI_Type *base, uint32_t mask);
AnnaBridge 189:f392fc9709a3 384
AnnaBridge 189:f392fc9709a3 385 /*@}*/
AnnaBridge 189:f392fc9709a3 386
AnnaBridge 189:f392fc9709a3 387 /*!
AnnaBridge 189:f392fc9709a3 388 * @name DMA Control
AnnaBridge 189:f392fc9709a3 389 * @{
AnnaBridge 189:f392fc9709a3 390 */
AnnaBridge 189:f392fc9709a3 391
AnnaBridge 189:f392fc9709a3 392 /*!
AnnaBridge 189:f392fc9709a3 393 * @brief Enables/disables the FlexIO SPI transmit DMA. This function enables/disables the FlexIO SPI Tx DMA,
AnnaBridge 189:f392fc9709a3 394 * which means that asserting the kFLEXIO_SPI_TxEmptyFlag does/doesn't trigger the DMA request.
AnnaBridge 189:f392fc9709a3 395 *
AnnaBridge 189:f392fc9709a3 396 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 397 * @param mask SPI DMA source.
AnnaBridge 189:f392fc9709a3 398 * @param enable True means enable DMA, false means disable DMA.
AnnaBridge 189:f392fc9709a3 399 */
AnnaBridge 189:f392fc9709a3 400 void FLEXIO_SPI_EnableDMA(FLEXIO_SPI_Type *base, uint32_t mask, bool enable);
AnnaBridge 189:f392fc9709a3 401
AnnaBridge 189:f392fc9709a3 402 /*!
AnnaBridge 189:f392fc9709a3 403 * @brief Gets the FlexIO SPI transmit data register address for MSB first transfer.
AnnaBridge 189:f392fc9709a3 404 *
AnnaBridge 189:f392fc9709a3 405 * This function returns the SPI data register address, which is mainly used by DMA/eDMA.
AnnaBridge 189:f392fc9709a3 406 *
AnnaBridge 189:f392fc9709a3 407 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 408 * @param direction Shift direction of MSB first or LSB first.
AnnaBridge 189:f392fc9709a3 409 * @return FlexIO SPI transmit data register address.
AnnaBridge 189:f392fc9709a3 410 */
AnnaBridge 189:f392fc9709a3 411 static inline uint32_t FLEXIO_SPI_GetTxDataRegisterAddress(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 412 flexio_spi_shift_direction_t direction)
AnnaBridge 189:f392fc9709a3 413 {
AnnaBridge 189:f392fc9709a3 414 if (direction == kFLEXIO_SPI_MsbFirst)
AnnaBridge 189:f392fc9709a3 415 {
AnnaBridge 189:f392fc9709a3 416 return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBufferBitSwapped,
AnnaBridge 189:f392fc9709a3 417 base->shifterIndex[0]) +
AnnaBridge 189:f392fc9709a3 418 3U;
AnnaBridge 189:f392fc9709a3 419 }
AnnaBridge 189:f392fc9709a3 420 else
AnnaBridge 189:f392fc9709a3 421 {
AnnaBridge 189:f392fc9709a3 422 return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBuffer, base->shifterIndex[0]);
AnnaBridge 189:f392fc9709a3 423 }
AnnaBridge 189:f392fc9709a3 424 }
AnnaBridge 189:f392fc9709a3 425
AnnaBridge 189:f392fc9709a3 426 /*!
AnnaBridge 189:f392fc9709a3 427 * @brief Gets the FlexIO SPI receive data register address for the MSB first transfer.
AnnaBridge 189:f392fc9709a3 428 *
AnnaBridge 189:f392fc9709a3 429 * This function returns the SPI data register address, which is mainly used by DMA/eDMA.
AnnaBridge 189:f392fc9709a3 430 *
AnnaBridge 189:f392fc9709a3 431 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 432 * @param direction Shift direction of MSB first or LSB first.
AnnaBridge 189:f392fc9709a3 433 * @return FlexIO SPI receive data register address.
AnnaBridge 189:f392fc9709a3 434 */
AnnaBridge 189:f392fc9709a3 435 static inline uint32_t FLEXIO_SPI_GetRxDataRegisterAddress(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 436 flexio_spi_shift_direction_t direction)
AnnaBridge 189:f392fc9709a3 437 {
AnnaBridge 189:f392fc9709a3 438 if (direction == kFLEXIO_SPI_MsbFirst)
AnnaBridge 189:f392fc9709a3 439 {
AnnaBridge 189:f392fc9709a3 440 return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBufferBitSwapped, base->shifterIndex[1]);
AnnaBridge 189:f392fc9709a3 441 }
AnnaBridge 189:f392fc9709a3 442 else
AnnaBridge 189:f392fc9709a3 443 {
AnnaBridge 189:f392fc9709a3 444 return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBuffer, base->shifterIndex[1]) + 3U;
AnnaBridge 189:f392fc9709a3 445 }
AnnaBridge 189:f392fc9709a3 446 }
AnnaBridge 189:f392fc9709a3 447
AnnaBridge 189:f392fc9709a3 448 /*@}*/
AnnaBridge 189:f392fc9709a3 449
AnnaBridge 189:f392fc9709a3 450 /*!
AnnaBridge 189:f392fc9709a3 451 * @name Bus Operations
AnnaBridge 189:f392fc9709a3 452 * @{
AnnaBridge 189:f392fc9709a3 453 */
AnnaBridge 189:f392fc9709a3 454
AnnaBridge 189:f392fc9709a3 455 /*!
AnnaBridge 189:f392fc9709a3 456 * @brief Enables/disables the FlexIO SPI module operation.
AnnaBridge 189:f392fc9709a3 457 *
AnnaBridge 189:f392fc9709a3 458 * @param base Pointer to the FLEXIO_SPI_Type.
AnnaBridge 189:f392fc9709a3 459 * @param enable True to enable, false to disable.
AnnaBridge 189:f392fc9709a3 460 */
AnnaBridge 189:f392fc9709a3 461 static inline void FLEXIO_SPI_Enable(FLEXIO_SPI_Type *base, bool enable)
AnnaBridge 189:f392fc9709a3 462 {
AnnaBridge 189:f392fc9709a3 463 if (enable)
AnnaBridge 189:f392fc9709a3 464 {
AnnaBridge 189:f392fc9709a3 465 base->flexioBase->CTRL |= FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 189:f392fc9709a3 466 }
AnnaBridge 189:f392fc9709a3 467 else
AnnaBridge 189:f392fc9709a3 468 {
AnnaBridge 189:f392fc9709a3 469 base->flexioBase->CTRL &= ~FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 189:f392fc9709a3 470 }
AnnaBridge 189:f392fc9709a3 471 }
AnnaBridge 189:f392fc9709a3 472
AnnaBridge 189:f392fc9709a3 473 /*!
AnnaBridge 189:f392fc9709a3 474 * @brief Sets baud rate for the FlexIO SPI transfer, which is only used for the master.
AnnaBridge 189:f392fc9709a3 475 *
AnnaBridge 189:f392fc9709a3 476 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 477 * @param baudRate_Bps Baud Rate needed in Hz.
AnnaBridge 189:f392fc9709a3 478 * @param srcClockHz SPI source clock frequency in Hz.
AnnaBridge 189:f392fc9709a3 479 */
AnnaBridge 189:f392fc9709a3 480 void FLEXIO_SPI_MasterSetBaudRate(FLEXIO_SPI_Type *base, uint32_t baudRate_Bps, uint32_t srcClockHz);
AnnaBridge 189:f392fc9709a3 481
AnnaBridge 189:f392fc9709a3 482 /*!
AnnaBridge 189:f392fc9709a3 483 * @brief Writes one byte of data, which is sent using the MSB method.
AnnaBridge 189:f392fc9709a3 484 *
AnnaBridge 189:f392fc9709a3 485 * @note This is a non-blocking API, which returns directly after the data is put into the
AnnaBridge 189:f392fc9709a3 486 * data register but the data transfer is not finished on the bus. Ensure that
AnnaBridge 189:f392fc9709a3 487 * the TxEmptyFlag is asserted before calling this API.
AnnaBridge 189:f392fc9709a3 488 *
AnnaBridge 189:f392fc9709a3 489 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 490 * @param direction Shift direction of MSB first or LSB first.
AnnaBridge 189:f392fc9709a3 491 * @param data 8 bit/16 bit data.
AnnaBridge 189:f392fc9709a3 492 */
AnnaBridge 189:f392fc9709a3 493 static inline void FLEXIO_SPI_WriteData(FLEXIO_SPI_Type *base, flexio_spi_shift_direction_t direction, uint16_t data)
AnnaBridge 189:f392fc9709a3 494 {
AnnaBridge 189:f392fc9709a3 495 if (direction == kFLEXIO_SPI_MsbFirst)
AnnaBridge 189:f392fc9709a3 496 {
AnnaBridge 189:f392fc9709a3 497 base->flexioBase->SHIFTBUFBBS[base->shifterIndex[0]] = data;
AnnaBridge 189:f392fc9709a3 498 }
AnnaBridge 189:f392fc9709a3 499 else
AnnaBridge 189:f392fc9709a3 500 {
AnnaBridge 189:f392fc9709a3 501 base->flexioBase->SHIFTBUF[base->shifterIndex[0]] = data;
AnnaBridge 189:f392fc9709a3 502 }
AnnaBridge 189:f392fc9709a3 503 }
AnnaBridge 189:f392fc9709a3 504
AnnaBridge 189:f392fc9709a3 505 /*!
AnnaBridge 189:f392fc9709a3 506 * @brief Reads 8 bit/16 bit data.
AnnaBridge 189:f392fc9709a3 507 *
AnnaBridge 189:f392fc9709a3 508 * @note This is a non-blocking API, which returns directly after the data is read from the
AnnaBridge 189:f392fc9709a3 509 * data register. Ensure that the RxFullFlag is asserted before calling this API.
AnnaBridge 189:f392fc9709a3 510 *
AnnaBridge 189:f392fc9709a3 511 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 512 * @param direction Shift direction of MSB first or LSB first.
AnnaBridge 189:f392fc9709a3 513 * @return 8 bit/16 bit data received.
AnnaBridge 189:f392fc9709a3 514 */
AnnaBridge 189:f392fc9709a3 515 static inline uint16_t FLEXIO_SPI_ReadData(FLEXIO_SPI_Type *base, flexio_spi_shift_direction_t direction)
AnnaBridge 189:f392fc9709a3 516 {
AnnaBridge 189:f392fc9709a3 517 if (direction == kFLEXIO_SPI_MsbFirst)
AnnaBridge 189:f392fc9709a3 518 {
AnnaBridge 189:f392fc9709a3 519 return base->flexioBase->SHIFTBUFBIS[base->shifterIndex[1]];
AnnaBridge 189:f392fc9709a3 520 }
AnnaBridge 189:f392fc9709a3 521 else
AnnaBridge 189:f392fc9709a3 522 {
AnnaBridge 189:f392fc9709a3 523 return base->flexioBase->SHIFTBUFBYS[base->shifterIndex[1]];
AnnaBridge 189:f392fc9709a3 524 }
AnnaBridge 189:f392fc9709a3 525 }
AnnaBridge 189:f392fc9709a3 526
AnnaBridge 189:f392fc9709a3 527 /*!
AnnaBridge 189:f392fc9709a3 528 * @brief Sends a buffer of data bytes.
AnnaBridge 189:f392fc9709a3 529 *
AnnaBridge 189:f392fc9709a3 530 * @note This function blocks using the polling method until all bytes have been sent.
AnnaBridge 189:f392fc9709a3 531 *
AnnaBridge 189:f392fc9709a3 532 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 533 * @param direction Shift direction of MSB first or LSB first.
AnnaBridge 189:f392fc9709a3 534 * @param buffer The data bytes to send.
AnnaBridge 189:f392fc9709a3 535 * @param size The number of data bytes to send.
AnnaBridge 189:f392fc9709a3 536 */
AnnaBridge 189:f392fc9709a3 537 void FLEXIO_SPI_WriteBlocking(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 538 flexio_spi_shift_direction_t direction,
AnnaBridge 189:f392fc9709a3 539 const uint8_t *buffer,
AnnaBridge 189:f392fc9709a3 540 size_t size);
AnnaBridge 189:f392fc9709a3 541
AnnaBridge 189:f392fc9709a3 542 /*!
AnnaBridge 189:f392fc9709a3 543 * @brief Receives a buffer of bytes.
AnnaBridge 189:f392fc9709a3 544 *
AnnaBridge 189:f392fc9709a3 545 * @note This function blocks using the polling method until all bytes have been received.
AnnaBridge 189:f392fc9709a3 546 *
AnnaBridge 189:f392fc9709a3 547 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 548 * @param direction Shift direction of MSB first or LSB first.
AnnaBridge 189:f392fc9709a3 549 * @param buffer The buffer to store the received bytes.
AnnaBridge 189:f392fc9709a3 550 * @param size The number of data bytes to be received.
AnnaBridge 189:f392fc9709a3 551 * @param direction Shift direction of MSB first or LSB first.
AnnaBridge 189:f392fc9709a3 552 */
AnnaBridge 189:f392fc9709a3 553 void FLEXIO_SPI_ReadBlocking(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 554 flexio_spi_shift_direction_t direction,
AnnaBridge 189:f392fc9709a3 555 uint8_t *buffer,
AnnaBridge 189:f392fc9709a3 556 size_t size);
AnnaBridge 189:f392fc9709a3 557
AnnaBridge 189:f392fc9709a3 558 /*!
AnnaBridge 189:f392fc9709a3 559 * @brief Receives a buffer of bytes.
AnnaBridge 189:f392fc9709a3 560 *
AnnaBridge 189:f392fc9709a3 561 * @note This function blocks via polling until all bytes have been received.
AnnaBridge 189:f392fc9709a3 562 *
AnnaBridge 189:f392fc9709a3 563 * @param base pointer to FLEXIO_SPI_Type structure
AnnaBridge 189:f392fc9709a3 564 * @param xfer FlexIO SPI transfer structure, see #flexio_spi_transfer_t.
AnnaBridge 189:f392fc9709a3 565 */
AnnaBridge 189:f392fc9709a3 566 void FLEXIO_SPI_MasterTransferBlocking(FLEXIO_SPI_Type *base, flexio_spi_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 567
AnnaBridge 189:f392fc9709a3 568 /*Transactional APIs*/
AnnaBridge 189:f392fc9709a3 569
AnnaBridge 189:f392fc9709a3 570 /*!
AnnaBridge 189:f392fc9709a3 571 * @name Transactional
AnnaBridge 189:f392fc9709a3 572 * @{
AnnaBridge 189:f392fc9709a3 573 */
AnnaBridge 189:f392fc9709a3 574
AnnaBridge 189:f392fc9709a3 575 /*!
AnnaBridge 189:f392fc9709a3 576 * @brief Initializes the FlexIO SPI Master handle, which is used in transactional functions.
AnnaBridge 189:f392fc9709a3 577 *
AnnaBridge 189:f392fc9709a3 578 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 579 * @param handle Pointer to the flexio_spi_master_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 580 * @param callback The callback function.
AnnaBridge 189:f392fc9709a3 581 * @param userData The parameter of the callback function.
AnnaBridge 189:f392fc9709a3 582 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 189:f392fc9709a3 583 * @retval kStatus_OutOfRange The FlexIO type/handle/ISR table out of range.
AnnaBridge 189:f392fc9709a3 584 */
AnnaBridge 189:f392fc9709a3 585 status_t FLEXIO_SPI_MasterTransferCreateHandle(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 586 flexio_spi_master_handle_t *handle,
AnnaBridge 189:f392fc9709a3 587 flexio_spi_master_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 588 void *userData);
AnnaBridge 189:f392fc9709a3 589
AnnaBridge 189:f392fc9709a3 590 /*!
AnnaBridge 189:f392fc9709a3 591 * @brief Master transfer data using IRQ.
AnnaBridge 189:f392fc9709a3 592 *
AnnaBridge 189:f392fc9709a3 593 * This function sends data using IRQ. This is a non-blocking function, which returns
AnnaBridge 189:f392fc9709a3 594 * right away. When all data is sent out/received, the callback function is called.
AnnaBridge 189:f392fc9709a3 595 *
AnnaBridge 189:f392fc9709a3 596 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 597 * @param handle Pointer to the flexio_spi_master_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 598 * @param xfer FlexIO SPI transfer structure. See #flexio_spi_transfer_t.
AnnaBridge 189:f392fc9709a3 599 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 189:f392fc9709a3 600 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 189:f392fc9709a3 601 * @retval kStatus_FLEXIO_SPI_Busy SPI is not idle, is running another transfer.
AnnaBridge 189:f392fc9709a3 602 */
AnnaBridge 189:f392fc9709a3 603 status_t FLEXIO_SPI_MasterTransferNonBlocking(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 604 flexio_spi_master_handle_t *handle,
AnnaBridge 189:f392fc9709a3 605 flexio_spi_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 606
AnnaBridge 189:f392fc9709a3 607 /*!
AnnaBridge 189:f392fc9709a3 608 * @brief Aborts the master data transfer, which used IRQ.
AnnaBridge 189:f392fc9709a3 609 *
AnnaBridge 189:f392fc9709a3 610 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 611 * @param handle Pointer to the flexio_spi_master_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 612 */
AnnaBridge 189:f392fc9709a3 613 void FLEXIO_SPI_MasterTransferAbort(FLEXIO_SPI_Type *base, flexio_spi_master_handle_t *handle);
AnnaBridge 189:f392fc9709a3 614
AnnaBridge 189:f392fc9709a3 615 /*!
AnnaBridge 189:f392fc9709a3 616 * @brief Gets the data transfer status which used IRQ.
AnnaBridge 189:f392fc9709a3 617 *
AnnaBridge 189:f392fc9709a3 618 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 619 * @param handle Pointer to the flexio_spi_master_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 620 * @param count Number of bytes transferred so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 621 * @retval kStatus_InvalidArgument count is Invalid.
AnnaBridge 189:f392fc9709a3 622 * @retval kStatus_Success Successfully return the count.
AnnaBridge 189:f392fc9709a3 623 */
AnnaBridge 189:f392fc9709a3 624 status_t FLEXIO_SPI_MasterTransferGetCount(FLEXIO_SPI_Type *base, flexio_spi_master_handle_t *handle, size_t *count);
AnnaBridge 189:f392fc9709a3 625
AnnaBridge 189:f392fc9709a3 626 /*!
AnnaBridge 189:f392fc9709a3 627 * @brief FlexIO SPI master IRQ handler function.
AnnaBridge 189:f392fc9709a3 628 *
AnnaBridge 189:f392fc9709a3 629 * @param spiType Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 630 * @param spiHandle Pointer to the flexio_spi_master_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 631 */
AnnaBridge 189:f392fc9709a3 632 void FLEXIO_SPI_MasterTransferHandleIRQ(void *spiType, void *spiHandle);
AnnaBridge 189:f392fc9709a3 633
AnnaBridge 189:f392fc9709a3 634 /*!
AnnaBridge 189:f392fc9709a3 635 * @brief Initializes the FlexIO SPI Slave handle, which is used in transactional functions.
AnnaBridge 189:f392fc9709a3 636 *
AnnaBridge 189:f392fc9709a3 637 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 638 * @param handle Pointer to the flexio_spi_slave_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 639 * @param callback The callback function.
AnnaBridge 189:f392fc9709a3 640 * @param userData The parameter of the callback function.
AnnaBridge 189:f392fc9709a3 641 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 189:f392fc9709a3 642 * @retval kStatus_OutOfRange The FlexIO type/handle/ISR table out of range.
AnnaBridge 189:f392fc9709a3 643 */
AnnaBridge 189:f392fc9709a3 644 status_t FLEXIO_SPI_SlaveTransferCreateHandle(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 645 flexio_spi_slave_handle_t *handle,
AnnaBridge 189:f392fc9709a3 646 flexio_spi_slave_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 647 void *userData);
AnnaBridge 189:f392fc9709a3 648
AnnaBridge 189:f392fc9709a3 649 /*!
AnnaBridge 189:f392fc9709a3 650 * @brief Slave transfer data using IRQ.
AnnaBridge 189:f392fc9709a3 651 *
AnnaBridge 189:f392fc9709a3 652 * This function sends data using IRQ. This is a non-blocking function, which returns
AnnaBridge 189:f392fc9709a3 653 * right away. When all data is sent out/received, the callback function is called.
AnnaBridge 189:f392fc9709a3 654 * @param handle Pointer to the flexio_spi_slave_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 655 *
AnnaBridge 189:f392fc9709a3 656 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 657 * @param xfer FlexIO SPI transfer structure. See #flexio_spi_transfer_t.
AnnaBridge 189:f392fc9709a3 658 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 189:f392fc9709a3 659 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 189:f392fc9709a3 660 * @retval kStatus_FLEXIO_SPI_Busy SPI is not idle; it is running another transfer.
AnnaBridge 189:f392fc9709a3 661 */
AnnaBridge 189:f392fc9709a3 662 status_t FLEXIO_SPI_SlaveTransferNonBlocking(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 663 flexio_spi_slave_handle_t *handle,
AnnaBridge 189:f392fc9709a3 664 flexio_spi_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 665
AnnaBridge 189:f392fc9709a3 666 /*!
AnnaBridge 189:f392fc9709a3 667 * @brief Aborts the slave data transfer which used IRQ, share same API with master.
AnnaBridge 189:f392fc9709a3 668 *
AnnaBridge 189:f392fc9709a3 669 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 670 * @param handle Pointer to the flexio_spi_slave_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 671 */
AnnaBridge 189:f392fc9709a3 672 static inline void FLEXIO_SPI_SlaveTransferAbort(FLEXIO_SPI_Type *base, flexio_spi_slave_handle_t *handle)
AnnaBridge 189:f392fc9709a3 673 {
AnnaBridge 189:f392fc9709a3 674 FLEXIO_SPI_MasterTransferAbort(base, handle);
AnnaBridge 189:f392fc9709a3 675 }
AnnaBridge 189:f392fc9709a3 676 /*!
AnnaBridge 189:f392fc9709a3 677 * @brief Gets the data transfer status which used IRQ, share same API with master.
AnnaBridge 189:f392fc9709a3 678 *
AnnaBridge 189:f392fc9709a3 679 * @param base Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 680 * @param handle Pointer to the flexio_spi_slave_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 681 * @param count Number of bytes transferred so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 682 * @retval kStatus_InvalidArgument count is Invalid.
AnnaBridge 189:f392fc9709a3 683 * @retval kStatus_Success Successfully return the count.
AnnaBridge 189:f392fc9709a3 684 */
AnnaBridge 189:f392fc9709a3 685 static inline status_t FLEXIO_SPI_SlaveTransferGetCount(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 686 flexio_spi_slave_handle_t *handle,
AnnaBridge 189:f392fc9709a3 687 size_t *count)
AnnaBridge 189:f392fc9709a3 688 {
AnnaBridge 189:f392fc9709a3 689 return FLEXIO_SPI_MasterTransferGetCount(base, handle, count);
AnnaBridge 189:f392fc9709a3 690 }
AnnaBridge 189:f392fc9709a3 691
AnnaBridge 189:f392fc9709a3 692 /*!
AnnaBridge 189:f392fc9709a3 693 * @brief FlexIO SPI slave IRQ handler function.
AnnaBridge 189:f392fc9709a3 694 *
AnnaBridge 189:f392fc9709a3 695 * @param spiType Pointer to the FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 696 * @param spiHandle Pointer to the flexio_spi_slave_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 697 */
AnnaBridge 189:f392fc9709a3 698 void FLEXIO_SPI_SlaveTransferHandleIRQ(void *spiType, void *spiHandle);
AnnaBridge 189:f392fc9709a3 699
AnnaBridge 189:f392fc9709a3 700 /*@}*/
AnnaBridge 189:f392fc9709a3 701
AnnaBridge 189:f392fc9709a3 702 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 703 }
AnnaBridge 189:f392fc9709a3 704 #endif /*_cplusplus*/
AnnaBridge 189:f392fc9709a3 705 /*@}*/
AnnaBridge 189:f392fc9709a3 706
AnnaBridge 189:f392fc9709a3 707 #endif /*_FSL_FLEXIO_SPI_H_*/