PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/drivers/I2CSlave.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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