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_KL43Z/TOOLCHAIN_GCC_ARM/fsl_flexio_i2c_master.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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