Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/I2CSlave.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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