ON Semiconductor / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

targets/TARGET_Maxim/TARGET_MAX32625/mxc/i2cs.h@1:f30bdcd2b33b, 2017-02-27 (annotated)

Committer:
jacobjohnson
Date:
Mon Feb 27 17:45:05 2017 +0000
Revision:
1:f30bdcd2b33b
Parent:
0:098463de4c5d 
changed the inputscale from 1 to 7 in analogin_api.c.  This will need to be changed later, and accessed from the main level, but for now this allows the  adc to read a value from 0 to 3.7V, instead of just up to 1V.;

Who changed what in which revision?

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