Add comment.
[bertos.git] / bertos / cfg / cfg_i2s.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  * All Rights Reserved.
31  * -->
32  *
33  * \brief Configuration file for I2S module.
34  *
35  *
36  * \author Luca Ottaviano <lottaviano@develer.com>
37  * \author Daniele Basile <asterix@develer.com>
38  */
39
40 #ifndef CFG_I2S_H
41 #define CFG_I2S_H
42
43 /**
44  * Module logging level.
45  *
46  * $WIZ$ type = "enum"
47  * $WIZ$ value_list = "log_level"
48  */
49 #define I2S_LOG_LEVEL      LOG_LVL_INFO
50
51 /**
52  * Module logging format.
53  *
54  * $WIZ$ type = "enum"
55  * $WIZ$ value_list = "log_format"
56  */
57 #define I2S_LOG_FORMAT     LOG_FMT_TERSE
58
59 /**
60  * Length of each play buffer.
61  *
62  * $WIZ$ type = "int"
63  */
64 #define CONFIG_PLAY_BUF_LEN    8192
65
66 /**
67  * Sampling frequency of the audio file.
68  *
69  * $WIZ$ type = "int"
70  * $WIZ$ min =  32000
71  * $WIZ$ max = 192000
72  */
73 #define CONFIG_SAMPLE_FREQ     44800UL
74
75 /**
76  * Sample bits per channel.
77  *
78  * $WIZ$ type = "int"
79  * * $WIZ$ min = 8
80  * $WIZ$ max = 32
81  */
82 #define CONFIG_WORD_BIT_SIZE               16
83
84 /**
85  * Number of channel.
86  *
87  * $WIZ$ type = "int"
88  */
89 #define CONFIG_CHANNEL_NUM                  2
90
91 /**
92  * Size of trasmit start delay
93  *
94  * $WIZ$ type = "int"
95  * $WIZ$ min = 0
96  * $WIZ$ max = 255
97  */
98 #define CONFIG_DELAY                        0
99
100 /**
101  * Generate frame sync every 2 x CONFIG_PERIOD bits (zero based)
102  *
103  * $WIZ$ type = "int"
104  * $WIZ$ min = 0
105  * $WIZ$ max = 512
106  */
107 #define CONFIG_PERIOD                      15
108
109 /**
110  * Number of words transmitted in frame
111  *
112  * $WIZ$ type = "int"
113  * $WIZ$ min = 0
114  * $WIZ$ max = 16
115  */
116 #define CONFIG_WORD_PER_FRAME               1
117
118 /**
119  * Size of Synchro data register (zero based)
120  *
121  * $WIZ$ type = "int"
122  * $WIZ$ min = 0
123  * $WIZ$ max = 15
124  */
125 #define CONFIG_FRAME_SYNC_SIZE             15
126
127
128 /**
129  * Extra Size of Synchro data register (CONFIG_FRAME_SYNC_SIZE + CONFIG_EXTRA_FRAME_SYNC_SIZE * 16 + 1) (zero based)
130  *
131  * $WIZ$ type = "int"
132  * $WIZ$ min = 0
133  * $WIZ$ max = 15
134  */
135 #define CONFIG_EXTRA_FRAME_SYNC_SIZE       0
136
137 #endif /* CFG_I2S_H */