BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

mbed-os/drivers/I2CSlave.h@1:9c5af431a1f1, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:47:08 2018 +0000
Revision:
1:9c5af431a1f1
sdf

Who changed what in which revision?

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