Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/I2CSlave.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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