include/device/information.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_INFORMATION_H_
  19 #define DEVICE_INFORMATION_H_
  20
  21 #include "common.h"
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif                          /* __cplusplus */
  26
  27 /**
  28  * @file information.h
  29  * @brief Defines device information APIs
  30  */
  31
  32 /** @addtogroup device
  33  *      @{
  34  */
  35
  36 /**
  37  * @brief Get particular device information on the memory
  38  * @remarks DevID(device id), Man(manufacture), Mod(model id or model number), SwV(software version),
  39  * HwV(hardware version), FwV(firmware version), OEM(original equipment manufacturer),
  40  * DevTyp(device type), Lang(language), DTDV(DTD version), PDAV(PDA version),
  41  *      CSCV(CSC version), ModemV(modem version), KernelV(kernal version), OPCO(OPCO information)
  42  * @par Useage:
  43  * @code
  44  *
  45  * char *value;
  46  * sync_agent_dev_return_e res = DICI_Get_DevInfo(1, "DevID", &value);
  47  *
  48  * @endcode
  49  * @param[in] device_plugin_id Device plugIn ID
  50  * @param[in] info_name Name of device information (see remarks)
  51  * @param[out] value Value of device information
  52  * @return Operation result
  53  * @retval SYNC_AGENT_DEV_RETURN_SUCCESS Successful
  54  * @retval error_value Operation failed
  55  * @pre The application should be called dev_init_dev()
  56  */
  57         sync_agent_dev_return_e sync_agent_get_devinfo(int device_plugin_id, char *info_name, char **value);
  58
  59 /**
  60  *      @}
  61  */
  62 #ifdef __cplusplus
  63 }
  64 #endif                          /* __cplusplus */
  65 #endif                          /* DEVICE_INFORMATION_H_ */