cc y / mbed

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.

Fork of mbed by mbed official

drivers/I2C.h@132:9baf128c2fab, 2016-12-20 (annotated)

Committer:
<>
Date:
Tue Dec 20 15:36:52 2016 +0000
Revision:
132:9baf128c2fab
Parent:
128:9bcdf88f62b0 
Release 132 of the mbed library



Ports for Upcoming Targets



3241: Add support for FRDM-KW41 https://github.com/ARMmbed/mbed-os/pull/3241

3291: Adding mbed enabled Maker board with NINA-B1 and EVA-M8Q https://github.com/ARMmbed/mbed-os/pull/3291



Fixes and Changes



3062: TARGET_STM :USB device FS  https://github.com/ARMmbed/mbed-os/pull/3062

3213: STM32: Refactor us_ticker.c + hal_tick.c files https://github.com/ARMmbed/mbed-os/pull/3213

3288: Dev spi asynch l0l1 https://github.com/ARMmbed/mbed-os/pull/3288

3289: Bug fix of initial value of interrupt edge in "gpio_irq_init" function. https://github.com/ARMmbed/mbed-os/pull/3289

3302: STM32F4 AnalogIn - Clear VBATE and TSVREFE bits before configuring ADC channels https://github.com/ARMmbed/mbed-os/pull/3302

3320: STM32 - Add ADC_VREF label https://github.com/ARMmbed/mbed-os/pull/3320

3321: no HSE available by default for NUCLEO_L432KC https://github.com/ARMmbed/mbed-os/pull/3321

3352: ublox eva nina - fix line endings https://github.com/ARMmbed/mbed-os/pull/3352

3322: DISCO_L053C8 doesn't support LSE https://github.com/ARMmbed/mbed-os/pull/3322

3345: STM32 - Remove TIM_IT_UPDATE flag in HAL_Suspend/ResumeTick functions https://github.com/ARMmbed/mbed-os/pull/3345

3309: [NUC472/M453] Fix CI failed tests https://github.com/ARMmbed/mbed-os/pull/3309

3157: [Silicon Labs] Adding support for EFR32MG1 wireless SoC https://github.com/ARMmbed/mbed-os/pull/3157

3301: I2C - correct return values for write functions (docs) - part 1 https://github.com/ARMmbed/mbed-os/pull/3301

3303: Fix #2956 #2939 #2957 #2959 #2960: Add HAL_DeInit function in gpio_irq destructor https://github.com/ARMmbed/mbed-os/pull/3303

3304: STM32L476: no HSE is present in NUCLEO and DISCO boards https://github.com/ARMmbed/mbed-os/pull/3304

3318: Register map changes for RevG https://github.com/ARMmbed/mbed-os/pull/3318

3317: NUCLEO_F429ZI has integrated LSE https://github.com/ARMmbed/mbed-os/pull/3317

3312: K64F: SPI Asynch API implementation https://github.com/ARMmbed/mbed-os/pull/3312

3324: Dev i2c common code https://github.com/ARMmbed/mbed-os/pull/3324

3369: Add CAN2 missing pins for connector CN12 https://github.com/ARMmbed/mbed-os/pull/3369

3377: STM32 NUCLEO-L152RE Update system core clock to 32MHz https://github.com/ARMmbed/mbed-os/pull/3377

3378: K66F: Enable LWIP feature https://github.com/ARMmbed/mbed-os/pull/3378

3382: [MAX32620] Fixing serial readable function. https://github.com/ARMmbed/mbed-os/pull/3382

3399: NUCLEO_F103RB - Add SERIAL_FC feature https://github.com/ARMmbed/mbed-os/pull/3399

3409: STM32L1 : map ST HAL assert into MBED assert https://github.com/ARMmbed/mbed-os/pull/3409

3416: Renames i2c_api.c for STM32F1 targets to fix IAR exporter https://github.com/ARMmbed/mbed-os/pull/3416

3348: Fix frequency function of CAN driver. https://github.com/ARMmbed/mbed-os/pull/3348

3366: NUCLEO_F412ZG - Add new platform https://github.com/ARMmbed/mbed-os/pull/3366

3379: STM32F0 : map ST HAL assert into MBED assert https://github.com/ARMmbed/mbed-os/pull/3379

3393: ISR register never re-evaluated in HAL_DMA_PollForTransfer for STM32F4 https://github.com/ARMmbed/mbed-os/pull/3393

3408: STM32F7 : map ST HAL assert into MBED assert https://github.com/ARMmbed/mbed-os/pull/3408

