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