mbed-os5 only for TYBLE16
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
hal/spi_api.h@0:5b88d5760320, 2019-12-17 (annotated)
- Committer:
- kenjiArai
- Date:
- Tue Dec 17 23:23:45 2019 +0000
- Revision:
- 0:5b88d5760320
- Child:
- 1:9db0e321a9f4
mbed-os5 only for TYBLE16
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kenjiArai | 0:5b88d5760320 | 1 | |
kenjiArai | 0:5b88d5760320 | 2 | /** \addtogroup hal */ |
kenjiArai | 0:5b88d5760320 | 3 | /** @{*/ |
kenjiArai | 0:5b88d5760320 | 4 | /* mbed Microcontroller Library |
kenjiArai | 0:5b88d5760320 | 5 | * Copyright (c) 2006-2013 ARM Limited |
kenjiArai | 0:5b88d5760320 | 6 | * SPDX-License-Identifier: Apache-2.0 |
kenjiArai | 0:5b88d5760320 | 7 | * |
kenjiArai | 0:5b88d5760320 | 8 | * Licensed under the Apache License, Version 2.0 (the "License"); |
kenjiArai | 0:5b88d5760320 | 9 | * you may not use this file except in compliance with the License. |
kenjiArai | 0:5b88d5760320 | 10 | * You may obtain a copy of the License at |
kenjiArai | 0:5b88d5760320 | 11 | * |
kenjiArai | 0:5b88d5760320 | 12 | * http://www.apache.org/licenses/LICENSE-2.0 |
kenjiArai | 0:5b88d5760320 | 13 | * |
kenjiArai | 0:5b88d5760320 | 14 | * Unless required by applicable law or agreed to in writing, software |
kenjiArai | 0:5b88d5760320 | 15 | * distributed under the License is distributed on an "AS IS" BASIS, |
kenjiArai | 0:5b88d5760320 | 16 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
kenjiArai | 0:5b88d5760320 | 17 | * See the License for the specific language governing permissions and |
kenjiArai | 0:5b88d5760320 | 18 | * limitations under the License. |
kenjiArai | 0:5b88d5760320 | 19 | */ |
kenjiArai | 0:5b88d5760320 | 20 | #ifndef MBED_SPI_API_H |
kenjiArai | 0:5b88d5760320 | 21 | #define MBED_SPI_API_H |
kenjiArai | 0:5b88d5760320 | 22 | |
kenjiArai | 0:5b88d5760320 | 23 | #include "device.h" |
kenjiArai | 0:5b88d5760320 | 24 | #include "pinmap.h" |
kenjiArai | 0:5b88d5760320 | 25 | #include "hal/dma_api.h" |
kenjiArai | 0:5b88d5760320 | 26 | #include "hal/buffer.h" |
kenjiArai | 0:5b88d5760320 | 27 | |
kenjiArai | 0:5b88d5760320 | 28 | #if DEVICE_SPI |
kenjiArai | 0:5b88d5760320 | 29 | |
kenjiArai | 0:5b88d5760320 | 30 | #define SPI_EVENT_ERROR (1 << 1) |
kenjiArai | 0:5b88d5760320 | 31 | #define SPI_EVENT_COMPLETE (1 << 2) |
kenjiArai | 0:5b88d5760320 | 32 | #define SPI_EVENT_RX_OVERFLOW (1 << 3) |
kenjiArai | 0:5b88d5760320 | 33 | #define SPI_EVENT_ALL (SPI_EVENT_ERROR | SPI_EVENT_COMPLETE | SPI_EVENT_RX_OVERFLOW) |
kenjiArai | 0:5b88d5760320 | 34 | |
kenjiArai | 0:5b88d5760320 | 35 | #define SPI_EVENT_INTERNAL_TRANSFER_COMPLETE (1 << 30) // Internal flag to report that an event occurred |
kenjiArai | 0:5b88d5760320 | 36 | |
kenjiArai | 0:5b88d5760320 | 37 | #define SPI_FILL_WORD (0xFFFF) |
kenjiArai | 0:5b88d5760320 | 38 | #define SPI_FILL_CHAR (0xFF) |
kenjiArai | 0:5b88d5760320 | 39 | |
kenjiArai | 0:5b88d5760320 | 40 | #if DEVICE_SPI_ASYNCH |
kenjiArai | 0:5b88d5760320 | 41 | /** Asynch SPI HAL structure |
kenjiArai | 0:5b88d5760320 | 42 | */ |
kenjiArai | 0:5b88d5760320 | 43 | typedef struct { |
kenjiArai | 0:5b88d5760320 | 44 | struct spi_s spi; /**< Target specific SPI structure */ |
kenjiArai | 0:5b88d5760320 | 45 | struct buffer_s tx_buff; /**< Tx buffer */ |
kenjiArai | 0:5b88d5760320 | 46 | struct buffer_s rx_buff; /**< Rx buffer */ |
kenjiArai | 0:5b88d5760320 | 47 | } spi_t; |
kenjiArai | 0:5b88d5760320 | 48 | |
kenjiArai | 0:5b88d5760320 | 49 | #else |
kenjiArai | 0:5b88d5760320 | 50 | /** Non-asynch SPI HAL structure |
kenjiArai | 0:5b88d5760320 | 51 | */ |
kenjiArai | 0:5b88d5760320 | 52 | typedef struct spi_s spi_t; |
kenjiArai | 0:5b88d5760320 | 53 | |
kenjiArai | 0:5b88d5760320 | 54 | #endif |
kenjiArai | 0:5b88d5760320 | 55 | |
kenjiArai | 0:5b88d5760320 | 56 | #ifdef __cplusplus |
kenjiArai | 0:5b88d5760320 | 57 | extern "C" { |
kenjiArai | 0:5b88d5760320 | 58 | #endif |
kenjiArai | 0:5b88d5760320 | 59 | |
kenjiArai | 0:5b88d5760320 | 60 | /** |
kenjiArai | 0:5b88d5760320 | 61 | * \defgroup hal_GeneralSPI SPI Configuration Functions |
kenjiArai | 0:5b88d5760320 | 62 | * @{ |
kenjiArai | 0:5b88d5760320 | 63 | */ |
kenjiArai | 0:5b88d5760320 | 64 | |
kenjiArai | 0:5b88d5760320 | 65 | #ifdef DEVICE_SPI_COUNT |
kenjiArai | 0:5b88d5760320 | 66 | /** |
kenjiArai | 0:5b88d5760320 | 67 | * Returns a variant of the SPIName enum uniquely identifying a SPI peripheral of the device. |
kenjiArai | 0:5b88d5760320 | 68 | * @param[in] mosi The pin to use for MOSI |
kenjiArai | 0:5b88d5760320 | 69 | * @param[in] miso The pin to use for MISO |
kenjiArai | 0:5b88d5760320 | 70 | * @param[in] sclk The pin to use for SCLK |
kenjiArai | 0:5b88d5760320 | 71 | * @return An SPI peripheral identifier |
kenjiArai | 0:5b88d5760320 | 72 | */ |
kenjiArai | 0:5b88d5760320 | 73 | SPIName spi_get_peripheral_name(PinName mosi, PinName miso, PinName mclk); |
kenjiArai | 0:5b88d5760320 | 74 | #endif |
kenjiArai | 0:5b88d5760320 | 75 | |
kenjiArai | 0:5b88d5760320 | 76 | /** Initialize the SPI peripheral |
kenjiArai | 0:5b88d5760320 | 77 | * |
kenjiArai | 0:5b88d5760320 | 78 | * Configures the pins used by SPI, sets a default format and frequency, and enables the peripheral |
kenjiArai | 0:5b88d5760320 | 79 | * @param[out] obj The SPI object to initialize |
kenjiArai | 0:5b88d5760320 | 80 | * @param[in] mosi The pin to use for MOSI |
kenjiArai | 0:5b88d5760320 | 81 | * @param[in] miso The pin to use for MISO |
kenjiArai | 0:5b88d5760320 | 82 | * @param[in] sclk The pin to use for SCLK |
kenjiArai | 0:5b88d5760320 | 83 | * @param[in] ssel The pin to use for SSEL |
kenjiArai | 0:5b88d5760320 | 84 | */ |
kenjiArai | 0:5b88d5760320 | 85 | void spi_init(spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel); |
kenjiArai | 0:5b88d5760320 | 86 | |
kenjiArai | 0:5b88d5760320 | 87 | /** Release a SPI object |
kenjiArai | 0:5b88d5760320 | 88 | * |
kenjiArai | 0:5b88d5760320 | 89 | * TODO: spi_free is currently unimplemented |
kenjiArai | 0:5b88d5760320 | 90 | * This will require reference counting at the C++ level to be safe |
kenjiArai | 0:5b88d5760320 | 91 | * |
kenjiArai | 0:5b88d5760320 | 92 | * Return the pins owned by the SPI object to their reset state |
kenjiArai | 0:5b88d5760320 | 93 | * Disable the SPI peripheral |
kenjiArai | 0:5b88d5760320 | 94 | * Disable the SPI clock |
kenjiArai | 0:5b88d5760320 | 95 | * @param[in] obj The SPI object to deinitialize |
kenjiArai | 0:5b88d5760320 | 96 | */ |
kenjiArai | 0:5b88d5760320 | 97 | void spi_free(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 98 | |
kenjiArai | 0:5b88d5760320 | 99 | /** Configure the SPI format |
kenjiArai | 0:5b88d5760320 | 100 | * |
kenjiArai | 0:5b88d5760320 | 101 | * Set the number of bits per frame, configure clock polarity and phase, shift order and master/slave mode. |
kenjiArai | 0:5b88d5760320 | 102 | * The default bit order is MSB. |
kenjiArai | 0:5b88d5760320 | 103 | * @param[in,out] obj The SPI object to configure |
kenjiArai | 0:5b88d5760320 | 104 | * @param[in] bits The number of bits per frame |
kenjiArai | 0:5b88d5760320 | 105 | * @param[in] mode The SPI mode (clock polarity, phase, and shift direction) |
kenjiArai | 0:5b88d5760320 | 106 | * @param[in] slave Zero for master mode or non-zero for slave mode |
kenjiArai | 0:5b88d5760320 | 107 | */ |
kenjiArai | 0:5b88d5760320 | 108 | void spi_format(spi_t *obj, int bits, int mode, int slave); |
kenjiArai | 0:5b88d5760320 | 109 | |
kenjiArai | 0:5b88d5760320 | 110 | /** Set the SPI baud rate |
kenjiArai | 0:5b88d5760320 | 111 | * |
kenjiArai | 0:5b88d5760320 | 112 | * Actual frequency may differ from the desired frequency due to available dividers and bus clock |
kenjiArai | 0:5b88d5760320 | 113 | * Configures the SPI peripheral's baud rate |
kenjiArai | 0:5b88d5760320 | 114 | * @param[in,out] obj The SPI object to configure |
kenjiArai | 0:5b88d5760320 | 115 | * @param[in] hz The baud rate in Hz |
kenjiArai | 0:5b88d5760320 | 116 | */ |
kenjiArai | 0:5b88d5760320 | 117 | void spi_frequency(spi_t *obj, int hz); |
kenjiArai | 0:5b88d5760320 | 118 | |
kenjiArai | 0:5b88d5760320 | 119 | /**@}*/ |
kenjiArai | 0:5b88d5760320 | 120 | /** |
kenjiArai | 0:5b88d5760320 | 121 | * \defgroup SynchSPI Synchronous SPI Hardware Abstraction Layer |
kenjiArai | 0:5b88d5760320 | 122 | * @{ |
kenjiArai | 0:5b88d5760320 | 123 | */ |
kenjiArai | 0:5b88d5760320 | 124 | |
kenjiArai | 0:5b88d5760320 | 125 | /** Write a byte out in master mode and receive a value |
kenjiArai | 0:5b88d5760320 | 126 | * |
kenjiArai | 0:5b88d5760320 | 127 | * @param[in] obj The SPI peripheral to use for sending |
kenjiArai | 0:5b88d5760320 | 128 | * @param[in] value The value to send |
kenjiArai | 0:5b88d5760320 | 129 | * @return Returns the value received during send |
kenjiArai | 0:5b88d5760320 | 130 | */ |
kenjiArai | 0:5b88d5760320 | 131 | int spi_master_write(spi_t *obj, int value); |
kenjiArai | 0:5b88d5760320 | 132 | |
kenjiArai | 0:5b88d5760320 | 133 | /** Write a block out in master mode and receive a value |
kenjiArai | 0:5b88d5760320 | 134 | * |
kenjiArai | 0:5b88d5760320 | 135 | * The total number of bytes sent and received will be the maximum of |
kenjiArai | 0:5b88d5760320 | 136 | * tx_length and rx_length. The bytes written will be padded with the |
kenjiArai | 0:5b88d5760320 | 137 | * value 0xff. |
kenjiArai | 0:5b88d5760320 | 138 | * |
kenjiArai | 0:5b88d5760320 | 139 | * @param[in] obj The SPI peripheral to use for sending |
kenjiArai | 0:5b88d5760320 | 140 | * @param[in] tx_buffer Pointer to the byte-array of data to write to the device |
kenjiArai | 0:5b88d5760320 | 141 | * @param[in] tx_length Number of bytes to write, may be zero |
kenjiArai | 0:5b88d5760320 | 142 | * @param[in] rx_buffer Pointer to the byte-array of data to read from the device |
kenjiArai | 0:5b88d5760320 | 143 | * @param[in] rx_length Number of bytes to read, may be zero |
kenjiArai | 0:5b88d5760320 | 144 | * @param[in] write_fill Default data transmitted while performing a read |
kenjiArai | 0:5b88d5760320 | 145 | * @returns |
kenjiArai | 0:5b88d5760320 | 146 | * The number of bytes written and read from the device. This is |
kenjiArai | 0:5b88d5760320 | 147 | * maximum of tx_length and rx_length. |
kenjiArai | 0:5b88d5760320 | 148 | */ |
kenjiArai | 0:5b88d5760320 | 149 | int spi_master_block_write(spi_t *obj, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, char write_fill); |
kenjiArai | 0:5b88d5760320 | 150 | |
kenjiArai | 0:5b88d5760320 | 151 | /** Check if a value is available to read |
kenjiArai | 0:5b88d5760320 | 152 | * |
kenjiArai | 0:5b88d5760320 | 153 | * @param[in] obj The SPI peripheral to check |
kenjiArai | 0:5b88d5760320 | 154 | * @return non-zero if a value is available |
kenjiArai | 0:5b88d5760320 | 155 | */ |
kenjiArai | 0:5b88d5760320 | 156 | int spi_slave_receive(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 157 | |
kenjiArai | 0:5b88d5760320 | 158 | /** Get a received value out of the SPI receive buffer in slave mode |
kenjiArai | 0:5b88d5760320 | 159 | * |
kenjiArai | 0:5b88d5760320 | 160 | * Blocks until a value is available |
kenjiArai | 0:5b88d5760320 | 161 | * @param[in] obj The SPI peripheral to read |
kenjiArai | 0:5b88d5760320 | 162 | * @return The value received |
kenjiArai | 0:5b88d5760320 | 163 | */ |
kenjiArai | 0:5b88d5760320 | 164 | int spi_slave_read(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 165 | |
kenjiArai | 0:5b88d5760320 | 166 | /** Write a value to the SPI peripheral in slave mode |
kenjiArai | 0:5b88d5760320 | 167 | * |
kenjiArai | 0:5b88d5760320 | 168 | * Blocks until the SPI peripheral can be written to |
kenjiArai | 0:5b88d5760320 | 169 | * @param[in] obj The SPI peripheral to write |
kenjiArai | 0:5b88d5760320 | 170 | * @param[in] value The value to write |
kenjiArai | 0:5b88d5760320 | 171 | */ |
kenjiArai | 0:5b88d5760320 | 172 | void spi_slave_write(spi_t *obj, int value); |
kenjiArai | 0:5b88d5760320 | 173 | |
kenjiArai | 0:5b88d5760320 | 174 | /** Checks if the specified SPI peripheral is in use |
kenjiArai | 0:5b88d5760320 | 175 | * |
kenjiArai | 0:5b88d5760320 | 176 | * @param[in] obj The SPI peripheral to check |
kenjiArai | 0:5b88d5760320 | 177 | * @return non-zero if the peripheral is currently transmitting |
kenjiArai | 0:5b88d5760320 | 178 | */ |
kenjiArai | 0:5b88d5760320 | 179 | int spi_busy(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 180 | |
kenjiArai | 0:5b88d5760320 | 181 | /** Get the module number |
kenjiArai | 0:5b88d5760320 | 182 | * |
kenjiArai | 0:5b88d5760320 | 183 | * @param[in] obj The SPI peripheral to check |
kenjiArai | 0:5b88d5760320 | 184 | * @return The module number |
kenjiArai | 0:5b88d5760320 | 185 | */ |
kenjiArai | 0:5b88d5760320 | 186 | uint8_t spi_get_module(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 187 | |
kenjiArai | 0:5b88d5760320 | 188 | /** Get the pins that support SPI MOSI |
kenjiArai | 0:5b88d5760320 | 189 | * |
kenjiArai | 0:5b88d5760320 | 190 | * Return a PinMap array of pins that support SPI MOSI in |
kenjiArai | 0:5b88d5760320 | 191 | * master mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 192 | * |
kenjiArai | 0:5b88d5760320 | 193 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 194 | */ |
kenjiArai | 0:5b88d5760320 | 195 | const PinMap *spi_master_mosi_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 196 | |
kenjiArai | 0:5b88d5760320 | 197 | /** Get the pins that support SPI MISO |
kenjiArai | 0:5b88d5760320 | 198 | * |
kenjiArai | 0:5b88d5760320 | 199 | * Return a PinMap array of pins that support SPI MISO in |
kenjiArai | 0:5b88d5760320 | 200 | * master mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 201 | * |
kenjiArai | 0:5b88d5760320 | 202 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 203 | */ |
kenjiArai | 0:5b88d5760320 | 204 | const PinMap *spi_master_miso_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 205 | |
kenjiArai | 0:5b88d5760320 | 206 | /** Get the pins that support SPI CLK |
kenjiArai | 0:5b88d5760320 | 207 | * |
kenjiArai | 0:5b88d5760320 | 208 | * Return a PinMap array of pins that support SPI CLK in |
kenjiArai | 0:5b88d5760320 | 209 | * master mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 210 | * |
kenjiArai | 0:5b88d5760320 | 211 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 212 | */ |
kenjiArai | 0:5b88d5760320 | 213 | const PinMap *spi_master_clk_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 214 | |
kenjiArai | 0:5b88d5760320 | 215 | /** Get the pins that support SPI CS |
kenjiArai | 0:5b88d5760320 | 216 | * |
kenjiArai | 0:5b88d5760320 | 217 | * Return a PinMap array of pins that support SPI CS in |
kenjiArai | 0:5b88d5760320 | 218 | * master mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 219 | * |
kenjiArai | 0:5b88d5760320 | 220 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 221 | */ |
kenjiArai | 0:5b88d5760320 | 222 | const PinMap *spi_master_cs_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 223 | |
kenjiArai | 0:5b88d5760320 | 224 | /** Get the pins that support SPI MOSI |
kenjiArai | 0:5b88d5760320 | 225 | * |
kenjiArai | 0:5b88d5760320 | 226 | * Return a PinMap array of pins that support SPI MOSI in |
kenjiArai | 0:5b88d5760320 | 227 | * slave mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 228 | * |
kenjiArai | 0:5b88d5760320 | 229 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 230 | */ |
kenjiArai | 0:5b88d5760320 | 231 | const PinMap *spi_slave_mosi_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 232 | |
kenjiArai | 0:5b88d5760320 | 233 | /** Get the pins that support SPI MISO |
kenjiArai | 0:5b88d5760320 | 234 | * |
kenjiArai | 0:5b88d5760320 | 235 | * Return a PinMap array of pins that support SPI MISO in |
kenjiArai | 0:5b88d5760320 | 236 | * slave mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 237 | * |
kenjiArai | 0:5b88d5760320 | 238 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 239 | */ |
kenjiArai | 0:5b88d5760320 | 240 | const PinMap *spi_slave_miso_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 241 | |
kenjiArai | 0:5b88d5760320 | 242 | /** Get the pins that support SPI CLK |
kenjiArai | 0:5b88d5760320 | 243 | * |
kenjiArai | 0:5b88d5760320 | 244 | * Return a PinMap array of pins that support SPI CLK in |
kenjiArai | 0:5b88d5760320 | 245 | * slave mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 246 | * |
kenjiArai | 0:5b88d5760320 | 247 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 248 | */ |
kenjiArai | 0:5b88d5760320 | 249 | const PinMap *spi_slave_clk_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 250 | |
kenjiArai | 0:5b88d5760320 | 251 | /** Get the pins that support SPI CS |
kenjiArai | 0:5b88d5760320 | 252 | * |
kenjiArai | 0:5b88d5760320 | 253 | * Return a PinMap array of pins that support SPI CS in |
kenjiArai | 0:5b88d5760320 | 254 | * slave mode. The array is terminated with {NC, NC, 0}. |
kenjiArai | 0:5b88d5760320 | 255 | * |
kenjiArai | 0:5b88d5760320 | 256 | * @return PinMap array |
kenjiArai | 0:5b88d5760320 | 257 | */ |
kenjiArai | 0:5b88d5760320 | 258 | const PinMap *spi_slave_cs_pinmap(void); |
kenjiArai | 0:5b88d5760320 | 259 | |
kenjiArai | 0:5b88d5760320 | 260 | /**@}*/ |
kenjiArai | 0:5b88d5760320 | 261 | |
kenjiArai | 0:5b88d5760320 | 262 | #if DEVICE_SPI_ASYNCH |
kenjiArai | 0:5b88d5760320 | 263 | /** |
kenjiArai | 0:5b88d5760320 | 264 | * \defgroup AsynchSPI Asynchronous SPI Hardware Abstraction Layer |
kenjiArai | 0:5b88d5760320 | 265 | * @{ |
kenjiArai | 0:5b88d5760320 | 266 | */ |
kenjiArai | 0:5b88d5760320 | 267 | |
kenjiArai | 0:5b88d5760320 | 268 | /** Begin the SPI transfer. Buffer pointers and lengths are specified in tx_buff and rx_buff |
kenjiArai | 0:5b88d5760320 | 269 | * |
kenjiArai | 0:5b88d5760320 | 270 | * @param[in] obj The SPI object that holds the transfer information |
kenjiArai | 0:5b88d5760320 | 271 | * @param[in] tx The transmit buffer |
kenjiArai | 0:5b88d5760320 | 272 | * @param[in] tx_length The number of bytes to transmit |
kenjiArai | 0:5b88d5760320 | 273 | * @param[in] rx The receive buffer |
kenjiArai | 0:5b88d5760320 | 274 | * @param[in] rx_length The number of bytes to receive |
kenjiArai | 0:5b88d5760320 | 275 | * @param[in] bit_width The bit width of buffer words |
kenjiArai | 0:5b88d5760320 | 276 | * @param[in] event The logical OR of events to be registered |
kenjiArai | 0:5b88d5760320 | 277 | * @param[in] handler SPI interrupt handler |
kenjiArai | 0:5b88d5760320 | 278 | * @param[in] hint A suggestion for how to use DMA with this transfer |
kenjiArai | 0:5b88d5760320 | 279 | */ |
kenjiArai | 0:5b88d5760320 | 280 | void spi_master_transfer(spi_t *obj, const void *tx, size_t tx_length, void *rx, size_t rx_length, uint8_t bit_width, uint32_t handler, uint32_t event, DMAUsage hint); |
kenjiArai | 0:5b88d5760320 | 281 | |
kenjiArai | 0:5b88d5760320 | 282 | /** The asynchronous IRQ handler |
kenjiArai | 0:5b88d5760320 | 283 | * |
kenjiArai | 0:5b88d5760320 | 284 | * Reads the received values out of the RX FIFO, writes values into the TX FIFO and checks for transfer termination |
kenjiArai | 0:5b88d5760320 | 285 | * conditions, such as buffer overflows or transfer complete. |
kenjiArai | 0:5b88d5760320 | 286 | * @param[in] obj The SPI object that holds the transfer information |
kenjiArai | 0:5b88d5760320 | 287 | * @return Event flags if a transfer termination condition was met; otherwise 0. |
kenjiArai | 0:5b88d5760320 | 288 | */ |
kenjiArai | 0:5b88d5760320 | 289 | uint32_t spi_irq_handler_asynch(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 290 | |
kenjiArai | 0:5b88d5760320 | 291 | /** Attempts to determine if the SPI peripheral is already in use |
kenjiArai | 0:5b88d5760320 | 292 | * |
kenjiArai | 0:5b88d5760320 | 293 | * If a temporary DMA channel has been allocated, peripheral is in use. |
kenjiArai | 0:5b88d5760320 | 294 | * If a permanent DMA channel has been allocated, check if the DMA channel is in use. If not, proceed as though no DMA |
kenjiArai | 0:5b88d5760320 | 295 | * channel were allocated. |
kenjiArai | 0:5b88d5760320 | 296 | * If no DMA channel is allocated, check whether tx and rx buffers have been assigned. For each assigned buffer, check |
kenjiArai | 0:5b88d5760320 | 297 | * if the corresponding buffer position is less than the buffer length. If buffers do not indicate activity, check if |
kenjiArai | 0:5b88d5760320 | 298 | * there are any bytes in the FIFOs. |
kenjiArai | 0:5b88d5760320 | 299 | * @param[in] obj The SPI object to check for activity |
kenjiArai | 0:5b88d5760320 | 300 | * @return Non-zero if the SPI port is active or zero if it is not. |
kenjiArai | 0:5b88d5760320 | 301 | */ |
kenjiArai | 0:5b88d5760320 | 302 | uint8_t spi_active(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 303 | |
kenjiArai | 0:5b88d5760320 | 304 | /** Abort an SPI transfer |
kenjiArai | 0:5b88d5760320 | 305 | * |
kenjiArai | 0:5b88d5760320 | 306 | * @param obj The SPI peripheral to stop |
kenjiArai | 0:5b88d5760320 | 307 | */ |
kenjiArai | 0:5b88d5760320 | 308 | void spi_abort_asynch(spi_t *obj); |
kenjiArai | 0:5b88d5760320 | 309 | |
kenjiArai | 0:5b88d5760320 | 310 | |
kenjiArai | 0:5b88d5760320 | 311 | #endif |
kenjiArai | 0:5b88d5760320 | 312 | |
kenjiArai | 0:5b88d5760320 | 313 | /**@}*/ |
kenjiArai | 0:5b88d5760320 | 314 | |
kenjiArai | 0:5b88d5760320 | 315 | #ifdef __cplusplus |
kenjiArai | 0:5b88d5760320 | 316 | } |
kenjiArai | 0:5b88d5760320 | 317 | #endif // __cplusplus |
kenjiArai | 0:5b88d5760320 | 318 | |
kenjiArai | 0:5b88d5760320 | 319 | #endif // SPI_DEVICE |
kenjiArai | 0:5b88d5760320 | 320 | |
kenjiArai | 0:5b88d5760320 | 321 | #endif // MBED_SPI_API_H |
kenjiArai | 0:5b88d5760320 | 322 | |
kenjiArai | 0:5b88d5760320 | 323 | /** @}*/ |