annotate gsm-fw/L1/audio_include/l1audio_btapi.h @ 932:79657f9c5772

compal-flash-boot-for-fc created
author Mychaela Falconia <falcon@ivan.Harhan.ORG>
date Sat, 31 Oct 2015 03:04:03 +0000
parents 527956ce73c7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
603
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
1 /****************************************************
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
2 / FILE NAME:- BT_L1_API.h file.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
3 / ****************************************************/
605
527956ce73c7 gsm-fw/L1/audio_include/l1audio_btapi.h: messed up previous #include fix
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 604
diff changeset
4 #include "../../include/config.h"
604
45bf440cc677 gsm-fw/L1/audio_include: initial preen over the imported LoCosto headers
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 603
diff changeset
5 #include "../include/l1_confg.h"
45bf440cc677 gsm-fw/L1/audio_include: initial preen over the imported LoCosto headers
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents: 603
diff changeset
6 #include "../include/l1_types.h"
603
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
7 #if(L1_BT_AUDIO==1)
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
8
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
9 /****************************************************
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
10 / Data structure defination
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
11 / ****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
12 #define BT_STATUS_ERROR 1
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
13 #define BT_STATUS_OK 0
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
14
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
15 /*-------------------------------------------------------------------------------
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
16 * L1AudioPcmStatus type
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
17 *
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
18 * Defines status of current PCM buffer
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
19 *
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
20 */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
21 typedef unsigned char L1AudioPcmStatus;
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
22
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
23 #define L1_PCM_READY (0x01) /* the next PCM block is ready */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
24 #define L1_PCM_PENDING (0x02) /* the next PCM block is not ready yet.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
25 a callback will be made when it will be ready */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
26 #define L1_PCM_MEDIA_ENDED (0x03) /* no PCM blocks are available anymore.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
27 (e.g. current track ended) */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
28 #define L1_PCM_FAILED (0x04) /* no PCM blocks are ready. general failure */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
29
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
30 typedef struct _L1AudioPcmBlock
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
31 {
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
32 UWORD8 *pcmBuffer; /* a pointer to the buffer holding the PCM data */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
33 int lengthInBytes; /* how many bytes are currently in the PCM buffer */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
34 } L1AudioPcmBlock;
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
35
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
36 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
37 typedef struct _L1AudioPcmConfig
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
38 {
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
39 int sampleRate; /* PCM sample rate in Hz (e.g. 44100, 48000, 32000, 16000) */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
40 short numChannels; /* number of audio channels (1 or 2, for mono or stereo) */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
41 short bitsPerSample; /* number of bits per PCM sample. must always be 16. */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
42 } L1AudioPcmConfig;
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
43 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
44
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
45 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
46 typedef void (*L1AudioPcmCallback)(L1AudioPcmBlock *pcmBlock);
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
47 /*Description:- A callback function, implemented at BTHAL_MM, which will be called by L1-MCU to send a ready PCM block.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
48 The callback will be called by L1-MCU only after a previous call from BTHAL_MM to request a PCM block returned Pending.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
49 NOTE: Since the callback is called from L1 context, the BTHAL_MM code should not spend considerable time in this function.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
50 It must not block the L1-MCU task.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
51
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
52 Parameters:
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
53 pcmBlock [in] - a pointer to a PCM block structure
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
54 Returns: void
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
55 */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
56
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
57 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
58 typedef void (*L1AudioConfigureCallback) (L1AudioPcmConfig *pcmConfig);
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
59
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
60 /*Description:- A callback function, implemented at BTHAL_MM, that will be called by MCU-L1 to specify the next PCM configuration.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
61 L1-MCU will call this function before a new audio track is going to start playing. BT side will use this info to reconfigure the current
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
62 A2DP stream, and after the configuration is completed, it will start pulling PCM blocks from the L1-MCU stack.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
63 Parameters: pcmConfig [in] - pointer to struct with the PCM config info
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
64 */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
65
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
66 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
67
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
68
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
69 BOOL L1Audio_InformBtAudioPathState (BOOL connected);
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
70 /*Description: - This function is implemented in L1-MCU and called by BTHAL_MM to inform L1,
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
71 whether the audio path to BT is up or down. The use of this function is optional. It should be used by BTHAL_MM,
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
72 to find out that L1-MCU is not being told byBMI/MMI, whether to use the BT audio or not.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
73
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
74 Parameters:- connected [in] -
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
75 TRUE - path is valid, MM should send the PCM to BT
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
76 FALSE - path is not valid, MM should send the PCM to handset default audio device
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
77 Returns: void
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
78 */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
79
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
80 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
81 void L1Audio_RegisterBthal (L1AudioPcmCallback pcmCallback, L1AudioConfigureCallback configCallback);
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
82 /*Description: - This function is implemented in L1-MCU and called by BTHAL_MM to init the L1-MCU for BT audio
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
83 and to register callback functions that the L1-MCU will need to call into BTHAL.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
84
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
85 Parameters:
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
86 pcmCallback [in] - pointer of the PCM callback function.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
87 configCallback [in] - pointer of the config callback function.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
88 Returns: void
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
89 */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
90
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
91
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
92 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
93 L1AudioPcmStatus L1Audio_PullPcmBlock (L1AudioPcmBlock *pcmBlock);
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
94 /*Description: - This function is implemented in L1-MCU and called by BTHAL_MM to pull the next PCM block.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
95 If L1 already has a ready PCM block it should fill he pcmBlock parameter and return L1_PCM_READY.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
96 If a block is not ready yet, it should return with proper return type as defined below.
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
97
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
98 Parameters:
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
99 pcmBlock [out] - a pointer to PCM block struct. if the function returns MM_PCM_READY, MM should fill this struct with the info of the current ready PCM block .
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
100 Returns:
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
101 L1_PCM_READY: The next PCM block is ready now
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
102 L1_PCM_PENDING: The next PCM block is not ready yet, a callback will be made by MM when it is ready
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
103 L1_PCM_MEDIA_ENDED: no more PCM blocks will be available anymore for the current track
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
104 L1_PCM_FAILED: other failures
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
105 */
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
106
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
107 /****************************************************/
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
108
d638de8cc6b8 gsm-fw/L1/audio_*/*.h: replacing Leonardo headers with LoCosto versions
Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
parents:
diff changeset
109 #endif