mbed library
Fork of mbed by
I2C.h@12:f63353af7be8, 2009-09-03 (annotated)
- Committer:
- rolf.meyer@arm.com
- Date:
- Thu Sep 03 18:03:51 2009 +0000
- Revision:
- 12:f63353af7be8
- Parent:
- 11:1c1ebd0324fa
- Child:
- 20:029aa53d7323
Some missing changes ;-)
Who changed what in which revision?
User | Revision | Line number | New 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: |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 20 | * > // Read from I2C slave at address 0x1234 |
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 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 36 | /* Constructor: I2C |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 37 | * Create an I2C Master interface, connected to the specified pins |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 38 | * |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 39 | * Variables: |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 40 | * sda - I2C data line pin |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 41 | * scl - I2C clock line pin |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 42 | */ |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 43 | I2C(PinName sda, PinName scl, const char *name = NULL); |
simon.ford@mbed.co.uk | 0:82220227f4fa | 44 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 45 | /* Function: frequency |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 46 | * Set the frequency of the I2C interface |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 47 | * |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 48 | * Variables: |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 49 | * hz - The bus frequency in hertz |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 50 | */ |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 51 | void frequency(int hz); |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 52 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 53 | /* Function: read |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 54 | * Read from an I2C slave |
simon.ford@mbed.co.uk | 0:82220227f4fa | 55 | * |
rolf.meyer@arm.com | 12:f63353af7be8 | 56 | * Performs a complete read transaction. The bottom bit of |
rolf.meyer@arm.com | 12:f63353af7be8 | 57 | * the address is forced to 1 to indicate a read. |
rolf.meyer@arm.com | 12:f63353af7be8 | 58 | * |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 59 | * Variables: |
rolf.meyer@arm.com | 12:f63353af7be8 | 60 | * address - 8-bit I2C slave address [ addr | 1 ] |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 61 | * data - Pointer to the byte-array to read data in to |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 62 | * length - Number of bytes to read |
rolf.meyer@arm.com | 12:f63353af7be8 | 63 | * returns - 0 on success (ack), or non-0 on failure (nack) |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 64 | */ |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 65 | int read(int address, char *data, int length); |
simon.ford@mbed.co.uk | 0:82220227f4fa | 66 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 67 | /* Function: write |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 68 | * Write to an I2C slave |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 69 | * |
rolf.meyer@arm.com | 12:f63353af7be8 | 70 | * Performs a complete write transaction. The bottom bit of |
rolf.meyer@arm.com | 12:f63353af7be8 | 71 | * the address is forced to 0 to indicate a write. |
rolf.meyer@arm.com | 12:f63353af7be8 | 72 | * |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 73 | * Variables: |
rolf.meyer@arm.com | 12:f63353af7be8 | 74 | * address - 8-bit I2C slave address [ addr | 0 ] |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 75 | * data - Pointer to the byte-array data to send |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 76 | * length - Number of bytes to send |
rolf.meyer@arm.com | 12:f63353af7be8 | 77 | * returns - 0 on success (ack), or non-0 on failure (nack) |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 78 | */ |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 79 | int write(int address, const char *data, int length); |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 80 | |
simon.ford@mbed.co.uk | 0:82220227f4fa | 81 | protected: |
simon.ford@mbed.co.uk | 0:82220227f4fa | 82 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 83 | I2CName _i2c; |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 84 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 85 | void aquire(); |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 86 | static I2C *_owner; |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 87 | int _hz; |
simon.ford@mbed.co.uk | 0:82220227f4fa | 88 | |
simon.ford@mbed.co.uk | 0:82220227f4fa | 89 | }; |
simon.ford@mbed.co.uk | 0:82220227f4fa | 90 | |
rolf.meyer@arm.com | 11:1c1ebd0324fa | 91 | } // namespace mbed |
simon.ford@mbed.co.uk | 0:82220227f4fa | 92 | |
simon.ford@mbed.co.uk | 1:6b7f447ca868 | 93 | #endif |