mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_UBRIDGE/TOOLCHAIN_ARM_STD/fsl_flexio_spi.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_UBRIDGE/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_K82F/drivers/fsl_flexio_spi.h@145:64910690c574 
mbed library. Release version 164

Who changed what in which revision?

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