video_in_hal/systemservice/task_manager/client/libtskmcfg/include/system_service/tskm_xml_data.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  * @file tskm_xml_data.h
  18  * @brief \~english This file provide api to operating task manager with XML data
  19  */
  20 /** @addtogroup BaseSystem
  21  *  @{
  22  */
  23 /** @addtogroup system_service
  24  *  @ingroup BaseSystem
  25  *  @{
  26  */
  27 /** @addtogroup task_manager
  28  *  @ingroup system_service
  29  *  @{
  30  */
  31 #ifndef TASK_MANAGER_CLIENT_LIBTSKMCFG_INCLUDE_SYSTEM_SERVICE_TSKM_XML_DATA_H_
  32 #define TASK_MANAGER_CLIENT_LIBTSKMCFG_INCLUDE_SYSTEM_SERVICE_TSKM_XML_DATA_H_
  33
  34 #include "system_service/tskm_type.h"
  35 #include "system_service/tskm_svc.h"
  36
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42   /////////////////////////////////////////////////////////////////////////////////////
  43   /// \ingroup tskm_initServiceList
  44   /// \~english @par Summary
  45   ///           init started services list
  46   /// \~english @param  [out] p_svcs
  47   ///           p_svcs   - pointer of service list
  48   /// \~english @par
  49   ///           p_svcs   TSKM_SVCS_CTX_t*
  50   /// \~english @code
  51   ///           typedef struct {
  52   ///             uint32_t svcNum;           // service num
  53   ///             TSKM_SVC_CTX_t *svcList;   // services list pointer
  54   ///           } TSKM_SVCS_CTX_t;
  55   ///           @endcode
  56   /// \~english @param  [in] iFd
  57   ///           iFd      - the file descriptor return by inotify_init1().
  58   /// \~english @par
  59   ///           p_svcs  int
  60   /// \~english @retval 0   Success
  61   /// \~english @retval -1  Failed
  62   /// \~english @par Preconditions
  63   ///       -  called in the ctxCreate()
  64   /// \~english @par Change of the internal state
  65   ///       -  The internal state is not changed.
  66   /// \~english @par Causes of failures
  67   ///       -  if srvId in serviceList greater than TSKM_SVC_ID_MAX_SIZE.  [-1]
  68   /// \~english @par Classification
  69   ///       -  public
  70   /// \~english @par Type
  71   ///       - sync only
  72   /// \~english @par Detail
  73   ///      Init started services list\n
  74   ///      Get the started services list from static variable serviceList and init by input parameter iFd\n
  75   ///      If envirment is NFS, change the path after /tmp to CAP path.\n
  76   ///
  77   /// \~english @see  None
  78   ////////////////////////////////////////////////////////////////////////////////////
  79 int tskm_initServiceList(TSKM_SVCS_CTX_t* p_svcs, int iFd);
  80
  81   /////////////////////////////////////////////////////////////////////////////////////
  82   /// \ingroup tskm_initWakeupCtx
  83   /// \~english @par Summary
  84   ///           Get state of started step.
  85   /// \~english @param  [out] p_wakeup
  86   ///           p_wakeup   - pointer of TSKM_GSTEP_CTX_t
  87   /// \~english @par
  88   ///           p_wakeup  TSKM_GSTEP_CTX_t*
  89   /// \~english @code
  90   /// typedef struct {
  91   ///   uint32_t gstepIdx;            // step Index
  92   ///   uint32_t gstepNum;            // number of step
  93   ///   TSKM_GSTEP_t* gstep;          // step start/stop info
  94   ///   uint64_t compState;
  95   /// } TSKM_GSTEP_CTX_t;
  96   ///           @endcode
  97   /// \~english @param  [in] isVupMode
  98   ///           isVupMode  - version up flag
  99   /// \~english @par
 100   ///           isVupMode  BOOL
 101   ///           TRUE       version up mode
 102   ///           FALSE      not versoin up mode
 103   /// \~english @retval  void
 104   ///
 105   /// \~english @par Preconditions
 106   ///       -   called in ctxCreate()
 107   /// \~english @par Change of the internal state
 108   ///       -  The internal state is not changed.
 109   /// \~english @par Causes of failures
 110   ///       -  none
 111   /// \~english @par Classification
 112   ///       -  public
 113   /// \~english @par Type
 114   ///       -  sync only
 115   /// \~english @par Detail
 116   ///      Get state of started step.\n
 117   ///      if version up mode is TRUE, retrun the wakeupGstepVup.\n
 118   ///      if version up mode is FALSE, return the wakeupGstep.\n
 119   ///
 120   /// \~english @see  None
 121   ////////////////////////////////////////////////////////////////////////////////////
 122 void tskm_initWakeupCtx(TSKM_GSTEP_CTX_t* p_wakeup, BOOL isVupMode);
 123
 124
 125   /////////////////////////////////////////////////////////////////////////////////////
 126   /// \ingroup tskm_initDownCtx
 127   /// \~english @par Summary
 128   ///           Get state of down step.
 129   /// \~english @param  [out] p_down
 130   ///           p_down   - pointer of TSKM_GSTEP_CTX_t
 131   /// \~english @par
 132   ///           p_wakeup  TSKM_GSTEP_CTX_t*
 133   /// \~english @code
 134   /// typedef struct {
 135   ///   uint32_t gstepIdx;            // step Index
 136   ///   uint32_t gstepNum;            // number of step
 137   ///   TSKM_GSTEP_t* gstep;          // step start/stop info
 138   ///   uint64_t compState;
 139   /// } TSKM_GSTEP_CTX_t;
 140   ///           @endcode
 141   /// \~english @param  [in] isVupMode
 142   ///           isVupMode  - version up mode flag
 143   /// \~english @par
 144   ///           isVupMode  BOOL
 145   ///           TRUE       version up mode
 146   ///           FALSE      not versoin up mode
 147   /// \~english @retval
 148   /// \~english @par Preconditions
 149   ///       -   called in ctxCreate().
 150   /// \~english @par Change of the internal state
 151   ///       -  The internal state is not changed.
 152   /// \~english @par Causes of failures
 153   ///       -  none
 154   /// \~english @par Classification
 155   ///       - public
 156   /// \~english @par Type
 157   ///       - sync only
 158   /// \~english @par Detail
 159   ///      Get state of down step.\n
 160   ///      if version up mode is TRUE, retrun the downGstepVup.\n
 161   ///      if version up mode is FALSE, return the downGstep.\n
 162   /// \~english @see  None
 163   ////////////////////////////////////////////////////////////////////////////////////
 164 void tskm_initDownCtx(TSKM_GSTEP_CTX_t* p_down, BOOL isVupMode);
 165
 166 #ifdef __cplusplus
 167 }
 168 #endif
 169
 170 #endif  // TASK_MANAGER_CLIENT_LIBTSKMCFG_INCLUDE_SYSTEM_SERVICE_TSKM_XML_DATA_H_
 171 /** @}*/
 172 /** @}*/
 173 /** @}*/