Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

I2CSlave.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 22:9114680c05da 1 /* mbed Microcontroller Library - I2CSlave
emilmont 27:7110ebee3484 2 * Copyright (c) 2007-2011 ARM Limited. All rights reserved.
simon 22:9114680c05da 3 */
simon 22:9114680c05da 4
simon 22:9114680c05da 5 #ifndef MBED_I2C_SLAVE_H
simon 22:9114680c05da 6 #define MBED_I2C_SLAVE_H
simon 22:9114680c05da 7
emilmont 27:7110ebee3484 8 #include "device.h"
emilmont 27:7110ebee3484 9
emilmont 27:7110ebee3484 10 #if DEVICE_I2CSLAVE
emilmont 27:7110ebee3484 11
simon 22:9114680c05da 12 #include "platform.h"
simon 22:9114680c05da 13 #include "PinNames.h"
simon 22:9114680c05da 14 #include "PeripheralNames.h"
simon 22:9114680c05da 15 #include "Base.h"
simon 22:9114680c05da 16
simon 22:9114680c05da 17 namespace mbed {
simon 22:9114680c05da 18
screamer 43:aff670d0d510 19 /** An I2C Slave, used for communicating with an I2C Master device
simon 22:9114680c05da 20 *
simon 22:9114680c05da 21 * Example:
screamer 43:aff670d0d510 22 * @code
screamer 43:aff670d0d510 23 * // Simple I2C responder
screamer 43:aff670d0d510 24 * #include <mbed.h>
screamer 43:aff670d0d510 25 *
screamer 43:aff670d0d510 26 * I2CSlave slave(p9, p10);
screamer 43:aff670d0d510 27 *
screamer 43:aff670d0d510 28 * int main() {
screamer 43:aff670d0d510 29 * char buf[10];
screamer 43:aff670d0d510 30 * char msg[] = "Slave!";
screamer 43:aff670d0d510 31 *
screamer 43:aff670d0d510 32 * slave.address(0xA0);
screamer 43:aff670d0d510 33 * while (1) {
screamer 43:aff670d0d510 34 * int i = slave.receive();
screamer 43:aff670d0d510 35 * switch (i) {
screamer 43:aff670d0d510 36 * case I2CSlave::ReadAddressed:
screamer 43:aff670d0d510 37 * slave.write(msg, strlen(msg) + 1); // Includes null char
screamer 43:aff670d0d510 38 * break;
screamer 43:aff670d0d510 39 * case I2CSlave::WriteGeneral:
screamer 43:aff670d0d510 40 * slave.read(buf, 10);
screamer 43:aff670d0d510 41 * printf("Read G: %s\n", buf);
screamer 43:aff670d0d510 42 * break;
screamer 43:aff670d0d510 43 * case I2CSlave::WriteAddressed:
screamer 43:aff670d0d510 44 * slave.read(buf, 10);
screamer 43:aff670d0d510 45 * printf("Read A: %s\n", buf);
screamer 43:aff670d0d510 46 * break;
screamer 43:aff670d0d510 47 * }
screamer 43:aff670d0d510 48 * for(int i = 0; i < 10; i++) buf[i] = 0; // Clear buffer
screamer 43:aff670d0d510 49 * }
screamer 43:aff670d0d510 50 * }
screamer 43:aff670d0d510 51 * @endcode
simon 22:9114680c05da 52 */
simon 22:9114680c05da 53 class I2CSlave : public Base {
simon 22:9114680c05da 54
simon 22:9114680c05da 55 public:
simon 22:9114680c05da 56
simon 22:9114680c05da 57 enum RxStatus {
simon 22:9114680c05da 58 NoData = 0
simon 22:9114680c05da 59 , ReadAddressed = 1
simon 22:9114680c05da 60 , WriteGeneral = 2
simon 22:9114680c05da 61 , WriteAddressed = 3
simon 22:9114680c05da 62 };
simon 22:9114680c05da 63
screamer 43:aff670d0d510 64 /** Create an I2C Slave interface, connected to the specified pins.
simon 22:9114680c05da 65 *
screamer 43:aff670d0d510 66 * @param sda I2C data line pin
screamer 43:aff670d0d510 67 * @param scl I2C clock line pin
simon 22:9114680c05da 68 */
simon 22:9114680c05da 69 I2CSlave(PinName sda, PinName scl, const char *name = NULL);
simon 22:9114680c05da 70
screamer 43:aff670d0d510 71 /** Set the frequency of the I2C interface
simon 22:9114680c05da 72 *
screamer 43:aff670d0d510 73 * @param hz The bus frequency in hertz
simon 22:9114680c05da 74 */
simon 22:9114680c05da 75 void frequency(int hz);
simon 22:9114680c05da 76
screamer 43:aff670d0d510 77 /** Checks to see if this I2C Slave has been addressed.
simon 22:9114680c05da 78 *
screamer 43:aff670d0d510 79 * @returns
screamer 43:aff670d0d510 80 * A status indicating if the device has been addressed, and how
screamer 43:aff670d0d510 81 * - NoData - the slave has not been addressed
screamer 43:aff670d0d510 82 * - ReadAddressed - the master has requested a read from this slave
screamer 43:aff670d0d510 83 * - WriteAddressed - the master is writing to this slave
screamer 43:aff670d0d510 84 * - WriteGeneral - the master is writing to all slave
simon 22:9114680c05da 85 */
simon 22:9114680c05da 86 int receive(void);
simon 22:9114680c05da 87
screamer 43:aff670d0d510 88 /** Read from an I2C master.
simon 22:9114680c05da 89 *
screamer 43:aff670d0d510 90 * @param data pointer to the byte array to read data in to
screamer 43:aff670d0d510 91 * @param length maximum number of bytes to read
screamer 43:aff670d0d510 92 *
screamer 43:aff670d0d510 93 * @returns
screamer 43:aff670d0d510 94 * 0 on success,
screamer 43:aff670d0d510 95 * non-0 otherwise
simon 22:9114680c05da 96 */
simon 22:9114680c05da 97 int read(char *data, int length);
simon 22:9114680c05da 98
screamer 43:aff670d0d510 99 /** Read a single byte from an I2C master.
simon 22:9114680c05da 100 *
screamer 43:aff670d0d510 101 * @returns
screamer 43:aff670d0d510 102 * the byte read
simon 22:9114680c05da 103 */
simon 22:9114680c05da 104 int read(void);
simon 22:9114680c05da 105
screamer 43:aff670d0d510 106 /** Write to an I2C master.
simon 22:9114680c05da 107 *
screamer 43:aff670d0d510 108 * @param data pointer to the byte array to be transmitted
screamer 43:aff670d0d510 109 * @param length the number of bytes to transmite
screamer 43:aff670d0d510 110 *
screamer 43:aff670d0d510 111 * @returns
screamer 43:aff670d0d510 112 * 0 on success,
screamer 43:aff670d0d510 113 * non-0 otherwise
simon 22:9114680c05da 114 */
simon 22:9114680c05da 115 int write(const char *data, int length);
simon 22:9114680c05da 116
screamer 43:aff670d0d510 117 /** Write a single byte to an I2C master.
screamer 43:aff670d0d510 118 *
screamer 43:aff670d0d510 119 * @data the byte to write
simon 22:9114680c05da 120 *
screamer 43:aff670d0d510 121 * @returns
screamer 43:aff670d0d510 122 * '1' if an ACK was received,
screamer 43:aff670d0d510 123 * '0' otherwise
simon 22:9114680c05da 124 */
simon 22:9114680c05da 125 int write(int data);
simon 22:9114680c05da 126
screamer 43:aff670d0d510 127 /** Sets the I2C slave address.
simon 22:9114680c05da 128 *
screamer 43:aff670d0d510 129 * @param address The address to set for the slave (ignoring the least
screamer 43:aff670d0d510 130 * signifcant bit). If set to 0, the slave will only respond to the
screamer 43:aff670d0d510 131 * general call address.
simon 22:9114680c05da 132 */
simon 22:9114680c05da 133 void address(int address);
simon 22:9114680c05da 134
screamer 43:aff670d0d510 135 /** Reset the I2C slave back into the known ready receiving state.
simon 22:9114680c05da 136 */
simon 22:9114680c05da 137 void stop(void);
simon 22:9114680c05da 138
simon 22:9114680c05da 139 protected:
simon 22:9114680c05da 140
simon 22:9114680c05da 141 I2CName _i2c;
simon 22:9114680c05da 142 };
simon 22:9114680c05da 143
simon 22:9114680c05da 144 } // namespace mbed
simon 22:9114680c05da 145
simon 22:9114680c05da 146 #endif
emilmont 27:7110ebee3484 147
emilmont 27:7110ebee3484 148 #endif
emilmont 27:7110ebee3484 149