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_i2c_master.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 #ifndef _FSL_FLEXIO_I2C_MASTER_H_
AnnaBridge 189:f392fc9709a3 31 #define _FSL_FLEXIO_I2C_MASTER_H_
AnnaBridge 189:f392fc9709a3 32
AnnaBridge 189:f392fc9709a3 33 #include "fsl_common.h"
AnnaBridge 189:f392fc9709a3 34 #include "fsl_flexio.h"
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /*!
AnnaBridge 189:f392fc9709a3 37 * @addtogroup flexio_i2c_master
AnnaBridge 189:f392fc9709a3 38 * @{
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 I2C master driver version 2.1.2. */
AnnaBridge 189:f392fc9709a3 49 #define FSL_FLEXIO_I2C_MASTER_DRIVER_VERSION (MAKE_VERSION(2, 1, 2))
AnnaBridge 189:f392fc9709a3 50 /*@}*/
AnnaBridge 189:f392fc9709a3 51
AnnaBridge 189:f392fc9709a3 52 /*! @brief FlexIO I2C transfer status*/
AnnaBridge 189:f392fc9709a3 53 enum _flexio_i2c_status
AnnaBridge 189:f392fc9709a3 54 {
AnnaBridge 189:f392fc9709a3 55 kStatus_FLEXIO_I2C_Busy = MAKE_STATUS(kStatusGroup_FLEXIO_I2C, 0), /*!< I2C is busy doing transfer. */
AnnaBridge 189:f392fc9709a3 56 kStatus_FLEXIO_I2C_Idle = MAKE_STATUS(kStatusGroup_FLEXIO_I2C, 1), /*!< I2C is busy doing transfer. */
AnnaBridge 189:f392fc9709a3 57 kStatus_FLEXIO_I2C_Nak = MAKE_STATUS(kStatusGroup_FLEXIO_I2C, 2), /*!< NAK received during transfer. */
AnnaBridge 189:f392fc9709a3 58 };
AnnaBridge 189:f392fc9709a3 59
AnnaBridge 189:f392fc9709a3 60 /*! @brief Define FlexIO I2C master interrupt mask. */
AnnaBridge 189:f392fc9709a3 61 enum _flexio_i2c_master_interrupt
AnnaBridge 189:f392fc9709a3 62 {
AnnaBridge 189:f392fc9709a3 63 kFLEXIO_I2C_TxEmptyInterruptEnable = 0x1U, /*!< Tx buffer empty interrupt enable. */
AnnaBridge 189:f392fc9709a3 64 kFLEXIO_I2C_RxFullInterruptEnable = 0x2U, /*!< Rx buffer full interrupt enable. */
AnnaBridge 189:f392fc9709a3 65 };
AnnaBridge 189:f392fc9709a3 66
AnnaBridge 189:f392fc9709a3 67 /*! @brief Define FlexIO I2C master status mask. */
AnnaBridge 189:f392fc9709a3 68 enum _flexio_i2c_master_status_flags
AnnaBridge 189:f392fc9709a3 69 {
AnnaBridge 189:f392fc9709a3 70 kFLEXIO_I2C_TxEmptyFlag = 0x1U, /*!< Tx shifter empty flag. */
AnnaBridge 189:f392fc9709a3 71 kFLEXIO_I2C_RxFullFlag = 0x2U, /*!< Rx shifter full/Transfer complete flag. */
AnnaBridge 189:f392fc9709a3 72 kFLEXIO_I2C_ReceiveNakFlag = 0x4U, /*!< Receive NAK flag. */
AnnaBridge 189:f392fc9709a3 73 };
AnnaBridge 189:f392fc9709a3 74
AnnaBridge 189:f392fc9709a3 75 /*! @brief Direction of master transfer.*/
AnnaBridge 189:f392fc9709a3 76 typedef enum _flexio_i2c_direction
AnnaBridge 189:f392fc9709a3 77 {
AnnaBridge 189:f392fc9709a3 78 kFLEXIO_I2C_Write = 0x0U, /*!< Master send to slave. */
AnnaBridge 189:f392fc9709a3 79 kFLEXIO_I2C_Read = 0x1U, /*!< Master receive from slave. */
AnnaBridge 189:f392fc9709a3 80 } flexio_i2c_direction_t;
AnnaBridge 189:f392fc9709a3 81
AnnaBridge 189:f392fc9709a3 82 /*! @brief Define FlexIO I2C master access structure typedef. */
AnnaBridge 189:f392fc9709a3 83 typedef struct _flexio_i2c_type
AnnaBridge 189:f392fc9709a3 84 {
AnnaBridge 189:f392fc9709a3 85 FLEXIO_Type *flexioBase; /*!< FlexIO base pointer. */
AnnaBridge 189:f392fc9709a3 86 uint8_t SDAPinIndex; /*!< Pin select for I2C SDA. */
AnnaBridge 189:f392fc9709a3 87 uint8_t SCLPinIndex; /*!< Pin select for I2C SCL. */
AnnaBridge 189:f392fc9709a3 88 uint8_t shifterIndex[2]; /*!< Shifter index used in FlexIO I2C. */
AnnaBridge 189:f392fc9709a3 89 uint8_t timerIndex[2]; /*!< Timer index used in FlexIO I2C. */
AnnaBridge 189:f392fc9709a3 90 } FLEXIO_I2C_Type;
AnnaBridge 189:f392fc9709a3 91
AnnaBridge 189:f392fc9709a3 92 /*! @brief Define FlexIO I2C master user configuration structure. */
AnnaBridge 189:f392fc9709a3 93 typedef struct _flexio_i2c_master_config
AnnaBridge 189:f392fc9709a3 94 {
AnnaBridge 189:f392fc9709a3 95 bool enableMaster; /*!< Enables the FlexIO I2C peripheral at initialization time. */
AnnaBridge 189:f392fc9709a3 96 bool enableInDoze; /*!< Enable/disable FlexIO operation in doze mode. */
AnnaBridge 189:f392fc9709a3 97 bool enableInDebug; /*!< Enable/disable FlexIO operation in debug mode. */
AnnaBridge 189:f392fc9709a3 98 bool enableFastAccess; /*!< Enable/disable fast access to FlexIO registers, fast access requires
AnnaBridge 189:f392fc9709a3 99 the FlexIO clock to be at least twice the frequency of the bus clock. */
AnnaBridge 189:f392fc9709a3 100 uint32_t baudRate_Bps; /*!< Baud rate in Bps. */
AnnaBridge 189:f392fc9709a3 101 } flexio_i2c_master_config_t;
AnnaBridge 189:f392fc9709a3 102
AnnaBridge 189:f392fc9709a3 103 /*! @brief Define FlexIO I2C master transfer structure. */
AnnaBridge 189:f392fc9709a3 104 typedef struct _flexio_i2c_master_transfer
AnnaBridge 189:f392fc9709a3 105 {
AnnaBridge 189:f392fc9709a3 106 uint32_t flags; /*!< Transfer flag which controls the transfer, reserved for FlexIO I2C. */
AnnaBridge 189:f392fc9709a3 107 uint8_t slaveAddress; /*!< 7-bit slave address. */
AnnaBridge 189:f392fc9709a3 108 flexio_i2c_direction_t direction; /*!< Transfer direction, read or write. */
AnnaBridge 189:f392fc9709a3 109 uint32_t subaddress; /*!< Sub address. Transferred MSB first. */
AnnaBridge 189:f392fc9709a3 110 uint8_t subaddressSize; /*!< Size of command buffer. */
AnnaBridge 189:f392fc9709a3 111 uint8_t volatile *data; /*!< Transfer buffer. */
AnnaBridge 189:f392fc9709a3 112 volatile size_t dataSize; /*!< Transfer size. */
AnnaBridge 189:f392fc9709a3 113 } flexio_i2c_master_transfer_t;
AnnaBridge 189:f392fc9709a3 114
AnnaBridge 189:f392fc9709a3 115 /*! @brief FlexIO I2C master handle typedef. */
AnnaBridge 189:f392fc9709a3 116 typedef struct _flexio_i2c_master_handle flexio_i2c_master_handle_t;
AnnaBridge 189:f392fc9709a3 117
AnnaBridge 189:f392fc9709a3 118 /*! @brief FlexIO I2C master transfer callback typedef. */
AnnaBridge 189:f392fc9709a3 119 typedef void (*flexio_i2c_master_transfer_callback_t)(FLEXIO_I2C_Type *base,
AnnaBridge 189:f392fc9709a3 120 flexio_i2c_master_handle_t *handle,
AnnaBridge 189:f392fc9709a3 121 status_t status,
AnnaBridge 189:f392fc9709a3 122 void *userData);
AnnaBridge 189:f392fc9709a3 123
AnnaBridge 189:f392fc9709a3 124 /*! @brief Define FlexIO I2C master handle structure. */
AnnaBridge 189:f392fc9709a3 125 struct _flexio_i2c_master_handle
AnnaBridge 189:f392fc9709a3 126 {
AnnaBridge 189:f392fc9709a3 127 flexio_i2c_master_transfer_t transfer; /*!< FlexIO I2C master transfer copy. */
AnnaBridge 189:f392fc9709a3 128 size_t transferSize; /*!< Total bytes to be transferred. */
AnnaBridge 189:f392fc9709a3 129 uint8_t state; /*!< Transfer state maintained during transfer. */
AnnaBridge 189:f392fc9709a3 130 flexio_i2c_master_transfer_callback_t completionCallback; /*!< Callback function called at transfer event. */
AnnaBridge 189:f392fc9709a3 131 /*!< Callback function called at transfer event. */
AnnaBridge 189:f392fc9709a3 132 void *userData; /*!< Callback parameter passed to callback function. */
AnnaBridge 189:f392fc9709a3 133 };
AnnaBridge 189:f392fc9709a3 134
AnnaBridge 189:f392fc9709a3 135 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 136 * API
AnnaBridge 189:f392fc9709a3 137 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 138
AnnaBridge 189:f392fc9709a3 139 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 140 extern "C" {
AnnaBridge 189:f392fc9709a3 141 #endif /*_cplusplus*/
AnnaBridge 189:f392fc9709a3 142
AnnaBridge 189:f392fc9709a3 143 /*!
AnnaBridge 189:f392fc9709a3 144 * @name Initialization and deinitialization
AnnaBridge 189:f392fc9709a3 145 * @{
AnnaBridge 189:f392fc9709a3 146 */
AnnaBridge 189:f392fc9709a3 147
AnnaBridge 189:f392fc9709a3 148 /*!
AnnaBridge 189:f392fc9709a3 149 * @brief Ungates the FlexIO clock, resets the FlexIO module, and configures the FlexIO I2C
AnnaBridge 189:f392fc9709a3 150 * hardware configuration.
AnnaBridge 189:f392fc9709a3 151 *
AnnaBridge 189:f392fc9709a3 152 * Example
AnnaBridge 189:f392fc9709a3 153 @code
AnnaBridge 189:f392fc9709a3 154 FLEXIO_I2C_Type base = {
AnnaBridge 189:f392fc9709a3 155 .flexioBase = FLEXIO,
AnnaBridge 189:f392fc9709a3 156 .SDAPinIndex = 0,
AnnaBridge 189:f392fc9709a3 157 .SCLPinIndex = 1,
AnnaBridge 189:f392fc9709a3 158 .shifterIndex = {0,1},
AnnaBridge 189:f392fc9709a3 159 .timerIndex = {0,1}
AnnaBridge 189:f392fc9709a3 160 };
AnnaBridge 189:f392fc9709a3 161 flexio_i2c_master_config_t config = {
AnnaBridge 189:f392fc9709a3 162 .enableInDoze = false,
AnnaBridge 189:f392fc9709a3 163 .enableInDebug = true,
AnnaBridge 189:f392fc9709a3 164 .enableFastAccess = false,
AnnaBridge 189:f392fc9709a3 165 .baudRate_Bps = 100000
AnnaBridge 189:f392fc9709a3 166 };
AnnaBridge 189:f392fc9709a3 167 FLEXIO_I2C_MasterInit(base, &config, srcClock_Hz);
AnnaBridge 189:f392fc9709a3 168 @endcode
AnnaBridge 189:f392fc9709a3 169 *
AnnaBridge 189:f392fc9709a3 170 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 171 * @param masterConfig Pointer to flexio_i2c_master_config_t structure.
AnnaBridge 189:f392fc9709a3 172 * @param srcClock_Hz FlexIO source clock in Hz.
AnnaBridge 189:f392fc9709a3 173 */
AnnaBridge 189:f392fc9709a3 174 void FLEXIO_I2C_MasterInit(FLEXIO_I2C_Type *base, flexio_i2c_master_config_t *masterConfig, uint32_t srcClock_Hz);
AnnaBridge 189:f392fc9709a3 175
AnnaBridge 189:f392fc9709a3 176 /*!
AnnaBridge 189:f392fc9709a3 177 * @brief De-initializes the FlexIO I2C master peripheral. Calling this API gates the FlexIO clock
AnnaBridge 189:f392fc9709a3 178 * and the FlexIO I2C master module can't work unless the FLEXIO_I2C_MasterInit is called.
AnnaBridge 189:f392fc9709a3 179 *
AnnaBridge 189:f392fc9709a3 180 * @param base pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 181 */
AnnaBridge 189:f392fc9709a3 182 void FLEXIO_I2C_MasterDeinit(FLEXIO_I2C_Type *base);
AnnaBridge 189:f392fc9709a3 183
AnnaBridge 189:f392fc9709a3 184 /*!
AnnaBridge 189:f392fc9709a3 185 * @brief Gets the default configuration to configure the FlexIO module. The configuration
AnnaBridge 189:f392fc9709a3 186 * can be used directly for calling the FLEXIO_I2C_MasterInit().
AnnaBridge 189:f392fc9709a3 187 *
AnnaBridge 189:f392fc9709a3 188 * Example:
AnnaBridge 189:f392fc9709a3 189 @code
AnnaBridge 189:f392fc9709a3 190 flexio_i2c_master_config_t config;
AnnaBridge 189:f392fc9709a3 191 FLEXIO_I2C_MasterGetDefaultConfig(&config);
AnnaBridge 189:f392fc9709a3 192 @endcode
AnnaBridge 189:f392fc9709a3 193 * @param masterConfig Pointer to flexio_i2c_master_config_t structure.
AnnaBridge 189:f392fc9709a3 194 */
AnnaBridge 189:f392fc9709a3 195 void FLEXIO_I2C_MasterGetDefaultConfig(flexio_i2c_master_config_t *masterConfig);
AnnaBridge 189:f392fc9709a3 196
AnnaBridge 189:f392fc9709a3 197 /*!
AnnaBridge 189:f392fc9709a3 198 * @brief Enables/disables the FlexIO module operation.
AnnaBridge 189:f392fc9709a3 199 *
AnnaBridge 189:f392fc9709a3 200 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 201 * @param enable Pass true to enable module, false to disable module.
AnnaBridge 189:f392fc9709a3 202 */
AnnaBridge 189:f392fc9709a3 203 static inline void FLEXIO_I2C_MasterEnable(FLEXIO_I2C_Type *base, bool enable)
AnnaBridge 189:f392fc9709a3 204 {
AnnaBridge 189:f392fc9709a3 205 if (enable)
AnnaBridge 189:f392fc9709a3 206 {
AnnaBridge 189:f392fc9709a3 207 base->flexioBase->CTRL |= FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 189:f392fc9709a3 208 }
AnnaBridge 189:f392fc9709a3 209 else
AnnaBridge 189:f392fc9709a3 210 {
AnnaBridge 189:f392fc9709a3 211 base->flexioBase->CTRL &= ~FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 189:f392fc9709a3 212 }
AnnaBridge 189:f392fc9709a3 213 }
AnnaBridge 189:f392fc9709a3 214
AnnaBridge 189:f392fc9709a3 215 /* @} */
AnnaBridge 189:f392fc9709a3 216
AnnaBridge 189:f392fc9709a3 217 /*!
AnnaBridge 189:f392fc9709a3 218 * @name Status
AnnaBridge 189:f392fc9709a3 219 * @{
AnnaBridge 189:f392fc9709a3 220 */
AnnaBridge 189:f392fc9709a3 221
AnnaBridge 189:f392fc9709a3 222 /*!
AnnaBridge 189:f392fc9709a3 223 * @brief Gets the FlexIO I2C master status flags.
AnnaBridge 189:f392fc9709a3 224 *
AnnaBridge 189:f392fc9709a3 225 * @param base Pointer to FLEXIO_I2C_Type structure
AnnaBridge 189:f392fc9709a3 226 * @return Status flag, use status flag to AND #_flexio_i2c_master_status_flags can get the related status.
AnnaBridge 189:f392fc9709a3 227 */
AnnaBridge 189:f392fc9709a3 228
AnnaBridge 189:f392fc9709a3 229 uint32_t FLEXIO_I2C_MasterGetStatusFlags(FLEXIO_I2C_Type *base);
AnnaBridge 189:f392fc9709a3 230
AnnaBridge 189:f392fc9709a3 231 /*!
AnnaBridge 189:f392fc9709a3 232 * @brief Clears the FlexIO I2C master status flags.
AnnaBridge 189:f392fc9709a3 233 *
AnnaBridge 189:f392fc9709a3 234 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 235 * @param mask Status flag.
AnnaBridge 189:f392fc9709a3 236 * The parameter can be any combination of the following values:
AnnaBridge 189:f392fc9709a3 237 * @arg kFLEXIO_I2C_RxFullFlag
AnnaBridge 189:f392fc9709a3 238 * @arg kFLEXIO_I2C_ReceiveNakFlag
AnnaBridge 189:f392fc9709a3 239 */
AnnaBridge 189:f392fc9709a3 240
AnnaBridge 189:f392fc9709a3 241 void FLEXIO_I2C_MasterClearStatusFlags(FLEXIO_I2C_Type *base, uint32_t mask);
AnnaBridge 189:f392fc9709a3 242
AnnaBridge 189:f392fc9709a3 243 /*@}*/
AnnaBridge 189:f392fc9709a3 244
AnnaBridge 189:f392fc9709a3 245 /*!
AnnaBridge 189:f392fc9709a3 246 * @name Interrupts
AnnaBridge 189:f392fc9709a3 247 * @{
AnnaBridge 189:f392fc9709a3 248 */
AnnaBridge 189:f392fc9709a3 249
AnnaBridge 189:f392fc9709a3 250 /*!
AnnaBridge 189:f392fc9709a3 251 * @brief Enables the FlexIO i2c master interrupt requests.
AnnaBridge 189:f392fc9709a3 252 *
AnnaBridge 189:f392fc9709a3 253 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 254 * @param mask Interrupt source.
AnnaBridge 189:f392fc9709a3 255 * Currently only one interrupt request source:
AnnaBridge 189:f392fc9709a3 256 * @arg kFLEXIO_I2C_TransferCompleteInterruptEnable
AnnaBridge 189:f392fc9709a3 257 */
AnnaBridge 189:f392fc9709a3 258 void FLEXIO_I2C_MasterEnableInterrupts(FLEXIO_I2C_Type *base, uint32_t mask);
AnnaBridge 189:f392fc9709a3 259
AnnaBridge 189:f392fc9709a3 260 /*!
AnnaBridge 189:f392fc9709a3 261 * @brief Disables the FlexIO I2C master interrupt requests.
AnnaBridge 189:f392fc9709a3 262 *
AnnaBridge 189:f392fc9709a3 263 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 264 * @param mask Interrupt source.
AnnaBridge 189:f392fc9709a3 265 */
AnnaBridge 189:f392fc9709a3 266 void FLEXIO_I2C_MasterDisableInterrupts(FLEXIO_I2C_Type *base, uint32_t mask);
AnnaBridge 189:f392fc9709a3 267
AnnaBridge 189:f392fc9709a3 268 /*@}*/
AnnaBridge 189:f392fc9709a3 269
AnnaBridge 189:f392fc9709a3 270 /*!
AnnaBridge 189:f392fc9709a3 271 * @name Bus Operations
AnnaBridge 189:f392fc9709a3 272 * @{
AnnaBridge 189:f392fc9709a3 273 */
AnnaBridge 189:f392fc9709a3 274
AnnaBridge 189:f392fc9709a3 275 /*!
AnnaBridge 189:f392fc9709a3 276 * @brief Sets the FlexIO I2C master transfer baudrate.
AnnaBridge 189:f392fc9709a3 277 *
AnnaBridge 189:f392fc9709a3 278 * @param base Pointer to FLEXIO_I2C_Type structure
AnnaBridge 189:f392fc9709a3 279 * @param baudRate_Bps the baud rate value in HZ
AnnaBridge 189:f392fc9709a3 280 * @param srcClock_Hz source clock in HZ
AnnaBridge 189:f392fc9709a3 281 */
AnnaBridge 189:f392fc9709a3 282 void FLEXIO_I2C_MasterSetBaudRate(FLEXIO_I2C_Type *base, uint32_t baudRate_Bps, uint32_t srcClock_Hz);
AnnaBridge 189:f392fc9709a3 283
AnnaBridge 189:f392fc9709a3 284 /*!
AnnaBridge 189:f392fc9709a3 285 * @brief Sends START + 7-bit address to the bus.
AnnaBridge 189:f392fc9709a3 286 *
AnnaBridge 189:f392fc9709a3 287 * @note This API should be called when the transfer configuration is ready to send a START signal
AnnaBridge 189:f392fc9709a3 288 * and 7-bit address to the bus. This is a non-blocking API, which returns directly after the address
AnnaBridge 189:f392fc9709a3 289 * is put into the data register but the address transfer is not finished on the bus. Ensure that
AnnaBridge 189:f392fc9709a3 290 * the kFLEXIO_I2C_RxFullFlag status is asserted before calling this API.
AnnaBridge 189:f392fc9709a3 291 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 292 * @param address 7-bit address.
AnnaBridge 189:f392fc9709a3 293 * @param direction transfer direction.
AnnaBridge 189:f392fc9709a3 294 * This parameter is one of the values in flexio_i2c_direction_t:
AnnaBridge 189:f392fc9709a3 295 * @arg kFLEXIO_I2C_Write: Transmit
AnnaBridge 189:f392fc9709a3 296 * @arg kFLEXIO_I2C_Read: Receive
AnnaBridge 189:f392fc9709a3 297 */
AnnaBridge 189:f392fc9709a3 298
AnnaBridge 189:f392fc9709a3 299 void FLEXIO_I2C_MasterStart(FLEXIO_I2C_Type *base, uint8_t address, flexio_i2c_direction_t direction);
AnnaBridge 189:f392fc9709a3 300
AnnaBridge 189:f392fc9709a3 301 /*!
AnnaBridge 189:f392fc9709a3 302 * @brief Sends the stop signal on the bus.
AnnaBridge 189:f392fc9709a3 303 *
AnnaBridge 189:f392fc9709a3 304 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 305 */
AnnaBridge 189:f392fc9709a3 306 void FLEXIO_I2C_MasterStop(FLEXIO_I2C_Type *base);
AnnaBridge 189:f392fc9709a3 307
AnnaBridge 189:f392fc9709a3 308 /*!
AnnaBridge 189:f392fc9709a3 309 * @brief Sends the repeated start signal on the bus.
AnnaBridge 189:f392fc9709a3 310 *
AnnaBridge 189:f392fc9709a3 311 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 312 */
AnnaBridge 189:f392fc9709a3 313 void FLEXIO_I2C_MasterRepeatedStart(FLEXIO_I2C_Type *base);
AnnaBridge 189:f392fc9709a3 314
AnnaBridge 189:f392fc9709a3 315 /*!
AnnaBridge 189:f392fc9709a3 316 * @brief Sends the stop signal when transfer is still on-going.
AnnaBridge 189:f392fc9709a3 317 *
AnnaBridge 189:f392fc9709a3 318 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 319 */
AnnaBridge 189:f392fc9709a3 320 void FLEXIO_I2C_MasterAbortStop(FLEXIO_I2C_Type *base);
AnnaBridge 189:f392fc9709a3 321
AnnaBridge 189:f392fc9709a3 322 /*!
AnnaBridge 189:f392fc9709a3 323 * @brief Configures the sent ACK/NAK for the following byte.
AnnaBridge 189:f392fc9709a3 324 *
AnnaBridge 189:f392fc9709a3 325 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 326 * @param enable True to configure send ACK, false configure to send NAK.
AnnaBridge 189:f392fc9709a3 327 */
AnnaBridge 189:f392fc9709a3 328 void FLEXIO_I2C_MasterEnableAck(FLEXIO_I2C_Type *base, bool enable);
AnnaBridge 189:f392fc9709a3 329
AnnaBridge 189:f392fc9709a3 330 /*!
AnnaBridge 189:f392fc9709a3 331 * @brief Sets the number of bytes to be transferred from a start signal to a stop signal.
AnnaBridge 189:f392fc9709a3 332 *
AnnaBridge 189:f392fc9709a3 333 * @note Call this API before a transfer begins because the timer generates a number of clocks according
AnnaBridge 189:f392fc9709a3 334 * to the number of bytes that need to be transferred.
AnnaBridge 189:f392fc9709a3 335 *
AnnaBridge 189:f392fc9709a3 336 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 337 * @param count Number of bytes need to be transferred from a start signal to a re-start/stop signal
AnnaBridge 189:f392fc9709a3 338 * @retval kStatus_Success Successfully configured the count.
AnnaBridge 189:f392fc9709a3 339 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 189:f392fc9709a3 340 */
AnnaBridge 189:f392fc9709a3 341 status_t FLEXIO_I2C_MasterSetTransferCount(FLEXIO_I2C_Type *base, uint8_t count);
AnnaBridge 189:f392fc9709a3 342
AnnaBridge 189:f392fc9709a3 343 /*!
AnnaBridge 189:f392fc9709a3 344 * @brief Writes one byte of data to the I2C bus.
AnnaBridge 189:f392fc9709a3 345 *
AnnaBridge 189:f392fc9709a3 346 * @note This is a non-blocking API, which returns directly after the data is put into the
AnnaBridge 189:f392fc9709a3 347 * data register but the data transfer is not finished on the bus. Ensure that
AnnaBridge 189:f392fc9709a3 348 * the TxEmptyFlag is asserted before calling this API.
AnnaBridge 189:f392fc9709a3 349 *
AnnaBridge 189:f392fc9709a3 350 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 351 * @param data a byte of data.
AnnaBridge 189:f392fc9709a3 352 */
AnnaBridge 189:f392fc9709a3 353 static inline void FLEXIO_I2C_MasterWriteByte(FLEXIO_I2C_Type *base, uint32_t data)
AnnaBridge 189:f392fc9709a3 354 {
AnnaBridge 189:f392fc9709a3 355 base->flexioBase->SHIFTBUFBBS[base->shifterIndex[0]] = data;
AnnaBridge 189:f392fc9709a3 356 }
AnnaBridge 189:f392fc9709a3 357
AnnaBridge 189:f392fc9709a3 358 /*!
AnnaBridge 189:f392fc9709a3 359 * @brief Reads one byte of data from the I2C bus.
AnnaBridge 189:f392fc9709a3 360 *
AnnaBridge 189:f392fc9709a3 361 * @note This is a non-blocking API, which returns directly after the data is read from the
AnnaBridge 189:f392fc9709a3 362 * data register. Ensure that the data is ready in the register.
AnnaBridge 189:f392fc9709a3 363 *
AnnaBridge 189:f392fc9709a3 364 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 365 * @return data byte read.
AnnaBridge 189:f392fc9709a3 366 */
AnnaBridge 189:f392fc9709a3 367 static inline uint8_t FLEXIO_I2C_MasterReadByte(FLEXIO_I2C_Type *base)
AnnaBridge 189:f392fc9709a3 368 {
AnnaBridge 189:f392fc9709a3 369 return base->flexioBase->SHIFTBUFBIS[base->shifterIndex[1]];
AnnaBridge 189:f392fc9709a3 370 }
AnnaBridge 189:f392fc9709a3 371
AnnaBridge 189:f392fc9709a3 372 /*!
AnnaBridge 189:f392fc9709a3 373 * @brief Sends a buffer of data in bytes.
AnnaBridge 189:f392fc9709a3 374 *
AnnaBridge 189:f392fc9709a3 375 * @note This function blocks via polling until all bytes have been sent.
AnnaBridge 189:f392fc9709a3 376 *
AnnaBridge 189:f392fc9709a3 377 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 378 * @param txBuff The data bytes to send.
AnnaBridge 189:f392fc9709a3 379 * @param txSize The number of data bytes to send.
AnnaBridge 189:f392fc9709a3 380 * @retval kStatus_Success Successfully write data.
AnnaBridge 189:f392fc9709a3 381 * @retval kStatus_FLEXIO_I2C_Nak Receive NAK during writing data.
AnnaBridge 189:f392fc9709a3 382 */
AnnaBridge 189:f392fc9709a3 383 status_t FLEXIO_I2C_MasterWriteBlocking(FLEXIO_I2C_Type *base, const uint8_t *txBuff, uint8_t txSize);
AnnaBridge 189:f392fc9709a3 384
AnnaBridge 189:f392fc9709a3 385 /*!
AnnaBridge 189:f392fc9709a3 386 * @brief Receives a buffer of bytes.
AnnaBridge 189:f392fc9709a3 387 *
AnnaBridge 189:f392fc9709a3 388 * @note This function blocks via polling until all bytes have been received.
AnnaBridge 189:f392fc9709a3 389 *
AnnaBridge 189:f392fc9709a3 390 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 391 * @param rxBuff The buffer to store the received bytes.
AnnaBridge 189:f392fc9709a3 392 * @param rxSize The number of data bytes to be received.
AnnaBridge 189:f392fc9709a3 393 */
AnnaBridge 189:f392fc9709a3 394 void FLEXIO_I2C_MasterReadBlocking(FLEXIO_I2C_Type *base, uint8_t *rxBuff, uint8_t rxSize);
AnnaBridge 189:f392fc9709a3 395
AnnaBridge 189:f392fc9709a3 396 /*!
AnnaBridge 189:f392fc9709a3 397 * @brief Performs a master polling transfer on the I2C bus.
AnnaBridge 189:f392fc9709a3 398 *
AnnaBridge 189:f392fc9709a3 399 * @note The API does not return until the transfer succeeds or fails due
AnnaBridge 189:f392fc9709a3 400 * to receiving NAK.
AnnaBridge 189:f392fc9709a3 401 *
AnnaBridge 189:f392fc9709a3 402 * @param base pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 403 * @param xfer pointer to flexio_i2c_master_transfer_t structure.
AnnaBridge 189:f392fc9709a3 404 * @return status of status_t.
AnnaBridge 189:f392fc9709a3 405 */
AnnaBridge 189:f392fc9709a3 406 status_t FLEXIO_I2C_MasterTransferBlocking(FLEXIO_I2C_Type *base, flexio_i2c_master_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 407 /*@}*/
AnnaBridge 189:f392fc9709a3 408
AnnaBridge 189:f392fc9709a3 409 /*Transactional APIs*/
AnnaBridge 189:f392fc9709a3 410
AnnaBridge 189:f392fc9709a3 411 /*!
AnnaBridge 189:f392fc9709a3 412 * @name Transactional
AnnaBridge 189:f392fc9709a3 413 * @{
AnnaBridge 189:f392fc9709a3 414 */
AnnaBridge 189:f392fc9709a3 415
AnnaBridge 189:f392fc9709a3 416 /*!
AnnaBridge 189:f392fc9709a3 417 * @brief Initializes the I2C handle which is used in transactional functions.
AnnaBridge 189:f392fc9709a3 418 *
AnnaBridge 189:f392fc9709a3 419 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 420 * @param handle Pointer to flexio_i2c_master_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 421 * @param callback Pointer to user callback function.
AnnaBridge 189:f392fc9709a3 422 * @param userData User param passed to the callback function.
AnnaBridge 189:f392fc9709a3 423 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 189:f392fc9709a3 424 * @retval kStatus_OutOfRange The FlexIO type/handle/isr table out of range.
AnnaBridge 189:f392fc9709a3 425 */
AnnaBridge 189:f392fc9709a3 426 status_t FLEXIO_I2C_MasterTransferCreateHandle(FLEXIO_I2C_Type *base,
AnnaBridge 189:f392fc9709a3 427 flexio_i2c_master_handle_t *handle,
AnnaBridge 189:f392fc9709a3 428 flexio_i2c_master_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 429 void *userData);
AnnaBridge 189:f392fc9709a3 430
AnnaBridge 189:f392fc9709a3 431 /*!
AnnaBridge 189:f392fc9709a3 432 * @brief Performs a master interrupt non-blocking transfer on the I2C bus.
AnnaBridge 189:f392fc9709a3 433 *
AnnaBridge 189:f392fc9709a3 434 * @note The API returns immediately after the transfer initiates.
AnnaBridge 189:f392fc9709a3 435 * Call FLEXIO_I2C_MasterGetTransferCount to poll the transfer status to check whether
AnnaBridge 189:f392fc9709a3 436 * the transfer is finished. If the return status is not kStatus_FLEXIO_I2C_Busy, the transfer
AnnaBridge 189:f392fc9709a3 437 * is finished.
AnnaBridge 189:f392fc9709a3 438 *
AnnaBridge 189:f392fc9709a3 439 * @param base Pointer to FLEXIO_I2C_Type structure
AnnaBridge 189:f392fc9709a3 440 * @param handle Pointer to flexio_i2c_master_handle_t structure which stores the transfer state
AnnaBridge 189:f392fc9709a3 441 * @param xfer pointer to flexio_i2c_master_transfer_t structure
AnnaBridge 189:f392fc9709a3 442 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 189:f392fc9709a3 443 * @retval kStatus_FLEXIO_I2C_Busy FlexIO I2C is not idle, is running another transfer.
AnnaBridge 189:f392fc9709a3 444 */
AnnaBridge 189:f392fc9709a3 445 status_t FLEXIO_I2C_MasterTransferNonBlocking(FLEXIO_I2C_Type *base,
AnnaBridge 189:f392fc9709a3 446 flexio_i2c_master_handle_t *handle,
AnnaBridge 189:f392fc9709a3 447 flexio_i2c_master_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 448
AnnaBridge 189:f392fc9709a3 449 /*!
AnnaBridge 189:f392fc9709a3 450 * @brief Gets the master transfer status during a interrupt non-blocking transfer.
AnnaBridge 189:f392fc9709a3 451 *
AnnaBridge 189:f392fc9709a3 452 * @param base Pointer to FLEXIO_I2C_Type structure.
AnnaBridge 189:f392fc9709a3 453 * @param handle Pointer to flexio_i2c_master_handle_t structure which stores the transfer state.
AnnaBridge 189:f392fc9709a3 454 * @param count Number of bytes transferred so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 455 * @retval kStatus_InvalidArgument count is Invalid.
AnnaBridge 189:f392fc9709a3 456 * @retval kStatus_Success Successfully return the count.
AnnaBridge 189:f392fc9709a3 457 */
AnnaBridge 189:f392fc9709a3 458 status_t FLEXIO_I2C_MasterTransferGetCount(FLEXIO_I2C_Type *base, flexio_i2c_master_handle_t *handle, size_t *count);
AnnaBridge 189:f392fc9709a3 459
AnnaBridge 189:f392fc9709a3 460 /*!
AnnaBridge 189:f392fc9709a3 461 * @brief Aborts an interrupt non-blocking transfer early.
AnnaBridge 189:f392fc9709a3 462 *
AnnaBridge 189:f392fc9709a3 463 * @note This API can be called at any time when an interrupt non-blocking transfer initiates
AnnaBridge 189:f392fc9709a3 464 * to abort the transfer early.
AnnaBridge 189:f392fc9709a3 465 *
AnnaBridge 189:f392fc9709a3 466 * @param base Pointer to FLEXIO_I2C_Type structure
AnnaBridge 189:f392fc9709a3 467 * @param handle Pointer to flexio_i2c_master_handle_t structure which stores the transfer state
AnnaBridge 189:f392fc9709a3 468 */
AnnaBridge 189:f392fc9709a3 469 void FLEXIO_I2C_MasterTransferAbort(FLEXIO_I2C_Type *base, flexio_i2c_master_handle_t *handle);
AnnaBridge 189:f392fc9709a3 470
AnnaBridge 189:f392fc9709a3 471 /*!
AnnaBridge 189:f392fc9709a3 472 * @brief Master interrupt handler.
AnnaBridge 189:f392fc9709a3 473 *
AnnaBridge 189:f392fc9709a3 474 * @param i2cType Pointer to FLEXIO_I2C_Type structure
AnnaBridge 189:f392fc9709a3 475 * @param i2cHandle Pointer to flexio_i2c_master_transfer_t structure
AnnaBridge 189:f392fc9709a3 476 */
AnnaBridge 189:f392fc9709a3 477 void FLEXIO_I2C_MasterTransferHandleIRQ(void *i2cType, void *i2cHandle);
AnnaBridge 189:f392fc9709a3 478
AnnaBridge 189:f392fc9709a3 479 /*@}*/
AnnaBridge 189:f392fc9709a3 480
AnnaBridge 189:f392fc9709a3 481 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 482 }
AnnaBridge 189:f392fc9709a3 483 #endif /*_cplusplus*/
AnnaBridge 189:f392fc9709a3 484 /*@}*/
AnnaBridge 189:f392fc9709a3 485
AnnaBridge 189:f392fc9709a3 486 #endif /*_FSL_FLEXIO_I2C_MASTER_H_*/