view src/aci2/aci/hl_audio_drv.c @ 600:8f50b202e81f

board preprocessor conditionals: prep for more FC hw in the future This change eliminates the CONFIG_TARGET_FCDEV3B preprocessor symbol and all preprocessor conditionals throughout the code base that tested for it, replacing them with CONFIG_TARGET_FCFAM or CONFIG_TARGET_FCMODEM. These new symbols are specified as follows: CONFIG_TARGET_FCFAM is intended to cover all hardware designs created by Mother Mychaela under the FreeCalypso trademark. This family will include modem products (repackagings of the FCDEV3B, possibly with RFFE or even RF transceiver changes), and also my desired FreeCalypso handset product. CONFIG_TARGET_FCMODEM is intended to cover all FreeCalypso modem products (which will be firmware-compatible with the FCDEV3B if they use TI Rita transceiver, or will require a different fw build if we switch to one of Silabs Aero transceivers), but not the handset product. Right now this CONFIG_TARGET_FCMODEM preprocessor symbol is used to conditionalize everything dealing with MCSI. At the present moment the future of FC hardware evolution is still unknown: it is not known whether we will ever have any beyond-FCDEV3B hardware at all (contingent on uncertain funding), and if we do produce further FC hardware designs, it is not known whether they will retain the same FIC modem core (triband), if we are going to have a quadband design that still retains the classic Rita transceiver, or if we are going to switch to Silabs Aero II or some other transceiver. If we produce a quadband modem that still uses Rita, it will run exactly the same fw as the FCDEV3B thanks to the way we define TSPACT signals for the RF_FAM=12 && CONFIG_TARGET_FCFAM combination, and the current fcdev3b build target will be renamed to fcmodem. OTOH, if that putative quadband modem will be Aero-based, then it will require a different fw build target, the fcdev3b target will stay as it is, and the two targets will both define CONFIG_TARGET_FCFAM and CONFIG_TARGET_FCMODEM, but will have different RF_FAM numbers. But no matter which way we are going to evolve, it is not right to have conditionals on CONFIG_TARGET_FCDEV3B in places like ACI, and the present change clears the way for future evolution.
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 01 Apr 2019 01:05:24 +0000
parents f18b29e27be5
children 92dbfa906f66
line wrap: on
line source

/*
+-----------------------------------------------------------------------------
|  Project :  GSM-PS (6147)
|  Modul   :  AOC
+-----------------------------------------------------------------------------
|  Copyright 2002 Texas Instruments Berlin, AG
|                 All rights reserved.
|
|                 This file is confidential and a trade secret of Texas
|                 Instruments Berlin, AG
|                 The receipt of or possession of this file does not convey
|                 any rights to reproduce or disclose its contents or to
|                 manufacture, use, or sell anything it may describe, in
|                 whole, or in part, without the specific written consent of
|                 Texas Instruments Berlin, AG.
+-----------------------------------------------------------------------------
|  Purpose :  This module defines the functions for the high level audio 
              driver interface.
+-----------------------------------------------------------------------------
*/


#ifndef HL_AUDIO_DRV_C
#define HL_AUDIO_DRV_C
#endif

#include "aci_all.h"
#include "aci_cmh.h"
#include "aci.h"
#include "psa.h"
#include "hl_audio_drv.h"
#include "rv/rv_general.h"
#include "audio/audio_api.h"
#include "fc-target.cfg"



/* ===============GLOBAL VARIABLES====================*/

LOCAL T_HL_VOCODER_STATE currVocoderState;

#ifdef CONFIG_TARGET_FCMODEM
GLOBAL UBYTE aci_digital_voice_autoswitch;
#endif

/* This flag helps enable the vocoder interface testing for
   specific tescases 
*/
#ifdef _SIMULATION_
BOOL vocoder_tst_flag; 
#endif


/* =============FUNCTION DEFINITIONS FOR L1===========*/
#ifndef _SIMULATION_
#ifdef VOCODER_FUNC_INTERFACE
void vocoder_mute_dl( BOOL mute );
void vocoder_mute_ul( BOOL mute );
void enable_tch_vocoder (BOOL vocoder_on);
#endif /* VOCODER_FUNC_INTERFACE */
#endif /* _SIMULATION_ */


/*================= FUNCTIONS ========================*/

/*
+-------------------------------------------------------------------+
| PROJECT : GSM-PS (6147)         MODULE  : HL_AUDIO_DRV            |
|                                 ROUTINE : hl_audio_drv_init       |
+-------------------------------------------------------------------+

  PURPOSE : This function is called to initialise the variables in 
            the High Level Audio driver
*/
GLOBAL void hl_audio_drv_init (void)
{
  TRACE_FUNCTION("hl_audio_drv_init()");

  currVocoderState = HL_VOCODER_DISABLED;
#ifdef _SIMULATION_
  vocoder_tst_flag = FALSE;
#endif

}


