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_MAX32630FTHR/TOOLCHAIN_GCC_ARM/i2cs.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 * @file
AnnaBridge 171:3a7713b1edbc 3 * @brief I2CS (Inter-Integrated Circuit Slave) function prototypes and data types.
AnnaBridge 171:3a7713b1edbc 4 */
AnnaBridge 171:3a7713b1edbc 5
AnnaBridge 171:3a7713b1edbc 6 /* ****************************************************************************
AnnaBridge 171:3a7713b1edbc 7 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 171:3a7713b1edbc 8 *
AnnaBridge 171:3a7713b1edbc 9 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 171:3a7713b1edbc 10 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 171:3a7713b1edbc 11 * to deal in the Software without restriction, including without limitation
AnnaBridge 171:3a7713b1edbc 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 171:3a7713b1edbc 13 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 171:3a7713b1edbc 14 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 171:3a7713b1edbc 15 *
AnnaBridge 171:3a7713b1edbc 16 * The above copyright notice and this permission notice shall be included
AnnaBridge 171:3a7713b1edbc 17 * in all copies or substantial portions of the Software.
AnnaBridge 171:3a7713b1edbc 18 *
AnnaBridge 171:3a7713b1edbc 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 171:3a7713b1edbc 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 171:3a7713b1edbc 21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 171:3a7713b1edbc 22 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 171:3a7713b1edbc 23 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 171:3a7713b1edbc 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 171:3a7713b1edbc 25 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 171:3a7713b1edbc 26 *
AnnaBridge 171:3a7713b1edbc 27 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 171:3a7713b1edbc 28 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 171:3a7713b1edbc 29 * Products, Inc. Branding Policy.
AnnaBridge 171:3a7713b1edbc 30 *
AnnaBridge 171:3a7713b1edbc 31 * The mere transfer of this software does not imply any licenses
AnnaBridge 171:3a7713b1edbc 32 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 171:3a7713b1edbc 33 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 171:3a7713b1edbc 34 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 171:3a7713b1edbc 35 * ownership rights.
AnnaBridge 171:3a7713b1edbc 36 *
AnnaBridge 171:3a7713b1edbc 37 * $Date: 2016-10-10 18:59:48 -0500 (Mon, 10 Oct 2016) $
AnnaBridge 171:3a7713b1edbc 38 * $Revision: 24661 $
AnnaBridge 171:3a7713b1edbc 39 *
AnnaBridge 171:3a7713b1edbc 40 *************************************************************************** */
AnnaBridge 171:3a7713b1edbc 41
AnnaBridge 171:3a7713b1edbc 42 /* Define to prevent redundant inclusion */
AnnaBridge 171:3a7713b1edbc 43 #ifndef _I2CS_H_
AnnaBridge 171:3a7713b1edbc 44 #define _I2CS_H_
AnnaBridge 171:3a7713b1edbc 45
AnnaBridge 171:3a7713b1edbc 46 /* **** Includes **** */
AnnaBridge 171:3a7713b1edbc 47 #include "mxc_config.h"
AnnaBridge 171:3a7713b1edbc 48 #include "mxc_sys.h"
AnnaBridge 171:3a7713b1edbc 49 #include "mxc_assert.h"
AnnaBridge 171:3a7713b1edbc 50 #include "i2cs_regs.h"
AnnaBridge 171:3a7713b1edbc 51
AnnaBridge 171:3a7713b1edbc 52 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 53 extern "C" {
AnnaBridge 171:3a7713b1edbc 54 #endif
AnnaBridge 171:3a7713b1edbc 55
AnnaBridge 171:3a7713b1edbc 56 /**
AnnaBridge 171:3a7713b1edbc 57 * @ingroup i2c_master_slave
AnnaBridge 171:3a7713b1edbc 58 * @defgroup i2cs I2C Slave
AnnaBridge 171:3a7713b1edbc 59 * @brief I2C Slave (I2CS) API
AnnaBridge 171:3a7713b1edbc 60 * @{
AnnaBridge 171:3a7713b1edbc 61 */
AnnaBridge 171:3a7713b1edbc 62
AnnaBridge 171:3a7713b1edbc 63 /* **** Definitions **** */
AnnaBridge 171:3a7713b1edbc 64 /**
AnnaBridge 171:3a7713b1edbc 65 * Internal buffer size for storing I2C Slave Messages
AnnaBridge 171:3a7713b1edbc 66 */
AnnaBridge 171:3a7713b1edbc 67 #define I2CS_BUFFER_SIZE 32
AnnaBridge 171:3a7713b1edbc 68
AnnaBridge 171:3a7713b1edbc 69 /**
AnnaBridge 171:3a7713b1edbc 70 * Enumeration type to select supported I2CS frequencies.
AnnaBridge 171:3a7713b1edbc 71 */
AnnaBridge 171:3a7713b1edbc 72 typedef enum {
AnnaBridge 171:3a7713b1edbc 73 I2CS_SPEED_100KHZ = 0, /**< Use to select a bus communication speed of 100 kHz. */
AnnaBridge 171:3a7713b1edbc 74 I2CS_SPEED_400KHZ = 1 /**< Use to select a bus communication speed of 400 kHz. */
AnnaBridge 171:3a7713b1edbc 75 } i2cs_speed_t;
AnnaBridge 171:3a7713b1edbc 76
AnnaBridge 171:3a7713b1edbc 77 /**
AnnaBridge 171:3a7713b1edbc 78 * Enumeration type to select the I2CS addressing mode.
AnnaBridge 171:3a7713b1edbc 79 */
AnnaBridge 171:3a7713b1edbc 80 typedef enum {
AnnaBridge 171:3a7713b1edbc 81 I2CS_ADDR_8 = 0, /**< Sets the slave address mode to 8-bits (7-bits address plus read/write bit). */
AnnaBridge 171:3a7713b1edbc 82 I2CS_ADDR_10 = MXC_F_I2CS_DEV_ID_TEN_BIT_ID_MODE /**< Sets the slave address mode to 10-bits. */
AnnaBridge 171:3a7713b1edbc 83 } i2cs_addr_t;
AnnaBridge 171:3a7713b1edbc 84
AnnaBridge 171:3a7713b1edbc 85 /**
AnnaBridge 171:3a7713b1edbc 86 * Type alias for an I2CS callback function that will be called when a given byte is updated by the Master, see I2CS_RegisterCallback(mxc_i2cs_regs_t *i2cs, uint8_t addr, i2cs_callback_fn callback).
AnnaBridge 171:3a7713b1edbc 87 * @details The function prototype for implementing callback_fn is:
AnnaBridge 171:3a7713b1edbc 88 * @code
AnnaBridge 171:3a7713b1edbc 89 * void func(uint8_t addr);
AnnaBridge 171:3a7713b1edbc 90 * @endcode
AnnaBridge 171:3a7713b1edbc 91 */
AnnaBridge 171:3a7713b1edbc 92 typedef void (*i2cs_callback_fn)(uint8_t error_code);
AnnaBridge 171:3a7713b1edbc 93 /* **** Globals **** */
AnnaBridge 171:3a7713b1edbc 94
AnnaBridge 171:3a7713b1edbc 95 /* **** Function Prototypes **** */
AnnaBridge 171:3a7713b1edbc 96
AnnaBridge 171:3a7713b1edbc 97 /**
AnnaBridge 171:3a7713b1edbc 98 * @brief Initialize I2CS module.
AnnaBridge 171:3a7713b1edbc 99 * @param i2cs Pointer to I2CS regs.
AnnaBridge 171:3a7713b1edbc 100 * @param sys_cfg Pointer to I2CS system configuration, see
AnnaBridge 171:3a7713b1edbc 101 * #sys_cfg_i2cs_t.
AnnaBridge 171:3a7713b1edbc 102 * @param speed I2CS frequency.
AnnaBridge 171:3a7713b1edbc 103 * @param address I2CS address.
AnnaBridge 171:3a7713b1edbc 104 * @param addr_len I2CS address length.
AnnaBridge 171:3a7713b1edbc 105 * @return #E_NO_ERROR if everything is successful or an
AnnaBridge 171:3a7713b1edbc 106 * @ref MXC_Error_Codes "error code" if unsuccessful.
AnnaBridge 171:3a7713b1edbc 107 *
AnnaBridge 171:3a7713b1edbc 108 */
AnnaBridge 171:3a7713b1edbc 109 int I2CS_Init(mxc_i2cs_regs_t *i2cs, const sys_cfg_i2cs_t *sys_cfg, i2cs_speed_t speed, uint16_t address, i2cs_addr_t addr_len);
AnnaBridge 171:3a7713b1edbc 110
AnnaBridge 171:3a7713b1edbc 111 /**
AnnaBridge 171:3a7713b1edbc 112 * @brief Shutdown I2CS module.
AnnaBridge 171:3a7713b1edbc 113 * @param i2cs Pointer to I2CS regs.
AnnaBridge 171:3a7713b1edbc 114 * @return #E_NO_ERROR if everything is successful or an
AnnaBridge 171:3a7713b1edbc 115 * @ref MXC_Error_Codes "error code" if unsuccessful.
AnnaBridge 171:3a7713b1edbc 116 */
AnnaBridge 171:3a7713b1edbc 117 int I2CS_Shutdown(mxc_i2cs_regs_t *i2cs);
AnnaBridge 171:3a7713b1edbc 118
AnnaBridge 171:3a7713b1edbc 119 /**
AnnaBridge 171:3a7713b1edbc 120 * @brief I2CS interrupt handler.
AnnaBridge 171:3a7713b1edbc 121 * @details This function should be called by the application from the
AnnaBridge 171:3a7713b1edbc 122 * interrupt handler if I2CS interrupts are enabled. Alternately,
AnnaBridge 171:3a7713b1edbc 123 * this function can be periodically called by the application if
AnnaBridge 171:3a7713b1edbc 124 * I2CS interrupts are disabled.
AnnaBridge 171:3a7713b1edbc 125 *
AnnaBridge 171:3a7713b1edbc 126 * @param i2cs Pointer to I2CS regs.
AnnaBridge 171:3a7713b1edbc 127 */
AnnaBridge 171:3a7713b1edbc 128 void I2CS_Handler(mxc_i2cs_regs_t *i2cs);
AnnaBridge 171:3a7713b1edbc 129
AnnaBridge 171:3a7713b1edbc 130 /**
AnnaBridge 171:3a7713b1edbc 131 * @brief Register a callback that is triggered by an update of a specified
AnnaBridge 171:3a7713b1edbc 132 * byte.
AnnaBridge 171:3a7713b1edbc 133 * @details Registering a callback causes the slave to interrupt when the
AnnaBridge 171:3a7713b1edbc 134 * master has updated a specified byte.
AnnaBridge 171:3a7713b1edbc 135 *
AnnaBridge 171:3a7713b1edbc 136 * @param i2cs Pointer to the I2CS register structure, see
AnnaBridge 171:3a7713b1edbc 137 * #mxc_i2cs_regs_t.
AnnaBridge 171:3a7713b1edbc 138 * @param addr Index to trigger a call to the #i2cs_callback_fn.
AnnaBridge 171:3a7713b1edbc 139 * @param callback callback function of type #i2cs_callback_fn to be called
AnnaBridge 171:3a7713b1edbc 140 * when the addr being written by the master matches \c addr.
AnnaBridge 171:3a7713b1edbc 141 */
AnnaBridge 171:3a7713b1edbc 142 void I2CS_RegisterCallback(mxc_i2cs_regs_t *i2cs, uint8_t addr, i2cs_callback_fn callback);
AnnaBridge 171:3a7713b1edbc 143
AnnaBridge 171:3a7713b1edbc 144 /**
AnnaBridge 171:3a7713b1edbc 145 * @brief Write I2CS data to a given byte.
AnnaBridge 171:3a7713b1edbc 146 * @details The slave has a buffer of registers that the external master can
AnnaBridge 171:3a7713b1edbc 147 * read. Use this function to write data into a specified
AnnaBridge 171:3a7713b1edbc 148 * address/index.
AnnaBridge 171:3a7713b1edbc 149 *
AnnaBridge 171:3a7713b1edbc 150 * @param i2cs Pointer to I2CS regs.
AnnaBridge 171:3a7713b1edbc 151 * @param addr Address/Index to write.
AnnaBridge 171:3a7713b1edbc 152 * @param data Data to be written.
AnnaBridge 171:3a7713b1edbc 153 */
AnnaBridge 171:3a7713b1edbc 154 __STATIC_INLINE void I2CS_Write(mxc_i2cs_regs_t *i2cs, uint8_t addr, uint8_t data)
AnnaBridge 171:3a7713b1edbc 155 {
AnnaBridge 171:3a7713b1edbc 156 // Make sure we don't overflow
AnnaBridge 171:3a7713b1edbc 157 MXC_ASSERT(addr < MXC_CFG_I2CS_BUFFER_SIZE);
AnnaBridge 171:3a7713b1edbc 158 i2cs->data_byte[addr] = ((i2cs->data_byte[addr] & ~MXC_F_I2CS_DATA_BYTE_DATA_FIELD) |
AnnaBridge 171:3a7713b1edbc 159 (data << MXC_F_I2CS_DATA_BYTE_DATA_FIELD_POS));
AnnaBridge 171:3a7713b1edbc 160 }
AnnaBridge 171:3a7713b1edbc 161
AnnaBridge 171:3a7713b1edbc 162 /**
AnnaBridge 171:3a7713b1edbc 163 * @brief Read I2CS data from a given address .
AnnaBridge 171:3a7713b1edbc 164 * @details The slave has a buffer of registers that the external master can
AnnaBridge 171:3a7713b1edbc 165 * read. Use this function to read the data from the registers.
AnnaBridge 171:3a7713b1edbc 166 *
AnnaBridge 171:3a7713b1edbc 167 * @param i2cs Pointer to I2CS regs.
AnnaBridge 171:3a7713b1edbc 168 * @param addr Address/Index to read from.
AnnaBridge 171:3a7713b1edbc 169 *
AnnaBridge 171:3a7713b1edbc 170 * @return Data contained in requested @c addr register.
AnnaBridge 171:3a7713b1edbc 171 */
AnnaBridge 171:3a7713b1edbc 172 __STATIC_INLINE uint8_t I2CS_Read(mxc_i2cs_regs_t *i2cs, uint8_t addr)
AnnaBridge 171:3a7713b1edbc 173 {
AnnaBridge 171:3a7713b1edbc 174 // Make sure we don't overflow
AnnaBridge 171:3a7713b1edbc 175 MXC_ASSERT(addr < MXC_CFG_I2CS_BUFFER_SIZE);
AnnaBridge 171:3a7713b1edbc 176 return ((i2cs->data_byte[addr] & MXC_F_I2CS_DATA_BYTE_DATA_FIELD) >>
AnnaBridge 171:3a7713b1edbc 177 MXC_F_I2CS_DATA_BYTE_DATA_FIELD_POS);
AnnaBridge 171:3a7713b1edbc 178 }
AnnaBridge 171:3a7713b1edbc 179
AnnaBridge 171:3a7713b1edbc 180 /**
AnnaBridge 171:3a7713b1edbc 181 * @brief Set the given index to read only (RO).
AnnaBridge 171:3a7713b1edbc 182 * @details This index will be flagged as read only. The slave will NACK the
AnnaBridge 171:3a7713b1edbc 183 * master if it attempts to write this location. Multiple calls with
AnnaBridge 171:3a7713b1edbc 184 * different index/address values will yield multiple read-only
AnnaBridge 171:3a7713b1edbc 185 * locations within the slave register set.
AnnaBridge 171:3a7713b1edbc 186 *
AnnaBridge 171:3a7713b1edbc 187 * @param i2cs Pointer to I2CS regs.
AnnaBridge 171:3a7713b1edbc 188 * @param addr Address/Index of the byte to set to RO.
AnnaBridge 171:3a7713b1edbc 189 */
AnnaBridge 171:3a7713b1edbc 190 __STATIC_INLINE void I2CS_SetRO(mxc_i2cs_regs_t *i2cs, uint8_t addr)
AnnaBridge 171:3a7713b1edbc 191 {
AnnaBridge 171:3a7713b1edbc 192 // Make sure we don't overflow
AnnaBridge 171:3a7713b1edbc 193 MXC_ASSERT(addr < MXC_CFG_I2CS_BUFFER_SIZE);
AnnaBridge 171:3a7713b1edbc 194 i2cs->data_byte[addr] |= MXC_F_I2CS_DATA_BYTE_READ_ONLY_FL;
AnnaBridge 171:3a7713b1edbc 195 }
AnnaBridge 171:3a7713b1edbc 196
AnnaBridge 171:3a7713b1edbc 197 /**
AnnaBridge 171:3a7713b1edbc 198 * @brief Sets the given address to R/W.
AnnaBridge 171:3a7713b1edbc 199 * @param i2cs Pointer to I2CS regs.
AnnaBridge 171:3a7713b1edbc 200 * @param addr Index to start clearing RO flag.
AnnaBridge 171:3a7713b1edbc 201 */
AnnaBridge 171:3a7713b1edbc 202 __STATIC_INLINE void I2CS_ClearRO(mxc_i2cs_regs_t *i2cs, uint8_t addr)
AnnaBridge 171:3a7713b1edbc 203 {
AnnaBridge 171:3a7713b1edbc 204 // Make sure we don't overflow
AnnaBridge 171:3a7713b1edbc 205 MXC_ASSERT(addr < MXC_CFG_I2CS_BUFFER_SIZE);
AnnaBridge 171:3a7713b1edbc 206 i2cs->data_byte[addr] &= ~MXC_F_I2CS_DATA_BYTE_READ_ONLY_FL;
AnnaBridge 171:3a7713b1edbc 207 }
AnnaBridge 171:3a7713b1edbc 208
AnnaBridge 171:3a7713b1edbc 209 /**@} end of group i2cs */
AnnaBridge 171:3a7713b1edbc 210
AnnaBridge 171:3a7713b1edbc 211 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 212 }
AnnaBridge 171:3a7713b1edbc 213 #endif
AnnaBridge 171:3a7713b1edbc 214
AnnaBridge 171:3a7713b1edbc 215 #endif /* _I2CS_H_ */