Alessandro Angelino / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

hal/spi_api.h@4:473d4af53300, 2016-04-04 (annotated)

Committer:
Alessandro Angelino
Date:
Mon Apr 04 14:24:07 2016 +0100
Revision:
4:473d4af53300
Parent:
0:9c59db1fbc9e 
Fix function to get sp when in unprivileged mode

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:9c59db1fbc9e 1 /* mbed Microcontroller Library
screamer 0:9c59db1fbc9e 2 * Copyright (c) 2006-2013 ARM Limited
screamer 0:9c59db1fbc9e 3 *
screamer 0:9c59db1fbc9e 4 * Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:9c59db1fbc9e 5 * you may not use this file except in compliance with the License.
screamer 0:9c59db1fbc9e 6 * You may obtain a copy of the License at
screamer 0:9c59db1fbc9e 7 *
screamer 0:9c59db1fbc9e 8 * http://www.apache.org/licenses/LICENSE-2.0
screamer 0:9c59db1fbc9e 9 *
screamer 0:9c59db1fbc9e 10 * Unless required by applicable law or agreed to in writing, software
screamer 0:9c59db1fbc9e 11 * distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:9c59db1fbc9e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:9c59db1fbc9e 13 * See the License for the specific language governing permissions and
screamer 0:9c59db1fbc9e 14 * limitations under the License.
screamer 0:9c59db1fbc9e 15 */
screamer 0:9c59db1fbc9e 16 #ifndef MBED_SPI_API_H
screamer 0:9c59db1fbc9e 17 #define MBED_SPI_API_H
screamer 0:9c59db1fbc9e 18
screamer 0:9c59db1fbc9e 19 #include "device.h"
screamer 0:9c59db1fbc9e 20 #include "dma_api.h"
screamer 0:9c59db1fbc9e 21 #include "buffer.h"
screamer 0:9c59db1fbc9e 22
screamer 0:9c59db1fbc9e 23 #if DEVICE_SPI
screamer 0:9c59db1fbc9e 24
screamer 0:9c59db1fbc9e 25 #define SPI_EVENT_ERROR (1 << 1)
screamer 0:9c59db1fbc9e 26 #define SPI_EVENT_COMPLETE (1 << 2)
screamer 0:9c59db1fbc9e 27 #define SPI_EVENT_RX_OVERFLOW (1 << 3)
screamer 0:9c59db1fbc9e 28 #define SPI_EVENT_ALL (SPI_EVENT_ERROR | SPI_EVENT_COMPLETE | SPI_EVENT_RX_OVERFLOW)
screamer 0:9c59db1fbc9e 29
screamer 0:9c59db1fbc9e 30 #define SPI_EVENT_INTERNAL_TRANSFER_COMPLETE (1 << 30) // internal flag to report an event occurred
screamer 0:9c59db1fbc9e 31
screamer 0:9c59db1fbc9e 32 #define SPI_FILL_WORD (0xFFFF)
screamer 0:9c59db1fbc9e 33
screamer 0:9c59db1fbc9e 34 #if DEVICE_SPI_ASYNCH
screamer 0:9c59db1fbc9e 35 /** Asynch spi hal structure
screamer 0:9c59db1fbc9e 36 */
screamer 0:9c59db1fbc9e 37 typedef struct {
screamer 0:9c59db1fbc9e 38 struct spi_s spi; /**< Target specific spi structure */
screamer 0:9c59db1fbc9e 39 struct buffer_s tx_buff; /**< Tx buffer */
screamer 0:9c59db1fbc9e 40 struct buffer_s rx_buff; /**< Rx buffer */
screamer 0:9c59db1fbc9e 41 } spi_t;
screamer 0:9c59db1fbc9e 42
screamer 0:9c59db1fbc9e 43 #else
screamer 0:9c59db1fbc9e 44 /** Non-asynch spi hal structure
screamer 0:9c59db1fbc9e 45 */
screamer 0:9c59db1fbc9e 46 typedef struct spi_s spi_t;
screamer 0:9c59db1fbc9e 47
screamer 0:9c59db1fbc9e 48 #endif
screamer 0:9c59db1fbc9e 49
screamer 0:9c59db1fbc9e 50 #ifdef __cplusplus
screamer 0:9c59db1fbc9e 51 extern "C" {
screamer 0:9c59db1fbc9e 52 #endif
screamer 0:9c59db1fbc9e 53
screamer 0:9c59db1fbc9e 54 /**
screamer 0:9c59db1fbc9e 55 * \defgroup GeneralSPI SPI Configuration Functions
screamer 0:9c59db1fbc9e 56 * @{
screamer 0:9c59db1fbc9e 57 */
screamer 0:9c59db1fbc9e 58
screamer 0:9c59db1fbc9e 59 /** Initialize the SPI peripheral
screamer 0:9c59db1fbc9e 60 *
screamer 0:9c59db1fbc9e 61 * Configures the pins used by SPI, sets a default format and frequency, and enables the peripheral
screamer 0:9c59db1fbc9e 62 * @param[out] obj The SPI object to initialize
screamer 0:9c59db1fbc9e 63 * @param[in] mosi The pin to use for MOSI
screamer 0:9c59db1fbc9e 64 * @param[in] miso The pin to use for MISO
screamer 0:9c59db1fbc9e 65 * @param[in] sclk The pin to use for SCLK
screamer 0:9c59db1fbc9e 66 * @param[in] ssel The pin to use for SSEL
screamer 0:9c59db1fbc9e 67 */
screamer 0:9c59db1fbc9e 68 void spi_init(spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel);
screamer 0:9c59db1fbc9e 69
screamer 0:9c59db1fbc9e 70 /** Release a SPI object
screamer 0:9c59db1fbc9e 71 *
screamer 0:9c59db1fbc9e 72 * TODO: spi_free is currently unimplemented
screamer 0:9c59db1fbc9e 73 * This will require reference counting at the C++ level to be safe
screamer 0:9c59db1fbc9e 74 *
screamer 0:9c59db1fbc9e 75 * Return the pins owned by the SPI object to their reset state
screamer 0:9c59db1fbc9e 76 * Disable the SPI peripheral
screamer 0:9c59db1fbc9e 77 * Disable the SPI clock
screamer 0:9c59db1fbc9e 78 * @param[in] obj The SPI object to deinitialize
screamer 0:9c59db1fbc9e 79 */
screamer 0:9c59db1fbc9e 80 void spi_free(spi_t *obj);
screamer 0:9c59db1fbc9e 81
screamer 0:9c59db1fbc9e 82 /** Configure the SPI format
screamer 0:9c59db1fbc9e 83 *
screamer 0:9c59db1fbc9e 84 * Set the number of bits per frame, configure clock polarity and phase, shift order and master/slave mode
screamer 0:9c59db1fbc9e 85 * @param[in,out] obj The SPI object to configure
screamer 0:9c59db1fbc9e 86 * @param[in] bits The number of bits per frame
screamer 0:9c59db1fbc9e 87 * @param[in] mode The SPI mode (clock polarity, phase, and shift direction)
screamer 0:9c59db1fbc9e 88 * @param[in] slave Zero for master mode or non-zero for slave mode
screamer 0:9c59db1fbc9e 89 */
screamer 0:9c59db1fbc9e 90 void spi_format(spi_t *obj, int bits, int mode, int slave);
screamer 0:9c59db1fbc9e 91
screamer 0:9c59db1fbc9e 92 /** Set the SPI baud rate
screamer 0:9c59db1fbc9e 93 *
screamer 0:9c59db1fbc9e 94 * Actual frequency may differ from the desired frequency due to available dividers and bus clock
screamer 0:9c59db1fbc9e 95 * Configures the SPI peripheral's baud rate
screamer 0:9c59db1fbc9e 96 * @param[in,out] obj The SPI object to configure
screamer 0:9c59db1fbc9e 97 * @param[in] hz The baud rate in Hz
screamer 0:9c59db1fbc9e 98 */
screamer 0:9c59db1fbc9e 99 void spi_frequency(spi_t *obj, int hz);
screamer 0:9c59db1fbc9e 100
screamer 0:9c59db1fbc9e 101 /**@}*/
screamer 0:9c59db1fbc9e 102 /**
screamer 0:9c59db1fbc9e 103 * \defgroup SynchSPI Synchronous SPI Hardware Abstraction Layer
screamer 0:9c59db1fbc9e 104 * @{
screamer 0:9c59db1fbc9e 105 */
screamer 0:9c59db1fbc9e 106
screamer 0:9c59db1fbc9e 107 /** Write a byte out in master mode and receive a value
screamer 0:9c59db1fbc9e 108 *
screamer 0:9c59db1fbc9e 109 * @param[in] obj The SPI peripheral to use for sending
screamer 0:9c59db1fbc9e 110 * @param[in] value The value to send
screamer 0:9c59db1fbc9e 111 * @return Returns the value received during send
screamer 0:9c59db1fbc9e 112 */
screamer 0:9c59db1fbc9e 113 int spi_master_write(spi_t *obj, int value);
screamer 0:9c59db1fbc9e 114
screamer 0:9c59db1fbc9e 115 /** Check if a value is available to read
screamer 0:9c59db1fbc9e 116 *
screamer 0:9c59db1fbc9e 117 * @param[in] obj The SPI peripheral to check
screamer 0:9c59db1fbc9e 118 * @return non-zero if a value is available
screamer 0:9c59db1fbc9e 119 */
screamer 0:9c59db1fbc9e 120 int spi_slave_receive(spi_t *obj);
screamer 0:9c59db1fbc9e 121
screamer 0:9c59db1fbc9e 122 /** Get a received value out of the SPI receive buffer in slave mode
screamer 0:9c59db1fbc9e 123 *
screamer 0:9c59db1fbc9e 124 * Blocks until a value is available
screamer 0:9c59db1fbc9e 125 * @param[in] obj The SPI peripheral to read
screamer 0:9c59db1fbc9e 126 * @return The value received
screamer 0:9c59db1fbc9e 127 */
screamer 0:9c59db1fbc9e 128 int spi_slave_read(spi_t *obj);
screamer 0:9c59db1fbc9e 129
screamer 0:9c59db1fbc9e 130 /** Write a value to the SPI peripheral in slave mode
screamer 0:9c59db1fbc9e 131 *
screamer 0:9c59db1fbc9e 132 * Blocks until the SPI peripheral can be written to
screamer 0:9c59db1fbc9e 133 * @param[in] obj The SPI peripheral to write
screamer 0:9c59db1fbc9e 134 * @param[in] value The value to write
screamer 0:9c59db1fbc9e 135 */
screamer 0:9c59db1fbc9e 136 void spi_slave_write(spi_t *obj, int value);
screamer 0:9c59db1fbc9e 137
screamer 0:9c59db1fbc9e 138 /** Checks if the specified SPI peripheral is in use
screamer 0:9c59db1fbc9e 139 *
screamer 0:9c59db1fbc9e 140 * @param[in] obj The SPI peripheral to check
screamer 0:9c59db1fbc9e 141 * @return non-zero if the peripheral is currently transmitting
screamer 0:9c59db1fbc9e 142 */
screamer 0:9c59db1fbc9e 143 int spi_busy(spi_t *obj);
screamer 0:9c59db1fbc9e 144
screamer 0:9c59db1fbc9e 145 /** Get the module number
screamer 0:9c59db1fbc9e 146 *
screamer 0:9c59db1fbc9e 147 * @param[in] obj The SPI peripheral to check
screamer 0:9c59db1fbc9e 148 * @return The module number
screamer 0:9c59db1fbc9e 149 */
screamer 0:9c59db1fbc9e 150 uint8_t spi_get_module(spi_t *obj);
screamer 0:9c59db1fbc9e 151
screamer 0:9c59db1fbc9e 152 /**@}*/
screamer 0:9c59db1fbc9e 153
screamer 0:9c59db1fbc9e 154 #if DEVICE_SPI_ASYNCH
screamer 0:9c59db1fbc9e 155 /**
screamer 0:9c59db1fbc9e 156 * \defgroup AsynchSPI Asynchronous SPI Hardware Abstraction Layer
screamer 0:9c59db1fbc9e 157 * @{
screamer 0:9c59db1fbc9e 158 */
screamer 0:9c59db1fbc9e 159
screamer 0:9c59db1fbc9e 160 /** Begin the SPI transfer. Buffer pointers and lengths are specified in tx_buff and rx_buff
screamer 0:9c59db1fbc9e 161 *
screamer 0:9c59db1fbc9e 162 * @param[in] obj The SPI object which holds the transfer information
screamer 0:9c59db1fbc9e 163 * @param[in] tx The buffer to send
screamer 0:9c59db1fbc9e 164 * @param[in] tx_length The number of words to transmit
screamer 0:9c59db1fbc9e 165 * @param[in] rx The buffer to receive
screamer 0:9c59db1fbc9e 166 * @param[in] rx_length The number of words to receive
screamer 0:9c59db1fbc9e 167 * @param[in] bit_width The bit width of buffer words
screamer 0:9c59db1fbc9e 168 * @param[in] event The logical OR of events to be registered
screamer 0:9c59db1fbc9e 169 * @param[in] handler SPI interrupt handler
screamer 0:9c59db1fbc9e 170 * @param[in] hint A suggestion for how to use DMA with this transfer
screamer 0:9c59db1fbc9e 171 */
screamer 0:9c59db1fbc9e 172 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);
screamer 0:9c59db1fbc9e 173
screamer 0:9c59db1fbc9e 174 /** The asynchronous IRQ handler
screamer 0:9c59db1fbc9e 175 *
screamer 0:9c59db1fbc9e 176 * Reads the received values out of the RX FIFO, writes values into the TX FIFO and checks for transfer termination
screamer 0:9c59db1fbc9e 177 * conditions, such as buffer overflows or transfer complete.
screamer 0:9c59db1fbc9e 178 * @param[in] obj The SPI object which holds the transfer information
screamer 0:9c59db1fbc9e 179 * @return event flags if a transfer termination condition was met or 0 otherwise.
screamer 0:9c59db1fbc9e 180 */
screamer 0:9c59db1fbc9e 181 uint32_t spi_irq_handler_asynch(spi_t *obj);
screamer 0:9c59db1fbc9e 182
screamer 0:9c59db1fbc9e 183 /** Attempts to determine if the SPI peripheral is already in use.
screamer 0:9c59db1fbc9e 184 *
screamer 0:9c59db1fbc9e 185 * If a temporary DMA channel has been allocated, peripheral is in use.
screamer 0:9c59db1fbc9e 186 * If a permanent DMA channel has been allocated, check if the DMA channel is in use. If not, proceed as though no DMA
screamer 0:9c59db1fbc9e 187 * channel were allocated.
screamer 0:9c59db1fbc9e 188 * If no DMA channel is allocated, check whether tx and rx buffers have been assigned. For each assigned buffer, check
screamer 0:9c59db1fbc9e 189 * if the corresponding buffer position is less than the buffer length. If buffers do not indicate activity, check if
screamer 0:9c59db1fbc9e 190 * there are any bytes in the FIFOs.
screamer 0:9c59db1fbc9e 191 * @param[in] obj The SPI object to check for activity
screamer 0:9c59db1fbc9e 192 * @return non-zero if the SPI port is active or zero if it is not.
screamer 0:9c59db1fbc9e 193 */
screamer 0:9c59db1fbc9e 194 uint8_t spi_active(spi_t *obj);
screamer 0:9c59db1fbc9e 195
screamer 0:9c59db1fbc9e 196 /** Abort an SPI transfer
screamer 0:9c59db1fbc9e 197 *
screamer 0:9c59db1fbc9e 198 * @param obj The SPI peripheral to stop
screamer 0:9c59db1fbc9e 199 */
screamer 0:9c59db1fbc9e 200 void spi_abort_asynch(spi_t *obj);
screamer 0:9c59db1fbc9e 201
screamer 0:9c59db1fbc9e 202
screamer 0:9c59db1fbc9e 203 #endif
screamer 0:9c59db1fbc9e 204
screamer 0:9c59db1fbc9e 205 /**@}*/
screamer 0:9c59db1fbc9e 206
screamer 0:9c59db1fbc9e 207 #ifdef __cplusplus
screamer 0:9c59db1fbc9e 208 }
screamer 0:9c59db1fbc9e 209 #endif // __cplusplus
screamer 0:9c59db1fbc9e 210
screamer 0:9c59db1fbc9e 211 #endif // SPI_DEVICE
screamer 0:9c59db1fbc9e 212
screamer 0:9c59db1fbc9e 213 #endif // MBED_SPI_API_H
screamer 0:9c59db1fbc9e 214