src/framework/device/information_internal.h

   1 /*
   2  * sync-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef INFORMATION_INTERNAL_H_
  19 #define INFORMATION_INTERNAL_H_
  20
  21 #include "device/information.h"
  22
  23 /**
  24  * @file information_internal.h
  25  * @brief Defines device information APIs
  26  */
  27
  28 /** @addtogroup device
  29  *      @{
  30  */
  31
  32 /**
  33  * @brief Load device information on the memory
  34  * @remarks Run only once at the beginning of the process
  35  * @par Usage:
  36  * @code
  37                 sync_agent_dev_return_e res = DICI_Init(1);
  38  * @endcode
  39  * @param[in] device_plugin_id Device plugIn ID
  40  * @return Operation result
  41  * @retval DICI_SUCCESS success
  42  * @retval SYNC_AGENT_DEV_RETURN_FAIL error
  43  */
  44 sync_agent_dev_return_e dev_init_dev(int device_plugin_id);
  45
  46 /**
  47  * @brief Free memory for device information on the memory
  48  * @par Usage:
  49  * @code
  50                 sync_agent_dev_return_e res = DICI_Destroy(1);
  51  * @endcode
  52  * @param[in] device_plugin_id Device plugIn ID
  53  * @return Operation result
  54  * @retval DICI_SUCCESS success
  55  * @retval DICI_FAIL Operation error
  56  */
  57 sync_agent_dev_return_e dev_destroy_dev(int device_plugin_id);
  58
  59 /**
  60  *      @}
  61  */
  62
  63 #endif                          /* INFORMATION_INTERNAL_H_ */