video_in_hal/stub/diag_code/library_dummy_dccc/include/stub/DIAG_API_DCCC.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    DIAG_API_DCCC.h
  19  * @brief   Diagcode feature API defined
  20 *****************************************************************************/
  21
  22
  23 /*****************************************************************************
  24  * *********************************
  25  * *  Diagcode feature API defined *
  26  * *********************************
  27  *
  28  * ** Creation and release considerations **
  29  *   -Because DiagCode API depends on product specifications, it is created at the product level.
  30  *
  31  *   -Submit and request the created headers and dummy Lib(empty functions defined only for I/F)
  32  *    from DiagService to BaseSystem and build them from BaseSystem.
  33  *
  34  *   -The century Lib created(not dummy Lib) is built from DiagService.
  35  *
  36  *     ->Since this API is also used in BaseSystem,
  37  *       the API must be inserted from the BaseSystem built to avoid errors in JointBuild.
  38  *
  39  * ** Notes on change **
  40  *   -When modifying a header without cahnging the I/F,
  41  *    only the header should be submitted to the BaseSystem and requested.
  42  *
  43  *   -Submit header and source code for dummy Lib when the header is modified due to an I/F change.
  44  *
  45  *   -When the legitimate Lib is changed without changing headers and I/F,
  46  *    no need to submit or request to BaseSystem.
  47  *
  48 *****************************************************************************/
  49
  50
  51 #ifndef DIAG_CODE_LIBRARY_DUMMY_DCCC_INCLUDE_VEHICLE_SERVICE_DIAG_API_DCCC_H_
  52 #define DIAG_CODE_LIBRARY_DUMMY_DCCC_INCLUDE_VEHICLE_SERVICE_DIAG_API_DCCC_H_
  53
  54 #include <native_service/frameworkunified_framework_if.h>
  55
  56 #ifdef __cplusplus
  57 extern "C" {
  58 #endif  // __cplusplus
  59
  60 #define        NTFY_DiagService_Availability_DCCC            ("DiagService/Availability")
  61
  62 /***********************************************************
  63     Enumerated type
  64 ***********************************************************/
  65 /*! @brief  Return value for DiagCode re-checking and clearing feature APIs */
  66 typedef enum {
  67     RET_DIAG_API_DCCC_NORMAL = 0,           //!<Success
  68     RET_DIAG_API_DCCC_ERROR                 //!<Error
  69 } RET_DIAG_API_DCCC;
  70
  71 /***********************************************************
  72     Constant
  73 ***********************************************************/
  74 // Common
  75 /*! @brief  message ID */
  76 #define MSGID_DIAG_API_DCCC_DELIVERY_ENTRY                  (0xFF000001)        // Delivery registration notice
  77 #define MSGID_DIAG_API_DCCC_SND_RECHECK                     (0xFF000002)        // Re-assay instruction
  78 #define MSGID_DIAG_API_DCCC_RET_RECHECK                     (0xFF000003)        // Re-assay completion notice
  79 #define MSGID_DIAG_API_DCCC_SND_DIAGCODECLR                 (0xFF000004)        // Diag deletion instruction
  80 #define MSGID_DIAG_API_DCCC_RET_DIAGCODECLR                 (0xFF000005)        // Daig deletion completion notice
  81
  82 /*! @brief  Delivery features */
  83 #define DIAG_API_DCCC_DELIVERY_RECHECK                      (0x00000001)        // Recheck
  84 #define DIAG_API_DCCC_DELIVERY_DIAGCODECLR                  (0x00000002)        // Diag delete
  85 #define DIAG_API_DCCC_DELIVERY_ALL                          (0xFFFFFFFF)        // All function
  86
  87 /*! @brief  Result of re-assay execution */
  88 #define DIAG_API_DCCC_RET_RECHECK_SUCCESS                   (0x00000000)        // Recheck successed
  89 #define DIAG_API_DCCC_RET_RECHECK_ERROR                     (0x00000001)        // Recheck failed
  90
  91
  92 /*! @brief  Diag deletion result */
  93 #define DIAG_API_DCCC_RET_DIAGCODECLR_SUCCESS               (0x00000000)        // Diag deleion successed
  94 #define DIAG_API_DCCC_RET_DIAGCODECLR_ERROR                 (0x00000001)        // Diag deleion failed
  95
  96 /***********************************************************
  97     API
  98 ***********************************************************/
  99 extern RET_DIAG_API_DCCC DIAG_API_DCCC_DeliveryEntry(HANDLE hApp, PCSTR notifyName, u_int32_t delivery);
 100 extern RET_DIAG_API_DCCC DIAG_API_DCCC_SND_ReCheck(HANDLE hApp, PCSTR notifyName);
 101 extern RET_DIAG_API_DCCC DIAG_API_DCCC_RET_ReCheck(HANDLE hApp, PCSTR notifyName, u_int32_t status);
 102 extern RET_DIAG_API_DCCC DIAG_API_DCCC_SND_DiagCodeCLR(HANDLE hApp, PCSTR notifyName);
 103 extern RET_DIAG_API_DCCC DIAG_API_DCCC_RET_DiagCodeCLR(HANDLE hApp, PCSTR notifyName, u_int32_t status);
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif  // __cplusplus
 108
 109 #endif  // DIAG_CODE_LIBRARY_DUMMY_DCCC_INCLUDE_VEHICLE_SERVICE_DIAG_API_DCCC_H_