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

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