include/device/common.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 DEVICE_COMMON_H_
  19 #define DEVICE_COMMON_H_
  20
  21 #include "error.h"
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif                          /* __cplusplus */
  26
  27 /**
  28  * @file common.h
  29  * @brief Defines enumerations for device execution
  30  */
  31
  32 /** @addtogroup device
  33  *      @{
  34  */
  35
  36 /**
  37  * @brief Get particular device information on the memory
  38  * @param[in] device_plugin_id Device plugIn ID
  39  * @param[in] info_name Name of device information
  40  * @param[out] value Value of device information
  41  * @return Calculated ID in unsigned integer type
  42  */
  43         typedef sync_agent_dev_return_e(*sync_agent_get_devinfo_cb) (int devinfo_plugin_id, char *info_name, char **value);
  44
  45 /**
  46  * @brief Execute particular device feature
  47  * @param[in] device_plugin_id Device PlugIn ID
  48  * @param[in] function_name Function name defined in plug-in
  49  * @param[in] args_cnt Number of following arguments which abbreviated
  50  * @return Calculated ID in unsigned integer type
  51  */
  52         typedef sync_agent_dev_return_e(*sync_agent_execute_dev_cb) (int devinfo_plugin_id, char *function_name, int args_cnt, ...);
  53
  54 /**
  55  *      @}
  56  */
  57 #ifdef __cplusplus
  58 }
  59 #endif                          /* __cplusplus */
  60 #endif                          /* DEVICE_COMMON_H_ */