Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

drivers/I2CSlave.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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