systemservice/interface_unified/library/include/system_service/interfaceunified_system_types.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file interfaceunified_system_types.h
  19  * @brief \~english This file supports the System Manager audio source types.
  20  */
  21 /** @addtogroup BaseSystem
  22  *  @{
  23  */
  24 /** @addtogroup system_service
  25  *  @ingroup BaseSystem
  26  *  @{
  27  */
  28 /** @addtogroup interface_unified
  29  *  @ingroup system_service
  30  *  @{
  31  */
  32 #ifndef INTERFACEUNIFIED_SYSTEM_TYPES_H_  // NOLINT (build/header_guard)
  33 #define INTERFACEUNIFIED_SYSTEM_TYPES_H_
  34
  35
  36 typedef enum _SS_Sources {
  37   SS_SOURCE_NA = 0,
  38   SS_SOURCE_FM = 1,  //## To be integrated into SS_SOURCE_AMFM for _CWORD71_
  39   SS_SOURCE_AM = 2,  //## To be integrated into SS_SOURCE_AMFM for _CWORD71_
  40
  41   SS_SOURCE_CD = 3,    // For Audio CDs
  42   SS_SOURCE_AUX = 4,
  43
  44   SS_SOURCE_PHONE = 5,    // Will be deprecated soon, use specific Incoming or Outgoing call.
  45   SS_SOURCE_TA = 6,  // ## To be integrated into SS_SOURCE_AMFM for _CWORD71_
  46   SS_SOURCE_CHIMES = 7,
  47   SS_SOURCE_NAVI = 8,
  48
  49   SS_SOURCE_MSC = 9,              ///< Any mass storage device (USB-MSC, SD, HDD etc.,)
  50   SS_SOURCE_MTP = 10,             ///< _CWORD104_, MTP protocol devices(like _CWORD28_ over USB)
  51
  52   SS_SOURCE__CWORD57_ = 11,  // ## To be integrated into SS_SOURCE_USB and SS_SOURCE_USB2 for _CWORD71_
  53
  54   SS_SOURCE__CWORD73__APP = 12,        ///< _CWORD73_ based audio application (_CWORD74_ over BT/USB) - _CWORD22_, _CWORD13_ etc.,
  55   SS_SOURCE__CWORD73__VIDEO_MODE = 13,  ///< _CWORD73_ Video Mode (_CWORD57_ playback)
  56
  57   SS_SOURCE_STREAMING = 14,      ///< Streaming over Wi-fi
  58   SS_SOURCE_BT_AUDIO = 15,       ///< Bluetooth Audio
  59   SS_SOURCE_BT_SPP = 16,         ///< Bluetooth SPP based audio application (_CWORD28_/BB etc.,)
  60
  61   SS_SOURCE_SPEECH = 17,         ///< Speech audio playback
  62
  63   SS_SOURCE_USB = SS_SOURCE_MSC,  ///< will be deprecated soon
  64
  65   SS_SOURCE__CWORD59_ = 18,
  66   SS_SOURCE_ADRM = 19,
  67   SS_SOURCE__CWORD60_ = 20,
  68   SS_SOURCE_ADRA = 21,
  69
  70
  71   SS_SOURCE_INCOMING_CALL = SS_SOURCE_PHONE,
  72
  73   SS_SOURCE_PRIVATE_MODE_CALL = 24,
  74
  75   SS_SOURCE_HANDSFREE_SPEAKING = 25,
  76
  77   SS_SOURCE_FM_DAB = 29,
  78   SS_SOURCE_SD_CARD = 30,
  79   SS_SOURCE_SDARS = 31,
  80   SS_SOURCE_BROWSER_ENT = 32,
  81   SS_SOURCE_ML_ENT = 33,
  82   SS_SOURCE_ML_INFO = 34,
  83
  84   SS_SOURCE_DATA_CD = 35,    // For Data CDs
  85
  86   SS_SOURCE_TAS = 40,                   // TA on same frequency
  87
  88   SS_SOURCE_DTV = 41,
  89   SS_SOURCE_DVD = 42,
  90   SS_SOURCE_BD  = 43,
  91   SS_SOURCE_DELIVERY_APP = 44,
  92   SS_SOURCE_ENTUNE_ENT = 45,
  93   SS_SOURCE_HDD_AUDIO = 46,
  94   SS_SOURCE_JOYFUL_TALK = 47,
  95   SS_SOURCE_CLEARANCE_SONAR = 48,  // Not used, To be deleted
  96   SS_SOURCE_DSRC = 49,
  97   SS_SOURCE_ENTUNE_INFO = 50,    // Not used, To be deleted
  98   SS_SOURCE_HELPNET = 51,
  99   SS_SOURCE_OTV = 52,
 100   SS_SOURCE_MIRACAST = 53,
 101   SS_SOURCE_RSE = 54,
 102   SS_SOURCE_INSIDER = 55,
 103   SS_SOURCE_MAIL = 56,
 104   SS_SOURCE_MAIL_RINGTONE = 57,
 105   SS_SOURCE_BD_REAR = 58,
 106   SS_SOURCE_HDMI_REAR = 59,
 107   SS_SOURCE_SD_CARD_REAR = 60,
 108   SS_SOURCE_MIRACAST_REAR = 61,
 109   SS_SOURCE_USB_REAR = 62,    // Not used, To be deleted
 110   SS_SOURCE_DLNA_REAR = 63,
 111   SS_SOURCE_BROWSER_INFO = 64,
 112   SS_SOURCE_DSRC_ENT = 65,
 113   SS_SOURCE_RECDATA_PLAY = 66,
 114 // add Source  ##
 115   SS_SOURCE_AMFM = SS_SOURCE_FM,
 116   SS_SOURCE_DLNA = 67,
 117   SS_SOURCE_USB2 = 68,
 118 // add interrupt audio source ##
 119   SS_SOURCE_VDSP = 69,
 120   SS_SOURCE_NAVI_VR = 70,
 121   SS_SOURCE_STARTUPBGM = 71,
 122   SS_SOURCE_STARTUPBGM_INIT = 72,
 123   SS_SOURCE_MAIL_INFO = 73,
 124
 125   SS_SOURCE_DIAG = 74,
 126   SS_SOURCE_MAYDAY = 75,
 127   SS_SOURCE_DCM = 76,
 128   SS_SOURCE_SD_VIDEO = 77,
 129
 130   SS_SOURCE_DELIVERY_APP_INFO = 78,
 131
 132   SS_SOURCE__CWORD27__INFO = 86,
 133
 134   // Declaration of special sources starting from 100
 135   SS_SOURCE_POWER_OFF = 100   // Being used by Mode
 136 }SS_SOURCE, *PSS_SOURCE;
 137
 138
 139 typedef enum _SS_Zones {
 140   SS_ZONE_NA = 0,
 141   SS_ZONE_DRIVER = 1,  ///< Zero/Driver zone
 142   SS_ZONE_REAR1,
 143   SS_ZONE_REAR2,
 144   SS_ZONE_REAR3,
 145   SS_ZONE_ALL
 146 }SS_ZONE, *PSS_ZONE;
 147
 148
 149 typedef enum E_AUDIO_PORT {
 150   SS_AUDIO_INPUT_PORT_1 = 0x01,      ///< Enum representing MCASP2
 151   SS_AUDIO_INPUT_PORT_2 = 0x02,      ///< Enum representing MCBSP
 152   SS_AUDIO_INPUT_PORT_3 = 0x03,    ///< Enum representing MCASP3
 153   SS_AUDIO_INPUT_PORT_4 = 0x04,      ///< Enum representing MCASP3
 154   SS_AUDIO_INPUT_PORT_5 = 0x05       ///< Enum representing other port
 155 }SS_AUDIO_INPUT_PORT, *PSS_AUDIO_INPUT_PORT;
 156
 157 typedef enum _SS_Device_Context {
 158   SINGLE_CONTEXT = 0,
 159   MULTI_CONTEXT = 1
 160 }SS_DEVICE_CONTEXT, *PSS_DEVICE_CONTEXT;
 161
 162 #endif /* INTERFACEUNIFIED_SYSTEM_TYPES_H_ */  // NOLINT (build/header_guard)
 163 /** @}*/
 164 /** @}*/
 165 /** @}*/