Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/I2CSlave.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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