include/TelMisc.h

   1 /*
   2  * libslp-tapi
   3  *
   4  * Copyright (c) 2014 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Ja-young Gu <jygu@samsung.com>
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20
  21 /**
  22  * @file TelMisc.h
  23  */
  24
  25 /**
  26  * @addtogroup CAPI_TELEPHONY_SERVICE_MODEM
  27  * @{
  28  */
  29
  30 #ifndef _TEL_MISC_H_
  31 #define _TEL_MISC_H_
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /**
  38  * @brief Definition for the maximum length of version.
  39  * @since_tizen 2.3
  40  */
  41 #define MAX_VERSION_LEN 32
  42
  43 /**
  44  * @brief Definition for the maximum length of serial number.
  45  * @since_tizen 2.3
  46  */
  47 #define TAPI_MISC_ME_SN_LEN_MAX 32
  48
  49 /**
  50  * @brief Definition for the maximum length of product code.
  51  * @since_tizen 2.3
  52  */
  53 #define TAPI_MISC_PRODUCT_CODE_LEN_MAX 32
  54
  55 /**
  56  * @brief Definition for the maximum length of model ID.
  57  * @since_tizen 2.3
  58  */
  59 #define TAPI_MISC_MODEL_ID_LEN_MAX 17
  60
  61 /**
  62  * @brief Definition for the maximum length of PRL version.
  63  * @since_tizen 2.3
  64  */
  65 #define TAPI_MISC_PRL_ERI_VER_LEN_MAX 17
  66
  67 /**
  68  * @brief Definition for the maximum length of CP chipset.
  69  * @since_tizen 2.3
  70  */
  71 #define TAPI_MISC_CP_CHIPSET_LEN_MAX 16
  72
  73 /**
  74  * @brief Definition for the maximum length of device name.
  75  * @since_tizen 2.3
  76  */
  77 #define TAPI_MISC_ME_DEVICE_NAME_LEN_MAX 32
  78
  79 /**
  80  * @brief The structure type for Mobile Equipment Version Information.
  81  * @since_tizen 2.3
  82  * @see tel_get_misc_me_version()
  83  * @see tel_get_misc_me_version_sync()
  84  */
  85 typedef struct {
  86         unsigned char ver_mask; /**< Version mask - 0x01:SW_ver, 0x02:HW_ver, 0x04:RF_CAL_date, 0x08:Product_code, 0x10:Model_ID, 0x20:PRL, 0x04:ERI, 0xff:all */
  87         unsigned char szSwVersion[MAX_VERSION_LEN]; /**< Software version, null termination */
  88         unsigned char szHwVersion[MAX_VERSION_LEN]; /**< Hardware version, null termination */
  89         unsigned char szRfCalDate[MAX_VERSION_LEN]; /**< Calculation Date, null termination */
  90         unsigned char szProductCode[TAPI_MISC_PRODUCT_CODE_LEN_MAX]; /**< Product code, null termination */
  91         unsigned char szModelId[TAPI_MISC_MODEL_ID_LEN_MAX]; /**< Model ID (only for CDMA), null termination */
  92         unsigned char prl_nam_num; /**< Number of PRL NAM fields */
  93         unsigned char szPrlVersion[TAPI_MISC_PRL_ERI_VER_LEN_MAX * 3];/**< PRL version (only for CDMA), null termination */
  94         unsigned char eri_nam_num; /**< Number of PRL NAM fields */
  95         unsigned char szEriVersion[TAPI_MISC_PRL_ERI_VER_LEN_MAX * 3];/**< ERI version (only for CDMA), null termination */
  96         unsigned char szCpChipset[TAPI_MISC_CP_CHIPSET_LEN_MAX];/**< CP chipset, null termination */
  97 } TelMiscVersionInformation;
  98
  99 /**
 100  * @brief The structure type for Mobile Equipment Serial Number Information.
 101  * @since_tizen 2.3
 102  * @see tel_get_misc_me_sn()
 103  * @see tel_get_misc_me_sn_sync()
 104  */
 105 typedef struct {
 106         unsigned char szEsn[TAPI_MISC_ME_SN_LEN_MAX]; /**< Number */
 107         unsigned char szMeid[TAPI_MISC_ME_SN_LEN_MAX]; /**< Number */
 108         unsigned char szImei[TAPI_MISC_ME_SN_LEN_MAX]; /**< Number */
 109         unsigned char szImeiSv[TAPI_MISC_ME_SN_LEN_MAX]; /**< Number */
 110 } TelMiscSNInformation;
 111
 112 /**
 113  * @brief The structure type for device info of cellular dongle.
 114  * @since_tizen 2.4
 115  * @see tel_get_device_info()
 116  */
 117 typedef struct {
 118         unsigned char vendor_name[TAPI_MISC_ME_DEVICE_NAME_LEN_MAX + 1]; /**< Vendor name */
 119         unsigned char device_name[TAPI_MISC_ME_DEVICE_NAME_LEN_MAX + 1]; /**< Device name */
 120 } TelMiscDeviceInfo_t;
 121
 122 #ifdef __cplusplus
 123 }
 124 #endif
 125
 126 #endif /* _TEL_MISC_H_ */
 127
 128 /**
 129  * @}
 130  */