service/other/vehicle_parameter_library/library/include/other_service/VP_FuncCheck_CanRcv.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 /**
  19  * @file VP_FuncCheck_CanRcv.h
  20  * @brief \~english Get function existence API header file
  21  */
  22 /* ====================================================================== */
  23
  24 #ifndef VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_FUNCCHECK_CANRCV_H_
  25 #define VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_FUNCCHECK_CANRCV_H_
  26
  27 #include <sys/types.h>
  28
  29 /** @addtogroup BaseSystem
  30  *  @{
  31  */
  32 /** @addtogroup other_service
  33  *  @ingroup BaseSystem
  34  *  @{
  35  */
  36 /** @addtogroup vehicle_parameter_library
  37  *  @ingroup other_service
  38  *  @{
  39  */
  40
  41 // typedef unsigned char u_int8;
  42
  43
  44 /**
  45 * @~english  XM Audio
  46 */
  47 #define XM_AUDIO                        ((u_int8_t)1)
  48 /**
  49 * @~english  _CWORD76_
  50 */
  51 #define _CWORD76_                       ((u_int8_t)2)
  52
  53 #define VP_CANRCV__CWORD27_             ((u_int8_t)3)                           /**< _CWORD27_                   */
  54 /**
  55 * @~english  WiFi HotSpot
  56 */
  57 #define WIFI_HOTSPOT                    ((u_int8_t)4)
  58 /**
  59 * @~english standard driving rregulation of AREA1
  60 */
  61 #define AREA1_STD_TRAF_LIMIT            ((u_int8_t)5)
  62 /**
  63 * @~english HD Data (Include traffic)
  64 */
  65 #define HD_DATA                         ((u_int8_t)6)
  66 /**
  67 * @~english WiFi 5G
  68 */
  69 #define WIFI_5G                         ((u_int8_t)7)
  70
  71 /**
  72 * @~english definiton of return value of API(VP_FuncCheck_CanRcv),which is used to get status of function implemention
  73 */
  74 #define FUNCTION_CHECK_RESULT_OK        ((u_int8_t)0)
  75 /**
  76 * @~english   this function is invalid
  77 */
  78 #define FUNCTION_CHECK_RESULT_NG        ((u_int8_t)1)
  79 /**
  80 * @~english this function does not exist
  81 */
  82 #define FUNCTION_CHECK_RESULT_UNKNOWN   ((u_int8_t)2)
  83 /**
  84 * @~english reference out of AREA1
  85 */
  86 #define FUNCTION_CHECK_RESULT_OUT_OF_AREA1 ((u_int8_t)3)
  87
  88 /* Function prototype declaration */
  89 #ifdef __cplusplus
  90 extern "C" {
  91 #endif
  92
  93 ////////////////////////////////////////////////////////////////////////////////
  94 /// \ingroup VP_FuncCheck_CanRcv
  95 /// \~english @par Brief
  96 ///         VP_FuncCheck_CanRcv
  97 /// \~english @param [in] FunctionName
  98 ///         function name
  99 /// \~english @retval FUNCTION_CHECK_RESULT_OK: This function is available
 100 /// \~english @retval FUNCTION_CHECK_RESULT_NG: This function is unavailable
 101 /// \~english @retval FUNCTION_CHECK_RESULT_UNKNOWN: This function does not exist
 102 /// \~english @retval FUNCTION_CHECK_RESULT_OUT_OF_AREA1: reference out of Area1
 103 /// \~english @par Prerequisite
 104 ///         None
 105 /// \~english @par Change of internal state
 106 ///         None
 107 /// \~english @par Conditions of processing failure
 108 ///         None
 109 /// \~english @par Classification
 110 ///         Public
 111 /// \~english @par Type
 112 ///         Sync Only
 113 /// \~english @par Detail
 114 ///         - To get the function check result from
 115 ///            - vehicle parameter:CAN info judge
 116 ///            - vehicle parameter:country ID
 117 ///            - country ID and function judge info in API
 118 ///         - When vehicle parameter:CAN info judge
 119 ///           is [CAN_judge] or [country_ID],
 120 ///           and if country_ID is unacquainted or undefined, the API returns [available].
 121 /// \~english @see None
 122 ////////////////////////////////////////////////////////////////////////////////
 123 u_int8_t VP_FuncCheck_CanRcv(u_int8_t FunctionName);
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129 /** @}*/  // end of vehicle_parameter_library
 130 /** @}*/  // end of other_service
 131 /** @}*/  // end of BaseSystem
 132
 133 #endif  // VEHICLE_PARAMETER_LIBRARY_LIBRARY_INCLUDE_OTHER_SERVICE_VP_FUNCCHECK_CANRCV_H_