doc/mobile/smartcard_doc.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   * @file smartcard_doc.h
  19   * @brief This file contains high level documentation the SMARTCARD API.
  20   */
  21
  22  /**
  23   * @defgroup CAPI_NETWORK_SMARTCARD_MODULE Smartcard
  24   * @brief The SMARTCARD API provides application communication to SE applet method.
  25   * @ingroup CAPI_NETWORK_FRAMEWORK
  26   *
  27   * @section CAPI_NETWORK_SMARTCARD_MODULE_HEADER Required Header
  28   * \#include <smartcard.h>
  29
  30   * @section CAPI_NETWORK_SMARTCARD_MODULE_OVERVIEW Overview
  31   * The SMARTCARD API provides function to communication to SE.
  32   *
  33   * - set up se service\n
  34   * - create reader from service\n
  35   * - open session from reader\n
  36   * - open channel from session\n
  37   * - transmit apdu data to channel and get response\n
  38   *
  39   * @subsection CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_DESCRIPTION SE Service
  40   * The SMARTCARD API provides functions to service framework\n
  41   * - get specification version. \n
  42   * - get readers \n
  43   *
  44   * @subsection CAPI_NETWORK_SMARTCARD_READER_MODULE_DESCRIPTION Reader
  45   *  The Reader api provides functions to about reader\n
  46   * - get reader name\n
  47   * - open / close session\n
  48   *
  49   * @subsection CAPI_NETWORK_SMARTCARD_SESSION_MODULE_DESCRIPTION Session
  50   * The Session api provide functions to about session \n
  51   * - open basic/logical channel\n
  52   * - close channels
  53   * - get atr (answer to reset)
  54   *
  55   * @subsection CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE_DESCRIPTION Channel
  56   * The Channel api provide functions to about channel.
  57   * - close channel\n
  58   * - transmit apdu\n
  59   *
  60   */
  61
  62  /**
  63   * @defgroup CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE SE Service
  64   * @brief The SE Service API provides functions to service framework.
  65   * @ingroup CAPI_NETWORK_SMARTCARD_MODULE
  66   *
  67   * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_HEADER Required Header
  68   * \#include <smartcard.h>
  69   * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_FEATURE Related Features
  70   * This API is related with the following features:\n
  71   * - http://tizen.org/feature/network.secure_element
  72   * - http://tizen.org/feature/network.secure_element.ese
  73   * - http://tizen.org/feature/network.secure_element.uicc
  74   * It is recommended to design feature related codes in your application for reliability.\n
  75   *
  76   * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  77   *
  78   * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  79   *
  80   * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  81   *
  82   */
  83
  84  /**
  85   * @defgroup CAPI_NETWORK_SMARTCARD_READER_MODULE Reader
  86   * @brief The Reader API provides functions to reader.
  87   * @ingroup CAPI_NETWORK_SMARTCARD_MODULE
  88   *
  89   * @section CAPI_NETWORK_SMARTCARD_READER_MODULE_HEADER Required Header
  90   * \#include <smartcard.h>
  91   * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_FEATURE Related Features
  92   * This API is related with the following features:\n
  93   * - http://tizen.org/feature/network.secure_element
  94   * - http://tizen.org/feature/network.secure_element.ese
  95   * - http://tizen.org/feature/network.secure_element.uicc
  96   * It is recommended to design feature related codes in your application for reliability.\n
  97   *
  98   * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  99   *
 100   * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 101   *
 102   * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 103   *
 104   */
 105
 106  /**
 107   * @defgroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE Session
 108   * @brief The Session API provides functions to session.
 109   * @ingroup CAPI_NETWORK_SMARTCARD_MODULE
 110   *
 111   * @section CAPI_NETWORK_SMARTCARD_SESSION_MODULE_HEADER Required Header
 112   * \#include <smartcard.h>
 113   * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_FEATURE Related Features
 114   * This API is related with the following features:\n
 115   * - http://tizen.org/feature/network.secure_element
 116   * - http://tizen.org/feature/network.secure_element.ese
 117   * - http://tizen.org/feature/network.secure_element.uicc
 118   * It is recommended to design feature related codes in your application for reliability.\n
 119   *
 120   * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 121   *
 122   * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 123   *
 124   * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 125   *
 126   */
 127
 128  /**
 129   * @defgroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE Channel
 130   * @brief The Channel API provides functions to channel.
 131   * @ingroup CAPI_NETWORK_SMARTCARD_MODULE
 132   *
 133   * @section CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE_HEADER Required Header
 134   * \#include <smartcard.h>
 135   * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_FEATURE Related Features
 136   * This API is related with the following features:\n
 137   * - http://tizen.org/feature/network.secure_element
 138   * - http://tizen.org/feature/network.secure_element.ese
 139   * - http://tizen.org/feature/network.secure_element.uicc
 140   * It is recommended to design feature related codes in your application for reliability.\n
 141   *
 142   * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
 143   *
 144   * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
 145   *
 146   * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 147   *
 148   */
 149