PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/I2CSlave.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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