Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/i2c_api.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
mohamedmoawya 0:e4c5e6ec922e 2 /** \addtogroup hal */
mohamedmoawya 0:e4c5e6ec922e 3 /** @{*/
mohamedmoawya 0:e4c5e6ec922e 4 /* mbed Microcontroller Library
mohamedmoawya 0:e4c5e6ec922e 5 * Copyright (c) 2006-2015 ARM Limited
mohamedmoawya 0:e4c5e6ec922e 6 *
mohamedmoawya 0:e4c5e6ec922e 7 * Licensed under the Apache License, Version 2.0 (the "License");
mohamedmoawya 0:e4c5e6ec922e 8 * you may not use this file except in compliance with the License.
mohamedmoawya 0:e4c5e6ec922e 9 * You may obtain a copy of the License at
mohamedmoawya 0:e4c5e6ec922e 10 *
mohamedmoawya 0:e4c5e6ec922e 11 * http://www.apache.org/licenses/LICENSE-2.0
mohamedmoawya 0:e4c5e6ec922e 12 *
mohamedmoawya 0:e4c5e6ec922e 13 * Unless required by applicable law or agreed to in writing, software
mohamedmoawya 0:e4c5e6ec922e 14 * distributed under the License is distributed on an "AS IS" BASIS,
mohamedmoawya 0:e4c5e6ec922e 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mohamedmoawya 0:e4c5e6ec922e 16 * See the License for the specific language governing permissions and
mohamedmoawya 0:e4c5e6ec922e 17 * limitations under the License.
mohamedmoawya 0:e4c5e6ec922e 18 */
mohamedmoawya 0:e4c5e6ec922e 19 #ifndef MBED_I2C_API_H
mohamedmoawya 0:e4c5e6ec922e 20 #define MBED_I2C_API_H
mohamedmoawya 0:e4c5e6ec922e 21
mohamedmoawya 0:e4c5e6ec922e 22 #include "device.h"
mohamedmoawya 0:e4c5e6ec922e 23 #include "hal/buffer.h"
mohamedmoawya 0:e4c5e6ec922e 24
mohamedmoawya 0:e4c5e6ec922e 25 #if DEVICE_I2C_ASYNCH
mohamedmoawya 0:e4c5e6ec922e 26 #include "hal/dma_api.h"
mohamedmoawya 0:e4c5e6ec922e 27 #endif
mohamedmoawya 0:e4c5e6ec922e 28
mohamedmoawya 0:e4c5e6ec922e 29 #if DEVICE_I2C
mohamedmoawya 0:e4c5e6ec922e 30
mohamedmoawya 0:e4c5e6ec922e 31 /**
mohamedmoawya 0:e4c5e6ec922e 32 * @defgroup hal_I2CEvents I2C Events Macros
mohamedmoawya 0:e4c5e6ec922e 33 *
mohamedmoawya 0:e4c5e6ec922e 34 * @{
mohamedmoawya 0:e4c5e6ec922e 35 */
mohamedmoawya 0:e4c5e6ec922e 36 #define I2C_EVENT_ERROR (1 << 1)
mohamedmoawya 0:e4c5e6ec922e 37 #define I2C_EVENT_ERROR_NO_SLAVE (1 << 2)
mohamedmoawya 0:e4c5e6ec922e 38 #define I2C_EVENT_TRANSFER_COMPLETE (1 << 3)
mohamedmoawya 0:e4c5e6ec922e 39 #define I2C_EVENT_TRANSFER_EARLY_NACK (1 << 4)
mohamedmoawya 0:e4c5e6ec922e 40 #define I2C_EVENT_ALL (I2C_EVENT_ERROR | I2C_EVENT_TRANSFER_COMPLETE | I2C_EVENT_ERROR_NO_SLAVE | I2C_EVENT_TRANSFER_EARLY_NACK)
mohamedmoawya 0:e4c5e6ec922e 41
mohamedmoawya 0:e4c5e6ec922e 42 /**@}*/
mohamedmoawya 0:e4c5e6ec922e 43
mohamedmoawya 0:e4c5e6ec922e 44 #if DEVICE_I2C_ASYNCH
mohamedmoawya 0:e4c5e6ec922e 45 /** Asynch I2C HAL structure
mohamedmoawya 0:e4c5e6ec922e 46 */
mohamedmoawya 0:e4c5e6ec922e 47 typedef struct {
mohamedmoawya 0:e4c5e6ec922e 48 struct i2c_s i2c; /**< Target specific I2C structure */
mohamedmoawya 0:e4c5e6ec922e 49 struct buffer_s tx_buff; /**< Tx buffer */
mohamedmoawya 0:e4c5e6ec922e 50 struct buffer_s rx_buff; /**< Rx buffer */
mohamedmoawya 0:e4c5e6ec922e 51 } i2c_t;
mohamedmoawya 0:e4c5e6ec922e 52
mohamedmoawya 0:e4c5e6ec922e 53 #else
mohamedmoawya 0:e4c5e6ec922e 54 /** Non-asynch I2C HAL structure
mohamedmoawya 0:e4c5e6ec922e 55 */
mohamedmoawya 0:e4c5e6ec922e 56 typedef struct i2c_s i2c_t;
mohamedmoawya 0:e4c5e6ec922e 57
mohamedmoawya 0:e4c5e6ec922e 58 #endif
mohamedmoawya 0:e4c5e6ec922e 59
mohamedmoawya 0:e4c5e6ec922e 60 enum {
mohamedmoawya 0:e4c5e6ec922e 61 I2C_ERROR_NO_SLAVE = -1,
mohamedmoawya 0:e4c5e6ec922e 62 I2C_ERROR_BUS_BUSY = -2
mohamedmoawya 0:e4c5e6ec922e 63 };
mohamedmoawya 0:e4c5e6ec922e 64
mohamedmoawya 0:e4c5e6ec922e 65 #ifdef __cplusplus
mohamedmoawya 0:e4c5e6ec922e 66 extern "C" {
mohamedmoawya 0:e4c5e6ec922e 67 #endif
mohamedmoawya 0:e4c5e6ec922e 68
mohamedmoawya 0:e4c5e6ec922e 69 /**
mohamedmoawya 0:e4c5e6ec922e 70 * \defgroup hal_GeneralI2C I2C Configuration Functions
mohamedmoawya 0:e4c5e6ec922e 71 * @{
mohamedmoawya 0:e4c5e6ec922e 72 */
mohamedmoawya 0:e4c5e6ec922e 73
mohamedmoawya 0:e4c5e6ec922e 74 /** Initialize the I2C peripheral. It sets the default parameters for I2C
mohamedmoawya 0:e4c5e6ec922e 75 * peripheral, and configures its specifieds pins.
mohamedmoawya 0:e4c5e6ec922e 76 *
mohamedmoawya 0:e4c5e6ec922e 77 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 78 * @param sda The sda pin
mohamedmoawya 0:e4c5e6ec922e 79 * @param scl The scl pin
mohamedmoawya 0:e4c5e6ec922e 80 */
mohamedmoawya 0:e4c5e6ec922e 81 void i2c_init(i2c_t *obj, PinName sda, PinName scl);
mohamedmoawya 0:e4c5e6ec922e 82
mohamedmoawya 0:e4c5e6ec922e 83 /** Configure the I2C frequency
mohamedmoawya 0:e4c5e6ec922e 84 *
mohamedmoawya 0:e4c5e6ec922e 85 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 86 * @param hz Frequency in Hz
mohamedmoawya 0:e4c5e6ec922e 87 */
mohamedmoawya 0:e4c5e6ec922e 88 void i2c_frequency(i2c_t *obj, int hz);
mohamedmoawya 0:e4c5e6ec922e 89
mohamedmoawya 0:e4c5e6ec922e 90 /** Send START command
mohamedmoawya 0:e4c5e6ec922e 91 *
mohamedmoawya 0:e4c5e6ec922e 92 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 93 */
mohamedmoawya 0:e4c5e6ec922e 94 int i2c_start(i2c_t *obj);
mohamedmoawya 0:e4c5e6ec922e 95
mohamedmoawya 0:e4c5e6ec922e 96 /** Send STOP command
mohamedmoawya 0:e4c5e6ec922e 97 *
mohamedmoawya 0:e4c5e6ec922e 98 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 99 */
mohamedmoawya 0:e4c5e6ec922e 100 int i2c_stop(i2c_t *obj);
mohamedmoawya 0:e4c5e6ec922e 101
mohamedmoawya 0:e4c5e6ec922e 102 /** Blocking reading data
mohamedmoawya 0:e4c5e6ec922e 103 *
mohamedmoawya 0:e4c5e6ec922e 104 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 105 * @param address 7-bit address (last bit is 1)
mohamedmoawya 0:e4c5e6ec922e 106 * @param data The buffer for receiving
mohamedmoawya 0:e4c5e6ec922e 107 * @param length Number of bytes to read
mohamedmoawya 0:e4c5e6ec922e 108 * @param stop Stop to be generated after the transfer is done
mohamedmoawya 0:e4c5e6ec922e 109 * @return Number of read bytes
mohamedmoawya 0:e4c5e6ec922e 110 */
mohamedmoawya 0:e4c5e6ec922e 111 int i2c_read(i2c_t *obj, int address, char *data, int length, int stop);
mohamedmoawya 0:e4c5e6ec922e 112
mohamedmoawya 0:e4c5e6ec922e 113 /** Blocking sending data
mohamedmoawya 0:e4c5e6ec922e 114 *
mohamedmoawya 0:e4c5e6ec922e 115 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 116 * @param address 7-bit address (last bit is 0)
mohamedmoawya 0:e4c5e6ec922e 117 * @param data The buffer for sending
mohamedmoawya 0:e4c5e6ec922e 118 * @param length Number of bytes to write
mohamedmoawya 0:e4c5e6ec922e 119 * @param stop Stop to be generated after the transfer is done
mohamedmoawya 0:e4c5e6ec922e 120 * @return
mohamedmoawya 0:e4c5e6ec922e 121 * zero or non-zero - Number of written bytes
mohamedmoawya 0:e4c5e6ec922e 122 * negative - I2C_ERROR_XXX status
mohamedmoawya 0:e4c5e6ec922e 123 */
mohamedmoawya 0:e4c5e6ec922e 124 int i2c_write(i2c_t *obj, int address, const char *data, int length, int stop);
mohamedmoawya 0:e4c5e6ec922e 125
mohamedmoawya 0:e4c5e6ec922e 126 /** Reset I2C peripheral. TODO: The action here. Most of the implementation sends stop()
mohamedmoawya 0:e4c5e6ec922e 127 *
mohamedmoawya 0:e4c5e6ec922e 128 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 129 */
mohamedmoawya 0:e4c5e6ec922e 130 void i2c_reset(i2c_t *obj);
mohamedmoawya 0:e4c5e6ec922e 131
mohamedmoawya 0:e4c5e6ec922e 132 /** Read one byte
mohamedmoawya 0:e4c5e6ec922e 133 *
mohamedmoawya 0:e4c5e6ec922e 134 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 135 * @param last Acknoledge
mohamedmoawya 0:e4c5e6ec922e 136 * @return The read byte
mohamedmoawya 0:e4c5e6ec922e 137 */
mohamedmoawya 0:e4c5e6ec922e 138 int i2c_byte_read(i2c_t *obj, int last);
mohamedmoawya 0:e4c5e6ec922e 139
mohamedmoawya 0:e4c5e6ec922e 140 /** Write one byte
mohamedmoawya 0:e4c5e6ec922e 141 *
mohamedmoawya 0:e4c5e6ec922e 142 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 143 * @param data Byte to be written
mohamedmoawya 0:e4c5e6ec922e 144 * @return 0 if NAK was received, 1 if ACK was received, 2 for timeout.
mohamedmoawya 0:e4c5e6ec922e 145 */
mohamedmoawya 0:e4c5e6ec922e 146 int i2c_byte_write(i2c_t *obj, int data);
mohamedmoawya 0:e4c5e6ec922e 147
mohamedmoawya 0:e4c5e6ec922e 148 /**@}*/
mohamedmoawya 0:e4c5e6ec922e 149
mohamedmoawya 0:e4c5e6ec922e 150 #if DEVICE_I2CSLAVE
mohamedmoawya 0:e4c5e6ec922e 151
mohamedmoawya 0:e4c5e6ec922e 152 /**
mohamedmoawya 0:e4c5e6ec922e 153 * \defgroup SynchI2C Synchronous I2C Hardware Abstraction Layer for slave
mohamedmoawya 0:e4c5e6ec922e 154 * @{
mohamedmoawya 0:e4c5e6ec922e 155 */
mohamedmoawya 0:e4c5e6ec922e 156
mohamedmoawya 0:e4c5e6ec922e 157 /** Configure I2C as slave or master.
mohamedmoawya 0:e4c5e6ec922e 158 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 159 * @param enable_slave Enable i2c hardware so you can receive events with ::i2c_slave_receive
mohamedmoawya 0:e4c5e6ec922e 160 * @return non-zero if a value is available
mohamedmoawya 0:e4c5e6ec922e 161 */
mohamedmoawya 0:e4c5e6ec922e 162 void i2c_slave_mode(i2c_t *obj, int enable_slave);
mohamedmoawya 0:e4c5e6ec922e 163
mohamedmoawya 0:e4c5e6ec922e 164 /** Check to see if the I2C slave has been addressed.
mohamedmoawya 0:e4c5e6ec922e 165 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 166 * @return The status - 1 - read addresses, 2 - write to all slaves,
mohamedmoawya 0:e4c5e6ec922e 167 * 3 write addressed, 0 - the slave has not been addressed
mohamedmoawya 0:e4c5e6ec922e 168 */
mohamedmoawya 0:e4c5e6ec922e 169 int i2c_slave_receive(i2c_t *obj);
mohamedmoawya 0:e4c5e6ec922e 170
mohamedmoawya 0:e4c5e6ec922e 171 /** Configure I2C as slave or master.
mohamedmoawya 0:e4c5e6ec922e 172 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 173 * @param data The buffer for receiving
mohamedmoawya 0:e4c5e6ec922e 174 * @param length Number of bytes to read
mohamedmoawya 0:e4c5e6ec922e 175 * @return non-zero if a value is available
mohamedmoawya 0:e4c5e6ec922e 176 */
mohamedmoawya 0:e4c5e6ec922e 177 int i2c_slave_read(i2c_t *obj, char *data, int length);
mohamedmoawya 0:e4c5e6ec922e 178
mohamedmoawya 0:e4c5e6ec922e 179 /** Configure I2C as slave or master.
mohamedmoawya 0:e4c5e6ec922e 180 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 181 * @param data The buffer for sending
mohamedmoawya 0:e4c5e6ec922e 182 * @param length Number of bytes to write
mohamedmoawya 0:e4c5e6ec922e 183 * @return non-zero if a value is available
mohamedmoawya 0:e4c5e6ec922e 184 */
mohamedmoawya 0:e4c5e6ec922e 185 int i2c_slave_write(i2c_t *obj, const char *data, int length);
mohamedmoawya 0:e4c5e6ec922e 186
mohamedmoawya 0:e4c5e6ec922e 187 /** Configure I2C address.
mohamedmoawya 0:e4c5e6ec922e 188 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 189 * @param idx Currently not used
mohamedmoawya 0:e4c5e6ec922e 190 * @param address The address to be set
mohamedmoawya 0:e4c5e6ec922e 191 * @param mask Currently not used
mohamedmoawya 0:e4c5e6ec922e 192 */
mohamedmoawya 0:e4c5e6ec922e 193 void i2c_slave_address(i2c_t *obj, int idx, uint32_t address, uint32_t mask);
mohamedmoawya 0:e4c5e6ec922e 194
mohamedmoawya 0:e4c5e6ec922e 195 #endif
mohamedmoawya 0:e4c5e6ec922e 196
mohamedmoawya 0:e4c5e6ec922e 197 /**@}*/
mohamedmoawya 0:e4c5e6ec922e 198
mohamedmoawya 0:e4c5e6ec922e 199 #if DEVICE_I2C_ASYNCH
mohamedmoawya 0:e4c5e6ec922e 200
mohamedmoawya 0:e4c5e6ec922e 201 /**
mohamedmoawya 0:e4c5e6ec922e 202 * \defgroup hal_AsynchI2C Asynchronous I2C Hardware Abstraction Layer
mohamedmoawya 0:e4c5e6ec922e 203 * @{
mohamedmoawya 0:e4c5e6ec922e 204 */
mohamedmoawya 0:e4c5e6ec922e 205
mohamedmoawya 0:e4c5e6ec922e 206 /** Start I2C asynchronous transfer
mohamedmoawya 0:e4c5e6ec922e 207 *
mohamedmoawya 0:e4c5e6ec922e 208 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 209 * @param tx The transmit buffer
mohamedmoawya 0:e4c5e6ec922e 210 * @param tx_length The number of bytes to transmit
mohamedmoawya 0:e4c5e6ec922e 211 * @param rx The receive buffer
mohamedmoawya 0:e4c5e6ec922e 212 * @param rx_length The number of bytes to receive
mohamedmoawya 0:e4c5e6ec922e 213 * @param address The address to be set - 7bit or 9bit
mohamedmoawya 0:e4c5e6ec922e 214 * @param stop If true, stop will be generated after the transfer is done
mohamedmoawya 0:e4c5e6ec922e 215 * @param handler The I2C IRQ handler to be set
mohamedmoawya 0:e4c5e6ec922e 216 * @param event Event mask for the transfer. See \ref hal_I2CEvents
mohamedmoawya 0:e4c5e6ec922e 217 * @param hint DMA hint usage
mohamedmoawya 0:e4c5e6ec922e 218 */
mohamedmoawya 0:e4c5e6ec922e 219 void i2c_transfer_asynch(i2c_t *obj, const void *tx, size_t tx_length, void *rx, size_t rx_length, uint32_t address, uint32_t stop, uint32_t handler, uint32_t event, DMAUsage hint);
mohamedmoawya 0:e4c5e6ec922e 220
mohamedmoawya 0:e4c5e6ec922e 221 /** The asynchronous IRQ handler
mohamedmoawya 0:e4c5e6ec922e 222 *
mohamedmoawya 0:e4c5e6ec922e 223 * @param obj The I2C object which holds the transfer information
mohamedmoawya 0:e4c5e6ec922e 224 * @return Event flags if a transfer termination condition was met, otherwise return 0.
mohamedmoawya 0:e4c5e6ec922e 225 */
mohamedmoawya 0:e4c5e6ec922e 226 uint32_t i2c_irq_handler_asynch(i2c_t *obj);
mohamedmoawya 0:e4c5e6ec922e 227
mohamedmoawya 0:e4c5e6ec922e 228 /** Attempts to determine if the I2C peripheral is already in use
mohamedmoawya 0:e4c5e6ec922e 229 *
mohamedmoawya 0:e4c5e6ec922e 230 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 231 * @return Non-zero if the I2C module is active or zero if it is not
mohamedmoawya 0:e4c5e6ec922e 232 */
mohamedmoawya 0:e4c5e6ec922e 233 uint8_t i2c_active(i2c_t *obj);
mohamedmoawya 0:e4c5e6ec922e 234
mohamedmoawya 0:e4c5e6ec922e 235 /** Abort asynchronous transfer
mohamedmoawya 0:e4c5e6ec922e 236 *
mohamedmoawya 0:e4c5e6ec922e 237 * This function does not perform any check - that should happen in upper layers.
mohamedmoawya 0:e4c5e6ec922e 238 * @param obj The I2C object
mohamedmoawya 0:e4c5e6ec922e 239 */
mohamedmoawya 0:e4c5e6ec922e 240 void i2c_abort_asynch(i2c_t *obj);
mohamedmoawya 0:e4c5e6ec922e 241
mohamedmoawya 0:e4c5e6ec922e 242 #endif
mohamedmoawya 0:e4c5e6ec922e 243
mohamedmoawya 0:e4c5e6ec922e 244 /**@}*/
mohamedmoawya 0:e4c5e6ec922e 245
mohamedmoawya 0:e4c5e6ec922e 246 #ifdef __cplusplus
mohamedmoawya 0:e4c5e6ec922e 247 }
mohamedmoawya 0:e4c5e6ec922e 248 #endif
mohamedmoawya 0:e4c5e6ec922e 249
mohamedmoawya 0:e4c5e6ec922e 250 #endif
mohamedmoawya 0:e4c5e6ec922e 251
mohamedmoawya 0:e4c5e6ec922e 252 #endif
mohamedmoawya 0:e4c5e6ec922e 253
mohamedmoawya 0:e4c5e6ec922e 254 /** @}*/