/*
+-------------------------------------------------------------------+
| PROJECT : GSM-PS (6147)         MODULE  : HL_AUDIO_DRV            |
|                                 ROUTINE : hl_drv_enable_vocoder   |
+-------------------------------------------------------------------+

  PURPOSE : This function is called to initialise the variables in 
            the High Level Audio driver
*/
GLOBAL T_HL_VOICE_DRV_RSLT hl_drv_enable_vocoder ( void )
{
#ifdef CONFIG_TARGET_FCMODEM
  T_AUDIO_VOICE_PATH_SETTING vpath = AUDIO_BLUETOOTH_HEADSET;
  T_AUDIO_FULL_ACCESS_WRITE audio_param;
  T_RV_RETURN return_path = { NULL, 0 };
#endif

  TRACE_FUNCTION("hl_drv_enable_vocoder()");
  /* If the vocoder is already enabled, then ignore the request */
  switch(currVocoderState)
  {
    case HL_VOCODER_ENABLED:
      TRACE_EVENT("*--Vocoder already active--*");
      return HL_VOICE_DRV_SUCC;

    case HL_VOCODER_ENABLE_REQ:
      TRACE_EVENT("*--Vocoder cannot be enabled--*");
      return HL_VOICE_DRV_FAIL;

    case HL_VOCODER_DISABLED:
      break;
  }

#ifdef _SIMULATION_
  if (vocoder_tst_flag)
#endif
  {
#ifndef VOCODER_FUNC_INTERFACE
  {
    PALLOC(mmi_tch_vocoder_cfg_req, MMI_TCH_VOCODER_CFG_REQ);
      mmi_tch_vocoder_cfg_req->vocoder_state = VOCODER_ENABLE;
    PSENDX(L1, mmi_tch_vocoder_cfg_req);
  }
    currVocoderState = HL_VOCODER_ENABLE_REQ;
#else
#ifndef _SIMULATION_
    TRACE_EVENT("Function interface for Vocoder");
    enable_tch_vocoder(TRUE);
    vocoder_mute_dl (FALSE);      /* un-mute speaker    */
    vocoder_mute_ul (FALSE);      /* un-mute microphone */
  #ifdef CONFIG_TARGET_FCMODEM
    if (aci_digital_voice_autoswitch)
    {
      audio_param.variable_indentifier = AUDIO_PATH_USED;
      audio_param.data = &vpath;
      audio_full_access_write(&audio_param, return_path);
    }
  #endif
    currVocoderState = HL_VOCODER_ENABLED;
#endif /* _SIMULATION_ */
#endif
  }
  return HL_VOICE_DRV_SUCC;
}

/*
+-------------------------------------------------------------------+
| PROJECT : GSM-PS (6147)         MODULE  : HL_AUDIO_DRV            |
|                                 ROUTINE : hl_drv_disable_vocoder  |
+-------------------------------------------------------------------+

  PURPOSE : This function is called to initialise the variables in 
            the High Level Audio driver
*/
GLOBAL void hl_drv_disable_vocoder ( void )
{
#ifdef CONFIG_TARGET_FCMODEM
  T_AUDIO_VOICE_PATH_SETTING vpath = AUDIO_GSM_VOICE_PATH;
  T_AUDIO_FULL_ACCESS_WRITE audio_param;
  T_RV_RETURN return_path = { NULL, 0 };
#endif

  TRACE_FUNCTION("hl_drv_disable_vocoder()");

  currVocoderState = HL_VOCODER_DISABLED;
#ifndef VOCODER_FUNC_INTERFACE
  /* Do nothing in this case */
#else
#ifndef _SIMULATION_
  TRACE_EVENT("Function interface for Vocoder");
  vocoder_mute_dl (TRUE);       /* mute speaker    */
  vocoder_mute_ul (TRUE);       /* mute microphone */
  enable_tch_vocoder (FALSE);   /* disable vocoder */
#ifdef CONFIG_TARGET_FCMODEM
  if (aci_digital_voice_autoswitch)
  {
    audio_param.variable_indentifier = AUDIO_PATH_USED;
    audio_param.data = &vpath;
    audio_full_access_write(&audio_param, return_path);
  }
#endif
#endif
#endif
}


/*
+-------------------------------------------------------------------+
| PROJECT : GSM-PS (6147)        MODULE  : HL_AUDIO_DRV             |
|                                ROUTINE : hl_drv_get_vocoder_state |
+-------------------------------------------------------------------+

  PURPOSE : This function returns the state of the vocoder
*/

GLOBAL T_HL_VOCODER_STATE hl_drv_get_vocoder_state (void)
{
  return currVocoderState;
}

#ifndef VOCODER_FUNC_INTERFACE
/*
+-------------------------------------------------------------------+
| PROJECT : GSM-PS (6147)        MODULE  : HL_AUDIO_DRV             |
|                                ROUTINE : hl_drv_vocoder_enabled   |
+-------------------------------------------------------------------+

  PURPOSE : Currently this function does nothing
*/

GLOBAL void hl_drv_vocoder_enabled (void)
{
  TRACE_FUNCTION("hl_drv_vocoder_enabled()");
  currVocoderState = HL_VOCODER_ENABLED;
}
#endif

#ifdef _SIMULATION_
/*
+-------------------------------------------------------------------+
| PROJECT : GSM-PS (6147)        MODULE  : HL_AUDIO_DRV             |
|                                ROUTINE : hl_audio_drv_initForTest |
+-------------------------------------------------------------------+

  PURPOSE : Initialise global variables related to simulaed 
*/

GLOBAL void hl_audio_drv_initForTest(void)
{
  vocoder_tst_flag = TRUE;
}
#endif