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

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/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 * SPDX-License-Identifier: Apache-2.0
ommpy 0:d383e2dee0f7 4 *
ommpy 0:d383e2dee0f7 5 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 6 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 7 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 8 *
ommpy 0:d383e2dee0f7 9 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 10 *
ommpy 0:d383e2dee0f7 11 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 12 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 14 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 15 * limitations under the License.
ommpy 0:d383e2dee0f7 16 */
ommpy 0:d383e2dee0f7 17 #ifndef MBED_I2C_SLAVE_H
ommpy 0:d383e2dee0f7 18 #define MBED_I2C_SLAVE_H
ommpy 0:d383e2dee0f7 19
ommpy 0:d383e2dee0f7 20 #include "platform/platform.h"
ommpy 0:d383e2dee0f7 21
ommpy 0:d383e2dee0f7 22 #if DEVICE_I2CSLAVE || defined(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 23
ommpy 0:d383e2dee0f7 24 #include "hal/i2c_api.h"
ommpy 0:d383e2dee0f7 25
ommpy 0:d383e2dee0f7 26 namespace mbed {
ommpy 0:d383e2dee0f7 27 /** \addtogroup drivers */
ommpy 0:d383e2dee0f7 28
ommpy 0:d383e2dee0f7 29 /** An I2C Slave, used for communicating with an I2C Master device.
ommpy 0:d383e2dee0f7 30 *
ommpy 0:d383e2dee0f7 31 * @note Synchronization level: Not protected
ommpy 0:d383e2dee0f7 32 *
ommpy 0:d383e2dee0f7 33 * Example Simple I2C responder:
ommpy 0:d383e2dee0f7 34 * @code
ommpy 0:d383e2dee0f7 35 * #include <mbed.h>
ommpy 0:d383e2dee0f7 36 *
ommpy 0:d383e2dee0f7 37 * const int SLAVE_ADDRESS = 0xA0;
ommpy 0:d383e2dee0f7 38 * const char message[] = "Slave!";
ommpy 0:d383e2dee0f7 39 *
ommpy 0:d383e2dee0f7 40 * I2CSlave slave(I2C_SDA, I2C_SCL);
ommpy 0:d383e2dee0f7 41 *
ommpy 0:d383e2dee0f7 42 * int main() {
ommpy 0:d383e2dee0f7 43 * slave.address(SLAVE_ADDRESS);
ommpy 0:d383e2dee0f7 44 * while (1) {
ommpy 0:d383e2dee0f7 45 * int operation = slave.receive();
ommpy 0:d383e2dee0f7 46 * switch (operation) {
ommpy 0:d383e2dee0f7 47 * case I2CSlave::ReadAddressed:
ommpy 0:d383e2dee0f7 48 * int status = slave.write(message, sizeof(message));
ommpy 0:d383e2dee0f7 49 * if (status == 0) {
ommpy 0:d383e2dee0f7 50 * printf("Written message: %s\n", message);
ommpy 0:d383e2dee0f7 51 * } else {
ommpy 0:d383e2dee0f7 52 * printf("Failed to write message.\n");
ommpy 0:d383e2dee0f7 53 * }
ommpy 0:d383e2dee0f7 54 * break;
ommpy 0:d383e2dee0f7 55 * case I2CSlave::WriteGeneral:
ommpy 0:d383e2dee0f7 56 * int byte_read = slave.read();
ommpy 0:d383e2dee0f7 57 * printf("Read General: %c (%d)\n", byte_read, byte_read);
ommpy 0:d383e2dee0f7 58 * break;
ommpy 0:d383e2dee0f7 59 * case I2CSlave::WriteAddressed:
ommpy 0:d383e2dee0f7 60 * int byte_read = slave.read();
ommpy 0:d383e2dee0f7 61 * printf("Read Addressed: %c (%d)\n", byte_read, byte_read);
ommpy 0:d383e2dee0f7 62 * break;
ommpy 0:d383e2dee0f7 63 * }
ommpy 0:d383e2dee0f7 64 * }
ommpy 0:d383e2dee0f7 65 * }
ommpy 0:d383e2dee0f7 66 * @endcode
ommpy 0:d383e2dee0f7 67 * @ingroup drivers
ommpy 0:d383e2dee0f7 68 */
ommpy 0:d383e2dee0f7 69 class I2CSlave {
ommpy 0:d383e2dee0f7 70
ommpy 0:d383e2dee0f7 71 public:
ommpy 0:d383e2dee0f7 72 enum RxStatus {
ommpy 0:d383e2dee0f7 73 NoData = 0,
ommpy 0:d383e2dee0f7 74 ReadAddressed = 1,
ommpy 0:d383e2dee0f7 75 WriteGeneral = 2,
ommpy 0:d383e2dee0f7 76 WriteAddressed = 3
ommpy 0:d383e2dee0f7 77 };
ommpy 0:d383e2dee0f7 78
ommpy 0:d383e2dee0f7 79 /** Create an I2C Slave interface, connected to the specified pins.
ommpy 0:d383e2dee0f7 80 *
ommpy 0:d383e2dee0f7 81 * @param sda I2C data line pin.
ommpy 0:d383e2dee0f7 82 * @param scl I2C clock line pin.
ommpy 0:d383e2dee0f7 83 */
ommpy 0:d383e2dee0f7 84 I2CSlave(PinName sda, PinName scl);
ommpy 0:d383e2dee0f7 85
ommpy 0:d383e2dee0f7 86 /** Set the frequency of the I2C interface.
ommpy 0:d383e2dee0f7 87 *
ommpy 0:d383e2dee0f7 88 * @param hz The bus frequency in Hertz.
ommpy 0:d383e2dee0f7 89 */
ommpy 0:d383e2dee0f7 90 void frequency(int hz);
ommpy 0:d383e2dee0f7 91
ommpy 0:d383e2dee0f7 92 /** Check if this I2C Slave has been addressed.
ommpy 0:d383e2dee0f7 93 *
ommpy 0:d383e2dee0f7 94 * @return A status indicating if the device has been addressed and how.
ommpy 0:d383e2dee0f7 95 * @retval NoData The slave has not been addressed.
ommpy 0:d383e2dee0f7 96 * @retval ReadAddressed The master has requested a read from this slave.
ommpy 0:d383e2dee0f7 97 * @retval WriteAddressed The master is writing to this slave.
ommpy 0:d383e2dee0f7 98 * @retval WriteGeneral The master is writing to all slave.
ommpy 0:d383e2dee0f7 99 */
ommpy 0:d383e2dee0f7 100 int receive(void);
ommpy 0:d383e2dee0f7 101
ommpy 0:d383e2dee0f7 102 /** Read specified number of bytes from an I2C master.
ommpy 0:d383e2dee0f7 103 *
ommpy 0:d383e2dee0f7 104 * @param data Pointer to the buffer to read data into.
ommpy 0:d383e2dee0f7 105 * @param length Number of bytes to read.
ommpy 0:d383e2dee0f7 106 *
ommpy 0:d383e2dee0f7 107 * @return Result of the operation.
ommpy 0:d383e2dee0f7 108 * @retval 0 If the number of bytes read is equal to length requested.
ommpy 0:d383e2dee0f7 109 * @retval nonzero On error or if the number of bytes read is less than requested.
ommpy 0:d383e2dee0f7 110 */
ommpy 0:d383e2dee0f7 111 int read(char *data, int length);
ommpy 0:d383e2dee0f7 112
ommpy 0:d383e2dee0f7 113 /** Read a single byte from an I2C master.
ommpy 0:d383e2dee0f7 114 *
ommpy 0:d383e2dee0f7 115 * @return The byte read.
ommpy 0:d383e2dee0f7 116 */
ommpy 0:d383e2dee0f7 117 int read(void);
ommpy 0:d383e2dee0f7 118
ommpy 0:d383e2dee0f7 119 /** Write to an I2C master.
ommpy 0:d383e2dee0f7 120 *
ommpy 0:d383e2dee0f7 121 * @param data Pointer to the buffer containing the data to be sent.
ommpy 0:d383e2dee0f7 122 * @param length Number of bytes to send.
ommpy 0:d383e2dee0f7 123 *
ommpy 0:d383e2dee0f7 124 * @return
ommpy 0:d383e2dee0f7 125 * @retval 0 If written all bytes successfully.
ommpy 0:d383e2dee0f7 126 * @retval nonzero On error or if the number of bytes written is less than requested.
ommpy 0:d383e2dee0f7 127 */
ommpy 0:d383e2dee0f7 128 int write(const char *data, int length);
ommpy 0:d383e2dee0f7 129
ommpy 0:d383e2dee0f7 130 /** Write a single byte to an I2C master.
ommpy 0:d383e2dee0f7 131 *
ommpy 0:d383e2dee0f7 132 * @param data Value to write.
ommpy 0:d383e2dee0f7 133 *
ommpy 0:d383e2dee0f7 134 * @return Result of the operation.
ommpy 0:d383e2dee0f7 135 * @retval 0 If a NACK is received.
ommpy 0:d383e2dee0f7 136 * @retval 1 If an ACK is received.
ommpy 0:d383e2dee0f7 137 * @retval 2 On timeout.
ommpy 0:d383e2dee0f7 138 */
ommpy 0:d383e2dee0f7 139 int write(int data);
ommpy 0:d383e2dee0f7 140
ommpy 0:d383e2dee0f7 141 /** Set the I2C slave address.
ommpy 0:d383e2dee0f7 142 *
ommpy 0:d383e2dee0f7 143 * @param address The address to set for the slave (least significant bit is ignored).
ommpy 0:d383e2dee0f7 144 *
ommpy 0:d383e2dee0f7 145 * @note If address is set to 0, the slave will only respond to the
ommpy 0:d383e2dee0f7 146 * general call address.
ommpy 0:d383e2dee0f7 147 */
ommpy 0:d383e2dee0f7 148 void address(int address);
ommpy 0:d383e2dee0f7 149
ommpy 0:d383e2dee0f7 150 /** Reset the I2C slave back into the known ready receiving state.
ommpy 0:d383e2dee0f7 151 */
ommpy 0:d383e2dee0f7 152 void stop(void);
ommpy 0:d383e2dee0f7 153
ommpy 0:d383e2dee0f7 154 #if !defined(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 155
ommpy 0:d383e2dee0f7 156 protected:
ommpy 0:d383e2dee0f7 157 /* Internal i2c object identifying the resources */
ommpy 0:d383e2dee0f7 158 i2c_t _i2c;
ommpy 0:d383e2dee0f7 159
ommpy 0:d383e2dee0f7 160 #endif //!defined(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 161 };
ommpy 0:d383e2dee0f7 162
ommpy 0:d383e2dee0f7 163 } // namespace mbed
ommpy 0:d383e2dee0f7 164
ommpy 0:d383e2dee0f7 165 #endif
ommpy 0:d383e2dee0f7 166
ommpy 0:d383e2dee0f7 167 #endif