erez i / mbed

version_2.0

Dependents:   cc3000_ping_demo_try_2

Fork of mbed by mbed official

I2CSlave.h@55:d722ed6a4237, 2013-01-16 (annotated)

Committer:
emilmont
Date:
Wed Jan 16 12:56:34 2013 +0000
Revision:
55:d722ed6a4237
Parent:
54:71b101360fb9
Child:
59:0883845fe643
Include "sleep_api.h" in "mbed.h"

Add initial IAR toolchain support

LPC I2C: better handling of status

Add sleep mode support for the LPC1768

Correct GCC "__semihost" definition

Correct GCC "_isatty" retargeting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
simon 22:9114680c05da 22 #ifndef MBED_I2C_SLAVE_H
simon 22:9114680c05da 23 #define MBED_I2C_SLAVE_H
simon 22:9114680c05da 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 27:7110ebee3484 26
emilmont 27:7110ebee3484 27 #if DEVICE_I2CSLAVE
emilmont 27:7110ebee3484 28
emilmont 44:24d45a770a51 29 #include "i2c_api.h"
simon 22:9114680c05da 30
simon 22:9114680c05da 31 namespace mbed {
simon 22:9114680c05da 32
emilmont 43:e2ed12d17f06 33 /** An I2C Slave, used for communicating with an I2C Master device
simon 22:9114680c05da 34 *
simon 22:9114680c05da 35 * Example:
emilmont 43:e2ed12d17f06 36 * @code
emilmont 43:e2ed12d17f06 37 * // Simple I2C responder
emilmont 43:e2ed12d17f06 38 * #include <mbed.h>
emilmont 43:e2ed12d17f06 39 *
emilmont 43:e2ed12d17f06 40 * I2CSlave slave(p9, p10);
emilmont 43:e2ed12d17f06 41 *
emilmont 43:e2ed12d17f06 42 * int main() {
emilmont 43:e2ed12d17f06 43 * char buf[10];
emilmont 43:e2ed12d17f06 44 * char msg[] = "Slave!";
emilmont 43:e2ed12d17f06 45 *
emilmont 43:e2ed12d17f06 46 * slave.address(0xA0);
emilmont 43:e2ed12d17f06 47 * while (1) {
emilmont 43:e2ed12d17f06 48 * int i = slave.receive();
emilmont 43:e2ed12d17f06 49 * switch (i) {
emilmont 55:d722ed6a4237 50 * case I2CSlave::ReadAddressed:
emilmont 43:e2ed12d17f06 51 * slave.write(msg, strlen(msg) + 1); // Includes null char
emilmont 43:e2ed12d17f06 52 * break;
emilmont 43:e2ed12d17f06 53 * case I2CSlave::WriteGeneral:
emilmont 43:e2ed12d17f06 54 * slave.read(buf, 10);
emilmont 43:e2ed12d17f06 55 * printf("Read G: %s\n", buf);
emilmont 43:e2ed12d17f06 56 * break;
emilmont 43:e2ed12d17f06 57 * case I2CSlave::WriteAddressed:
emilmont 43:e2ed12d17f06 58 * slave.read(buf, 10);
emilmont 43:e2ed12d17f06 59 * printf("Read A: %s\n", buf);
emilmont 43:e2ed12d17f06 60 * break;
emilmont 43:e2ed12d17f06 61 * }
emilmont 43:e2ed12d17f06 62 * for(int i = 0; i < 10; i++) buf[i] = 0; // Clear buffer
emilmont 43:e2ed12d17f06 63 * }
emilmont 43:e2ed12d17f06 64 * }
emilmont 55:d722ed6a4237 65 * @endcode
simon 22:9114680c05da 66 */
emilmont 44:24d45a770a51 67 class I2CSlave {
simon 22:9114680c05da 68
simon 22:9114680c05da 69 public:
simon 22:9114680c05da 70 enum RxStatus {
emilmont 44:24d45a770a51 71 NoData = 0,
emilmont 44:24d45a770a51 72 ReadAddressed = 1,
emilmont 44:24d45a770a51 73 WriteGeneral = 2,
emilmont 44:24d45a770a51 74 WriteAddressed = 3
simon 22:9114680c05da 75 };
simon 22:9114680c05da 76
emilmont 43:e2ed12d17f06 77 /** Create an I2C Slave interface, connected to the specified pins.
simon 22:9114680c05da 78 *
emilmont 43:e2ed12d17f06 79 * @param sda I2C data line pin
emilmont 43:e2ed12d17f06 80 * @param scl I2C clock line pin
simon 22:9114680c05da 81 */
emilmont 44:24d45a770a51 82 I2CSlave(PinName sda, PinName scl);
simon 22:9114680c05da 83
emilmont 43:e2ed12d17f06 84 /** Set the frequency of the I2C interface
simon 22:9114680c05da 85 *
emilmont 43:e2ed12d17f06 86 * @param hz The bus frequency in hertz
simon 22:9114680c05da 87 */
simon 22:9114680c05da 88 void frequency(int hz);
simon 22:9114680c05da 89
emilmont 43:e2ed12d17f06 90 /** Checks to see if this I2C Slave has been addressed.
simon 22:9114680c05da 91 *
emilmont 43:e2ed12d17f06 92 * @returns
emilmont 43:e2ed12d17f06 93 * A status indicating if the device has been addressed, and how
emilmont 43:e2ed12d17f06 94 * - NoData - the slave has not been addressed
emilmont 43:e2ed12d17f06 95 * - ReadAddressed - the master has requested a read from this slave
emilmont 43:e2ed12d17f06 96 * - WriteAddressed - the master is writing to this slave
emilmont 55:d722ed6a4237 97 * - WriteGeneral - the master is writing to all slave
simon 22:9114680c05da 98 */
simon 22:9114680c05da 99 int receive(void);
simon 22:9114680c05da 100
emilmont 43:e2ed12d17f06 101 /** Read from an I2C master.
simon 22:9114680c05da 102 *
emilmont 43:e2ed12d17f06 103 * @param data pointer to the byte array to read data in to
emilmont 43:e2ed12d17f06 104 * @param length maximum number of bytes to read
emilmont 43:e2ed12d17f06 105 *
emilmont 43:e2ed12d17f06 106 * @returns
emilmont 43:e2ed12d17f06 107 * 0 on success,
emilmont 43:e2ed12d17f06 108 * non-0 otherwise
simon 22:9114680c05da 109 */
emilmont 55:d722ed6a4237 110 int read(char *data, int length);
simon 22:9114680c05da 111
emilmont 43:e2ed12d17f06 112 /** Read a single byte from an I2C master.
simon 22:9114680c05da 113 *
emilmont 43:e2ed12d17f06 114 * @returns
emilmont 43:e2ed12d17f06 115 * the byte read
simon 22:9114680c05da 116 */
simon 22:9114680c05da 117 int read(void);
simon 22:9114680c05da 118
emilmont 43:e2ed12d17f06 119 /** Write to an I2C master.
simon 22:9114680c05da 120 *
emilmont 43:e2ed12d17f06 121 * @param data pointer to the byte array to be transmitted
emilmont 43:e2ed12d17f06 122 * @param length the number of bytes to transmite
emilmont 43:e2ed12d17f06 123 *
emilmont 43:e2ed12d17f06 124 * @returns
emilmont 43:e2ed12d17f06 125 * 0 on success,
emilmont 43:e2ed12d17f06 126 * non-0 otherwise
simon 22:9114680c05da 127 */
simon 22:9114680c05da 128 int write(const char *data, int length);
simon 22:9114680c05da 129
emilmont 43:e2ed12d17f06 130 /** Write a single byte to an I2C master.
emilmont 43:e2ed12d17f06 131 *
emilmont 43:e2ed12d17f06 132 * @data the byte to write
simon 22:9114680c05da 133 *
emilmont 43:e2ed12d17f06 134 * @returns
emilmont 43:e2ed12d17f06 135 * '1' if an ACK was received,
emilmont 43:e2ed12d17f06 136 * '0' otherwise
simon 22:9114680c05da 137 */
simon 22:9114680c05da 138 int write(int data);
simon 22:9114680c05da 139
emilmont 43:e2ed12d17f06 140 /** Sets the I2C slave address.
simon 22:9114680c05da 141 *
emilmont 43:e2ed12d17f06 142 * @param address The address to set for the slave (ignoring the least
emilmont 44:24d45a770a51 143 * signifcant bit). If set to 0, the slave will only respond to the
emilmont 44:24d45a770a51 144 * general call address.
simon 22:9114680c05da 145 */
simon 22:9114680c05da 146 void address(int address);
simon 22:9114680c05da 147
emilmont 43:e2ed12d17f06 148 /** Reset the I2C slave back into the known ready receiving state.
simon 22:9114680c05da 149 */
simon 22:9114680c05da 150 void stop(void);
simon 22:9114680c05da 151
simon 22:9114680c05da 152 protected:
emilmont 44:24d45a770a51 153 i2c_t _i2c;
simon 22:9114680c05da 154 };
simon 22:9114680c05da 155
simon 22:9114680c05da 156 } // namespace mbed
simon 22:9114680c05da 157
simon 22:9114680c05da 158 #endif
emilmont 27:7110ebee3484 159
emilmont 27:7110ebee3484 160 #endif