Kenji Arai / mbed-os_TYBLE16

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.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/I2CSlave.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2006-2019 ARM Limited
kenjiArai 0:5b88d5760320 3 * SPDX-License-Identifier: Apache-2.0
kenjiArai 0:5b88d5760320 4 *
kenjiArai 0:5b88d5760320 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 6 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 7 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 8 *
kenjiArai 0:5b88d5760320 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 14 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 15 * limitations under the License.
kenjiArai 0:5b88d5760320 16 */
kenjiArai 0:5b88d5760320 17 #ifndef MBED_I2C_SLAVE_H
kenjiArai 0:5b88d5760320 18 #define MBED_I2C_SLAVE_H
kenjiArai 0:5b88d5760320 19
kenjiArai 0:5b88d5760320 20 #include "platform/platform.h"
kenjiArai 0:5b88d5760320 21
kenjiArai 0:5b88d5760320 22 #if DEVICE_I2CSLAVE || defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 23
kenjiArai 0:5b88d5760320 24 #include "hal/i2c_api.h"
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26 namespace mbed {
kenjiArai 1:9db0e321a9f4 27 /**
kenjiArai 1:9db0e321a9f4 28 * \defgroup drivers_I2CSlave I2CSlave class
kenjiArai 1:9db0e321a9f4 29 * \ingroup drivers-public-api-i2c
kenjiArai 1:9db0e321a9f4 30 * @{
kenjiArai 1:9db0e321a9f4 31 */
kenjiArai 0:5b88d5760320 32
kenjiArai 0:5b88d5760320 33 /** An I2C Slave, used for communicating with an I2C Master device.
kenjiArai 0:5b88d5760320 34 *
kenjiArai 0:5b88d5760320 35 * @note Synchronization level: Not protected
kenjiArai 0:5b88d5760320 36 *
kenjiArai 0:5b88d5760320 37 * Example Simple I2C responder:
kenjiArai 0:5b88d5760320 38 * @code
kenjiArai 0:5b88d5760320 39 * #include <mbed.h>
kenjiArai 0:5b88d5760320 40 *
kenjiArai 0:5b88d5760320 41 * const int SLAVE_ADDRESS = 0xA0;
kenjiArai 0:5b88d5760320 42 * const char message[] = "Slave!";
kenjiArai 0:5b88d5760320 43 *
kenjiArai 0:5b88d5760320 44 * I2CSlave slave(I2C_SDA, I2C_SCL);
kenjiArai 0:5b88d5760320 45 *
kenjiArai 0:5b88d5760320 46 * int main() {
kenjiArai 0:5b88d5760320 47 * slave.address(SLAVE_ADDRESS);
kenjiArai 0:5b88d5760320 48 * while (1) {
kenjiArai 0:5b88d5760320 49 * int operation = slave.receive();
kenjiArai 0:5b88d5760320 50 * switch (operation) {
kenjiArai 0:5b88d5760320 51 * case I2CSlave::ReadAddressed:
kenjiArai 0:5b88d5760320 52 * int status = slave.write(message, sizeof(message));
kenjiArai 0:5b88d5760320 53 * if (status == 0) {
kenjiArai 0:5b88d5760320 54 * printf("Written message: %s\n", message);
kenjiArai 0:5b88d5760320 55 * } else {
kenjiArai 0:5b88d5760320 56 * printf("Failed to write message.\n");
kenjiArai 0:5b88d5760320 57 * }
kenjiArai 0:5b88d5760320 58 * break;
kenjiArai 0:5b88d5760320 59 * case I2CSlave::WriteGeneral:
kenjiArai 0:5b88d5760320 60 * int byte_read = slave.read();
kenjiArai 0:5b88d5760320 61 * printf("Read General: %c (%d)\n", byte_read, byte_read);
kenjiArai 0:5b88d5760320 62 * break;
kenjiArai 0:5b88d5760320 63 * case I2CSlave::WriteAddressed:
kenjiArai 0:5b88d5760320 64 * int byte_read = slave.read();
kenjiArai 0:5b88d5760320 65 * printf("Read Addressed: %c (%d)\n", byte_read, byte_read);
kenjiArai 0:5b88d5760320 66 * break;
kenjiArai 0:5b88d5760320 67 * }
kenjiArai 0:5b88d5760320 68 * }
kenjiArai 0:5b88d5760320 69 * }
kenjiArai 0:5b88d5760320 70 * @endcode
kenjiArai 0:5b88d5760320 71 */
kenjiArai 0:5b88d5760320 72 class I2CSlave {
kenjiArai 0:5b88d5760320 73
kenjiArai 0:5b88d5760320 74 public:
kenjiArai 0:5b88d5760320 75 enum RxStatus {
kenjiArai 0:5b88d5760320 76 NoData = 0,
kenjiArai 0:5b88d5760320 77 ReadAddressed = 1,
kenjiArai 0:5b88d5760320 78 WriteGeneral = 2,
kenjiArai 0:5b88d5760320 79 WriteAddressed = 3
kenjiArai 0:5b88d5760320 80 };
kenjiArai 0:5b88d5760320 81
kenjiArai 0:5b88d5760320 82 /** Create an I2C Slave interface, connected to the specified pins.
kenjiArai 0:5b88d5760320 83 *
kenjiArai 0:5b88d5760320 84 * @param sda I2C data line pin.
kenjiArai 0:5b88d5760320 85 * @param scl I2C clock line pin.
kenjiArai 0:5b88d5760320 86 */
kenjiArai 0:5b88d5760320 87 I2CSlave(PinName sda, PinName scl);
kenjiArai 0:5b88d5760320 88
kenjiArai 1:9db0e321a9f4 89 /** Create an I2C Slave interface, connected to the specified pins.
kenjiArai 1:9db0e321a9f4 90 *
kenjiArai 1:9db0e321a9f4 91 * @param static_pinmap reference to structure which holds static pinmap.
kenjiArai 1:9db0e321a9f4 92 */
kenjiArai 1:9db0e321a9f4 93 I2CSlave(const i2c_pinmap_t &static_pinmap);
kenjiArai 1:9db0e321a9f4 94 I2CSlave(const i2c_pinmap_t &&) = delete; // prevent passing of temporary objects
kenjiArai 1:9db0e321a9f4 95
kenjiArai 0:5b88d5760320 96 /** Set the frequency of the I2C interface.
kenjiArai 0:5b88d5760320 97 *
kenjiArai 0:5b88d5760320 98 * @param hz The bus frequency in Hertz.
kenjiArai 0:5b88d5760320 99 */
kenjiArai 0:5b88d5760320 100 void frequency(int hz);
kenjiArai 0:5b88d5760320 101
kenjiArai 0:5b88d5760320 102 /** Check if this I2C Slave has been addressed.
kenjiArai 0:5b88d5760320 103 *
kenjiArai 0:5b88d5760320 104 * @return A status indicating if the device has been addressed and how.
kenjiArai 0:5b88d5760320 105 * @retval NoData The slave has not been addressed.
kenjiArai 0:5b88d5760320 106 * @retval ReadAddressed The master has requested a read from this slave.
kenjiArai 0:5b88d5760320 107 * @retval WriteAddressed The master is writing to this slave.
kenjiArai 0:5b88d5760320 108 * @retval WriteGeneral The master is writing to all slave.
kenjiArai 0:5b88d5760320 109 */
kenjiArai 0:5b88d5760320 110 int receive(void);
kenjiArai 0:5b88d5760320 111
kenjiArai 0:5b88d5760320 112 /** Read specified number of bytes from an I2C master.
kenjiArai 0:5b88d5760320 113 *
kenjiArai 0:5b88d5760320 114 * @param data Pointer to the buffer to read data into.
kenjiArai 0:5b88d5760320 115 * @param length Number of bytes to read.
kenjiArai 0:5b88d5760320 116 *
kenjiArai 0:5b88d5760320 117 * @return Result of the operation.
kenjiArai 0:5b88d5760320 118 * @retval 0 If the number of bytes read is equal to length requested.
kenjiArai 0:5b88d5760320 119 * @retval nonzero On error or if the number of bytes read is less than requested.
kenjiArai 0:5b88d5760320 120 */
kenjiArai 0:5b88d5760320 121 int read(char *data, int length);
kenjiArai 0:5b88d5760320 122
kenjiArai 0:5b88d5760320 123 /** Read a single byte from an I2C master.
kenjiArai 0:5b88d5760320 124 *
kenjiArai 0:5b88d5760320 125 * @return The byte read.
kenjiArai 0:5b88d5760320 126 */
kenjiArai 0:5b88d5760320 127 int read(void);
kenjiArai 0:5b88d5760320 128
kenjiArai 0:5b88d5760320 129 /** Write to an I2C master.
kenjiArai 0:5b88d5760320 130 *
kenjiArai 0:5b88d5760320 131 * @param data Pointer to the buffer containing the data to be sent.
kenjiArai 0:5b88d5760320 132 * @param length Number of bytes to send.
kenjiArai 0:5b88d5760320 133 *
kenjiArai 0:5b88d5760320 134 * @return
kenjiArai 0:5b88d5760320 135 * @retval 0 If written all bytes successfully.
kenjiArai 0:5b88d5760320 136 * @retval nonzero On error or if the number of bytes written is less than requested.
kenjiArai 0:5b88d5760320 137 */
kenjiArai 0:5b88d5760320 138 int write(const char *data, int length);
kenjiArai 0:5b88d5760320 139
kenjiArai 0:5b88d5760320 140 /** Write a single byte to an I2C master.
kenjiArai 0:5b88d5760320 141 *
kenjiArai 0:5b88d5760320 142 * @param data Value to write.
kenjiArai 0:5b88d5760320 143 *
kenjiArai 0:5b88d5760320 144 * @return Result of the operation.
kenjiArai 0:5b88d5760320 145 * @retval 0 If a NACK is received.
kenjiArai 0:5b88d5760320 146 * @retval 1 If an ACK is received.
kenjiArai 0:5b88d5760320 147 * @retval 2 On timeout.
kenjiArai 0:5b88d5760320 148 */
kenjiArai 0:5b88d5760320 149 int write(int data);
kenjiArai 0:5b88d5760320 150
kenjiArai 0:5b88d5760320 151 /** Set the I2C slave address.
kenjiArai 0:5b88d5760320 152 *
kenjiArai 0:5b88d5760320 153 * @param address The address to set for the slave (least significant bit is ignored).
kenjiArai 0:5b88d5760320 154 *
kenjiArai 0:5b88d5760320 155 * @note If address is set to 0, the slave will only respond to the
kenjiArai 0:5b88d5760320 156 * general call address.
kenjiArai 0:5b88d5760320 157 */
kenjiArai 0:5b88d5760320 158 void address(int address);
kenjiArai 0:5b88d5760320 159
kenjiArai 0:5b88d5760320 160 /** Reset the I2C slave back into the known ready receiving state.
kenjiArai 0:5b88d5760320 161 */
kenjiArai 0:5b88d5760320 162 void stop(void);
kenjiArai 0:5b88d5760320 163
kenjiArai 0:5b88d5760320 164 #if !defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 165
kenjiArai 0:5b88d5760320 166 protected:
kenjiArai 0:5b88d5760320 167 /* Internal i2c object identifying the resources */
kenjiArai 0:5b88d5760320 168 i2c_t _i2c;
kenjiArai 0:5b88d5760320 169
kenjiArai 0:5b88d5760320 170 #endif //!defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 171 };
kenjiArai 0:5b88d5760320 172
kenjiArai 1:9db0e321a9f4 173 /** @}*/
kenjiArai 1:9db0e321a9f4 174
kenjiArai 0:5b88d5760320 175 } // namespace mbed
kenjiArai 0:5b88d5760320 176
kenjiArai 0:5b88d5760320 177 #endif
kenjiArai 0:5b88d5760320 178
kenjiArai 0:5b88d5760320 179 #endif