Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/I2CSlave.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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