Manh Pham / Mbed OS Nucleo_rtos_basic_ir_controller

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:c8673aa96267, 2018-04-07 (annotated)

Committer:
manhpham
Date:
Sat Apr 07 09:22:54 2018 +0000
Revision:
0:c8673aa96267
Nucleo_rtos_basic_ir_controller

Who changed what in which revision?

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