takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/I2CSlave.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

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