Vladimir Vana / mbed

pro vyuku PSS v Jecne

i2c_api.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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