audio_command_id.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/audio/audio_command_id.h
 *
 *   Copyright 2018 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#ifndef __INCLUDE_AUDIO_AUDIO_COMMAND_ID_H
#define __INCLUDE_AUDIO_AUDIO_COMMAND_ID_H


 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
/*--- Category Code --------------------------------------------------------*/

 
#define AUDCMD_CATEGORY_GENERAL      0x00
#define AUDCMD_CATEGORY_EFFECTOR     0x10
#define AUDCMD_CATEGORY_PLAYER       0x20
#define AUDCMD_CATEGORY_RECORDER     0x30
#define AUDCMD_CATEGORY_RECOGNITION  0x40
#define AUDCMD_CATEGORY_BASEBAND     0x50
#define AUDCMD_CATEGORY_THROUGH      0x60
#define AUDCMD_CATEGORY_TRANSITION   0x70
 
#define AUDCMD_CATEGORY_ERRNOTIFY    0xF0

 
/*--------------------------------------------------------------------------*/
/*--- General Function Code ------------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDCMD_GETSTATUS        (AUDCMD_CATEGORY_GENERAL | 0x01)

 
#define AUDCMD_INITATTENTIONS   (AUDCMD_CATEGORY_GENERAL | 0x02)



 
#define AUDRLT_NOTIFYSTATUS         AUDCMD_GETSTATUS

 
#define AUDRLT_INITATTENTIONSCMPLT  AUDCMD_INITATTENTIONS

 
/*--------------------------------------------------------------------------*/
/*--- Effector Function Code -----------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define  AUDCMD_INIT_MICFRONTEND (AUDCMD_CATEGORY_EFFECTOR | 0x01)

 
#define  AUDCMD_INIT_PREPROCESS_DSP (AUDCMD_CATEGORY_EFFECTOR | 0x02)

 
#define  AUDCMD_SET_PREPROCESS_DSP  (AUDCMD_CATEGORY_EFFECTOR | 0x03)

 
#define  AUDCMD_INIT_OUTPUTMIXER (AUDCMD_CATEGORY_EFFECTOR | 0x04)

 
#define  AUDCMD_INITMPP       (AUDCMD_CATEGORY_EFFECTOR | 0x05)

 
#define  AUDCMD_SETMPPPARAM   (AUDCMD_CATEGORY_EFFECTOR | 0x06)



 
#define  AUDRLT_INIT_MICFRONTEND  AUDCMD_INIT_MICFRONTEND

 
#define  AUDRLT_INIT_PREPROCESS_DSP_CMPLT  AUDCMD_INIT_PREPROCESS_DSP

 
#define  AUDRLT_SET_PREPROCESS_DSP_CMPLT   AUDCMD_SET_PREPROCESS_DSP

 
#define  AUDRLT_INIT_OUTPUTMIXER_CMPLT  AUDCMD_INIT_OUTPUTMIXER

 
#define  AUDRLT_INITMPPCMPLT    AUDCMD_INITMPP

 
#define  AUDRLT_SETMPPCMPLT     AUDCMD_SETMPPPARAM

 
/*--------------------------------------------------------------------------*/
/*--- Player Function Code -------------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDCMD_INITPLAYER     (AUDCMD_CATEGORY_PLAYER | 0x01)

 
#define AUDCMD_PLAYPLAYER     (AUDCMD_CATEGORY_PLAYER | 0x02)

 
#define AUDCMD_STOPPLAYER     (AUDCMD_CATEGORY_PLAYER | 0x03)

 
#define AUDCMD_CLKRECOVERY    (AUDCMD_CATEGORY_PLAYER | 0x04)

 
#define AUDCMD_SETGAIN        (AUDCMD_CATEGORY_PLAYER | 0x05)



 
#define  AUDRLT_INITPLAYERCMPLT      AUDCMD_INITPLAYER

 
#define  AUDRLT_PLAYCMPLT            AUDCMD_PLAYPLAYER

 
#define  AUDRLT_STOPCMPLT            AUDCMD_STOPPLAYER

 
#define  AUDRLT_CLKRECOVERY_CMPLT    AUDCMD_CLKRECOVERY

 
#define  AUDRLT_SETGAIN_CMPLT        AUDCMD_SETGAIN

 
#define  AUDRLT_SENDPFCMD_CMPLT      AUDCMD_SENDPOSTCMD

 
/*--------------------------------------------------------------------------*/
/*--- Recorder Function Code -----------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDCMD_INITREC    (AUDCMD_CATEGORY_RECORDER | 0x01)

 
#define AUDCMD_STARTREC   (AUDCMD_CATEGORY_RECORDER | 0x02)

 
#define AUDCMD_STOPREC    (AUDCMD_CATEGORY_RECORDER | 0x03)



 
#define AUDRLT_RECCMPLT      AUDCMD_STARTREC

 
#define AUDRLT_STOPRECCMPLT  AUDCMD_STOPREC

 
#define AUDRLT_INITRECCMPLT  AUDCMD_INITREC

 
/*--------------------------------------------------------------------------*/
/*--- Recognition Function Code --------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDCMD_START_RECOGNIZER  (AUDCMD_CATEGORY_RECOGNITION | 0x01)

 
#define AUDCMD_STOP_RECOGNIZER   (AUDCMD_CATEGORY_RECOGNITION | 0x02)

 
#define AUDCMD_INIT_RECOGNIZER   (AUDCMD_CATEGORY_RECOGNITION | 0x03)

 
#define AUDCMD_INIT_RECOGNIZER_DSP (AUDCMD_CATEGORY_RECOGNITION | 0x04)

 
#define AUDCMD_SET_RECOGNIZER_DSP  (AUDCMD_CATEGORY_RECOGNITION | 0x05)

 
/* result code */


 
#define  AUDRLT_START_RECOGNIZER_CMPLT  AUDCMD_START_RECOGNIZER

 
#define  AUDRLT_STOP_RECOGNIZER_CMPLT   AUDCMD_STOP_RECOGNIZER

 
#define  AUDRLT_INIT_RECOGNIZER_CMPLT   AUDCMD_INIT_RECOGNIZER

 
#define  AUDRLT_INIT_RECOGNIZER_DSP_CMPLT AUDCMD_INIT_RECOGNIZER_DSP

 
#define  AUDRLT_SET_RECOGNIZER_DSP_CMPLT  AUDCMD_SET_RECOGNIZER_DSP

 
/*--------------------------------------------------------------------------*/
/*--- Baseband Function Code -----------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDCMD_STARTBB          (AUDCMD_CATEGORY_BASEBAND | 0x01)

 
#define AUDCMD_STOPBB           (AUDCMD_CATEGORY_BASEBAND | 0x02)

 
#define AUDCMD_INITMICGAIN      (AUDCMD_CATEGORY_BASEBAND | 0x03)

 
#define AUDCMD_INITI2SPARAM     (AUDCMD_CATEGORY_BASEBAND | 0x04)

 
#define AUDCMD_INITDEQPARAM     (AUDCMD_CATEGORY_BASEBAND | 0x05)

 
#define AUDCMD_INITOUTPUTSELECT (AUDCMD_CATEGORY_BASEBAND | 0x06)

 
#define AUDCMD_INITDNCPARAM     (AUDCMD_CATEGORY_BASEBAND | 0x07)

 
#define AUDCMD_INITCLEARSTEREO  (AUDCMD_CATEGORY_BASEBAND | 0x08)

 
#define AUDCMD_SETVOLUME        (AUDCMD_CATEGORY_BASEBAND | 0x09)

 
#define AUDCMD_SETVOLUMEMUTE    (AUDCMD_CATEGORY_BASEBAND | 0x0a)

 
#define AUDCMD_SETBEEPPARAM     (AUDCMD_CATEGORY_BASEBAND | 0x0b)

 
#define AUDCMD_SETRENDERINGCLK  (AUDCMD_CATEGORY_BASEBAND | 0x0c)

 
#define AUDCMD_INITSPDRVMODE     (AUDCMD_CATEGORY_BASEBAND | 0x0d)
#define AUDCMD_SETSPDRVMODE      (AUDCMD_INITSPDRVMODE) /* old command name */

 
#define AUDCMD_SETMICMAP        (AUDCMD_CATEGORY_BASEBAND | 0x0e)



 
#define AUDRLT_STARTBBCMPLT             AUDCMD_STARTBB

 
#define AUDRLT_STOPBBCMPLT              AUDCMD_STOPBB

 
#define AUDRLT_INITMICGAINCMPLT         AUDCMD_INITMICGAIN

 
#define AUDRLT_SETMICMAPCMPLT           AUDCMD_SETMICMAP

 
#define AUDRLT_INITI2SPARAMCMPLT        AUDCMD_INITI2SPARAM

 
#define AUDRLT_INITDEQPARAMCMPLT        AUDCMD_INITDEQPARAM

 
#define AUDRLT_INITOUTPUTSELECTCMPLT    AUDCMD_INITOUTPUTSELECT

 
#define AUDRLT_INITDNCPARAMCMPLT        AUDCMD_INITDNCPARAM

 
#define AUDRLT_INITCLEARSTEREOCMPLT     AUDCMD_INITCLEARSTEREO

 
#define AUDRLT_SETVOLUMECMPLT           AUDCMD_SETVOLUME

 
#define AUDRLT_SETVOLUMEMUTECMPLT       AUDCMD_SETVOLUMEMUTE

 
#define AUDRLT_SETBEEPCMPLT             AUDCMD_SETBEEPPARAM

 
#define AUDRLT_SETRENDERINGCLKCMPLT     AUDCMD_SETRENDERINGCLK

 
#define AUDRLT_INITSPDRVMODECMPLT        AUDCMD_INITSPDRVMODE
#define AUDRLT_SETSPDRVMODECMPLT         AUDRLT_INITSPDRVMODECMPLT /* old result code */

 
/*--------------------------------------------------------------------------*/
/*--- Through Function Code ------------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDCMD_SETTHROUGHPATH   (AUDCMD_CATEGORY_THROUGH | 0x01)



 
#define AUDRLT_SETTHROUGHPATHCMPLT       AUDCMD_SETTHROUGHPATH

 
/*--------------------------------------------------------------------------*/
/*--- Transition Function Code ---------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDCMD_POWERON              (AUDCMD_CATEGORY_TRANSITION | 0x01)

 
#define AUDCMD_SETPOWEROFFSTATUS    (AUDCMD_CATEGORY_TRANSITION | 0x02)

 
#define AUDCMD_SETBASEBANDSTATUS    (AUDCMD_CATEGORY_TRANSITION | 0x03)

 
#define AUDCMD_SETPLAYERSTATUS      (AUDCMD_CATEGORY_TRANSITION | 0x04)

 
#define AUDCMD_SETRECORDERSTATUS    (AUDCMD_CATEGORY_TRANSITION | 0x05)

 
#define AUDCMD_SETREADYSTATUS       (AUDCMD_CATEGORY_TRANSITION | 0x06)

 
#define AUDCMD_SETTHROUGHSTATUS     (AUDCMD_CATEGORY_TRANSITION | 0x07)

 
#define AUDCMD_SETPLAYERSTATUSPOST  (AUDCMD_CATEGORY_TRANSITION | 0x08)

 
#define AUDCMD_SETRECOGNIZERSTATUS  (AUDCMD_CATEGORY_TRANSITION | 0x09)



 
#define AUDRLT_STATUSCHANGED        (AUDCMD_CATEGORY_TRANSITION | 0x0f)

 
/*--------------------------------------------------------------------------*/
/*--- Error Notification Code ----------------------------------------------*/
/*--------------------------------------------------------------------------*/


 
#define AUDRLT_ERRORRESPONSE          (AUDCMD_CATEGORY_ERRNOTIFY | 0x01)

 
#define AUDRLT_ERRORATTENTION         (AUDCMD_CATEGORY_ERRNOTIFY | 0x02)

 
#endif /* __INCLUDE_AUDIO_AUDIO_COMMAND_ID_H */