pro vyuku PSS v Jecne

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