2 * Copyright (c) 2013-2020 ARM Limited. All rights reserved.
4 * SPDX-License-Identifier: Apache-2.0
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
10 * www.apache.org/licenses/LICENSE-2.0
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.
18 * $Date: 24. January 2020
21 * Project: SAI (Serial Audio Interface) Driver definitions
26 * Removed volatile from ARM_SAI_STATUS
28 * ARM_SAI_STATUS made volatile
41 #include "Driver_Common.h"
43 #define ARM_SAI_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(1,2) /* API version */
46 /****** SAI Control Codes *****/
48 #define ARM_SAI_CONTROL_Msk (0xFFUL)
49 #define ARM_SAI_CONFIGURE_TX (0x01UL) ///< Configure Transmitter; arg1 and arg2 provide additional configuration
50 #define ARM_SAI_CONFIGURE_RX (0x02UL) ///< Configure Receiver; arg1 and arg2 provide additional configuration
51 #define ARM_SAI_CONTROL_TX (0x03UL) ///< Control Transmitter; arg1.0: 0=disable (default), 1=enable; arg1.1: mute
52 #define ARM_SAI_CONTROL_RX (0x04UL) ///< Control Receiver; arg1.0: 0=disable (default), 1=enable
53 #define ARM_SAI_MASK_SLOTS_TX (0x05UL) ///< Mask Transmitter slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default
54 #define ARM_SAI_MASK_SLOTS_RX (0x06UL) ///< Mask Receiver slots; arg1 = mask (bit: 0=active, 1=inactive); all configured slots are active by default
55 #define ARM_SAI_ABORT_SEND (0x07UL) ///< Abort \ref ARM_SAI_Send
56 #define ARM_SAI_ABORT_RECEIVE (0x08UL) ///< Abort \ref ARM_SAI_Receive
58 /*----- SAI Control Codes: Configuration Parameters: Mode -----*/
59 #define ARM_SAI_MODE_Pos 8
60 #define ARM_SAI_MODE_Msk (1UL << ARM_SAI_MODE_Pos)
61 #define ARM_SAI_MODE_MASTER (1UL << ARM_SAI_MODE_Pos) ///< Master Mode
62 #define ARM_SAI_MODE_SLAVE (0UL << ARM_SAI_MODE_Pos) ///< Slave Mode (default)
64 /*----- SAI Control Codes: Configuration Parameters: Synchronization -----*/
65 #define ARM_SAI_SYNCHRONIZATION_Pos 9
66 #define ARM_SAI_SYNCHRONIZATION_Msk (1UL << ARM_SAI_SYNCHRONIZATION_Pos)
67 #define ARM_SAI_ASYNCHRONOUS (0UL << ARM_SAI_SYNCHRONIZATION_Pos) ///< Asynchronous (default)
68 #define ARM_SAI_SYNCHRONOUS (1UL << ARM_SAI_SYNCHRONIZATION_Pos) ///< Synchronous
70 /*----- SAI Control Codes: Configuration Parameters: Protocol -----*/
71 #define ARM_SAI_PROTOCOL_Pos 10
72 #define ARM_SAI_PROTOCOL_Msk (7UL << ARM_SAI_PROTOCOL_Pos)
73 #define ARM_SAI_PROTOCOL_USER (0UL << ARM_SAI_PROTOCOL_Pos) ///< User defined (default)
74 #define ARM_SAI_PROTOCOL_I2S (1UL << ARM_SAI_PROTOCOL_Pos) ///< I2S
75 #define ARM_SAI_PROTOCOL_MSB_JUSTIFIED (2UL << ARM_SAI_PROTOCOL_Pos) ///< MSB (left) justified
76 #define ARM_SAI_PROTOCOL_LSB_JUSTIFIED (3UL << ARM_SAI_PROTOCOL_Pos) ///< LSB (right) justified
77 #define ARM_SAI_PROTOCOL_PCM_SHORT (4UL << ARM_SAI_PROTOCOL_Pos) ///< PCM with short frame
78 #define ARM_SAI_PROTOCOL_PCM_LONG (5UL << ARM_SAI_PROTOCOL_Pos) ///< PCM with long frame
79 #define ARM_SAI_PROTOCOL_AC97 (6UL << ARM_SAI_PROTOCOL_Pos) ///< AC'97
81 /*----- SAI Control Codes: Configuration Parameters: Data Size -----*/
82 #define ARM_SAI_DATA_SIZE_Pos 13
83 #define ARM_SAI_DATA_SIZE_Msk (0x1FUL << ARM_SAI_DATA_SIZE_Pos)
84 #define ARM_SAI_DATA_SIZE(n) ((((n)-1UL)&0x1FUL) << ARM_SAI_DATA_SIZE_Pos) ///< Data size in bits (8..32)
86 /*----- SAI Control Codes: Configuration Parameters: Bit Order -----*/
87 #define ARM_SAI_BIT_ORDER_Pos 18
88 #define ARM_SAI_BIT_ORDER_Msk (1UL << ARM_SAI_BIT_ORDER_Pos)
89 #define ARM_SAI_MSB_FIRST (0UL << ARM_SAI_BIT_ORDER_Pos) ///< Data is transferred with MSB first (default)
90 #define ARM_SAI_LSB_FIRST (1UL << ARM_SAI_BIT_ORDER_Pos) ///< Data is transferred with LSB first; User Protocol only (ignored otherwise)
92 /*----- SAI Control Codes: Configuration Parameters: Mono Mode -----*/
93 #define ARM_SAI_MONO_MODE (1UL << 19) ///< Mono Mode (only for I2S, MSB/LSB justified)
95 /*----- SAI Control Codes:Configuration Parameters: Companding -----*/
96 #define ARM_SAI_COMPANDING_Pos 20
97 #define ARM_SAI_COMPANDING_Msk (3UL << ARM_SAI_COMPANDING_Pos)
98 #define ARM_SAI_COMPANDING_NONE (0UL << ARM_SAI_COMPANDING_Pos) ///< No companding (default)
99 #define ARM_SAI_COMPANDING_A_LAW (2UL << ARM_SAI_COMPANDING_Pos) ///< A-Law companding
100 #define ARM_SAI_COMPANDING_U_LAW (3UL << ARM_SAI_COMPANDING_Pos) ///< u-Law companding
102 /*----- SAI Control Codes: Configuration Parameters: Clock Polarity -----*/
103 #define ARM_SAI_CLOCK_POLARITY_Pos 23
104 #define ARM_SAI_CLOCK_POLARITY_Msk (1UL << ARM_SAI_CLOCK_POLARITY_Pos)
105 #define ARM_SAI_CLOCK_POLARITY_0 (0UL << ARM_SAI_CLOCK_POLARITY_Pos) ///< Drive on falling edge, Capture on rising edge (default)
106 #define ARM_SAI_CLOCK_POLARITY_1 (1UL << ARM_SAI_CLOCK_POLARITY_Pos) ///< Drive on rising edge, Capture on falling edge
108 /*----- SAI Control Codes: Configuration Parameters: Master Clock Pin -----*/
109 #define ARM_SAI_MCLK_PIN_Pos 24
110 #define ARM_SAI_MCLK_PIN_Msk (3UL << ARM_SAI_MCLK_PIN_Pos)
111 #define ARM_SAI_MCLK_PIN_INACTIVE (0UL << ARM_SAI_MCLK_PIN_Pos) ///< MCLK not used (default)
112 #define ARM_SAI_MCLK_PIN_OUTPUT (1UL << ARM_SAI_MCLK_PIN_Pos) ///< MCLK is output (Master only)
113 #define ARM_SAI_MCLK_PIN_INPUT (2UL << ARM_SAI_MCLK_PIN_Pos) ///< MCLK is input (Master only)
116 /****** SAI Configuration (arg1) *****/
118 /*----- SAI Configuration (arg1): Frame Length -----*/
119 #define ARM_SAI_FRAME_LENGTH_Pos 0
120 #define ARM_SAI_FRAME_LENGTH_Msk (0x3FFUL << ARM_SAI_FRAME_LENGTH_Pos)
121 #define ARM_SAI_FRAME_LENGTH(n) ((((n)-1UL)&0x3FFUL) << ARM_SAI_FRAME_LENGTH_Pos) ///< Frame length in bits (8..1024); default depends on protocol and data
123 /*----- SAI Configuration (arg1): Frame Sync Width -----*/
124 #define ARM_SAI_FRAME_SYNC_WIDTH_Pos 10
125 #define ARM_SAI_FRAME_SYNC_WIDTH_Msk (0xFFUL << ARM_SAI_FRAME_SYNC_WIDTH_Pos)
126 #define ARM_SAI_FRAME_SYNC_WIDTH(n) ((((n)-1UL)&0xFFUL) << ARM_SAI_FRAME_SYNC_WIDTH_Pos) ///< Frame Sync width in bits (1..256); default=1; User Protocol only (ignored otherwise)
128 /*----- SAI Configuration (arg1): Frame Sync Polarity -----*/
129 #define ARM_SAI_FRAME_SYNC_POLARITY_Pos 18
130 #define ARM_SAI_FRAME_SYNC_POLARITY_Msk (1UL << ARM_SAI_FRAME_SYNC_POLARITY_Pos)
131 #define ARM_SAI_FRAME_SYNC_POLARITY_HIGH (0UL << ARM_SAI_FRAME_SYNC_POLARITY_Pos) ///< Frame Sync is active high (default); User Protocol only (ignored otherwise)
132 #define ARM_SAI_FRAME_SYNC_POLARITY_LOW (1UL << ARM_SAI_FRAME_SYNC_POLARITY_Pos) ///< Frame Sync is active low; User Protocol only (ignored otherwise)
134 /*----- SAI Configuration (arg1): Frame Sync Early -----*/
135 #define ARM_SAI_FRAME_SYNC_EARLY (1UL << 19) ///< Frame Sync one bit before the first bit of the frame; User Protocol only (ignored otherwise)
137 /*----- SAI Configuration (arg1): Slot Count -----*/
138 #define ARM_SAI_SLOT_COUNT_Pos 20
139 #define ARM_SAI_SLOT_COUNT_Msk (0x1FUL << ARM_SAI_SLOT_COUNT_Pos)
140 #define ARM_SAI_SLOT_COUNT(n) ((((n)-1UL)&0x1FUL) << ARM_SAI_SLOT_COUNT_Pos) ///< Number of slots in frame (1..32); default=1; User Protocol only (ignored otherwise)
142 /*----- SAI Configuration (arg1): Slot Size -----*/
143 #define ARM_SAI_SLOT_SIZE_Pos 25
144 #define ARM_SAI_SLOT_SIZE_Msk (3UL << ARM_SAI_SLOT_SIZE_Pos)
145 #define ARM_SAI_SLOT_SIZE_DEFAULT (0UL << ARM_SAI_SLOT_SIZE_Pos) ///< Slot size is equal to data size (default)
146 #define ARM_SAI_SLOT_SIZE_16 (1UL << ARM_SAI_SLOT_SIZE_Pos) ///< Slot size = 16 bits; User Protocol only (ignored otherwise)
147 #define ARM_SAI_SLOT_SIZE_32 (3UL << ARM_SAI_SLOT_SIZE_Pos) ///< Slot size = 32 bits; User Protocol only (ignored otherwise)
149 /*----- SAI Configuration (arg1): Slot Offset -----*/
150 #define ARM_SAI_SLOT_OFFSET_Pos 27
151 #define ARM_SAI_SLOT_OFFSET_Msk (0x1FUL << ARM_SAI_SLOT_OFFSET_Pos)
152 #define ARM_SAI_SLOT_OFFSET(n) (((n)&0x1FUL) << ARM_SAI_SLOT_OFFSET_Pos) ///< Offset of first data bit in slot (0..31); default=0; User Protocol only (ignored otherwise)
154 /****** SAI Configuration (arg2) *****/
156 /*----- SAI Control Codes: Configuration Parameters: Audio Frequency (Master only) -----*/
157 #define ARM_SAI_AUDIO_FREQ_Msk (0x0FFFFFUL) ///< Audio frequency mask
159 /*----- SAI Control Codes: Configuration Parameters: Master Clock Prescaler (Master only and MCLK Pin) -----*/
160 #define ARM_SAI_MCLK_PRESCALER_Pos 20
161 #define ARM_SAI_MCLK_PRESCALER_Msk (0xFFFUL << ARM_SAI_MCLK_PRESCALER_Pos)
162 #define ARM_SAI_MCLK_PRESCALER(n) ((((n)-1UL)&0xFFFUL) << ARM_SAI_MCLK_PRESCALER_Pos) ///< MCLK prescaler; Audio_frequency = MCLK/n; n = 1..4096 (default=1)
165 /****** SAI specific error codes *****/
166 #define ARM_SAI_ERROR_SYNCHRONIZATION (ARM_DRIVER_ERROR_SPECIFIC - 1) ///< Specified Synchronization not supported
167 #define ARM_SAI_ERROR_PROTOCOL (ARM_DRIVER_ERROR_SPECIFIC - 2) ///< Specified Protocol not supported
168 #define ARM_SAI_ERROR_DATA_SIZE (ARM_DRIVER_ERROR_SPECIFIC - 3) ///< Specified Data size not supported
169 #define ARM_SAI_ERROR_BIT_ORDER (ARM_DRIVER_ERROR_SPECIFIC - 4) ///< Specified Bit order not supported
170 #define ARM_SAI_ERROR_MONO_MODE (ARM_DRIVER_ERROR_SPECIFIC - 5) ///< Specified Mono mode not supported
171 #define ARM_SAI_ERROR_COMPANDING (ARM_DRIVER_ERROR_SPECIFIC - 6) ///< Specified Companding not supported
172 #define ARM_SAI_ERROR_CLOCK_POLARITY (ARM_DRIVER_ERROR_SPECIFIC - 7) ///< Specified Clock polarity not supported
173 #define ARM_SAI_ERROR_AUDIO_FREQ (ARM_DRIVER_ERROR_SPECIFIC - 8) ///< Specified Audio frequency not supported
174 #define ARM_SAI_ERROR_MCLK_PIN (ARM_DRIVER_ERROR_SPECIFIC - 9) ///< Specified MCLK Pin setting not supported
175 #define ARM_SAI_ERROR_MCLK_PRESCALER (ARM_DRIVER_ERROR_SPECIFIC - 10) ///< Specified MCLK Prescaler not supported
176 #define ARM_SAI_ERROR_FRAME_LENGTH (ARM_DRIVER_ERROR_SPECIFIC - 11) ///< Specified Frame length not supported
177 #define ARM_SAI_ERROR_FRAME_LENGHT (ARM_DRIVER_ERROR_SPECIFIC - 11) ///< Specified Frame length not supported @deprecated use \ref ARM_SAI_ERROR_FRAME_LENGTH instead
178 #define ARM_SAI_ERROR_FRAME_SYNC_WIDTH (ARM_DRIVER_ERROR_SPECIFIC - 12) ///< Specified Frame Sync width not supported
179 #define ARM_SAI_ERROR_FRAME_SYNC_POLARITY (ARM_DRIVER_ERROR_SPECIFIC - 13) ///< Specified Frame Sync polarity not supported
180 #define ARM_SAI_ERROR_FRAME_SYNC_EARLY (ARM_DRIVER_ERROR_SPECIFIC - 14) ///< Specified Frame Sync early not supported
181 #define ARM_SAI_ERROR_SLOT_COUNT (ARM_DRIVER_ERROR_SPECIFIC - 15) ///< Specified Slot count not supported
182 #define ARM_SAI_ERROR_SLOT_SIZE (ARM_DRIVER_ERROR_SPECIFIC - 16) ///< Specified Slot size not supported
183 #define ARM_SAI_ERROR_SLOT_OFFESET (ARM_DRIVER_ERROR_SPECIFIC - 17) ///< Specified Slot offset not supported
189 typedef struct _ARM_SAI_STATUS {
190 uint32_t tx_busy : 1; ///< Transmitter busy flag
191 uint32_t rx_busy : 1; ///< Receiver busy flag
192 uint32_t tx_underflow : 1; ///< Transmit data underflow detected (cleared on start of next send operation)
193 uint32_t rx_overflow : 1; ///< Receive data overflow detected (cleared on start of next receive operation)
194 uint32_t frame_error : 1; ///< Sync Frame error detected (cleared on start of next send/receive operation)
195 uint32_t reserved : 27;
199 /****** SAI Event *****/
200 #define ARM_SAI_EVENT_SEND_COMPLETE (1UL << 0) ///< Send completed
201 #define ARM_SAI_EVENT_RECEIVE_COMPLETE (1UL << 1) ///< Receive completed
202 #define ARM_SAI_EVENT_TX_UNDERFLOW (1UL << 2) ///< Transmit data not available
203 #define ARM_SAI_EVENT_RX_OVERFLOW (1UL << 3) ///< Receive data overflow
204 #define ARM_SAI_EVENT_FRAME_ERROR (1UL << 4) ///< Sync Frame error in Slave mode (optional)
207 // Function documentation
209 \fn ARM_DRIVER_VERSION ARM_SAI_GetVersion (void)
210 \brief Get driver version.
211 \return \ref ARM_DRIVER_VERSION
213 \fn ARM_SAI_CAPABILITIES ARM_SAI_GetCapabilities (void)
214 \brief Get driver capabilities.
215 \return \ref ARM_SAI_CAPABILITIES
217 \fn int32_t ARM_SAI_Initialize (ARM_SAI_SignalEvent_t cb_event)
218 \brief Initialize SAI Interface.
219 \param[in] cb_event Pointer to \ref ARM_SAI_SignalEvent
220 \return \ref execution_status
222 \fn int32_t ARM_SAI_Uninitialize (void)
223 \brief De-initialize SAI Interface.
224 \return \ref execution_status
226 \fn int32_t ARM_SAI_PowerControl (ARM_POWER_STATE state)
227 \brief Control SAI Interface Power.
228 \param[in] state Power state
229 \return \ref execution_status
231 \fn int32_t ARM_SAI_Send (const void *data, uint32_t num)
232 \brief Start sending data to SAI transmitter.
233 \param[in] data Pointer to buffer with data to send to SAI transmitter
234 \param[in] num Number of data items to send
235 \return \ref execution_status
237 \fn int32_t ARM_SAI_Receive (void *data, uint32_t num)
238 \brief Start receiving data from SAI receiver.
239 \param[out] data Pointer to buffer for data to receive from SAI receiver
240 \param[in] num Number of data items to receive
241 \return \ref execution_status
243 \fn uint32_t ARM_SAI_GetTxCount (void)
244 \brief Get transmitted data count.
245 \return number of data items transmitted
247 \fn uint32_t ARM_SAI_GetRxCount (void)
248 \brief Get received data count.
249 \return number of data items received
251 \fn int32_t ARM_SAI_Control (uint32_t control, uint32_t arg1, uint32_t arg2)
252 \brief Control SAI Interface.
253 \param[in] control Operation
254 \param[in] arg1 Argument 1 of operation (optional)
255 \param[in] arg2 Argument 2 of operation (optional)
256 \return common \ref execution_status and driver specific \ref sai_execution_status
258 \fn ARM_SAI_STATUS ARM_SAI_GetStatus (void)
259 \brief Get SAI status.
260 \return SAI status \ref ARM_SAI_STATUS
262 \fn void ARM_SAI_SignalEvent (uint32_t event)
263 \brief Signal SAI Events.
264 \param[in] event \ref SAI_events notification mask
268 typedef void (*ARM_SAI_SignalEvent_t) (uint32_t event); ///< Pointer to \ref ARM_SAI_SignalEvent : Signal SAI Event.
272 \brief SAI Driver Capabilities.
274 typedef struct _ARM_SAI_CAPABILITIES {
275 uint32_t asynchronous : 1; ///< supports asynchronous Transmit/Receive
276 uint32_t synchronous : 1; ///< supports synchronous Transmit/Receive
277 uint32_t protocol_user : 1; ///< supports user defined Protocol
278 uint32_t protocol_i2s : 1; ///< supports I2S Protocol
279 uint32_t protocol_justified : 1; ///< supports MSB/LSB justified Protocol
280 uint32_t protocol_pcm : 1; ///< supports PCM short/long frame Protocol
281 uint32_t protocol_ac97 : 1; ///< supports AC'97 Protocol
282 uint32_t mono_mode : 1; ///< supports Mono mode
283 uint32_t companding : 1; ///< supports Companding
284 uint32_t mclk_pin : 1; ///< supports MCLK (Master Clock) pin
285 uint32_t event_frame_error : 1; ///< supports Frame error event: \ref ARM_SAI_EVENT_FRAME_ERROR
286 uint32_t reserved : 21; ///< Reserved (must be zero)
287 } ARM_SAI_CAPABILITIES;
291 \brief Access structure of the SAI Driver.
293 typedef struct _ARM_DRIVER_SAI {
294 ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_SAI_GetVersion : Get driver version.
295 ARM_SAI_CAPABILITIES (*GetCapabilities) (void); ///< Pointer to \ref ARM_SAI_GetCapabilities : Get driver capabilities.
296 int32_t (*Initialize) (ARM_SAI_SignalEvent_t cb_event); ///< Pointer to \ref ARM_SAI_Initialize : Initialize SAI Interface.
297 int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_SAI_Uninitialize : De-initialize SAI Interface.
298 int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_SAI_PowerControl : Control SAI Interface Power.
299 int32_t (*Send) (const void *data, uint32_t num); ///< Pointer to \ref ARM_SAI_Send : Start sending data to SAI Interface.
300 int32_t (*Receive) ( void *data, uint32_t num); ///< Pointer to \ref ARM_SAI_Receive : Start receiving data from SAI Interface.
301 uint32_t (*GetTxCount) (void); ///< Pointer to \ref ARM_SAI_GetTxCount : Get transmitted data count.
302 uint32_t (*GetRxCount) (void); ///< Pointer to \ref ARM_SAI_GetRxCount : Get received data count.
303 int32_t (*Control) (uint32_t control, uint32_t arg1, uint32_t arg2); ///< Pointer to \ref ARM_SAI_Control : Control SAI Interface.
304 ARM_SAI_STATUS (*GetStatus) (void); ///< Pointer to \ref ARM_SAI_GetStatus : Get SAI status.
305 } const ARM_DRIVER_SAI;
311 #endif /* DRIVER_SAI_H_ */