begriffs open source - cmsis/blob - CMSIS/Driver/Include/Driver_SPI.h

   1 /*
   2  * Copyright (c) 2013-2016 ARM Limited. All rights reserved.
   3  *
   4  * SPDX-License-Identifier: Apache-2.0
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the License); you may
   7  * not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  14  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * $Date:        17. Apr 2014
  19  * $Revision:    V2.01
  20  *
  21  * Project:      SPI (Serial Peripheral Interface) Driver definitions
  22  */
  23
  24 /* History:
  25  *  Version 2.01
  26  *    Renamed status flag "tx_rx_busy" to "busy"
  27  *  Version 2.00
  28  *    New simplified driver:
  29  *      complexity moved to upper layer (especially data handling)
  30  *      more unified API for different communication interfaces
  31  *    Added:
  32  *      Slave Mode
  33  *      Half-duplex Modes
  34  *      Configurable number of data bits
  35  *      Support for TI Mode and Microwire
  36  *    Changed prefix ARM_DRV -> ARM_DRIVER
  37  *  Version 1.10
  38  *    Namespace prefix ARM_ added
  39  *  Version 1.01
  40  *    Added "send_done_event" to Capabilities
  41  *  Version 1.00
  42  *    Initial release
  43  */
  44
  45 #ifndef DRIVER_SPI_H_
  46 #define DRIVER_SPI_H_
  47
  48 #ifdef  __cplusplus
  49 extern "C"
  50 {
  51 #endif
  52
  53 #include "Driver_Common.h"
  54
  55 #define ARM_SPI_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,01)  /* API version */
  56
  57
  58 /****** SPI Control Codes *****/
  59
  60 #define ARM_SPI_CONTROL_Pos              0
  61 #define ARM_SPI_CONTROL_Msk             (0xFFUL << ARM_SPI_CONTROL_Pos)
  62
  63 /*----- SPI Control Codes: Mode -----*/
  64 #define ARM_SPI_MODE_INACTIVE           (0x00UL << ARM_SPI_CONTROL_Pos)     ///< SPI Inactive
  65 #define ARM_SPI_MODE_MASTER             (0x01UL << ARM_SPI_CONTROL_Pos)     ///< SPI Master (Output on MOSI, Input on MISO); arg = Bus Speed in bps
  66 #define ARM_SPI_MODE_SLAVE              (0x02UL << ARM_SPI_CONTROL_Pos)     ///< SPI Slave  (Output on MISO, Input on MOSI)
  67 #define ARM_SPI_MODE_MASTER_SIMPLEX     (0x03UL << ARM_SPI_CONTROL_Pos)     ///< SPI Master (Output/Input on MOSI); arg = Bus Speed in bps
  68 #define ARM_SPI_MODE_SLAVE_SIMPLEX      (0x04UL << ARM_SPI_CONTROL_Pos)     ///< SPI Slave  (Output/Input on MISO)
  69
  70 /*----- SPI Control Codes: Mode Parameters: Frame Format -----*/
  71 #define ARM_SPI_FRAME_FORMAT_Pos         8
  72 #define ARM_SPI_FRAME_FORMAT_Msk        (7UL << ARM_SPI_FRAME_FORMAT_Pos)
  73 #define ARM_SPI_CPOL0_CPHA0             (0UL << ARM_SPI_FRAME_FORMAT_Pos)   ///< Clock Polarity 0, Clock Phase 0 (default)
  74 #define ARM_SPI_CPOL0_CPHA1             (1UL << ARM_SPI_FRAME_FORMAT_Pos)   ///< Clock Polarity 0, Clock Phase 1
  75 #define ARM_SPI_CPOL1_CPHA0             (2UL << ARM_SPI_FRAME_FORMAT_Pos)   ///< Clock Polarity 1, Clock Phase 0
  76 #define ARM_SPI_CPOL1_CPHA1             (3UL << ARM_SPI_FRAME_FORMAT_Pos)   ///< Clock Polarity 1, Clock Phase 1
  77 #define ARM_SPI_TI_SSI                  (4UL << ARM_SPI_FRAME_FORMAT_Pos)   ///< Texas Instruments Frame Format
  78 #define ARM_SPI_MICROWIRE               (5UL << ARM_SPI_FRAME_FORMAT_Pos)   ///< National Microwire Frame Format
  79
  80 /*----- SPI Control Codes: Mode Parameters: Data Bits -----*/
  81 #define ARM_SPI_DATA_BITS_Pos            12
  82 #define ARM_SPI_DATA_BITS_Msk           (0x3FUL << ARM_SPI_DATA_BITS_Pos)
  83 #define ARM_SPI_DATA_BITS(n)            (((n) & 0x3F) << ARM_SPI_DATA_BITS_Pos) ///< Number of Data bits
  84
  85 /*----- SPI Control Codes: Mode Parameters: Bit Order -----*/
  86 #define ARM_SPI_BIT_ORDER_Pos            18
  87 #define ARM_SPI_BIT_ORDER_Msk           (1UL << ARM_SPI_BIT_ORDER_Pos)
  88 #define ARM_SPI_MSB_LSB                 (0UL << ARM_SPI_BIT_ORDER_Pos)      ///< SPI Bit order from MSB to LSB (default)
  89 #define ARM_SPI_LSB_MSB                 (1UL << ARM_SPI_BIT_ORDER_Pos)      ///< SPI Bit order from LSB to MSB
  90
  91 /*----- SPI Control Codes: Mode Parameters: Slave Select Mode -----*/
  92 #define ARM_SPI_SS_MASTER_MODE_Pos       19
  93 #define ARM_SPI_SS_MASTER_MODE_Msk      (3UL << ARM_SPI_SS_MASTER_MODE_Pos)
  94 #define ARM_SPI_SS_MASTER_UNUSED        (0UL << ARM_SPI_SS_MASTER_MODE_Pos) ///< SPI Slave Select when Master: Not used (default)
  95 #define ARM_SPI_SS_MASTER_SW            (1UL << ARM_SPI_SS_MASTER_MODE_Pos) ///< SPI Slave Select when Master: Software controlled
  96 #define ARM_SPI_SS_MASTER_HW_OUTPUT     (2UL << ARM_SPI_SS_MASTER_MODE_Pos) ///< SPI Slave Select when Master: Hardware controlled Output
  97 #define ARM_SPI_SS_MASTER_HW_INPUT      (3UL << ARM_SPI_SS_MASTER_MODE_Pos) ///< SPI Slave Select when Master: Hardware monitored Input
  98 #define ARM_SPI_SS_SLAVE_MODE_Pos        21
  99 #define ARM_SPI_SS_SLAVE_MODE_Msk       (1UL << ARM_SPI_SS_SLAVE_MODE_Pos)
 100 #define ARM_SPI_SS_SLAVE_HW             (0UL << ARM_SPI_SS_SLAVE_MODE_Pos)  ///< SPI Slave Select when Slave: Hardware monitored (default)
 101 #define ARM_SPI_SS_SLAVE_SW             (1UL << ARM_SPI_SS_SLAVE_MODE_Pos)  ///< SPI Slave Select when Slave: Software controlled
 102
 103
 104 /*----- SPI Control Codes: Miscellaneous Controls  -----*/
 105 #define ARM_SPI_SET_BUS_SPEED           (0x10UL << ARM_SPI_CONTROL_Pos)     ///< Set Bus Speed in bps; arg = value
 106 #define ARM_SPI_GET_BUS_SPEED           (0x11UL << ARM_SPI_CONTROL_Pos)     ///< Get Bus Speed in bps
 107 #define ARM_SPI_SET_DEFAULT_TX_VALUE    (0x12UL << ARM_SPI_CONTROL_Pos)     ///< Set default Transmit value; arg = value
 108 #define ARM_SPI_CONTROL_SS              (0x13UL << ARM_SPI_CONTROL_Pos)     ///< Control Slave Select; arg: 0=inactive, 1=active
 109 #define ARM_SPI_ABORT_TRANSFER          (0x14UL << ARM_SPI_CONTROL_Pos)     ///< Abort current data transfer
 110
 111
 112 /****** SPI Slave Select Signal definitions *****/
 113 #define ARM_SPI_SS_INACTIVE              0                                  ///< SPI Slave Select Signal Inactive
 114 #define ARM_SPI_SS_ACTIVE                1                                  ///< SPI Slave Select Signal Active
 115
 116
 117 /****** SPI specific error codes *****/
 118 #define ARM_SPI_ERROR_MODE              (ARM_DRIVER_ERROR_SPECIFIC - 1)     ///< Specified Mode not supported
 119 #define ARM_SPI_ERROR_FRAME_FORMAT      (ARM_DRIVER_ERROR_SPECIFIC - 2)     ///< Specified Frame Format not supported
 120 #define ARM_SPI_ERROR_DATA_BITS         (ARM_DRIVER_ERROR_SPECIFIC - 3)     ///< Specified number of Data bits not supported
 121 #define ARM_SPI_ERROR_BIT_ORDER         (ARM_DRIVER_ERROR_SPECIFIC - 4)     ///< Specified Bit order not supported
 122 #define ARM_SPI_ERROR_SS_MODE           (ARM_DRIVER_ERROR_SPECIFIC - 5)     ///< Specified Slave Select Mode not supported
 123
 124
 125 /**
 126 \brief SPI Status
 127 */
 128 typedef struct _ARM_SPI_STATUS {
 129   uint32_t busy       : 1;              ///< Transmitter/Receiver busy flag
 130   uint32_t data_lost  : 1;              ///< Data lost: Receive overflow / Transmit underflow (cleared on start of transfer operation)
 131   uint32_t mode_fault : 1;              ///< Mode fault detected; optional (cleared on start of transfer operation)
 132 } ARM_SPI_STATUS;
 133
 134
 135 /****** SPI Event *****/
 136 #define ARM_SPI_EVENT_TRANSFER_COMPLETE (1UL << 0)  ///< Data Transfer completed
 137 #define ARM_SPI_EVENT_DATA_LOST         (1UL << 1)  ///< Data lost: Receive overflow / Transmit underflow
 138 #define ARM_SPI_EVENT_MODE_FAULT        (1UL << 2)  ///< Master Mode Fault (SS deactivated when Master)
 139
 140
 141 // Function documentation
 142 /**
 143   \fn          ARM_DRIVER_VERSION ARM_SPI_GetVersion (void)
 144   \brief       Get driver version.
 145   \return      \ref ARM_DRIVER_VERSION
 146
 147   \fn          ARM_SPI_CAPABILITIES ARM_SPI_GetCapabilities (void)
 148   \brief       Get driver capabilities.
 149   \return      \ref ARM_SPI_CAPABILITIES
 150
 151   \fn          int32_t ARM_SPI_Initialize (ARM_SPI_SignalEvent_t cb_event)
 152   \brief       Initialize SPI Interface.
 153   \param[in]   cb_event  Pointer to \ref ARM_SPI_SignalEvent
 154   \return      \ref execution_status
 155
 156   \fn          int32_t ARM_SPI_Uninitialize (void)
 157   \brief       De-initialize SPI Interface.
 158   \return      \ref execution_status
 159
 160   \fn          int32_t ARM_SPI_PowerControl (ARM_POWER_STATE state)
 161   \brief       Control SPI Interface Power.
 162   \param[in]   state  Power state
 163   \return      \ref execution_status
 164
 165   \fn          int32_t ARM_SPI_Send (const void *data, uint32_t num)
 166   \brief       Start sending data to SPI transmitter.
 167   \param[in]   data  Pointer to buffer with data to send to SPI transmitter
 168   \param[in]   num   Number of data items to send
 169   \return      \ref execution_status
 170
 171   \fn          int32_t ARM_SPI_Receive (void *data, uint32_t num)
 172   \brief       Start receiving data from SPI receiver.
 173   \param[out]  data  Pointer to buffer for data to receive from SPI receiver
 174   \param[in]   num   Number of data items to receive
 175   \return      \ref execution_status
 176
 177   \fn          int32_t ARM_SPI_Transfer (const void *data_out,
 178                                                void *data_in,
 179                                          uint32_t    num)
 180   \brief       Start sending/receiving data to/from SPI transmitter/receiver.
 181   \param[in]   data_out  Pointer to buffer with data to send to SPI transmitter
 182   \param[out]  data_in   Pointer to buffer for data to receive from SPI receiver
 183   \param[in]   num       Number of data items to transfer
 184   \return      \ref execution_status
 185
 186   \fn          uint32_t ARM_SPI_GetDataCount (void)
 187   \brief       Get transferred data count.
 188   \return      number of data items transferred
 189
 190   \fn          int32_t ARM_SPI_Control (uint32_t control, uint32_t arg)
 191   \brief       Control SPI Interface.
 192   \param[in]   control  Operation
 193   \param[in]   arg      Argument of operation (optional)
 194   \return      common \ref execution_status and driver specific \ref spi_execution_status
 195
 196   \fn          ARM_SPI_STATUS ARM_SPI_GetStatus (void)
 197   \brief       Get SPI status.
 198   \return      SPI status \ref ARM_SPI_STATUS
 199
 200   \fn          void ARM_SPI_SignalEvent (uint32_t event)
 201   \brief       Signal SPI Events.
 202   \param[in]   event \ref SPI_events notification mask
 203   \return      none
 204 */
 205
 206 typedef void (*ARM_SPI_SignalEvent_t) (uint32_t event);  ///< Pointer to \ref ARM_SPI_SignalEvent : Signal SPI Event.
 207
 208
 209 /**
 210 \brief SPI Driver Capabilities.
 211 */
 212 typedef struct _ARM_SPI_CAPABILITIES {
 213   uint32_t simplex          : 1;        ///< supports Simplex Mode (Master and Slave)
 214   uint32_t ti_ssi           : 1;        ///< supports TI Synchronous Serial Interface
 215   uint32_t microwire        : 1;        ///< supports Microwire Interface
 216   uint32_t event_mode_fault : 1;        ///< Signal Mode Fault event: \ref ARM_SPI_EVENT_MODE_FAULT
 217 } ARM_SPI_CAPABILITIES;
 218
 219
 220 /**
 221 \brief Access structure of the SPI Driver.
 222 */
 223 typedef struct _ARM_DRIVER_SPI {
 224   ARM_DRIVER_VERSION   (*GetVersion)      (void);                             ///< Pointer to \ref ARM_SPI_GetVersion : Get driver version.
 225   ARM_SPI_CAPABILITIES (*GetCapabilities) (void);                             ///< Pointer to \ref ARM_SPI_GetCapabilities : Get driver capabilities.
 226   int32_t              (*Initialize)      (ARM_SPI_SignalEvent_t cb_event);   ///< Pointer to \ref ARM_SPI_Initialize : Initialize SPI Interface.
 227   int32_t              (*Uninitialize)    (void);                             ///< Pointer to \ref ARM_SPI_Uninitialize : De-initialize SPI Interface.
 228   int32_t              (*PowerControl)    (ARM_POWER_STATE state);            ///< Pointer to \ref ARM_SPI_PowerControl : Control SPI Interface Power.
 229   int32_t              (*Send)            (const void *data, uint32_t num);   ///< Pointer to \ref ARM_SPI_Send : Start sending data to SPI Interface.
 230   int32_t              (*Receive)         (      void *data, uint32_t num);   ///< Pointer to \ref ARM_SPI_Receive : Start receiving data from SPI Interface.
 231   int32_t              (*Transfer)        (const void *data_out,
 232                                                  void *data_in,
 233                                            uint32_t    num);                  ///< Pointer to \ref ARM_SPI_Transfer : Start sending/receiving data to/from SPI.
 234   uint32_t             (*GetDataCount)    (void);                             ///< Pointer to \ref ARM_SPI_GetDataCount : Get transferred data count.
 235   int32_t              (*Control)         (uint32_t control, uint32_t arg);   ///< Pointer to \ref ARM_SPI_Control : Control SPI Interface.
 236   ARM_SPI_STATUS       (*GetStatus)       (void);                             ///< Pointer to \ref ARM_SPI_GetStatus : Get SPI status.
 237 } const ARM_DRIVER_SPI;
 238
 239 #ifdef  __cplusplus
 240 }
 241 #endif
 242
 243 #endif /* DRIVER_SPI_H_ */