Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/I2CSlave.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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