Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/I2C.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ebrus 0:6bc4ac881c8e 1 /* mbed Microcontroller Library
ebrus 0:6bc4ac881c8e 2 * Copyright (c) 2006-2013 ARM Limited
ebrus 0:6bc4ac881c8e 3 *
ebrus 0:6bc4ac881c8e 4 * Licensed under the Apache License, Version 2.0 (the "License");
ebrus 0:6bc4ac881c8e 5 * you may not use this file except in compliance with the License.
ebrus 0:6bc4ac881c8e 6 * You may obtain a copy of the License at
ebrus 0:6bc4ac881c8e 7 *
ebrus 0:6bc4ac881c8e 8 * http://www.apache.org/licenses/LICENSE-2.0
ebrus 0:6bc4ac881c8e 9 *
ebrus 0:6bc4ac881c8e 10 * Unless required by applicable law or agreed to in writing, software
ebrus 0:6bc4ac881c8e 11 * distributed under the License is distributed on an "AS IS" BASIS,
ebrus 0:6bc4ac881c8e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ebrus 0:6bc4ac881c8e 13 * See the License for the specific language governing permissions and
ebrus 0:6bc4ac881c8e 14 * limitations under the License.
ebrus 0:6bc4ac881c8e 15 */
ebrus 0:6bc4ac881c8e 16 #ifndef MBED_I2C_H
ebrus 0:6bc4ac881c8e 17 #define MBED_I2C_H
ebrus 0:6bc4ac881c8e 18
ebrus 0:6bc4ac881c8e 19 #include "platform.h"
ebrus 0:6bc4ac881c8e 20
ebrus 0:6bc4ac881c8e 21 #if DEVICE_I2C
ebrus 0:6bc4ac881c8e 22
ebrus 0:6bc4ac881c8e 23 #include "i2c_api.h"
ebrus 0:6bc4ac881c8e 24
ebrus 0:6bc4ac881c8e 25 namespace mbed {
ebrus 0:6bc4ac881c8e 26
ebrus 0:6bc4ac881c8e 27 /** An I2C Master, used for communicating with I2C slave devices
ebrus 0:6bc4ac881c8e 28 *
ebrus 0:6bc4ac881c8e 29 * Example:
ebrus 0:6bc4ac881c8e 30 * @code
ebrus 0:6bc4ac881c8e 31 * // Read from I2C slave at address 0x62
ebrus 0:6bc4ac881c8e 32 *
ebrus 0:6bc4ac881c8e 33 * #include "mbed.h"
ebrus 0:6bc4ac881c8e 34 *
ebrus 0:6bc4ac881c8e 35 * I2C i2c(p28, p27);
ebrus 0:6bc4ac881c8e 36 *
ebrus 0:6bc4ac881c8e 37 * int main() {
ebrus 0:6bc4ac881c8e 38 * int address = 0x62;
ebrus 0:6bc4ac881c8e 39 * char data[2];
ebrus 0:6bc4ac881c8e 40 * i2c.read(address, data, 2);
ebrus 0:6bc4ac881c8e 41 * }
ebrus 0:6bc4ac881c8e 42 * @endcode
ebrus 0:6bc4ac881c8e 43 */
ebrus 0:6bc4ac881c8e 44 class I2C {
ebrus 0:6bc4ac881c8e 45
ebrus 0:6bc4ac881c8e 46 public:
ebrus 0:6bc4ac881c8e 47 enum RxStatus {
ebrus 0:6bc4ac881c8e 48 NoData,
ebrus 0:6bc4ac881c8e 49 MasterGeneralCall,
ebrus 0:6bc4ac881c8e 50 MasterWrite,
ebrus 0:6bc4ac881c8e 51 MasterRead
ebrus 0:6bc4ac881c8e 52 };
ebrus 0:6bc4ac881c8e 53
ebrus 0:6bc4ac881c8e 54 enum Acknowledge {
ebrus 0:6bc4ac881c8e 55 NoACK = 0,
ebrus 0:6bc4ac881c8e 56 ACK = 1
ebrus 0:6bc4ac881c8e 57 };
ebrus 0:6bc4ac881c8e 58
ebrus 0:6bc4ac881c8e 59 /** Create an I2C Master interface, connected to the specified pins
ebrus 0:6bc4ac881c8e 60 *
ebrus 0:6bc4ac881c8e 61 * @param sda I2C data line pin
ebrus 0:6bc4ac881c8e 62 * @param scl I2C clock line pin
ebrus 0:6bc4ac881c8e 63 */
ebrus 0:6bc4ac881c8e 64 I2C(PinName sda, PinName scl);
ebrus 0:6bc4ac881c8e 65
ebrus 0:6bc4ac881c8e 66 /** Set the frequency of the I2C interface
ebrus 0:6bc4ac881c8e 67 *
ebrus 0:6bc4ac881c8e 68 * @param hz The bus frequency in hertz
ebrus 0:6bc4ac881c8e 69 */
ebrus 0:6bc4ac881c8e 70 void frequency(int hz);
ebrus 0:6bc4ac881c8e 71
ebrus 0:6bc4ac881c8e 72 /** Read from an I2C slave
ebrus 0:6bc4ac881c8e 73 *
ebrus 0:6bc4ac881c8e 74 * Performs a complete read transaction. The bottom bit of
ebrus 0:6bc4ac881c8e 75 * the address is forced to 1 to indicate a read.
ebrus 0:6bc4ac881c8e 76 *
ebrus 0:6bc4ac881c8e 77 * @param address 8-bit I2C slave address [ addr | 1 ]
ebrus 0:6bc4ac881c8e 78 * @param data Pointer to the byte-array to read data in to
ebrus 0:6bc4ac881c8e 79 * @param length Number of bytes to read
ebrus 0:6bc4ac881c8e 80 * @param repeated Repeated start, true - don't send stop at end
ebrus 0:6bc4ac881c8e 81 *
ebrus 0:6bc4ac881c8e 82 * @returns
ebrus 0:6bc4ac881c8e 83 * 0 on success (ack),
ebrus 0:6bc4ac881c8e 84 * non-0 on failure (nack)
ebrus 0:6bc4ac881c8e 85 */
ebrus 0:6bc4ac881c8e 86 int read(int address, char *data, int length, bool repeated = false);
ebrus 0:6bc4ac881c8e 87
ebrus 0:6bc4ac881c8e 88 /** Read a single byte from the I2C bus
ebrus 0:6bc4ac881c8e 89 *
ebrus 0:6bc4ac881c8e 90 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
ebrus 0:6bc4ac881c8e 91 *
ebrus 0:6bc4ac881c8e 92 * @returns
ebrus 0:6bc4ac881c8e 93 * the byte read
ebrus 0:6bc4ac881c8e 94 */
ebrus 0:6bc4ac881c8e 95 int read(int ack);
ebrus 0:6bc4ac881c8e 96
ebrus 0:6bc4ac881c8e 97 /** Write to an I2C slave
ebrus 0:6bc4ac881c8e 98 *
ebrus 0:6bc4ac881c8e 99 * Performs a complete write transaction. The bottom bit of
ebrus 0:6bc4ac881c8e 100 * the address is forced to 0 to indicate a write.
ebrus 0:6bc4ac881c8e 101 *
ebrus 0:6bc4ac881c8e 102 * @param address 8-bit I2C slave address [ addr | 0 ]
ebrus 0:6bc4ac881c8e 103 * @param data Pointer to the byte-array data to send
ebrus 0:6bc4ac881c8e 104 * @param length Number of bytes to send
ebrus 0:6bc4ac881c8e 105 * @param repeated Repeated start, true - do not send stop at end
ebrus 0:6bc4ac881c8e 106 *
ebrus 0:6bc4ac881c8e 107 * @returns
ebrus 0:6bc4ac881c8e 108 * 0 on success (ack),
ebrus 0:6bc4ac881c8e 109 * non-0 on failure (nack)
ebrus 0:6bc4ac881c8e 110 */
ebrus 0:6bc4ac881c8e 111 int write(int address, const char *data, int length, bool repeated = false);
ebrus 0:6bc4ac881c8e 112
ebrus 0:6bc4ac881c8e 113 /** Write single byte out on the I2C bus
ebrus 0:6bc4ac881c8e 114 *
ebrus 0:6bc4ac881c8e 115 * @param data data to write out on bus
ebrus 0:6bc4ac881c8e 116 *
ebrus 0:6bc4ac881c8e 117 * @returns
ebrus 0:6bc4ac881c8e 118 * '1' if an ACK was received,
ebrus 0:6bc4ac881c8e 119 * '0' otherwise
ebrus 0:6bc4ac881c8e 120 */
ebrus 0:6bc4ac881c8e 121 int write(int data);
ebrus 0:6bc4ac881c8e 122
ebrus 0:6bc4ac881c8e 123 /** Creates a start condition on the I2C bus
ebrus 0:6bc4ac881c8e 124 */
ebrus 0:6bc4ac881c8e 125
ebrus 0:6bc4ac881c8e 126 void start(void);
ebrus 0:6bc4ac881c8e 127
ebrus 0:6bc4ac881c8e 128 /** Creates a stop condition on the I2C bus
ebrus 0:6bc4ac881c8e 129 */
ebrus 0:6bc4ac881c8e 130 void stop(void);
ebrus 0:6bc4ac881c8e 131
ebrus 0:6bc4ac881c8e 132 protected:
ebrus 0:6bc4ac881c8e 133 void aquire();
ebrus 0:6bc4ac881c8e 134
ebrus 0:6bc4ac881c8e 135 i2c_t _i2c;
ebrus 0:6bc4ac881c8e 136 static I2C *_owner;
ebrus 0:6bc4ac881c8e 137 int _hz;
ebrus 0:6bc4ac881c8e 138 };
ebrus 0:6bc4ac881c8e 139
ebrus 0:6bc4ac881c8e 140 } // namespace mbed
ebrus 0:6bc4ac881c8e 141
ebrus 0:6bc4ac881c8e 142 #endif
ebrus 0:6bc4ac881c8e 143
ebrus 0:6bc4ac881c8e 144 #endif