Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/spi_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-2013 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_SPI_API_H
mohamedmoawya 0:e4c5e6ec922e 20 #define MBED_SPI_API_H
mohamedmoawya 0:e4c5e6ec922e 21
mohamedmoawya 0:e4c5e6ec922e 22 #include "device.h"
mohamedmoawya 0:e4c5e6ec922e 23 #include "hal/dma_api.h"
mohamedmoawya 0:e4c5e6ec922e 24 #include "hal/buffer.h"
mohamedmoawya 0:e4c5e6ec922e 25
mohamedmoawya 0:e4c5e6ec922e 26 #if DEVICE_SPI
mohamedmoawya 0:e4c5e6ec922e 27
mohamedmoawya 0:e4c5e6ec922e 28 #define SPI_EVENT_ERROR (1 << 1)
mohamedmoawya 0:e4c5e6ec922e 29 #define SPI_EVENT_COMPLETE (1 << 2)
mohamedmoawya 0:e4c5e6ec922e 30 #define SPI_EVENT_RX_OVERFLOW (1 << 3)
mohamedmoawya 0:e4c5e6ec922e 31 #define SPI_EVENT_ALL (SPI_EVENT_ERROR | SPI_EVENT_COMPLETE | SPI_EVENT_RX_OVERFLOW)
mohamedmoawya 0:e4c5e6ec922e 32
mohamedmoawya 0:e4c5e6ec922e 33 #define SPI_EVENT_INTERNAL_TRANSFER_COMPLETE (1 << 30) // Internal flag to report that an event occurred
mohamedmoawya 0:e4c5e6ec922e 34
mohamedmoawya 0:e4c5e6ec922e 35 #define SPI_FILL_WORD (0xFFFF)
mohamedmoawya 0:e4c5e6ec922e 36 #define SPI_FILL_CHAR (0xFF)
mohamedmoawya 0:e4c5e6ec922e 37
mohamedmoawya 0:e4c5e6ec922e 38 #if DEVICE_SPI_ASYNCH
mohamedmoawya 0:e4c5e6ec922e 39 /** Asynch SPI HAL structure
mohamedmoawya 0:e4c5e6ec922e 40 */
mohamedmoawya 0:e4c5e6ec922e 41 typedef struct {
mohamedmoawya 0:e4c5e6ec922e 42 struct spi_s spi; /**< Target specific SPI structure */
mohamedmoawya 0:e4c5e6ec922e 43 struct buffer_s tx_buff; /**< Tx buffer */
mohamedmoawya 0:e4c5e6ec922e 44 struct buffer_s rx_buff; /**< Rx buffer */
mohamedmoawya 0:e4c5e6ec922e 45 } spi_t;
mohamedmoawya 0:e4c5e6ec922e 46
mohamedmoawya 0:e4c5e6ec922e 47 #else
mohamedmoawya 0:e4c5e6ec922e 48 /** Non-asynch SPI HAL structure
mohamedmoawya 0:e4c5e6ec922e 49 */
mohamedmoawya 0:e4c5e6ec922e 50 typedef struct spi_s spi_t;
mohamedmoawya 0:e4c5e6ec922e 51
mohamedmoawya 0:e4c5e6ec922e 52 #endif
mohamedmoawya 0:e4c5e6ec922e 53
mohamedmoawya 0:e4c5e6ec922e 54 #ifdef __cplusplus
mohamedmoawya 0:e4c5e6ec922e 55 extern "C" {
mohamedmoawya 0:e4c5e6ec922e 56 #endif
mohamedmoawya 0:e4c5e6ec922e 57
mohamedmoawya 0:e4c5e6ec922e 58 /**
mohamedmoawya 0:e4c5e6ec922e 59 * \defgroup hal_GeneralSPI SPI Configuration Functions
mohamedmoawya 0:e4c5e6ec922e 60 * @{
mohamedmoawya 0:e4c5e6ec922e 61 */
mohamedmoawya 0:e4c5e6ec922e 62
mohamedmoawya 0:e4c5e6ec922e 63 /** Initialize the SPI peripheral
mohamedmoawya 0:e4c5e6ec922e 64 *
mohamedmoawya 0:e4c5e6ec922e 65 * Configures the pins used by SPI, sets a default format and frequency, and enables the peripheral
mohamedmoawya 0:e4c5e6ec922e 66 * @param[out] obj The SPI object to initialize
mohamedmoawya 0:e4c5e6ec922e 67 * @param[in] mosi The pin to use for MOSI
mohamedmoawya 0:e4c5e6ec922e 68 * @param[in] miso The pin to use for MISO
mohamedmoawya 0:e4c5e6ec922e 69 * @param[in] sclk The pin to use for SCLK
mohamedmoawya 0:e4c5e6ec922e 70 * @param[in] ssel The pin to use for SSEL
mohamedmoawya 0:e4c5e6ec922e 71 */
mohamedmoawya 0:e4c5e6ec922e 72 void spi_init(spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel);
mohamedmoawya 0:e4c5e6ec922e 73
mohamedmoawya 0:e4c5e6ec922e 74 /** Release a SPI object
mohamedmoawya 0:e4c5e6ec922e 75 *
mohamedmoawya 0:e4c5e6ec922e 76 * TODO: spi_free is currently unimplemented
mohamedmoawya 0:e4c5e6ec922e 77 * This will require reference counting at the C++ level to be safe
mohamedmoawya 0:e4c5e6ec922e 78 *
mohamedmoawya 0:e4c5e6ec922e 79 * Return the pins owned by the SPI object to their reset state
mohamedmoawya 0:e4c5e6ec922e 80 * Disable the SPI peripheral
mohamedmoawya 0:e4c5e6ec922e 81 * Disable the SPI clock
mohamedmoawya 0:e4c5e6ec922e 82 * @param[in] obj The SPI object to deinitialize
mohamedmoawya 0:e4c5e6ec922e 83 */
mohamedmoawya 0:e4c5e6ec922e 84 void spi_free(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 85
mohamedmoawya 0:e4c5e6ec922e 86 /** Configure the SPI format
mohamedmoawya 0:e4c5e6ec922e 87 *
mohamedmoawya 0:e4c5e6ec922e 88 * Set the number of bits per frame, configure clock polarity and phase, shift order and master/slave mode.
mohamedmoawya 0:e4c5e6ec922e 89 * The default bit order is MSB.
mohamedmoawya 0:e4c5e6ec922e 90 * @param[in,out] obj The SPI object to configure
mohamedmoawya 0:e4c5e6ec922e 91 * @param[in] bits The number of bits per frame
mohamedmoawya 0:e4c5e6ec922e 92 * @param[in] mode The SPI mode (clock polarity, phase, and shift direction)
mohamedmoawya 0:e4c5e6ec922e 93 * @param[in] slave Zero for master mode or non-zero for slave mode
mohamedmoawya 0:e4c5e6ec922e 94 */
mohamedmoawya 0:e4c5e6ec922e 95 void spi_format(spi_t *obj, int bits, int mode, int slave);
mohamedmoawya 0:e4c5e6ec922e 96
mohamedmoawya 0:e4c5e6ec922e 97 /** Set the SPI baud rate
mohamedmoawya 0:e4c5e6ec922e 98 *
mohamedmoawya 0:e4c5e6ec922e 99 * Actual frequency may differ from the desired frequency due to available dividers and bus clock
mohamedmoawya 0:e4c5e6ec922e 100 * Configures the SPI peripheral's baud rate
mohamedmoawya 0:e4c5e6ec922e 101 * @param[in,out] obj The SPI object to configure
mohamedmoawya 0:e4c5e6ec922e 102 * @param[in] hz The baud rate in Hz
mohamedmoawya 0:e4c5e6ec922e 103 */
mohamedmoawya 0:e4c5e6ec922e 104 void spi_frequency(spi_t *obj, int hz);
mohamedmoawya 0:e4c5e6ec922e 105
mohamedmoawya 0:e4c5e6ec922e 106 /**@}*/
mohamedmoawya 0:e4c5e6ec922e 107 /**
mohamedmoawya 0:e4c5e6ec922e 108 * \defgroup SynchSPI Synchronous SPI Hardware Abstraction Layer
mohamedmoawya 0:e4c5e6ec922e 109 * @{
mohamedmoawya 0:e4c5e6ec922e 110 */
mohamedmoawya 0:e4c5e6ec922e 111
mohamedmoawya 0:e4c5e6ec922e 112 /** Write a byte out in master mode and receive a value
mohamedmoawya 0:e4c5e6ec922e 113 *
mohamedmoawya 0:e4c5e6ec922e 114 * @param[in] obj The SPI peripheral to use for sending
mohamedmoawya 0:e4c5e6ec922e 115 * @param[in] value The value to send
mohamedmoawya 0:e4c5e6ec922e 116 * @return Returns the value received during send
mohamedmoawya 0:e4c5e6ec922e 117 */
mohamedmoawya 0:e4c5e6ec922e 118 int spi_master_write(spi_t *obj, int value);
mohamedmoawya 0:e4c5e6ec922e 119
mohamedmoawya 0:e4c5e6ec922e 120 /** Write a block out in master mode and receive a value
mohamedmoawya 0:e4c5e6ec922e 121 *
mohamedmoawya 0:e4c5e6ec922e 122 * The total number of bytes sent and received will be the maximum of
mohamedmoawya 0:e4c5e6ec922e 123 * tx_length and rx_length. The bytes written will be padded with the
mohamedmoawya 0:e4c5e6ec922e 124 * value 0xff.
mohamedmoawya 0:e4c5e6ec922e 125 *
mohamedmoawya 0:e4c5e6ec922e 126 * @param[in] obj The SPI peripheral to use for sending
mohamedmoawya 0:e4c5e6ec922e 127 * @param[in] tx_buffer Pointer to the byte-array of data to write to the device
mohamedmoawya 0:e4c5e6ec922e 128 * @param[in] tx_length Number of bytes to write, may be zero
mohamedmoawya 0:e4c5e6ec922e 129 * @param[in] rx_buffer Pointer to the byte-array of data to read from the device
mohamedmoawya 0:e4c5e6ec922e 130 * @param[in] rx_length Number of bytes to read, may be zero
mohamedmoawya 0:e4c5e6ec922e 131 * @param[in] write_fill Default data transmitted while performing a read
mohamedmoawya 0:e4c5e6ec922e 132 * @returns
mohamedmoawya 0:e4c5e6ec922e 133 * The number of bytes written and read from the device. This is
mohamedmoawya 0:e4c5e6ec922e 134 * maximum of tx_length and rx_length.
mohamedmoawya 0:e4c5e6ec922e 135 */
mohamedmoawya 0:e4c5e6ec922e 136 int spi_master_block_write(spi_t *obj, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, char write_fill);
mohamedmoawya 0:e4c5e6ec922e 137
mohamedmoawya 0:e4c5e6ec922e 138 /** Check if a value is available to read
mohamedmoawya 0:e4c5e6ec922e 139 *
mohamedmoawya 0:e4c5e6ec922e 140 * @param[in] obj The SPI peripheral to check
mohamedmoawya 0:e4c5e6ec922e 141 * @return non-zero if a value is available
mohamedmoawya 0:e4c5e6ec922e 142 */
mohamedmoawya 0:e4c5e6ec922e 143 int spi_slave_receive(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 144
mohamedmoawya 0:e4c5e6ec922e 145 /** Get a received value out of the SPI receive buffer in slave mode
mohamedmoawya 0:e4c5e6ec922e 146 *
mohamedmoawya 0:e4c5e6ec922e 147 * Blocks until a value is available
mohamedmoawya 0:e4c5e6ec922e 148 * @param[in] obj The SPI peripheral to read
mohamedmoawya 0:e4c5e6ec922e 149 * @return The value received
mohamedmoawya 0:e4c5e6ec922e 150 */
mohamedmoawya 0:e4c5e6ec922e 151 int spi_slave_read(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 152
mohamedmoawya 0:e4c5e6ec922e 153 /** Write a value to the SPI peripheral in slave mode
mohamedmoawya 0:e4c5e6ec922e 154 *
mohamedmoawya 0:e4c5e6ec922e 155 * Blocks until the SPI peripheral can be written to
mohamedmoawya 0:e4c5e6ec922e 156 * @param[in] obj The SPI peripheral to write
mohamedmoawya 0:e4c5e6ec922e 157 * @param[in] value The value to write
mohamedmoawya 0:e4c5e6ec922e 158 */
mohamedmoawya 0:e4c5e6ec922e 159 void spi_slave_write(spi_t *obj, int value);
mohamedmoawya 0:e4c5e6ec922e 160
mohamedmoawya 0:e4c5e6ec922e 161 /** Checks if the specified SPI peripheral is in use
mohamedmoawya 0:e4c5e6ec922e 162 *
mohamedmoawya 0:e4c5e6ec922e 163 * @param[in] obj The SPI peripheral to check
mohamedmoawya 0:e4c5e6ec922e 164 * @return non-zero if the peripheral is currently transmitting
mohamedmoawya 0:e4c5e6ec922e 165 */
mohamedmoawya 0:e4c5e6ec922e 166 int spi_busy(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 167
mohamedmoawya 0:e4c5e6ec922e 168 /** Get the module number
mohamedmoawya 0:e4c5e6ec922e 169 *
mohamedmoawya 0:e4c5e6ec922e 170 * @param[in] obj The SPI peripheral to check
mohamedmoawya 0:e4c5e6ec922e 171 * @return The module number
mohamedmoawya 0:e4c5e6ec922e 172 */
mohamedmoawya 0:e4c5e6ec922e 173 uint8_t spi_get_module(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 174
mohamedmoawya 0:e4c5e6ec922e 175 /**@}*/
mohamedmoawya 0:e4c5e6ec922e 176
mohamedmoawya 0:e4c5e6ec922e 177 #if DEVICE_SPI_ASYNCH
mohamedmoawya 0:e4c5e6ec922e 178 /**
mohamedmoawya 0:e4c5e6ec922e 179 * \defgroup AsynchSPI Asynchronous SPI Hardware Abstraction Layer
mohamedmoawya 0:e4c5e6ec922e 180 * @{
mohamedmoawya 0:e4c5e6ec922e 181 */
mohamedmoawya 0:e4c5e6ec922e 182
mohamedmoawya 0:e4c5e6ec922e 183 /** Begin the SPI transfer. Buffer pointers and lengths are specified in tx_buff and rx_buff
mohamedmoawya 0:e4c5e6ec922e 184 *
mohamedmoawya 0:e4c5e6ec922e 185 * @param[in] obj The SPI object that holds the transfer information
mohamedmoawya 0:e4c5e6ec922e 186 * @param[in] tx The transmit buffer
mohamedmoawya 0:e4c5e6ec922e 187 * @param[in] tx_length The number of bytes to transmit
mohamedmoawya 0:e4c5e6ec922e 188 * @param[in] rx The receive buffer
mohamedmoawya 0:e4c5e6ec922e 189 * @param[in] rx_length The number of bytes to receive
mohamedmoawya 0:e4c5e6ec922e 190 * @param[in] bit_width The bit width of buffer words
mohamedmoawya 0:e4c5e6ec922e 191 * @param[in] event The logical OR of events to be registered
mohamedmoawya 0:e4c5e6ec922e 192 * @param[in] handler SPI interrupt handler
mohamedmoawya 0:e4c5e6ec922e 193 * @param[in] hint A suggestion for how to use DMA with this transfer
mohamedmoawya 0:e4c5e6ec922e 194 */
mohamedmoawya 0:e4c5e6ec922e 195 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);
mohamedmoawya 0:e4c5e6ec922e 196
mohamedmoawya 0:e4c5e6ec922e 197 /** The asynchronous IRQ handler
mohamedmoawya 0:e4c5e6ec922e 198 *
mohamedmoawya 0:e4c5e6ec922e 199 * Reads the received values out of the RX FIFO, writes values into the TX FIFO and checks for transfer termination
mohamedmoawya 0:e4c5e6ec922e 200 * conditions, such as buffer overflows or transfer complete.
mohamedmoawya 0:e4c5e6ec922e 201 * @param[in] obj The SPI object that holds the transfer information
mohamedmoawya 0:e4c5e6ec922e 202 * @return Event flags if a transfer termination condition was met; otherwise 0.
mohamedmoawya 0:e4c5e6ec922e 203 */
mohamedmoawya 0:e4c5e6ec922e 204 uint32_t spi_irq_handler_asynch(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 205
mohamedmoawya 0:e4c5e6ec922e 206 /** Attempts to determine if the SPI peripheral is already in use
mohamedmoawya 0:e4c5e6ec922e 207 *
mohamedmoawya 0:e4c5e6ec922e 208 * If a temporary DMA channel has been allocated, peripheral is in use.
mohamedmoawya 0:e4c5e6ec922e 209 * If a permanent DMA channel has been allocated, check if the DMA channel is in use. If not, proceed as though no DMA
mohamedmoawya 0:e4c5e6ec922e 210 * channel were allocated.
mohamedmoawya 0:e4c5e6ec922e 211 * If no DMA channel is allocated, check whether tx and rx buffers have been assigned. For each assigned buffer, check
mohamedmoawya 0:e4c5e6ec922e 212 * if the corresponding buffer position is less than the buffer length. If buffers do not indicate activity, check if
mohamedmoawya 0:e4c5e6ec922e 213 * there are any bytes in the FIFOs.
mohamedmoawya 0:e4c5e6ec922e 214 * @param[in] obj The SPI object to check for activity
mohamedmoawya 0:e4c5e6ec922e 215 * @return Non-zero if the SPI port is active or zero if it is not.
mohamedmoawya 0:e4c5e6ec922e 216 */
mohamedmoawya 0:e4c5e6ec922e 217 uint8_t spi_active(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 218
mohamedmoawya 0:e4c5e6ec922e 219 /** Abort an SPI transfer
mohamedmoawya 0:e4c5e6ec922e 220 *
mohamedmoawya 0:e4c5e6ec922e 221 * @param obj The SPI peripheral to stop
mohamedmoawya 0:e4c5e6ec922e 222 */
mohamedmoawya 0:e4c5e6ec922e 223 void spi_abort_asynch(spi_t *obj);
mohamedmoawya 0:e4c5e6ec922e 224
mohamedmoawya 0:e4c5e6ec922e 225
mohamedmoawya 0:e4c5e6ec922e 226 #endif
mohamedmoawya 0:e4c5e6ec922e 227
mohamedmoawya 0:e4c5e6ec922e 228 /**@}*/
mohamedmoawya 0:e4c5e6ec922e 229
mohamedmoawya 0:e4c5e6ec922e 230 #ifdef __cplusplus
mohamedmoawya 0:e4c5e6ec922e 231 }
mohamedmoawya 0:e4c5e6ec922e 232 #endif // __cplusplus
mohamedmoawya 0:e4c5e6ec922e 233
mohamedmoawya 0:e4c5e6ec922e 234 #endif // SPI_DEVICE
mohamedmoawya 0:e4c5e6ec922e 235
mohamedmoawya 0:e4c5e6ec922e 236 #endif // MBED_SPI_API_H
mohamedmoawya 0:e4c5e6ec922e 237
mohamedmoawya 0:e4c5e6ec922e 238 /** @}*/