Gan likun / The prosthetic control

The prosthetic control（MIT）

hal/i2c_api.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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