view src/cs/services/audio/audio_mode_full_write.c @ 275:79cfefc1e2b4

audio mode load: gracefully handle mode files of wrong AEC version Unfortunately our change of enabling L1_NEW_AEC (which is necessary in order to bring our Calypso ARM fw into match with the underlying DSP reality) brings along a change in the audio mode file binary format and file size - all those new tunable AEC parameters do need to be stored somewhere, after all. But we already have existing mode files in the old format, and setting AEC config to garbage when loading old audio modes (which is what would happen without the present change) is not an appealing proposition. The solution implemented in the present change is as follows: the audio mode loading code checks the file size, and if it differs from the active version of T_AUDIO_MODE, the T_AUDIO_AEC_CFG structure is cleared - set to the default (disabled AEC) for the compiled type of AEC. We got lucky in that this varying T_AUDIO_AEC_CFG structure sits at the end of T_AUDIO_MODE!
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 30 Jul 2021 02:55:48 +0000
parents 4e78acac3d88
children
line wrap: on
line source

/****************************************************************************/
/*                                                                          */
/*  File Name:  audio_mode_full_write.c                                     */
/*                                                                          */
/*  Purpose:  This file contains all the functions used for audio mode full */
/*            write services.                                               */
/*                                                                          */
/*  Version   0.1                                                           */
/*                                                                          */
/*  Date        Modification                                                */
/*  ------------------------------------------------------------------------*/
/*  14 Jan 2002  Create                                                     */
/*                                                                          */
/*  Author      Francois Mazard                                             */
/*                                                                          */
/* (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved*/
/****************************************************************************/

#include "rv/rv_defined_swe.h"

