Add support for old init.
[bertos.git] / bertos / cpu / arm / drv / i2s_at91.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief I2S driver functions.
34  *
35  * This driver uses a double buffering technique to keep i2s bus busy. First fill in the two buffers
36  * using i2s_getBuffer(), then start audio playing with i2s_start(). Then call i2s_getFreeBuffer()
37  * until you have finished your samples. The reproduction will automatically stop if you don't
38  * call i2s_getFreeBuffer() frequently enough.
39  *
40  * Example:
41  * \code
42  * // fill in the buffers before start
43  * buf = i2s_getBuffer(I2S_FIRST_BUF);
44  * // ...
45  * buf = i2s_getBuffer(I2S_SECOND_BUF);
46  * // ...
47  * // here the driver will play only the first two buffers...
48  * i2s_start();
49  * // ...call getFreeBuffer() to continue playing.
50  * while (!(buf = i2s_getFreeBuffer()))
51  *     ;
52  * // now fill the buffer again
53  * \endcode
54  *
55  * \author Luca Ottaviano <lottaviano@develer.com>
56  *
57  * $WIZ$ module_name = "i2s"
58  * $WIZ$ module_configuration = "bertos/cfg/cfg_i2s.h"
59  * $WIZ$ module_supports = "at91"
60  */
61
62 #ifndef I2S_H
63 #define I2S_H
64
65 #include "cfg/cfg_i2s.h"
66
67 #include <cfg/compiler.h>
68 #include <cfg/macros.h>
69 #include <io/arm.h>
70
71 /**
72  * First buffer.
73  */
74 #define I2S_FIRST_BUF  0
75 /**
76  * Second buffer.
77  */
78 #define I2S_SECOND_BUF 1
79
80 /**
81  * Initializes the module and sets current buffer to I2S_FIRST_BUF.
82  */
83 void i2s_init(void);
84
85 /**
86  * Returns one of the two buffers or NULL if none is available.
87  *
88  * You can't call this function if you have already started the player.
89  * \param buf_num The number of the buffer, ie I2S_FIRST_BUF or I2S_SECOND_BUF.
90  * \return A pointer to the buffer if the buffer is available (not full), 0 on errors
91  */
92 uint8_t *i2s_getBuffer(unsigned buf_num);
93
94 /**
95  * Returns a buffer that will be played after the current one.
96  *
97  * You should fill it faster than your reproduction time. You can't call this function
98  * if the player is not running
99  * \return The next buffer to be played, 0 if both are busy.
100  */
101 uint8_t *i2s_getFreeBuffer(void);
102
103 /**
104  * Starts playing from I2S_FIRST_BUFFER.
105  *
106  * You must have filled both buffers before calling this function. Does nothing if already playing.
107  * \return false on errors, true otherwise.
108  */
109 bool i2s_start(void);
110
111 INLINE bool i2s_isPlaying(void)
112 {
113         return !(SSC_SR & BV(SSC_TXEMPTY));
114 }
115
116 #endif /* I2S_H */