4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
33 * \brief TAS5706A Power DAC i2c driver.
36 * \author Francesco Sacchi <batt@develer.com>
38 * $WIZ$ module_name = "tas5706a"
39 * $WIZ$ module_depends = "timer", "i2c"
40 * $WIZ$ module_configuration = "bertos/cfg/cfg_tas5706a.h"
41 * $WIZ$ module_hw = "bertos/hw/hw_tas5706a.h"
44 #ifndef DRV_TAS5706A_H
45 #define DRV_TAS5706A_H
47 #include "cfg/cfg_i2c.h"
49 #include <cfg/compiler.h>
54 #define tas5706a_init(...) PP_CAT(tas5706a_init ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
55 #define tas5706a_setLowPower(...) PP_CAT(tas5706a_setLowPower ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
56 #define tas5706a_setVolume(...) PP_CAT(tas5706a_setVolume ## _, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
58 #define tas5706a_init(args...) PP_CAT(tas5706a_init ## _, COUNT_PARMS(args)) (args)
59 #define tas5706a_setLowPower(args...) PP_CAT(tas5706a_setLowPower ## _, COUNT_PARMS(args)) (args)
60 #define tas5706a_setVolume(args...) PP_CAT(tas5706a_setVolume ## _, COUNT_PARMS(args)) (args)
63 typedef enum Tas5706aCh
71 * TAS minimum volume (%).
76 * TAS maximum volume (%).
78 #define TAS_VOL_MAX 100
80 typedef uint8_t tas5706a_vol_t;
83 * Set the volume for the specified channel.
85 * The volume must be expressed in % and will be at maximum CONFIG_TAS_MAX_VOL.
87 * \param i2c The i2c context.
88 * \param ch The channel to be controlled.
89 * \param vol The volume you want to set.
91 void tas5706a_setVolume_3(I2c *i2c, Tas5706aCh ch, tas5706a_vol_t vol);
94 * Set TAS chip to low power mode.
96 * When in low power mode, the TAS will not play any sound. You should put the TAS chip in low
97 * power whenever possible to prevent overheating and to save power.
99 * \param i2c The i2c context.
100 * \param val True if you want to enable low power mode, false otherwise.
102 void tas5706a_setLowPower_2(I2c *i2c, bool val);
105 * Initialize the TAS chip.
107 * \param i2c The i2c context.
109 void tas5706a_init_1(I2c *i2c);
111 #if !CONFIG_I2C_DISABLE_OLD_API
113 DEPRECATED INLINE void tas5706a_setVolume_2(Tas5706aCh ch, tas5706a_vol_t vol)
115 tas5706a_setVolume_3(&local_i2c_old_api, ch, vol);
117 DEPRECATED INLINE void tas5706a_setLowPower_1(bool val)
119 tas5706a_setLowPower_2(&local_i2c_old_api, val);
121 DEPRECATED INLINE void tas5706a_init_0(void)
123 tas5706a_init_1(&local_i2c_old_api);
126 #endif /* !CONFIG_I2C_DISABLE_OLD_API */
128 #endif /* DRV_TAS5706A_H */