include/system_info.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   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 #ifndef __TIZEN_SYSTEM_SYSTEM_INFO_H__
  19 #define __TIZEN_SYSTEM_SYSTEM_INFO_H__
  20
  21 #include <tizen.h>
  22
  23 #ifdef __cplusplus
  24 extern "C"
  25 {
  26 #endif
  27
  28 /**
  29  * @addtogroup CAPI_SYSTEM_SYSTEM_INFO_MODULE
  30  * @{
  31  */
  32
  33 /**
  34  * @brief Enumeration of error code for system information
  35  */
  36 typedef enum {
  37         SYSTEM_INFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
  38         SYSTEM_INFO_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
  39         SYSTEM_INFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
  40         SYSTEM_INFO_ERROR_IO_ERROR =  TIZEN_ERROR_IO_ERROR,     /**< An input/output error occurred when read value from system */
  41 } system_info_error_e;
  42
  43 /**
  44  * @brief Enumeration of key for system information
  45  */
  46 typedef enum {
  47         SYSTEM_INFO_KEY_MODEL, /**< The model of the device */
  48         SYSTEM_INFO_KEY_TIZEN_VERSION, /**< The version of the Tizen API */
  49         SYSTEM_INFO_KEY_BLUETOOTH_SUPPORTED, /**< Indicates whether the device supports Bluetooth */
  50         SYSTEM_INFO_KEY_CAMERA_COUNT, /**< The number of cameras in the device */
  51         SYSTEM_INFO_KEY_FMRADIO_SUPPORTED, /**< Indicates whether the device supports FM radio */
  52         SYSTEM_INFO_KEY_GPS_SUPPORTED, /**< Indicates whether the device supports GPS */
  53         SYSTEM_INFO_KEY_KEYBOARD_TYPE, /**< The type of the keyboard */
  54         SYSTEM_INFO_KEY_MULTI_POINT_TOUCH_COUNT, /**< The maximum number of concurrent touch points supported in the device */
  55         SYSTEM_INFO_KEY_NETWORK_TYPE, /**< The supported network type */
  56         SYSTEM_INFO_KEY_NFC_SUPPORTED, /**< Indicates whether the device supports NFC */
  57         SYSTEM_INFO_KEY_OPENGLES_VERSION, /**< The supported version of the OpenGL ES */
  58         SYSTEM_INFO_KEY_SCREEN_BITS_PER_PIXEL, /**< The number of bits per pixel */
  59         SYSTEM_INFO_KEY_SCREEN_HEIGHT, /**< The height of the screen in pixels */
  60         SYSTEM_INFO_KEY_SCREEN_WIDTH, /**< The width of the screen in pixels */
  61         SYSTEM_INFO_KEY_TVOUT_SUPPORTED, /**< Indicates whether the device supports TV-out */
  62         SYSTEM_INFO_KEY_WIFI_SUPPORTED, /**< Indicates whether the device supports Wi-Fi */
  63         SYSTEM_INFO_KEY_MOBILE_DEVICE_ID, /**< The unique ID to identify GSM, UMTS and CDMA mobile devices */
  64         SYSTEM_INFO_KEY_CSC_SALES_CODE, /**< The sales code of CSC */
  65         SYSTEM_INFO_KEY_PLATFORM_NAME, /**< The name of platform */
  66         SYSTEM_INFO_KEY_TIZEN_VERSION_NAME, /**< The name of tizen version  */
  67         SYSTEM_INFO_KEY_HAPTIC_SUPPORTED, /**< Indicates whether the device supports Haptic */
  68         SYSTEM_INFO_KEY_WIFI_DIRECT_SUPPORTED, /**< Indicates whether the device supports Wi-Fi Direct */
  69         SYSTEM_INFO_KEY_SCREEN_DPI, /**< The width of the screen DPI */
  70         SYSTEM_INFO_KEY_DEVICE_UUID, /**< The Device unique ID to identify */
  71         SYSTEM_INFO_KEY_CPS_SUPPORTED, /**< Indicates whether the device supports CPS */
  72         SYSTEM_INFO_KEY_WPS_SUPPORTED, /**< Indicates whether the device supports WPS */
  73         SYSTEM_INFO_KEY_USB_HOST_SUPPORTED, /**< Indicates whether the device supports USB host */
  74         SYSTEM_INFO_KEY_USB_ACCESSORY_SUPPORTED, /**< Indicates whether the device supports USB accessory */
  75         SYSTEM_INFO_KEY_CORE_CPU_ARCH, /**< The CORE CPU architecture of model */
  76         SYSTEM_INFO_KEY_CORE_FPU_ARCH, /**< The CORE FPU architecture of model */
  77         SYSTEM_INFO_KEY_FRONT_CAMERA_SUPPORTED, /**< Indicates whether the device supports front camera */
  78         SYSTEM_INFO_KEY_FRONT_CAMERA_AF_SUPPORTED, /**< Indicates whether the device supports front camera auto focus */
  79         SYSTEM_INFO_KEY_FRONT_CAMERA_FLASH_SUPPORTED, /**< Indicates whether the device supports front camera flash */
  80         SYSTEM_INFO_KEY_BACK_CAMERA_SUPPORTED, /**< Indicates whether the device supports back camera */
  81         SYSTEM_INFO_KEY_BACK_CAMERA_AF_SUPPORTED, /**< Indicates whether the device supports back camera auto focus */
  82         SYSTEM_INFO_KEY_BACK_CAMERA_FLASH_SUPPORTED, /**< Indicates whether the device supports back camera flash */
  83         SYSTEM_INFO_KEY_HDMI_SUPPORTED, /**< Indicates whether the device supports HDMI */
  84         SYSTEM_INFO_KEY_RCA_SUPPORTED, /**< Indicates whether the device supports RCA */
  85         SYSTEM_INFO_KEY_SIP_VOIP_SUPPORTED, /**< Indicates whether the device supports SIP VOIP */
  86         SYSTEM_INFO_KEY_MICROPHONE_SUPPORTED, /**< Indicates whether the device supports Microphone */
  87         SYSTEM_INFO_KEY_SPEECH_RECOGNITION_SUPPORTED, /**< Indicates whether the device supports stt */
  88         SYSTEM_INFO_KEY_BAROMETER_SENSOR_SUPPORTED, /**< Indicates whether the device supports barometer sensor */
  89         SYSTEM_INFO_KEY_OPENGLES_TEXTURE_FORMAT, /**< The supported texture format of the OpenGL ES */
  90         SYSTEM_INFO_KEY_CORE_CPU_FREQ, /**< The CORE CPU frequency of model */
  91         SYSTEM_INFO_KEY_PHYSICAL_SCREEN_HEIGHT, /**< The physical screen height in millimeters */
  92         SYSTEM_INFO_KEY_PHYSICAL_SCREEN_WIDTH, /**< The physical screen width in millimeters */
  93         SYSTEM_INFO_KEY_BUILD_STRING, /**< The build string of platform binary */
  94         SYSTEM_INFO_KEY_BUILD_DATE, /**< The build date of platform binary */
  95         SYSTEM_INFO_KEY_BUILD_TIME /**< The build time of platform binary */
  96 } system_info_key_e;
  97
  98 /**
  99  * @brief   Gets the integer value of the system information
 100  * @param[in] key The name of the system information to get
 101  * @param[out] value The value of the given system information
 102  * @return  0 on success, otherwise a negative error value.
 103  * @retval  #SYSTEM_INFO_ERROR_NONE Successful
 104  * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Invalid parameter
 105  * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
 106  */
 107 int system_info_get_value_int(system_info_key_e key, int *value);
 108
 109 /**
 110  * @brief   Gets the boolean value of the system information
 111  * @param[in] key The name of the system information to get
 112  * @param[out] value The value of the given system information
 113  * @return  0 on success, otherwise a negative error value.
 114  * @retval  #SYSTEM_INFO_ERROR_NONE Successful
 115  * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Invalid parameter
 116  * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
 117  */
 118 int system_info_get_value_bool(system_info_key_e key, bool *value);
 119
 120 /**
 121  * @brief   Gets the double value of the system information
 122  * @param[in] key The name of the system information to get
 123  * @param[out] value The value of the given system information
 124  * @return  0 on success, otherwise a negative error value.
 125  * @retval  #SYSTEM_INFO_ERROR_NONE Successful
 126  * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Invalid parameter
 127  * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
 128  */
 129 int system_info_get_value_double(system_info_key_e key, double *value);
 130
 131 /**
 132  * @brief   Gets the string value of the system information
 133  * @remarks The @a value must be released with free() by you.
 134  * @param[in] key The name of the system information to get
 135  * @param[out] value The value of the given system information
 136  * @return  0 on success, otherwise a negative error value.
 137  * @retval  #SYSTEM_INFO_ERROR_NONE Successful
 138  * @retval  #SYSTEM_INFO_ERROR_INVALID_PARAMETER Invalid parameter
 139  * @retval  #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
 140  * @retval  #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred when read value from system
 141  */
 142 int system_info_get_value_string(system_info_key_e key, char **value);
 143
 144 /**
 145  * @}
 146  */
 147
 148 #ifdef __cplusplus
 149 }
 150 #endif
 151
 152 #endif /* __TIZEN_SYSTEM_SYSTEM_INFO_H__ */