mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/I2CSlave.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
156:ff21514d8981
Child:
171:3a7713b1edbc
mbed library. Release version 162

Who changed what in which revision?

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