3411: STM32L0 : map ST HAL assert into MBED assert https://github.com/ARMmbed/mbed-os/pull/3411

3424: STM32F4 - FIX to add the update of hdma->State variable https://github.com/ARMmbed/mbed-os/pull/3424

3427: Fix stm i2c slave https://github.com/ARMmbed/mbed-os/pull/3427

3429: Fix stm i2c fix init https://github.com/ARMmbed/mbed-os/pull/3429

3434: [NUC472/M453] Fix stuck in lp_ticker_init and other updates https://github.com/ARMmbed/mbed-os/pull/3434

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 2 * Copyright (c) 2006-2015 ARM Limited
<> 128:9bcdf88f62b0 3 *
<> 128:9bcdf88f62b0 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 5 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 6 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 7 *
<> 128:9bcdf88f62b0 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 9 *
<> 128:9bcdf88f62b0 10 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 13 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 14 * limitations under the License.
<> 128:9bcdf88f62b0 15 */
<> 128:9bcdf88f62b0 16 #ifndef MBED_I2C_H
<> 128:9bcdf88f62b0 17 #define MBED_I2C_H
<> 128:9bcdf88f62b0 18
<> 128:9bcdf88f62b0 19 #include "platform/platform.h"
<> 128:9bcdf88f62b0 20
<> 128:9bcdf88f62b0 21 #if DEVICE_I2C
<> 128:9bcdf88f62b0 22
<> 128:9bcdf88f62b0 23 #include "hal/i2c_api.h"
<> 128:9bcdf88f62b0 24 #include "platform/SingletonPtr.h"
<> 128:9bcdf88f62b0 25 #include "platform/PlatformMutex.h"
<> 128:9bcdf88f62b0 26
<> 128:9bcdf88f62b0 27 #if DEVICE_I2C_ASYNCH
<> 128:9bcdf88f62b0 28 #include "platform/CThunk.h"
<> 128:9bcdf88f62b0 29 #include "hal/dma_api.h"
<> 128:9bcdf88f62b0 30 #include "platform/FunctionPointer.h"
<> 128:9bcdf88f62b0 31 #endif
<> 128:9bcdf88f62b0 32
<> 128:9bcdf88f62b0 33 namespace mbed {
<> 128:9bcdf88f62b0 34 /** \addtogroup drivers */
<> 128:9bcdf88f62b0 35 /** @{*/
<> 128:9bcdf88f62b0 36
<> 128:9bcdf88f62b0 37 /** An I2C Master, used for communicating with I2C slave devices
<> 128:9bcdf88f62b0 38 *
<> 128:9bcdf88f62b0 39 * @Note Synchronization level: Thread safe
<> 128:9bcdf88f62b0 40 *
<> 128:9bcdf88f62b0 41 * Example:
<> 128:9bcdf88f62b0 42 * @code
<> 128:9bcdf88f62b0 43 * // Read from I2C slave at address 0x62
<> 128:9bcdf88f62b0 44 *
<> 128:9bcdf88f62b0 45 * #include "mbed.h"
<> 128:9bcdf88f62b0 46 *
<> 128:9bcdf88f62b0 47 * I2C i2c(p28, p27);
<> 128:9bcdf88f62b0 48 *
<> 128:9bcdf88f62b0 49 * int main() {
<> 128:9bcdf88f62b0 50 * int address = 0x62;
<> 128:9bcdf88f62b0 51 * char data[2];
<> 128:9bcdf88f62b0 52 * i2c.read(address, data, 2);
<> 128:9bcdf88f62b0 53 * }
<> 128:9bcdf88f62b0 54 * @endcode
<> 128:9bcdf88f62b0 55 */
<> 128:9bcdf88f62b0 56 class I2C {
<> 128:9bcdf88f62b0 57
<> 128:9bcdf88f62b0 58 public:
<> 128:9bcdf88f62b0 59 enum RxStatus {
<> 128:9bcdf88f62b0 60 NoData,
<> 128:9bcdf88f62b0 61 MasterGeneralCall,
<> 128:9bcdf88f62b0 62 MasterWrite,
<> 128:9bcdf88f62b0 63 MasterRead
<> 128:9bcdf88f62b0 64 };
<> 128:9bcdf88f62b0 65
<> 128:9bcdf88f62b0 66 enum Acknowledge {
<> 128:9bcdf88f62b0 67 NoACK = 0,
<> 128:9bcdf88f62b0 68 ACK = 1
<> 128:9bcdf88f62b0 69 };
<> 128:9bcdf88f62b0 70
<> 128:9bcdf88f62b0 71 /** Create an I2C Master interface, connected to the specified pins
<> 128:9bcdf88f62b0 72 *
<> 128:9bcdf88f62b0 73 * @param sda I2C data line pin
<> 128:9bcdf88f62b0 74 * @param scl I2C clock line pin
<> 128:9bcdf88f62b0 75 */
<> 128:9bcdf88f62b0 76 I2C(PinName sda, PinName scl);
<> 128:9bcdf88f62b0 77
<> 128:9bcdf88f62b0 78 /** Set the frequency of the I2C interface
<> 128:9bcdf88f62b0 79 *
<> 128:9bcdf88f62b0 80 * @param hz The bus frequency in hertz
<> 128:9bcdf88f62b0 81 */
<> 128:9bcdf88f62b0 82 void frequency(int hz);
<> 128:9bcdf88f62b0 83
<> 128:9bcdf88f62b0 84 /** Read from an I2C slave
<> 128:9bcdf88f62b0 85 *
<> 128:9bcdf88f62b0 86 * Performs a complete read transaction. The bottom bit of
<> 128:9bcdf88f62b0 87 * the address is forced to 1 to indicate a read.
<> 128:9bcdf88f62b0 88 *
<> 128:9bcdf88f62b0 89 * @param address 8-bit I2C slave address [ addr | 1 ]
<> 128:9bcdf88f62b0 90 * @param data Pointer to the byte-array to read data in to
<> 128:9bcdf88f62b0 91 * @param length Number of bytes to read
<> 128:9bcdf88f62b0 92 * @param repeated Repeated start, true - don't send stop at end
<> 128:9bcdf88f62b0 93 *
<> 128:9bcdf88f62b0 94 * @returns
<> 128:9bcdf88f62b0 95 * 0 on success (ack),
<> 128:9bcdf88f62b0 96 * non-0 on failure (nack)
<> 128:9bcdf88f62b0 97 */
<> 128:9bcdf88f62b0 98 int read(int address, char *data, int length, bool repeated = false);
<> 128:9bcdf88f62b0 99
<> 128:9bcdf88f62b0 100 /** Read a single byte from the I2C bus
<> 128:9bcdf88f62b0 101 *
<> 128:9bcdf88f62b0 102 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
<> 128:9bcdf88f62b0 103 *
<> 128:9bcdf88f62b0 104 * @returns
<> 128:9bcdf88f62b0 105 * the byte read
<> 128:9bcdf88f62b0 106 */
<> 128:9bcdf88f62b0 107 int read(int ack);
<> 128:9bcdf88f62b0 108
<> 128:9bcdf88f62b0 109 /** Write to an I2C slave
<> 128:9bcdf88f62b0 110 *
<> 128:9bcdf88f62b0 111 * Performs a complete write transaction. The bottom bit of
<> 128:9bcdf88f62b0 112 * the address is forced to 0 to indicate a write.
<> 128:9bcdf88f62b0 113 *
<> 128:9bcdf88f62b0 114 * @param address 8-bit I2C slave address [ addr | 0 ]
<> 128:9bcdf88f62b0 115 * @param data Pointer to the byte-array data to send
<> 128:9bcdf88f62b0 116 * @param length Number of bytes to send
<> 128:9bcdf88f62b0 117 * @param repeated Repeated start, true - do not send stop at end
<> 128:9bcdf88f62b0 118 *
<> 128:9bcdf88f62b0 119 * @returns
<> 132:9baf128c2fab 120 * 0 or non-zero - written number of bytes,
<> 132:9baf128c2fab 121 * negative - I2C_ERROR_XXX status
<> 128:9bcdf88f62b0 122 */
<> 128:9bcdf88f62b0 123 int write(int address, const char *data, int length, bool repeated = false);
<> 128:9bcdf88f62b0 124
<> 128:9bcdf88f62b0 125 /** Write single byte out on the I2C bus
<> 128:9bcdf88f62b0 126 *
<> 128:9bcdf88f62b0 127 * @param data data to write out on bus
<> 128:9bcdf88f62b0 128 *
<> 128:9bcdf88f62b0 129 * @returns
<> 132:9baf128c2fab 130 * '0' - NAK was received
<> 132:9baf128c2fab 131 * '1' - ACK was received,
<> 132:9baf128c2fab 132 * '2' - timeout
<> 128:9bcdf88f62b0 133 */
<> 128:9bcdf88f62b0 134 int write(int data);
<> 128:9bcdf88f62b0 135
<> 128:9bcdf88f62b0 136 /** Creates a start condition on the I2C bus
<> 128:9bcdf88f62b0 137 */
<> 128:9bcdf88f62b0 138
<> 128:9bcdf88f62b0 139 void start(void);
<> 128:9bcdf88f62b0 140
<> 128:9bcdf88f62b0 141 /** Creates a stop condition on the I2C bus
<> 128:9bcdf88f62b0 142 */
<> 128:9bcdf88f62b0 143 void stop(void);
<> 128:9bcdf88f62b0 144
<> 128:9bcdf88f62b0 145 /** Acquire exclusive access to this I2C bus
<> 128:9bcdf88f62b0 146 */
<> 128:9bcdf88f62b0 147 virtual void lock(void);
<> 128:9bcdf88f62b0 148
<> 128:9bcdf88f62b0 149 /** Release exclusive access to this I2C bus
<> 128:9bcdf88f62b0 150 */
<> 128:9bcdf88f62b0 151 virtual void unlock(void);
<> 128:9bcdf88f62b0 152
<> 128:9bcdf88f62b0 153 virtual ~I2C() {
<> 128:9bcdf88f62b0 154 // Do nothing
<> 128:9bcdf88f62b0 155 }
<> 128:9bcdf88f62b0 156
<> 128:9bcdf88f62b0 157 #if DEVICE_I2C_ASYNCH
<> 128:9bcdf88f62b0 158
<> 128:9bcdf88f62b0 159 /** Start non-blocking I2C transfer.
<> 128:9bcdf88f62b0 160 *
<> 128:9bcdf88f62b0 161 * @param address 8/10 bit I2c slave address
<> 128:9bcdf88f62b0 162 * @param tx_buffer The TX buffer with data to be transfered
<> 128:9bcdf88f62b0 163 * @param tx_length The length of TX buffer in bytes
<> 128:9bcdf88f62b0 164 * @param rx_buffer The RX buffer which is used for received data
<> 128:9bcdf88f62b0 165 * @param rx_length The length of RX buffer in bytes
<> 128:9bcdf88f62b0 166 * @param event The logical OR of events to modify
<> 128:9bcdf88f62b0 167 * @param callback The event callback function
<> 128:9bcdf88f62b0 168 * @param repeated Repeated start, true - do not send stop at end
<> 128:9bcdf88f62b0 169 * @return Zero if the transfer has started, or -1 if I2C peripheral is busy
<> 128:9bcdf88f62b0 170 */
<> 128:9bcdf88f62b0 171 int transfer(int address, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, const event_callback_t& callback, int event = I2C_EVENT_TRANSFER_COMPLETE, bool repeated = false);
<> 128:9bcdf88f62b0 172
<> 128:9bcdf88f62b0 173 /** Abort the on-going I2C transfer
<> 128:9bcdf88f62b0 174 */
<> 128:9bcdf88f62b0 175 void abort_transfer();
<> 128:9bcdf88f62b0 176 protected:
<> 128:9bcdf88f62b0 177 void irq_handler_asynch(void);
<> 128:9bcdf88f62b0 178 event_callback_t _callback;
<> 128:9bcdf88f62b0 179 CThunk<I2C> _irq;
<> 128:9bcdf88f62b0 180 DMAUsage _usage;
<> 128:9bcdf88f62b0 181 #endif
<> 128:9bcdf88f62b0 182
<> 128:9bcdf88f62b0 183 protected:
<> 128:9bcdf88f62b0 184 void aquire();
<> 128:9bcdf88f62b0 185
<> 128:9bcdf88f62b0 186 i2c_t _i2c;
<> 128:9bcdf88f62b0 187 static I2C *_owner;
<> 128:9bcdf88f62b0 188 int _hz;
<> 128:9bcdf88f62b0 189 static SingletonPtr<PlatformMutex> _mutex;
<> 128:9bcdf88f62b0 190 };
<> 128:9bcdf88f62b0 191
<> 128:9bcdf88f62b0 192 } // namespace mbed
<> 128:9bcdf88f62b0 193
<> 128:9bcdf88f62b0 194 #endif
<> 128:9bcdf88f62b0 195
<> 128:9bcdf88f62b0 196 #endif
<> 128:9bcdf88f62b0 197
<> 128:9bcdf88f62b0 198 /** @}*/