bertos/drv/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  *
  31  * -->
  32  *
  33  * \brief TAS5706A Power DAC i2c driver.
  34  *
  35  *
  36  * \author Francesco Sacchi <batt@develer.com>
  37  *
  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"
  42  */
  43
  44 #ifndef DRV_TAS5706A_H
  45 #define DRV_TAS5706A_H
  46
  47 #include <cfg/compiler.h>
  48
  49 typedef enum Tas5706aCh
  50 {
  51         TAS_CH1,
  52         TAS_CH2,
  53         TAS_CNT,
  54 } Tas5706aCh;
  55
  56 /**
  57  * TAS minimum volume (%).
  58  */
  59 #define TAS_VOL_MIN 0
  60
  61 /**
  62  * TAS maximum volume (%).
  63  */
  64 #define TAS_VOL_MAX 100
  65
  66 typedef uint8_t tas5706a_vol_t;
  67
  68 /**
  69  * Set the volume for the specified channel.
  70  *
  71  * The volume must be expressed in % and will be at maximum CONFIG_TAS_MAX_VOL.
  72  *
  73  * \param ch The channel to be controlled.
  74  * \param vol The volume you want to set.
  75  */
  76 void tas5706a_setVolume(Tas5706aCh ch, tas5706a_vol_t vol);
  77
  78 /**
  79  * Initialize the TAS chip.
  80  */
  81 void tas5706a_init(void);
  82
  83 /**
  84  * Set TAS chip to low power mode.
  85  *
  86  * When in low power mode, the TAS will not play any sound. You should put the TAS chip in low
  87  * power whenever possible to prevent overheating and to save power.
  88  *
  89  * \param val True if you want to enable low power mode, false otherwise.
  90  */
  91 void tas5706a_setLowPower(bool val);
  92
  93 #endif /* DRV_TAS5706A_H */