#ifdef RVM_AUDIO_MAIN_SWE
  #ifndef _WINDOWS
    #include "config/swconfig.cfg"
    #include "config/sys.cfg"
    #include "config/chipset.cfg"
  #endif

  #include "l1_confg.h"
  #include "rv/rv_general.h"
  #include "rvm/rvm_gen.h"
  #include "audio/audio_ffs_i.h"
  #include "audio/audio_api.h"
  #include "audio/audio_structs_i.h"
  #include "audio/audio_error_hdlr_i.h"
  #include "audio/audio_var_i.h"
  #include "audio/audio_messages_i.h"
  #include "audio/audio_macro_i.h"
  #include "rvf/rvf_target.h"
  #include "audio/audio_const_i.h"

  /* include the usefull L1 header */
  #ifdef _WINDOWS
    #define BOOL_FLAG
    //#define CHAR_FLAG
  #endif
  #include "l1_types.h"
  #include "l1audio_const.h"
  #include "l1audio_cust.h"
  #include "l1audio_defty.h"
  #include "l1audio_msgty.h"
  #include "l1audio_signa.h"
  #if TESTMODE
   #include "l1tm_defty.h"
  #endif
  #if (L1_GTT == 1)
    #include "l1gtt_const.h"
    #include "l1gtt_defty.h"
  #endif
  #include "l1_const.h"
  #include "l1_defty.h"
  #include "l1_msgty.h"
  #include "l1_signa.h"
  #ifdef _WINDOWS
    #define L1_ASYNC_C
  #endif
  #include "l1_varex.h"

  #include "ffs/ffs_api.h"

  #ifndef _WINDOWS
    #include "l1audio_cust.h"
  #endif

  /* external dependency */
  extern T_AUDIO_RET audio_mode_voice_path_write               (T_AUDIO_VOICE_PATH_SETTING *data,
                                                                UINT8 *message_to_confirm);
  extern T_AUDIO_RET audio_mode_microphone_mode_write          (INT8  *data);
  extern T_AUDIO_RET audio_mode_microphone_gain_write          (INT8  *data);
  extern T_AUDIO_RET audio_mode_microphone_extra_gain_write    (INT8  *data);
  extern T_AUDIO_RET audio_mode_microphone_output_bias_write   (INT8  *data);
  extern T_AUDIO_RET audio_mode_speaker_mode_write             (INT8  *data);
  extern T_AUDIO_RET audio_mode_speaker_gain_write             (INT8  *data);
  extern T_AUDIO_RET audio_mode_speaker_filter_write           (INT8  *data);
  extern T_AUDIO_RET audio_mode_speaker_buzzer_write           (INT8  *data);
  extern T_AUDIO_RET audio_mode_sidetone_gain_write            (INT8  *data);
  extern T_AUDIO_RET audio_mode_aec_write                       (T_AUDIO_AEC_CFG *data);
  extern T_AUDIO_RET audio_mode_speaker_volume_write           (T_AUDIO_SPEAKER_LEVEL *data);
  extern T_AUDIO_RET audio_mode_speaker_microphone_fir_write   (T_AUDIO_FIR_COEF *data_speaker,
                                                                T_AUDIO_FIR_COEF *data_microphone);


  /********************************************************************************/
  /*                                                                              */
  /*    Function Name:   audio_mode_full_access_write_send_status                 */
  /*                                                                              */
  /*    Purpose:  This function sends the full acess write status to the entity.  */
  /*                                                                              */
  /*    Input Parameters:                                                         */
  /*        status,                                                               */
  /*        return path                                                           */
  /*                                                                              */
  /*    Output Parameters:                                                        */
  /*        None.                                                                 */
  /*                                                                              */
  /*    Note:                                                                     */
  /*        None.                                                                 */
  /*                                                                              */
  /*    Revision History:                                                         */
  /*        None.                                                                 */
  /*                                                                              */
  /********************************************************************************/
  void audio_mode_full_access_write_send_status (T_AUDIO_RET status, T_RV_RETURN return_path)
  {
    void *p_send_message = NULL;
    T_RVF_MB_STATUS mb_status = RVF_RED;

    while (mb_status == RVF_RED)
    {
      /* allocate the message buffer */
      mb_status = rvf_get_buf (p_audio_gbl_var->mb_external,
                               sizeof (T_AUDIO_FULL_ACCESS_WRITE_DONE),
                               (T_RVF_BUFFER **) (&p_send_message));

      /* If insufficient resources, then report a memory error and abort.               */
      /* and wait until more ressource is given */
      if (mb_status == RVF_RED)
      {
        audio_mode_error_trace(AUDIO_ENTITY_NO_MEMORY);
        rvf_delay(RVF_MS_TO_TICKS(1000));
      }
    }
    /*fill the header of the message */
    ((T_AUDIO_FULL_ACCESS_WRITE_DONE *)(p_send_message))->os_hdr.msg_id =
      AUDIO_FULL_ACCESS_WRITE_DONE;

    /* fill the status parameters */
    ((T_AUDIO_FULL_ACCESS_WRITE_DONE *)(p_send_message))->status = status;

    if (return_path.callback_func == NULL)
    {
      /* send the message to the entity */
      rvf_send_msg (return_path.addr_id,
                    p_send_message);
    }
    else
    {
      /* call the callback function */
      (*return_path.callback_func)((void *)(p_send_message));
	  rvf_free_buf((T_RVF_BUFFER *)p_send_message);
    }
  }

  /********************************************************************************/
  /*                                                                              */
  /*    Function Name:   audio_mode_full_access_write_manager                     */
  /*                                                                              */
  /*    Purpose:  This function manage the audio mode full write services.        */
  /*                                                                              */
  /*    Input Parameters:                                                         */
  /*        Audio message.                                                        */
  /*                                                                              */
  /*    Output Parameters:                                                        */
  /*        None.                                                                 */
  /*                                                                              */
  /*    Note:                                                                     */
  /*        None.                                                                 */
  /*                                                                              */
  /*    Revision History:                                                         */
  /*        None.                                                                 */
  /*                                                                              */
  /********************************************************************************/
  void audio_mode_full_access_write_manager (T_RV_HDR *p_message)
  {
    T_AUDIO_MODE_FULL_ACCESS_WRITE_REQ *p_parameter;
    T_RV_RET      status_free_buf;
    T_AUDIO_RET   status = AUDIO_ERROR;
    UINT8         message_to_confirm;

    p_parameter = ((T_AUDIO_MODE_FULL_ACCESS_WRITE_REQ *)p_message);

    switch (p_audio_gbl_var->audio_mode_var.full_access_write_var.state)
    {
      case AUDIO_MODE_FULL_WRITE_IDLE:
      {
        switch (p_parameter->audio_parameter.variable_indentifier)
        {
          case AUDIO_PATH_USED:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: voice path", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_voice_path_write((T_AUDIO_VOICE_PATH_SETTING *)p_parameter->audio_parameter.data,
                                                 &message_to_confirm);

            if (status == AUDIO_OK)
            {
              /* Save the return path */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.callback_func =
                p_parameter->return_path.callback_func;
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.addr_id =
                p_parameter->return_path.addr_id;

              /* save the buffer pointer in order to deallocate it after */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.buffer =
                p_parameter->audio_parameter.data;

              /* Calculate the number of confirmation message to receive */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.number_of_message = message_to_confirm;

              p_audio_gbl_var->audio_mode_var.full_access_write_var.state = AUDIO_MODE_FULL_WRITE_WAIT_MESSAGE_CONF;
              return;
            }
            break;
          }
          case AUDIO_MICROPHONE_MODE:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: microphone mode", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_microphone_mode_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_MICROPHONE_GAIN:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: microphone gain", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_microphone_gain_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_MICROPHONE_EXTRA_GAIN:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: microphone extra gain", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_microphone_extra_gain_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_MICROPHONE_OUTPUT_BIAS:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: microphone output bias", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_microphone_output_bias_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_MICROPHONE_FIR:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: microphone FIR", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_speaker_microphone_fir_write(NULL,
                      (T_AUDIO_FIR_COEF *)p_parameter->audio_parameter.data);

            if (status == AUDIO_OK)
            {
              /* save the buffer pointer in order to deallocate it after */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.buffer =
                p_parameter->audio_parameter.data;

              /* Save the return path */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.callback_func =
                p_parameter->return_path.callback_func;
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.addr_id =
                p_parameter->return_path.addr_id;

              /* wait 1 message: FIR */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.number_of_message = 1;

              p_audio_gbl_var->audio_mode_var.full_access_write_var.state = AUDIO_MODE_FULL_WRITE_WAIT_MESSAGE_CONF;
              return;
            }
            break;
          }
          case AUDIO_SPEAKER_MODE:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: speaker mode", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_speaker_mode_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_SPEAKER_GAIN:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: speaker gain", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_speaker_gain_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_SPEAKER_FILTER:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: speaker filter", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_speaker_filter_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_SPEAKER_FIR:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: speaker FIR", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_speaker_microphone_fir_write ((T_AUDIO_FIR_COEF *)p_parameter->audio_parameter.data,
                      NULL);

            if (status == AUDIO_OK)
            {
              /* save the buffer pointer in order to deallocate it after */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.buffer =
                p_parameter->audio_parameter.data;

              /* Save the return path */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.callback_func =
                p_parameter->return_path.callback_func;
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.addr_id =
                p_parameter->return_path.addr_id;

              /* wait 1 message: FIR */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.number_of_message = 1;

              p_audio_gbl_var->audio_mode_var.full_access_write_var.state = AUDIO_MODE_FULL_WRITE_WAIT_MESSAGE_CONF;
              return;
            }
            break;
          }
          case AUDIO_SPEAKER_BUZZER_STATE:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: buzzer state", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_speaker_buzzer_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_MICROPHONE_SPEAKER_LOOP_SIDETONE:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: sidetone", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_sidetone_gain_write((INT8  *)p_parameter->audio_parameter.data);
            break;
          }
          case AUDIO_MICROPHONE_SPEAKER_LOOP_AEC:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: AEC", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_aec_write((T_AUDIO_AEC_CFG *)p_parameter->audio_parameter.data);

            if (status == AUDIO_OK)
            {
              /* save the buffer pointer in order to deallocate it after */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.buffer =
                p_parameter->audio_parameter.data;

              /* Save the return path */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.callback_func =
                p_parameter->return_path.callback_func;
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path.addr_id =
                p_parameter->return_path.addr_id;

              /* wait 1 message: AEC */
              p_audio_gbl_var->audio_mode_var.full_access_write_var.number_of_message = 1;

              p_audio_gbl_var->audio_mode_var.full_access_write_var.state = AUDIO_MODE_FULL_WRITE_WAIT_MESSAGE_CONF;
              return;
            }
            break;
          }
          case AUDIO_SPEAKER_VOLUME_LEVEL:
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: volume level", RV_TRACE_LEVEL_DEBUG_LOW);

            status = audio_mode_speaker_volume_write((T_AUDIO_SPEAKER_LEVEL *)p_parameter->audio_parameter.data);
            break;
          }
        }

          status_free_buf = rvf_free_buf((T_RVF_BUFFER *)p_parameter->audio_parameter.data);
          if (status_free_buf != RVF_GREEN)
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: A wrong data buffer is deallocated ",
                           RV_TRACE_LEVEL_ERROR);
          }

        /* Send the confirmation message */
        audio_mode_full_access_write_send_status (status, p_parameter->return_path);
        break;
      }
      case AUDIO_MODE_FULL_WRITE_WAIT_MESSAGE_CONF:
      {
        p_audio_gbl_var->audio_mode_var.full_access_write_var.number_of_message--;

        if (p_audio_gbl_var->audio_mode_var.full_access_write_var.number_of_message == 0)
        {
          status_free_buf = rvf_free_buf(p_audio_gbl_var->audio_mode_var.full_access_write_var.buffer);

          if (status_free_buf != RVF_GREEN)
          {
            AUDIO_SEND_TRACE("AUDIO MODE FULL ACCESS WRITE: A wrong data buffer is deallocated ",
                            RV_TRACE_LEVEL_ERROR);
            /* Send the confirmation message */
            audio_mode_full_access_write_send_status (AUDIO_ERROR,
              p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path);

            p_audio_gbl_var->audio_mode_var.full_access_write_var.state = AUDIO_MODE_FULL_WRITE_IDLE;
            return;
          }

          /* Send the confirmation message */
          audio_mode_full_access_write_send_status (AUDIO_OK,
            p_audio_gbl_var->audio_mode_var.full_access_write_var.return_path);

          p_audio_gbl_var->audio_mode_var.full_access_write_var.state = AUDIO_MODE_FULL_WRITE_IDLE;
        }

        break;
      }
    }
  }
#endif /* RVM_AUDIO_MAIN_SWE */