cc y / mbed

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 mbed by mbed official

drivers/I2CSlave.h@128:9bcdf88f62b0, 2016-10-27 (annotated)

Committer:
<>
Date:
Thu Oct 27 16:45:56 2016 +0100
Revision:
128:9bcdf88f62b0
Release 128 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



2966: Add kw24 support https://github.com/ARMmbed/mbed-os/pull/2966

3068: MultiTech mDot - clean up PeripheralPins.c and add new pin names https://github.com/ARMmbed/mbed-os/pull/3068

3089: Kinetis HAL: Remove clock initialization code from serial and ticker  https://github.com/ARMmbed/mbed-os/pull/3089

2943: [NRF5] NVIC_SetVector functionality https://github.com/ARMmbed/mbed-os/pull/2943

2938: InterruptIn changes in NCS36510 HAL. https://github.com/ARMmbed/mbed-os/pull/2938

3108: Fix sleep function for NRF52. https://github.com/ARMmbed/mbed-os/pull/3108

3076: STM32F1: Correct timer master value reading https://github.com/ARMmbed/mbed-os/pull/3076

3085: Add LOWPOWERTIMER capability for NUCLEO_F303ZE https://github.com/ARMmbed/mbed-os/pull/3085

3046: [BEETLE] Update BLE stack on Beetle board https://github.com/ARMmbed/mbed-os/pull/3046

3122: [Silicon Labs] Update of Silicon Labs HAL https://github.com/ARMmbed/mbed-os/pull/3122

3022: OnSemi RAM usage fix https://github.com/ARMmbed/mbed-os/pull/3022

3121: STM32F3: Correct UART4 and UART5 defines when using DEVICE_SERIAL_ASYNCH https://github.com/ARMmbed/mbed-os/pull/3121

3142: Targets- NUMAKER_PFM_NUC47216 remove mbed 2 https://github.com/ARMmbed/mbed-os/pull/3142

Who changed what in which revision?

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