Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/I2CSlave.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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