Add comments.
[bertos.git] / boards / arduino / hw / hw_tas5706a.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 HW pin handling.
34  *
35  *
36  * \author Francesco Sacchi <batt@develer.com>
37  */
38
39 #ifndef HW_TAS5706A_H
40 #define HW_TAS5706A_H
41
42 #include <cfg/macros.h>
43
44 #warning FIXME: This is an example implementation, you must implement it
45
46 #define TAS5706A_SETPOWERDOWN(val) do { (void) val; /* implement me */ } while (0)
47 #define TAS5706A_SETRESET(val)     do { (void) val; /* implement me */ } while (0)
48 #define TAS5706A_SETMUTE(val)      do { (void) val; /* implement me */ } while (0)
49
50 #define TAS5706A_PIN_INIT() \
51         do { \
52                 TAS5706A_SETPOWERDOWN(true); \
53                 TAS5706A_SETRESET(true); \
54                 TAS5706A_SETMUTE(true); \
55                 /* complete me */ \
56         } while (0)
57
58 #define TAS5706A_MCLK_INIT() \
59         do { \
60                 /* implement me */ \
61         } while(0)
62
63
64 #endif /* HW_TAS5706A_H */