systemservice/interface_unified/library/include/system_service/ss_devicedetection_service_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 ss_devicedetection_service_types.h
  19  * @brief This file supports the Device Detection service.
  20  */
  21
  22 /** @addtogroup BaseSystem
  23  *  @{
  24  */
  25 /** @addtogroup system_service
  26  *  @ingroup BaseSystem
  27  *  @{
  28  */
  29 /** @addtogroup device_detection_service
  30  *  @ingroup system_service
  31  *  @{
  32  */
  33
  34 #ifndef SS_DEVDETECT_TYPES_H_  // NOLINT (build/header_guard)
  35 #define SS_DEVDETECT_TYPES_H_
  36
  37 /**
  38  * \~english Deive type(eUSB,eSD...)
  39  */
  40 typedef enum _DeviceType {
  41   /**
  42    * \~english USB
  43    */
  44   eUSB,
  45   /**
  46    * \~english SD
  47    */
  48   eSD,
  49   /**
  50    * \~english EMMC
  51    */
  52   eMMC,
  53   /**
  54    * \~english DISC
  55    */
  56   eDISC,
  57   /**
  58    * \~english MTP
  59    */
  60   eMTP
  61 } EDEVICE_TYPE;
  62
  63 /**
  64  * \~english Action result
  65  */
  66 typedef enum _SsDevError {
  67   /**
  68    * \~english success
  69    */
  70   SS_DEV_OK,
  71   /**
  72    * \~english error
  73    */
  74   SS_DEV_ERR,
  75   /**
  76    * \~english mount error
  77    */
  78   SS_DEV_ERR_MOUNT,
  79   /**
  80    * \~english device busy
  81    */
  82   SS_DEV_ERR_BUSY,
  83 } SS_DEV_ERROR;
  84
  85 /**
  86  * \~english USB port
  87  */
  88 typedef enum _USBPort {
  89   /**
  90    * \~english USB0(IF-BOX)
  91    */
  92   SS_DEV_USB_PORT0,     // IF-BOX
  93   /**
  94    * \~english USB1(DCM)
  95    */
  96   SS_DEV_USB_PORT1,     // DCM
  97   /**
  98    * \~english USB2(DSRC/ETC)
  99    */
 100   SS_DEV_USB_PORT2,     // DSRC/ETC
 101   /**
 102    * \~english USB3(External deck)
 103    */
 104   SS_DEV_USB_PORT3,     // External DECK
 105   /**
 106    * \~english USB4(Drive recorder)
 107    */
 108   SS_DEV_USB_PORT4,     // Supplies drive recorder
 109   /**
 110    * \~english USB number max.
 111    */
 112   SS_DEV_USB_MAX        // MAX
 113 } SS_DEV_USBPORT;
 114
 115 /**
 116  * \~english notify code
 117  */
 118 typedef enum SsNotifyCode {
 119   /**
 120    * \~english Unsupport USB device
 121    */
 122   SS_DEV_UNSUPPORT_USB,    // Un support USB device
 123   /**
 124    * \~english The connected device has no response.
 125    */
 126   SS_DEV_NON_RESPONSE_USB,  // Enemuration Error
 127   /**
 128    * \~english It detects a USB device of current excess that has been connected to the bus power HUB.
 129    */
 130   SS_DEV_HIGH_POWER_USB,    // It detects a USB device of current excess that
 131           // has been connected to the bus power HUB.
 132   /**
 133    * \~english Over support USB(3 or more units)
 134    */
 135   SS_DEV_OVER_SUPPORT_USB,  // Over support USB(3 or more units)
 136   /**
 137    * \~english  Over number of USB HUB(2 or more units)
 138    */
 139   SS_DEV_OVER_NUM_USB_HUB,  // Over number of USB HUB(2 or more units)
 140 } SS_NOTIFY_CODE;
 141
 142 /**
 143  * \~english RoleSw state
 144  */
 145 typedef enum _SsDevRoleSwState {
 146   /**
 147    * \~english start
 148    */
 149   SS_DEV_ROLE_SW_START,
 150   /**
 151    * \~english begin end
 152    */
 153   SS_DEV_ROLE_SW_BEGIN_END,
 154   /**
 155    * \~english end
 156    */
 157   SS_DEV_ROLE_SW_END,
 158   /**
 159    * \~english restart
 160    */
 161   SS_DEV_ROLE_SW_RESTART,
 162 } SS_DEV_ROLE_SW_STATE;
 163
 164 /**
 165  * \~english Disc Type(eCD, eDVD, eBD)
 166  */
 167 typedef enum _DiscType {
 168   /**
 169    * \~english CD
 170    */
 171   eCD,
 172   /**
 173    * \~english DVD
 174    */
 175   eDVD,
 176   /**
 177    * \~english BD
 178    */
 179   eBD,
 180 } EDISC_TYPE;
 181
 182 #endif /* SS_DEVDETECT_TYPES_H_ */  // NOLINT (build/header_guard)
 183
 184 /** @}*/  // end of device_detection_service
 185 /** @}*/  // end of system_service
 186 /** @}*/  // end of BaseSystem