begriffs open source - cmsis/blob - CMSIS/Driver/Include/Driver_SAI.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:        9. Dec 2014
  19  * $Revision:    V1.00
  20  *
  21  * Project:      SAI (Serial Audio Interface) Driver definitions
  22  */
  23
  24 /* History:
  25  *  Version 1.00
  26  *    Initial release
  27  */
  28
  29 #ifndef DRIVER_SAI_H_
  30 #define DRIVER_SAI_H_
  31
  32 #ifdef  __cplusplus
  33 extern "C"
  34 {
  35 #endif
  36
  37 #include "Driver_Common.h"
  38
  39 #define ARM_SAI_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(1,00)  /* API version */
  40
  41
  42 /****** SAI Control Codes *****/
  43
  44 #define ARM_SAI_CONTROL_Msk             (0xFFU)
  45 #define ARM_SAI_CONFIGURE_TX            (0x01U)     ///< Configure Transmitter;  arg1 and arg2 provide additional configuration
  46 #define ARM_SAI_CONFIGURE_RX            (0x02U)     ///< Configure Receiver;     arg1 and arg2 provide additional configuration
  47 #define ARM_SAI_CONTROL_TX              (0x03U)     ///< Control Transmitter;    arg1.0: 0=disable (default), 1=enable; arg1.1: mute
  48 #define ARM_SAI_CONTROL_RX              (0x04U)     ///< Control Receiver;       arg1.0: 0=disable (default), 1=enable
  49 #define ARM_SAI_MASK_SLOTS_TX           (0x05U)     ///< Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default
  50 #define ARM_SAI_MASK_SLOTS_RX           (0x06U)     ///< Mask Receiver    slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default
  51 #define ARM_SAI_ABORT_SEND              (0x07U)     ///< Abort \ref ARM_SAI_Send
  52 #define ARM_SAI_ABORT_RECEIVE           (0x08U)     ///< Abort \ref ARM_SAI_Receive
  53
  54 /*----- SAI Control Codes: Configuration Parameters: Mode -----*/
  55 #define ARM_SAI_MODE_Pos                 8
  56 #define ARM_SAI_MODE_Msk                (1U << ARM_SAI_MODE_Pos)
  57 #define ARM_SAI_MODE_MASTER             (1U << ARM_SAI_MODE_Pos)                ///< Master Mode
  58 #define ARM_SAI_MODE_SLAVE              (0U << ARM_SAI_MODE_Pos)                ///< Slave Mode (default)
  59
  60 /*----- SAI Control Codes: Configuration Parameters: Synchronization -----*/
  61 #define ARM_SAI_SYNCHRONIZATION_Pos      9
  62 #define ARM_SAI_SYNCHRONIZATION_Msk     (1U << ARM_SAI_SYNCHRONIZATION_Pos)
  63 #define ARM_SAI_ASYNCHRONOUS            (0U << ARM_SAI_SYNCHRONIZATION_Pos)     ///< Asynchronous (default)
  64 #define ARM_SAI_SYNCHRONOUS             (1U << ARM_SAI_SYNCHRONIZATION_Pos)     ///< Synchronous
  65
  66 /*----- SAI Control Codes: Configuration Parameters: Protocol -----*/
  67 #define ARM_SAI_PROTOCOL_Pos             10
  68 #define ARM_SAI_PROTOCOL_Msk            (7U << ARM_SAI_PROTOCOL_Pos)
  69 #define ARM_SAI_PROTOCOL_USER           (0U << ARM_SAI_PROTOCOL_Pos)            ///< User defined (default)
  70 #define ARM_SAI_PROTOCOL_I2S            (1U << ARM_SAI_PROTOCOL_Pos)            ///< I2S
  71 #define ARM_SAI_PROTOCOL_MSB_JUSTIFIED  (2U << ARM_SAI_PROTOCOL_Pos)            ///< MSB (left) justified
  72 #define ARM_SAI_PROTOCOL_LSB_JUSTIFIED  (3U << ARM_SAI_PROTOCOL_Pos)            ///< LSB (right) justified
  73 #define ARM_SAI_PROTOCOL_PCM_SHORT      (4U << ARM_SAI_PROTOCOL_Pos)            ///< PCM with short frame
  74 #define ARM_SAI_PROTOCOL_PCM_LONG       (5U << ARM_SAI_PROTOCOL_Pos)            ///< PCM with long frame
  75 #define ARM_SAI_PROTOCOL_AC97           (6U << ARM_SAI_PROTOCOL_Pos)            ///< AC'97
  76
  77 /*----- SAI Control Codes: Configuration Parameters: Data Size -----*/
  78 #define ARM_SAI_DATA_SIZE_Pos            13
  79 #define ARM_SAI_DATA_SIZE_Msk                    (0x1FU  << ARM_SAI_DATA_SIZE_Pos)
  80 #define ARM_SAI_DATA_SIZE(n)            ((((n)-1)&0x1FU) << ARM_SAI_DATA_SIZE_Pos)  ///< Data size in bits (8..32)
  81
  82 /*----- SAI Control Codes: Configuration Parameters: Bit Order -----*/
  83 #define ARM_SAI_BIT_ORDER_Pos            18
  84 #define ARM_SAI_BIT_ORDER_Msk           (1U << ARM_SAI_BIT_ORDER_Pos)
  85 #define ARM_SAI_MSB_FIRST               (0U << ARM_SAI_BIT_ORDER_Pos)           ///< Data is transferred with MSB first (default)
  86 #define ARM_SAI_LSB_FIRST               (1U << ARM_SAI_BIT_ORDER_Pos)           ///< Data is transferred with LSB first; User Protocol only (ignored otherwise)
  87
  88 /*----- SAI Control Codes: Configuration Parameters: Mono Mode -----*/
  89 #define ARM_SAI_MONO_MODE               (1U << 19)                              ///< Mono Mode (only for I2S, MSB/LSB justified)
  90
  91 /*----- SAI Control Codes:Configuration Parameters: Companding -----*/
  92 #define ARM_SAI_COMPANDING_Pos           20
  93 #define ARM_SAI_COMPANDING_Msk          (3U << ARM_SAI_COMPANDING_Pos)
  94 #define ARM_SAI_COMPANDING_NONE         (0U << ARM_SAI_COMPANDING_Pos)          ///< No compading (default)
  95 #define ARM_SAI_COMPANDING_A_LAW        (2U << ARM_SAI_COMPANDING_Pos)          ///< A-Law companding
  96 #define ARM_SAI_COMPANDING_U_LAW        (3U << ARM_SAI_COMPANDING_Pos)          ///< u-Law companding
  97
  98 /*----- SAI Control Codes: Configuration Parameters: Clock Polarity -----*/
  99 #define ARM_SAI_CLOCK_POLARITY_Pos       23
 100 #define ARM_SAI_CLOCK_POLARITY_Msk      (1U << ARM_SAI_CLOCK_POLARITY_Pos)
 101 #define ARM_SAI_CLOCK_POLARITY_0        (0U << ARM_SAI_CLOCK_POLARITY_Pos)      ///< Drive on falling edge, Capture on rising  edge (default)
 102 #define ARM_SAI_CLOCK_POLARITY_1        (1U << ARM_SAI_CLOCK_POLARITY_Pos)      ///< Drive on rising  edge, Capture on falling edge
 103
 104 /*----- SAI Control Codes: Configuration Parameters: Master Clock Pin -----*/
 105 #define ARM_SAI_MCLK_PIN_Pos             24
 106 #define ARM_SAI_MCLK_PIN_Msk            (3U << ARM_SAI_MCLK_PIN_Pos)
 107 #define ARM_SAI_MCLK_PIN_INACTIVE       (0U << ARM_SAI_MCLK_PIN_Pos)            ///< MCLK not used (default)
 108 #define ARM_SAI_MCLK_PIN_OUTPUT         (1U << ARM_SAI_MCLK_PIN_Pos)            ///< MCLK is output (Master only)
 109 #define ARM_SAI_MCLK_PIN_INPUT          (2U << ARM_SAI_MCLK_PIN_Pos)            ///< MCLK is input  (Master only)
 110
 111
 112 /****** SAI Configuration (arg1) *****/
 113
 114 /*----- SAI Configuration (arg1): Frame Length -----*/
 115 #define ARM_SAI_FRAME_LENGTH_Pos          0
 116 #define ARM_SAI_FRAME_LENGTH_Msk                  (0x3FFU  << ARM_SAI_FRAME_LENGTH_Pos)
 117 #define ARM_SAI_FRAME_LENGTH(n)          ((((n)-1)&0x3FFU) << ARM_SAI_FRAME_LENGTH_Pos)     ///< Frame length in bits (8..1024); default depends on protocol and data
 118
 119 /*----- SAI Configuration (arg1): Frame Sync Width -----*/
 120 #define ARM_SAI_FRAME_SYNC_WIDTH_Pos      10
 121 #define ARM_SAI_FRAME_SYNC_WIDTH_Msk              (0xFFU  << ARM_SAI_FRAME_SYNC_WIDTH_Pos)
 122 #define ARM_SAI_FRAME_SYNC_WIDTH(n)      ((((n)-1)&0xFFU) << ARM_SAI_FRAME_SYNC_WIDTH_Pos)  ///< Frame Sync width in bits (1..256); default=1; User Protocol only (ignored otherwise)
 123
 124 /*----- SAI Configuration (arg1): Frame Sync Polarity -----*/
 125 #define ARM_SAI_FRAME_SYNC_POLARITY_Pos   18
 126 #define ARM_SAI_FRAME_SYNC_POLARITY_Msk  (1U << ARM_SAI_FRAME_SYNC_POLARITY_Pos)
 127 #define ARM_SAI_FRAME_SYNC_POLARITY_HIGH (0U << ARM_SAI_FRAME_SYNC_POLARITY_Pos)            ///< Frame Sync is active high (default); User Protocol only (ignored otherwise)
 128 #define ARM_SAI_FRAME_SYNC_POLARITY_LOW  (1U << ARM_SAI_FRAME_SYNC_POLARITY_Pos)            ///< Frame Sync is active low; User Protocol only (ignored otherwise)
 129
 130 /*----- SAI Configuration (arg1): Frame Sync Early -----*/
 131 #define ARM_SAI_FRAME_SYNC_EARLY         (1U << 19)                                         ///< Frame Sync one bit before the first bit of the frame; User Protocol only (ignored otherwise)
 132
 133 /*----- SAI Configuration (arg1): Slot Count -----*/
 134 #define ARM_SAI_SLOT_COUNT_Pos            20
 135 #define ARM_SAI_SLOT_COUNT_Msk                    (0x1FU  << ARM_SAI_SLOT_COUNT_Pos)
 136 #define ARM_SAI_SLOT_COUNT(n)            ((((n)-1)&0x1FU) << ARM_SAI_SLOT_COUNT_Pos)        ///< Number of slots in frame (1..32); default=1; User Protocol only (ignored otherwise)
 137
 138 /*----- SAI Configuration (arg1): Slot Size -----*/
 139 #define ARM_SAI_SLOT_SIZE_Pos             25
 140 #define ARM_SAI_SLOT_SIZE_Msk            (3U << ARM_SAI_SLOT_SIZE_Pos)
 141 #define ARM_SAI_SLOT_SIZE_DEFAULT        (0U << ARM_SAI_SLOT_SIZE_Pos)                      ///< Slot size is equal to data size (default)
 142 #define ARM_SAI_SLOT_SIZE_16             (1U << ARM_SAI_SLOT_SIZE_Pos)                      ///< Slot size = 16 bits; User Protocol only (ignored otherwise)
 143 #define ARM_SAI_SLOT_SIZE_32             (3U << ARM_SAI_SLOT_SIZE_Pos)                      ///< Slot size = 32 bits; User Protocol only (ignored otherwise)
 144
 145 /*----- SAI Configuration (arg1): Slot Offset -----*/
 146 #define ARM_SAI_SLOT_OFFSET_Pos           27
 147 #define ARM_SAI_SLOT_OFFSET_Msk               (0x1FU  << ARM_SAI_SLOT_OFFSET_Pos)
 148 #define ARM_SAI_SLOT_OFFSET(n)           (((n)&0x1FU) << ARM_SAI_SLOT_OFFSET_Pos)           ///< Offset of first data bit in slot (0..31); default=0; User Protocol only (ignored otherwise)
 149
 150 /****** SAI Configuration (arg2) *****/
 151
 152 /*----- SAI Control Codes: Configuration Parameters: Audio Frequency (Master only) -----*/
 153 #define ARM_SAI_AUDIO_FREQ_Msk          (0x0FFFFFU)                                         ///< Audio frequency mask
 154
 155 /*----- SAI Control Codes: Configuration Parameters: Master Clock Prescaler (Master only and MCLK Pin) -----*/
 156 #define ARM_SAI_MCLK_PRESCALER_Pos       20
 157 #define ARM_SAI_MCLK_PRESCALER_Msk      (0xFFFU << ARM_SAI_MCLK_PRESCALER_Pos)
 158 #define ARM_SAI_MCLK_PRESCALER(n)       ((((n)-1)&0xFFFU) << ARM_SAI_MCLK_PRESCALER_Pos)    ///< MCLK prescaler; Audio_frequency = MCLK/n; n = 1..4096 (default=1)
 159
 160
 161 /****** SAI specific error codes *****/
 162 #define ARM_SAI_ERROR_SYNCHRONIZATION       (ARM_DRIVER_ERROR_SPECIFIC - 1)     ///< Specified Synchronization not supported
 163 #define ARM_SAI_ERROR_PROTOCOL              (ARM_DRIVER_ERROR_SPECIFIC - 2)     ///< Specified Protocol not supported
 164 #define ARM_SAI_ERROR_DATA_SIZE             (ARM_DRIVER_ERROR_SPECIFIC - 3)     ///< Specified Data size not supported
 165 #define ARM_SAI_ERROR_BIT_ORDER             (ARM_DRIVER_ERROR_SPECIFIC - 4)     ///< Specified Bit order not supported
 166 #define ARM_SAI_ERROR_MONO_MODE             (ARM_DRIVER_ERROR_SPECIFIC - 5)     ///< Specified Mono mode not supported
 167 #define ARM_SAI_ERROR_COMPANDING            (ARM_DRIVER_ERROR_SPECIFIC - 6)     ///< Specified Companding not supported
 168 #define ARM_SAI_ERROR_CLOCK_POLARITY        (ARM_DRIVER_ERROR_SPECIFIC - 7)     ///< Specified Clock polarity not supported
 169 #define ARM_SAI_ERROR_AUDIO_FREQ            (ARM_DRIVER_ERROR_SPECIFIC - 8)     ///< Specified Audio frequency not supported
 170 #define ARM_SAI_ERROR_MCLK_PIN              (ARM_DRIVER_ERROR_SPECIFIC - 9)     ///< Specified MCLK Pin setting not supported
 171 #define ARM_SAI_ERROR_MCLK_PRESCALER        (ARM_DRIVER_ERROR_SPECIFIC - 10)    ///< Specified MCLK Prescaler not supported
 172 #define ARM_SAI_ERROR_FRAME_LENGHT          (ARM_DRIVER_ERROR_SPECIFIC - 11)    ///< Specified Frame length not supported
 173 #define ARM_SAI_ERROR_FRAME_SYNC_WIDTH      (ARM_DRIVER_ERROR_SPECIFIC - 12)    ///< Specified Frame Sync width not supported
 174 #define ARM_SAI_ERROR_FRAME_SYNC_POLARITY   (ARM_DRIVER_ERROR_SPECIFIC - 13)    ///< Specified Frame Sync polarity not supported
 175 #define ARM_SAI_ERROR_FRAME_SYNC_EARLY      (ARM_DRIVER_ERROR_SPECIFIC - 14)    ///< Specified Frame Sync early not supported
 176 #define ARM_SAI_ERROR_SLOT_COUNT            (ARM_DRIVER_ERROR_SPECIFIC - 15)    ///< Specified Slot count not supported
 177 #define ARM_SAI_ERROR_SLOT_SIZE             (ARM_DRIVER_ERROR_SPECIFIC - 16)    ///< Specified Slot size not supported
 178 #define ARM_SAI_ERROR_SLOT_OFFESET          (ARM_DRIVER_ERROR_SPECIFIC - 17)    ///< Specified Slot offset not supported
 179
 180
 181 /**
 182 \brief SAI Status
 183 */
 184 typedef struct _ARM_SAI_STATUS {
 185   uint32_t tx_busy          : 1;        ///< Transmitter busy flag
 186   uint32_t rx_busy          : 1;        ///< Receiver busy flag
 187   uint32_t tx_underflow     : 1;        ///< Transmit data underflow detected (cleared on start of next send operation)
 188   uint32_t rx_overflow      : 1;        ///< Receive data overflow detected (cleared on start of next receive operation)
 189   uint32_t frame_error      : 1;        ///< Sync Frame error detected (cleared on start of next send/receive operation)
 190 } ARM_SAI_STATUS;
 191
 192
 193 /****** SAI Event *****/
 194 #define ARM_SAI_EVENT_SEND_COMPLETE     (1U << 0)   ///< Send completed
 195 #define ARM_SAI_EVENT_RECEIVE_COMPLETE  (1U << 1)   ///< Receive completed
 196 #define ARM_SAI_EVENT_TX_UNDERFLOW      (1U << 2)   ///< Transmit data not available
 197 #define ARM_SAI_EVENT_RX_OVERFLOW       (1U << 3)   ///< Receive data overflow
 198 #define ARM_SAI_EVENT_FRAME_ERROR       (1U << 4)   ///< Sync Frame error in Slave mode (optional)
 199
 200
 201 // Function documentation
 202 /**
 203   \fn          ARM_DRIVER_VERSION ARM_SAI_GetVersion (void)
 204   \brief       Get driver version.
 205   \return      \ref ARM_DRIVER_VERSION
 206
 207   \fn          ARM_SAI_CAPABILITIES ARM_SAI_GetCapabilities (void)
 208   \brief       Get driver capabilities.
 209   \return      \ref ARM_SAI_CAPABILITIES
 210
 211   \fn          int32_t ARM_SAI_Initialize (ARM_SAI_SignalEvent_t cb_event)
 212   \brief       Initialize SAI Interface.
 213   \param[in]   cb_event  Pointer to \ref ARM_SAI_SignalEvent
 214   \return      \ref execution_status
 215
 216   \fn          int32_t ARM_SAI_Uninitialize (void)
 217   \brief       De-initialize SAI Interface.
 218   \return      \ref execution_status
 219
 220   \fn          int32_t ARM_SAI_PowerControl (ARM_POWER_STATE state)
 221   \brief       Control SAI Interface Power.
 222   \param[in]   state  Power state
 223   \return      \ref execution_status
 224
 225   \fn          int32_t ARM_SAI_Send (const void *data, uint32_t num)
 226   \brief       Start sending data to SAI transmitter.
 227   \param[in]   data  Pointer to buffer with data to send to SAI transmitter
 228   \param[in]   num   Number of data items to send
 229   \return      \ref execution_status
 230
 231   \fn          int32_t ARM_SAI_Receive (void *data, uint32_t num)
 232   \brief       Start receiving data from SAI receiver.
 233   \param[out]  data  Pointer to buffer for data to receive from SAI receiver
 234   \param[in]   num   Number of data items to receive
 235   \return      \ref execution_status
 236
 237   \fn          uint32_t ARM_SAI_GetTxCount (void)
 238   \brief       Get transmitted data count.
 239   \return      number of data items transmitted
 240
 241   \fn          uint32_t ARM_SAI_GetRxCount (void)
 242   \brief       Get received data count.
 243   \return      number of data items received
 244
 245   \fn          int32_t ARM_SAI_Control (uint32_t control, uint32_t arg1, uint32_t arg2)
 246   \brief       Control SAI Interface.
 247   \param[in]   control  Operation
 248   \param[in]   arg1     Argument 1 of operation (optional)
 249   \param[in]   arg2     Argument 2 of operation (optional)
 250   \return      common \ref execution_status and driver specific \ref sai_execution_status
 251
 252   \fn          ARM_SAI_STATUS ARM_SAI_GetStatus (void)
 253   \brief       Get SAI status.
 254   \return      SAI status \ref ARM_SAI_STATUS
 255
 256   \fn          void ARM_SAI_SignalEvent (uint32_t event)
 257   \brief       Signal SAI Events.
 258   \param[in]   event \ref SAI_events notification mask
 259   \return      none
 260 */
 261
 262 typedef void (*ARM_SAI_SignalEvent_t) (uint32_t event);  ///< Pointer to \ref ARM_SAI_SignalEvent : Signal SAI Event.
 263
 264
 265 /**
 266 \brief SAI Driver Capabilities.
 267 */
 268 typedef struct _ARM_SAI_CAPABILITIES {
 269   uint32_t asynchronous          : 1;   ///< supports asynchronous Transmit/Receive
 270   uint32_t synchronous           : 1;   ///< supports synchronous Transmit/Receive
 271   uint32_t protocol_user         : 1;   ///< supports user defined Protocol
 272   uint32_t protocol_i2s          : 1;   ///< supports I2S Protocol
 273   uint32_t protocol_justified    : 1;   ///< supports MSB/LSB justified Protocol
 274   uint32_t protocol_pcm          : 1;   ///< supports PCM short/long frame Protocol
 275   uint32_t protocol_ac97         : 1;   ///< supports AC'97 Protocol
 276   uint32_t mono_mode             : 1;   ///< supports Mono mode
 277   uint32_t companding            : 1;   ///< supports Companding
 278   uint32_t mclk_pin              : 1;   ///< supports MCLK (Master Clock) pin
 279   uint32_t event_frame_error     : 1;   ///< supports Frame error event: \ref ARM_SAI_EVENT_FRAME_ERROR
 280 } ARM_SAI_CAPABILITIES;
 281
 282
 283 /**
 284 \brief Access structure of the SAI Driver.
 285 */
 286 typedef struct _ARM_DRIVER_SAI {
 287   ARM_DRIVER_VERSION   (*GetVersion)      (void);                                            ///< Pointer to \ref ARM_SAI_GetVersion : Get driver version.
 288   ARM_SAI_CAPABILITIES (*GetCapabilities) (void);                                            ///< Pointer to \ref ARM_SAI_GetCapabilities : Get driver capabilities.
 289   int32_t              (*Initialize)      (ARM_SAI_SignalEvent_t cb_event);                  ///< Pointer to \ref ARM_SAI_Initialize : Initialize SAI Interface.
 290   int32_t              (*Uninitialize)    (void);                                            ///< Pointer to \ref ARM_SAI_Uninitialize : De-initialize SAI Interface.
 291   int32_t              (*PowerControl)    (ARM_POWER_STATE state);                           ///< Pointer to \ref ARM_SAI_PowerControl : Control SAI Interface Power.
 292   int32_t              (*Send)            (const void *data, uint32_t num);                  ///< Pointer to \ref ARM_SAI_Send : Start sending data to SAI Interface.
 293   int32_t              (*Receive)         (      void *data, uint32_t num);                  ///< Pointer to \ref ARM_SAI_Receive : Start receiving data from SAI Interface.
 294   uint32_t             (*GetTxCount)      (void);                                            ///< Pointer to \ref ARM_SAI_GetTxCount : Get transmitted data count.
 295   uint32_t             (*GetRxCount)      (void);                                            ///< Pointer to \ref ARM_SAI_GetRxCount : Get received data count.
 296   int32_t              (*Control)         (uint32_t control, uint32_t arg1, uint32_t arg2);  ///< Pointer to \ref ARM_SAI_Control : Control SAI Interface.
 297   ARM_SAI_STATUS       (*GetStatus)       (void);                                            ///< Pointer to \ref ARM_SAI_GetStatus : Get SAI status.
 298 } const ARM_DRIVER_SAI;
 299
 300 #ifdef  __cplusplus
 301 }
 302 #endif
 303
 304 #endif /* DRIVER_SAI_H_ */