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@20:029aa53d7323, 2010-06-03 (annotated)

Committer:
simon
Date:
Thu Jun 03 11:17:50 2010 +0000
Revision:
20:029aa53d7323
Parent:
12:f63353af7be8
Child:
21:3944f1e2fa4f
* Add SPISlave, SPIHalfDuplex, SerialHalfDuplex

 * Add I2C repeated start

 * Add ethernet set_link()

 * Add documentation for wait()

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - I2C
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 * sford
rolf.meyer@arm.com 11:1c1ebd0324fa 4 */
simon.ford@mbed.co.uk 0:82220227f4fa 5
simon.ford@mbed.co.uk 0:82220227f4fa 6 #ifndef MBED_I2C_H
simon.ford@mbed.co.uk 0:82220227f4fa 7 #define MBED_I2C_H
simon.ford@mbed.co.uk 0:82220227f4fa 8
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "PeripheralNames.h"
simon.ford@mbed.co.uk 0:82220227f4fa 12 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 13
simon.ford@mbed.co.uk 0:82220227f4fa 14 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 15
simon.ford@mbed.co.uk 0:82220227f4fa 16 /* Class: I2C
simon.ford@mbed.co.uk 0:82220227f4fa 17 * An I2C Master, used for communicating with I2C slave devices
rolf.meyer@arm.com 11:1c1ebd0324fa 18 *
rolf.meyer@arm.com 11:1c1ebd0324fa 19 * Example:
simon 20:029aa53d7323 20 * > // Read from I2C slave at address 0x62
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * > I2C i2c(p28, p27);
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * > int main() {
rolf.meyer@arm.com 12:f63353af7be8 27 * > int address = 0x62;
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * > char data[2];
rolf.meyer@arm.com 12:f63353af7be8 29 * > i2c.read(address, data, 2);
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * > }
simon.ford@mbed.co.uk 0:82220227f4fa 31 */
simon.ford@mbed.co.uk 0:82220227f4fa 32 class I2C : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 33
simon.ford@mbed.co.uk 0:82220227f4fa 34 public:
simon.ford@mbed.co.uk 0:82220227f4fa 35
simon 20:029aa53d7323 36 enum RxStatus {
simon 20:029aa53d7323 37 NoData
simon 20:029aa53d7323 38 , MasterGeneralCall
simon 20:029aa53d7323 39 , MasterWrite
simon 20:029aa53d7323 40 , MasterRead
simon 20:029aa53d7323 41 };
simon 20:029aa53d7323 42
rolf.meyer@arm.com 11:1c1ebd0324fa 43 /* Constructor: I2C
rolf.meyer@arm.com 11:1c1ebd0324fa 44 * Create an I2C Master interface, connected to the specified pins
rolf.meyer@arm.com 11:1c1ebd0324fa 45 *
rolf.meyer@arm.com 11:1c1ebd0324fa 46 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 47 * sda - I2C data line pin
rolf.meyer@arm.com 11:1c1ebd0324fa 48 * scl - I2C clock line pin
rolf.meyer@arm.com 11:1c1ebd0324fa 49 */
rolf.meyer@arm.com 11:1c1ebd0324fa 50 I2C(PinName sda, PinName scl, const char *name = NULL);
simon.ford@mbed.co.uk 0:82220227f4fa 51
rolf.meyer@arm.com 11:1c1ebd0324fa 52 /* Function: frequency
rolf.meyer@arm.com 11:1c1ebd0324fa 53 * Set the frequency of the I2C interface
rolf.meyer@arm.com 11:1c1ebd0324fa 54 *
rolf.meyer@arm.com 11:1c1ebd0324fa 55 * Variables:
rolf.meyer@arm.com 11:1c1ebd0324fa 56 * hz - The bus frequency in hertz
rolf.meyer@arm.com 11:1c1ebd0324fa 57 */
rolf.meyer@arm.com 11:1c1ebd0324fa 58 void frequency(int hz);
rolf.meyer@arm.com 11:1c1ebd0324fa 59
rolf.meyer@arm.com 11:1c1ebd0324fa 60 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 61 * Read from an I2C slave
simon.ford@mbed.co.uk 0:82220227f4fa 62 *
rolf.meyer@arm.com 12:f63353af7be8 63 * Performs a complete read transaction. The bottom bit of
rolf.meyer@arm.com 12:f63353af7be8 64 * the address is forced to 1 to indicate a read.
rolf.meyer@arm.com 12:f63353af7be8 65 *
rolf.meyer@arm.com 11:1c1ebd0324fa 66 * Variables:
rolf.meyer@arm.com 12:f63353af7be8 67 * address - 8-bit I2C slave address [ addr | 1 ]
rolf.meyer@arm.com 11:1c1ebd0324fa 68 * data - Pointer to the byte-array to read data in to
rolf.meyer@arm.com 11:1c1ebd0324fa 69 * length - Number of bytes to read
simon 20:029aa53d7323 70 * repeated - Repeated start, true - don't send stop at end
rolf.meyer@arm.com 12:f63353af7be8 71 * returns - 0 on success (ack), or non-0 on failure (nack)
rolf.meyer@arm.com 11:1c1ebd0324fa 72 */
simon 20:029aa53d7323 73 int read(int address, char *data, int length, bool repeated = false);
simon.ford@mbed.co.uk 0:82220227f4fa 74
rolf.meyer@arm.com 11:1c1ebd0324fa 75 /* Function: write
rolf.meyer@arm.com 11:1c1ebd0324fa 76 * Write to an I2C slave
rolf.meyer@arm.com 11:1c1ebd0324fa 77 *
rolf.meyer@arm.com 12:f63353af7be8 78 * Performs a complete write transaction. The bottom bit of
rolf.meyer@arm.com 12:f63353af7be8 79 * the address is forced to 0 to indicate a write.
rolf.meyer@arm.com 12:f63353af7be8 80 *
rolf.meyer@arm.com 11:1c1ebd0324fa 81 * Variables:
rolf.meyer@arm.com 12:f63353af7be8 82 * address - 8-bit I2C slave address [ addr | 0 ]
rolf.meyer@arm.com 11:1c1ebd0324fa 83 * data - Pointer to the byte-array data to send
rolf.meyer@arm.com 11:1c1ebd0324fa 84 * length - Number of bytes to send
simon 20:029aa53d7323 85 * repeated - Repeated start, true - do not send stop at end
rolf.meyer@arm.com 12:f63353af7be8 86 * returns - 0 on success (ack), or non-0 on failure (nack)
rolf.meyer@arm.com 11:1c1ebd0324fa 87 */
simon 20:029aa53d7323 88 int write(int address, const char *data, int length, bool repeated = false);
rolf.meyer@arm.com 11:1c1ebd0324fa 89
simon.ford@mbed.co.uk 0:82220227f4fa 90 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 91
rolf.meyer@arm.com 11:1c1ebd0324fa 92 void aquire();
simon 20:029aa53d7323 93
simon 20:029aa53d7323 94 I2CName _i2c;
simon 20:029aa53d7323 95 static I2C *_owner;
simon 20:029aa53d7323 96 int _hz;
simon.ford@mbed.co.uk 0:82220227f4fa 97
simon.ford@mbed.co.uk 0:82220227f4fa 98 };
simon.ford@mbed.co.uk 0:82220227f4fa 99
rolf.meyer@arm.com 11:1c1ebd0324fa 100 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 101
simon.ford@mbed.co.uk 1:6b7f447ca868 102 #endif