Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

I2C.h@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
27:7110ebee3484 
Conversion of the classes documentation to Doxygen format

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - I2C
emilmont 27:7110ebee3484 2 * Copyright (c) 2007-2011 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
simon.ford@mbed.co.uk 0:82220227f4fa 4
simon.ford@mbed.co.uk 0:82220227f4fa 5 #ifndef MBED_I2C_H
simon.ford@mbed.co.uk 0:82220227f4fa 6 #define MBED_I2C_H
simon.ford@mbed.co.uk 0:82220227f4fa 7
emilmont 27:7110ebee3484 8 #include "device.h"
emilmont 27:7110ebee3484 9
emilmont 27:7110ebee3484 10 #if DEVICE_I2C
emilmont 27:7110ebee3484 11
rolf.meyer@arm.com 11:1c1ebd0324fa 12 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 13 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 14 #include "PeripheralNames.h"
simon.ford@mbed.co.uk 0:82220227f4fa 15 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 16
simon.ford@mbed.co.uk 0:82220227f4fa 17 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 18
screamer 43:aff670d0d510 19 /** An I2C Master, used for communicating with I2C slave devices
rolf.meyer@arm.com 11:1c1ebd0324fa 20 *
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * Example:
screamer 43:aff670d0d510 22 * @code
screamer 43:aff670d0d510 23 * // Read from I2C slave at address 0x62
screamer 43:aff670d0d510 24 *
screamer 43:aff670d0d510 25 * #include "mbed.h"
screamer 43:aff670d0d510 26 *
screamer 43:aff670d0d510 27 * I2C i2c(p28, p27);
screamer 43:aff670d0d510 28 *
screamer 43:aff670d0d510 29 * int main() {
screamer 43:aff670d0d510 30 * int address = 0x62;
screamer 43:aff670d0d510 31 * char data[2];
screamer 43:aff670d0d510 32 * i2c.read(address, data, 2);
screamer 43:aff670d0d510 33 * }
screamer 43:aff670d0d510 34 * @endcode
simon.ford@mbed.co.uk 0:82220227f4fa 35 */
simon.ford@mbed.co.uk 0:82220227f4fa 36 class I2C : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 37
simon.ford@mbed.co.uk 0:82220227f4fa 38 public:
simon.ford@mbed.co.uk 0:82220227f4fa 39
simon 20:029aa53d7323 40 enum RxStatus {
simon 20:029aa53d7323 41 NoData
simon 20:029aa53d7323 42 , MasterGeneralCall
simon 20:029aa53d7323 43 , MasterWrite
simon 20:029aa53d7323 44 , MasterRead
simon 20:029aa53d7323 45 };
simon 20:029aa53d7323 46
simon 21:3944f1e2fa4f 47 enum Acknowledge {
simon 21:3944f1e2fa4f 48 NoACK = 0
simon 21:3944f1e2fa4f 49 , ACK = 1
simon 21:3944f1e2fa4f 50 };
simon 21:3944f1e2fa4f 51
screamer 43:aff670d0d510 52 /** Create an I2C Master interface, connected to the specified pins
rolf.meyer@arm.com 11:1c1ebd0324fa 53 *
screamer 43:aff670d0d510 54 * @param sda I2C data line pin
screamer 43:aff670d0d510 55 * @param scl I2C clock line pin
rolf.meyer@arm.com 11:1c1ebd0324fa 56 */
rolf.meyer@arm.com 11:1c1ebd0324fa 57 I2C(PinName sda, PinName scl, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 58
screamer 43:aff670d0d510 59 /** Set the frequency of the I2C interface
rolf.meyer@arm.com 11:1c1ebd0324fa 60 *
screamer 43:aff670d0d510 61 * @param hz The bus frequency in hertz
rolf.meyer@arm.com 11:1c1ebd0324fa 62 */
rolf.meyer@arm.com 11:1c1ebd0324fa 63 void frequency(int hz);
rolf.meyer@arm.com 11:1c1ebd0324fa 64
screamer 43:aff670d0d510 65 /** Read from an I2C slave
simon.ford@mbed.co.uk 0:82220227f4fa 66 *
screamer 43:aff670d0d510 67 * Performs a complete read transaction. The bottom bit of
screamer 43:aff670d0d510 68 * the address is forced to 1 to indicate a read.
rolf.meyer@arm.com 12:f63353af7be8 69 *
screamer 43:aff670d0d510 70 * @param address 8-bit I2C slave address [ addr | 1 ]
screamer 43:aff670d0d510 71 * @param data Pointer to the byte-array to read data in to
screamer 43:aff670d0d510 72 * @param length Number of bytes to read
screamer 43:aff670d0d510 73 * @param repeated Repeated start, true - don't send stop at end
screamer 43:aff670d0d510 74 *
screamer 43:aff670d0d510 75 * @returns
screamer 43:aff670d0d510 76 * 0 on success (ack),
screamer 43:aff670d0d510 77 * non-0 on failure (nack)
rolf.meyer@arm.com 11:1c1ebd0324fa 78 */
simon 20:029aa53d7323 79 int read(int address, char *data, int length, bool repeated = false);
simon.ford@mbed.co.uk 0:82220227f4fa 80
screamer 43:aff670d0d510 81 /** Read a single byte from the I2C bus
simon 21:3944f1e2fa4f 82 *
screamer 43:aff670d0d510 83 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
screamer 43:aff670d0d510 84 *
screamer 43:aff670d0d510 85 * @returns
screamer 43:aff670d0d510 86 * the byte read
simon 21:3944f1e2fa4f 87 */
simon 21:3944f1e2fa4f 88 int read(int ack);
simon 21:3944f1e2fa4f 89
screamer 43:aff670d0d510 90 /** Write to an I2C slave
rolf.meyer@arm.com 11:1c1ebd0324fa 91 *
screamer 43:aff670d0d510 92 * Performs a complete write transaction. The bottom bit of
screamer 43:aff670d0d510 93 * the address is forced to 0 to indicate a write.
rolf.meyer@arm.com 12:f63353af7be8 94 *
screamer 43:aff670d0d510 95 * @param address 8-bit I2C slave address [ addr | 0 ]
screamer 43:aff670d0d510 96 * @param data Pointer to the byte-array data to send
screamer 43:aff670d0d510 97 * @param length Number of bytes to send
screamer 43:aff670d0d510 98 * @param repeated Repeated start, true - do not send stop at end
screamer 43:aff670d0d510 99 *
screamer 43:aff670d0d510 100 * @returns
screamer 43:aff670d0d510 101 * 0 on success (ack),
screamer 43:aff670d0d510 102 * non-0 on failure (nack)
rolf.meyer@arm.com 11:1c1ebd0324fa 103 */
simon 20:029aa53d7323 104 int write(int address, const char *data, int length, bool repeated = false);
simon 21:3944f1e2fa4f 105
screamer 43:aff670d0d510 106 /** Write single byte out on the I2C bus
screamer 43:aff670d0d510 107 *
screamer 43:aff670d0d510 108 * @param data data to write out on bus
simon 21:3944f1e2fa4f 109 *
screamer 43:aff670d0d510 110 * @returns
screamer 43:aff670d0d510 111 * '1' if an ACK was received,
screamer 43:aff670d0d510 112 * '0' otherwise
simon 21:3944f1e2fa4f 113 */
simon 21:3944f1e2fa4f 114 int write(int data);
simon 21:3944f1e2fa4f 115
screamer 43:aff670d0d510 116 /** Creates a start condition on the I2C bus
simon 21:3944f1e2fa4f 117 */
simon 21:3944f1e2fa4f 118 void start(void);
simon 21:3944f1e2fa4f 119
screamer 43:aff670d0d510 120 /** Creates a stop condition on the I2C bus
simon 21:3944f1e2fa4f 121 */
simon 21:3944f1e2fa4f 122 void stop(void);
simon 21:3944f1e2fa4f 123
simon.ford@mbed.co.uk 0:82220227f4fa 124 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 125
rolf.meyer@arm.com 11:1c1ebd0324fa 126 void aquire();
simon 20:029aa53d7323 127
simon 20:029aa53d7323 128 I2CName _i2c;
simon 20:029aa53d7323 129 static I2C *_owner;
simon 20:029aa53d7323 130 int _hz;
simon.ford@mbed.co.uk 0:82220227f4fa 131
simon.ford@mbed.co.uk 0:82220227f4fa 132 };
simon.ford@mbed.co.uk 0:82220227f4fa 133
rolf.meyer@arm.com 11:1c1ebd0324fa 134 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 135
simon.ford@mbed.co.uk 1:6b7f447ca868 136 #endif
emilmont 27:7110ebee3484 137
emilmont 27:7110ebee3484 138 #endif
emilmont 27:7110ebee3484 139