include/system_info_type.h

   1 /*
   2  * Copyright (c) 2014 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_TYPE_H__
  19 #define __TIZEN_SYSTEM_SYSTEM_INFO_TYPE_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 codes 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 reading value from system */
  41         SYSTEM_INFO_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< No permission to use the API */
  42         SYSTEM_INFO_ERROR_NOT_SUPPORTED     = TIZEN_ERROR_NOT_SUPPORTED,     /**< Not supported parameter (Since 3.0) */
  43 } system_info_error_e;
  44
  45 /**
  46  * @internal
  47  * @brief Enumeration of key for system information
  48  */
  49 typedef enum {
  50         SYSTEM_INFO_KEY_MODEL,                  /**< @internal The model of the device */
  51         SYSTEM_INFO_KEY_TIZEN_VERSION,          /**< @internal The version of the Tizen API */
  52         SYSTEM_INFO_KEY_PLATFORM_NAME,          /**< @internal The name of platform */
  53         SYSTEM_INFO_KEY_TIZEN_VERSION_NAME,     /**< @internal The name of tizen version  */
  54         SYSTEM_INFO_KEY_MANUFACTURER,           /**< @internal The manufacturer of the device */
  55         SYSTEM_INFO_KEY_CORE_CPU_ARCH,          /**< @internal The CORE CPU architecture of model */
  56         SYSTEM_INFO_KEY_CORE_CPU_FREQ,          /**< @internal The CORE CPU frequency of model */
  57         SYSTEM_INFO_KEY_BUILD_STRING,           /**< @internal The build string of platform binary */
  58         SYSTEM_INFO_KEY_BUILD_DATE,             /**< @internal The build date of platform binary */
  59         SYSTEM_INFO_KEY_BUILD_TIME,             /**< @internal The build time of platform binary */
  60         SYSTEM_INFO_KEY_SCREEN_HEIGHT,          /**< @internal The height of the screen in pixels */
  61         SYSTEM_INFO_KEY_SCREEN_WIDTH,           /**< @internal The width of the screen in pixels */
  62         SYSTEM_INFO_KEY_PHYSICAL_SCREEN_HEIGHT, /**< @internal The physical screen height in millimeters */
  63         SYSTEM_INFO_KEY_PHYSICAL_SCREEN_WIDTH,  /**< @internal The physical screen width in millimeters */
  64         SYSTEM_INFO_KEY_TETHERING_SUPPORTED,    /**< @internal Indicates whether the device supports tethering */
  65 } system_info_key_e;
  66
  67
  68
  69 /**
  70  * @}
  71  */
  72
  73 #ifdef __cplusplus
  74 }
  75 #endif
  76
  77 #endif /* __TIZEN_SYSTEM_SYSTEM_INFO_TYPE_H__ */