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