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@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
22:9114680c05da
Child:
43:aff670d0d510
New Libraries 11.11

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