jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

I2C.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

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