Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

I2CSlave.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

UserRevisionLine numberNew contents of line
esokic 0:05aad811ea07 1 /* mbed Microcontroller Library
esokic 0:05aad811ea07 2 * Copyright (c) 2006-2013 ARM Limited
esokic 0:05aad811ea07 3 *
esokic 0:05aad811ea07 4 * Licensed under the Apache License, Version 2.0 (the "License");
esokic 0:05aad811ea07 5 * you may not use this file except in compliance with the License.
esokic 0:05aad811ea07 6 * You may obtain a copy of the License at
esokic 0:05aad811ea07 7 *
esokic 0:05aad811ea07 8 * http://www.apache.org/licenses/LICENSE-2.0
esokic 0:05aad811ea07 9 *
esokic 0:05aad811ea07 10 * Unless required by applicable law or agreed to in writing, software
esokic 0:05aad811ea07 11 * distributed under the License is distributed on an "AS IS" BASIS,
esokic 0:05aad811ea07 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
esokic 0:05aad811ea07 13 * See the License for the specific language governing permissions and
esokic 0:05aad811ea07 14 * limitations under the License.
esokic 0:05aad811ea07 15 */
esokic 0:05aad811ea07 16 #ifndef MBED_I2C_SLAVE_H
esokic 0:05aad811ea07 17 #define MBED_I2C_SLAVE_H
esokic 0:05aad811ea07 18
esokic 0:05aad811ea07 19 #include "platform.h"
esokic 0:05aad811ea07 20
esokic 0:05aad811ea07 21 #if DEVICE_I2CSLAVE
esokic 0:05aad811ea07 22
esokic 0:05aad811ea07 23 #include "i2c_api.h"
esokic 0:05aad811ea07 24
esokic 0:05aad811ea07 25 namespace mbed {
esokic 0:05aad811ea07 26
esokic 0:05aad811ea07 27 /** An I2C Slave, used for communicating with an I2C Master device
esokic 0:05aad811ea07 28 *
esokic 0:05aad811ea07 29 * Example:
esokic 0:05aad811ea07 30 * @code
esokic 0:05aad811ea07 31 * // Simple I2C responder
esokic 0:05aad811ea07 32 * #include <mbed.h>
esokic 0:05aad811ea07 33 *
esokic 0:05aad811ea07 34 * I2CSlave slave(p9, p10);
esokic 0:05aad811ea07 35 *
esokic 0:05aad811ea07 36 * int main() {
esokic 0:05aad811ea07 37 * char buf[10];
esokic 0:05aad811ea07 38 * char msg[] = "Slave!";
esokic 0:05aad811ea07 39 *
esokic 0:05aad811ea07 40 * slave.address(0xA0);
esokic 0:05aad811ea07 41 * while (1) {
esokic 0:05aad811ea07 42 * int i = slave.receive();
esokic 0:05aad811ea07 43 * switch (i) {
esokic 0:05aad811ea07 44 * case I2CSlave::ReadAddressed:
esokic 0:05aad811ea07 45 * slave.write(msg, strlen(msg) + 1); // Includes null char
esokic 0:05aad811ea07 46 * break;
esokic 0:05aad811ea07 47 * case I2CSlave::WriteGeneral:
esokic 0:05aad811ea07 48 * slave.read(buf, 10);
esokic 0:05aad811ea07 49 * printf("Read G: %s\n", buf);
esokic 0:05aad811ea07 50 * break;
esokic 0:05aad811ea07 51 * case I2CSlave::WriteAddressed:
esokic 0:05aad811ea07 52 * slave.read(buf, 10);
esokic 0:05aad811ea07 53 * printf("Read A: %s\n", buf);
esokic 0:05aad811ea07 54 * break;
esokic 0:05aad811ea07 55 * }
esokic 0:05aad811ea07 56 * for(int i = 0; i < 10; i++) buf[i] = 0; // Clear buffer
esokic 0:05aad811ea07 57 * }
esokic 0:05aad811ea07 58 * }
esokic 0:05aad811ea07 59 * @endcode
esokic 0:05aad811ea07 60 */
esokic 0:05aad811ea07 61 class I2CSlave {
esokic 0:05aad811ea07 62
esokic 0:05aad811ea07 63 public:
esokic 0:05aad811ea07 64 enum RxStatus {
esokic 0:05aad811ea07 65 NoData = 0,
esokic 0:05aad811ea07 66 ReadAddressed = 1,
esokic 0:05aad811ea07 67 WriteGeneral = 2,
esokic 0:05aad811ea07 68 WriteAddressed = 3
esokic 0:05aad811ea07 69 };
esokic 0:05aad811ea07 70
esokic 0:05aad811ea07 71 /** Create an I2C Slave interface, connected to the specified pins.
esokic 0:05aad811ea07 72 *
esokic 0:05aad811ea07 73 * @param sda I2C data line pin
esokic 0:05aad811ea07 74 * @param scl I2C clock line pin
esokic 0:05aad811ea07 75 */
esokic 0:05aad811ea07 76 I2CSlave(PinName sda, PinName scl);
esokic 0:05aad811ea07 77
esokic 0:05aad811ea07 78 /** Set the frequency of the I2C interface
esokic 0:05aad811ea07 79 *
esokic 0:05aad811ea07 80 * @param hz The bus frequency in hertz
esokic 0:05aad811ea07 81 */
esokic 0:05aad811ea07 82 void frequency(int hz);
esokic 0:05aad811ea07 83
esokic 0:05aad811ea07 84 /** Checks to see if this I2C Slave has been addressed.
esokic 0:05aad811ea07 85 *
esokic 0:05aad811ea07 86 * @returns
esokic 0:05aad811ea07 87 * A status indicating if the device has been addressed, and how
esokic 0:05aad811ea07 88 * - NoData - the slave has not been addressed
esokic 0:05aad811ea07 89 * - ReadAddressed - the master has requested a read from this slave
esokic 0:05aad811ea07 90 * - WriteAddressed - the master is writing to this slave
esokic 0:05aad811ea07 91 * - WriteGeneral - the master is writing to all slave
esokic 0:05aad811ea07 92 */
esokic 0:05aad811ea07 93 int receive(void);
esokic 0:05aad811ea07 94
esokic 0:05aad811ea07 95 /** Read from an I2C master.
esokic 0:05aad811ea07 96 *
esokic 0:05aad811ea07 97 * @param data pointer to the byte array to read data in to
esokic 0:05aad811ea07 98 * @param length maximum number of bytes to read
esokic 0:05aad811ea07 99 *
esokic 0:05aad811ea07 100 * @returns
esokic 0:05aad811ea07 101 * 0 on success,
esokic 0:05aad811ea07 102 * non-0 otherwise
esokic 0:05aad811ea07 103 */
esokic 0:05aad811ea07 104 int read(char *data, int length);
esokic 0:05aad811ea07 105
esokic 0:05aad811ea07 106 /** Read a single byte from an I2C master.
esokic 0:05aad811ea07 107 *
esokic 0:05aad811ea07 108 * @returns
esokic 0:05aad811ea07 109 * the byte read
esokic 0:05aad811ea07 110 */
esokic 0:05aad811ea07 111 int read(void);
esokic 0:05aad811ea07 112
esokic 0:05aad811ea07 113 /** Write to an I2C master.
esokic 0:05aad811ea07 114 *
esokic 0:05aad811ea07 115 * @param data pointer to the byte array to be transmitted
esokic 0:05aad811ea07 116 * @param length the number of bytes to transmite
esokic 0:05aad811ea07 117 *
esokic 0:05aad811ea07 118 * @returns
esokic 0:05aad811ea07 119 * 0 on success,
esokic 0:05aad811ea07 120 * non-0 otherwise
esokic 0:05aad811ea07 121 */
esokic 0:05aad811ea07 122 int write(const char *data, int length);
esokic 0:05aad811ea07 123
esokic 0:05aad811ea07 124 /** Write a single byte to an I2C master.
esokic 0:05aad811ea07 125 *
esokic 0:05aad811ea07 126 * @data the byte to write
esokic 0:05aad811ea07 127 *
esokic 0:05aad811ea07 128 * @returns
esokic 0:05aad811ea07 129 * '1' if an ACK was received,
esokic 0:05aad811ea07 130 * '0' otherwise
esokic 0:05aad811ea07 131 */
esokic 0:05aad811ea07 132 int write(int data);
esokic 0:05aad811ea07 133
esokic 0:05aad811ea07 134 /** Sets the I2C slave address.
esokic 0:05aad811ea07 135 *
esokic 0:05aad811ea07 136 * @param address The address to set for the slave (ignoring the least
esokic 0:05aad811ea07 137 * signifcant bit). If set to 0, the slave will only respond to the
esokic 0:05aad811ea07 138 * general call address.
esokic 0:05aad811ea07 139 */
esokic 0:05aad811ea07 140 void address(int address);
esokic 0:05aad811ea07 141
esokic 0:05aad811ea07 142 /** Reset the I2C slave back into the known ready receiving state.
esokic 0:05aad811ea07 143 */
esokic 0:05aad811ea07 144 void stop(void);
esokic 0:05aad811ea07 145
esokic 0:05aad811ea07 146 protected:
esokic 0:05aad811ea07 147 i2c_t _i2c;
esokic 0:05aad811ea07 148 };
esokic 0:05aad811ea07 149
esokic 0:05aad811ea07 150 } // namespace mbed
esokic 0:05aad811ea07 151
esokic 0:05aad811ea07 152 #endif
esokic 0:05aad811ea07 153
esokic 0:05aad811ea07 154 #endif