Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/I2C.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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