mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

I2CSlave.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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