2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file smartcard_doc.h
19 * @brief This file contains high level documentation the SMARTCARD API.
23 * @defgroup CAPI_NETWORK_SMARTCARD_MODULE Smartcard
24 * @brief The SMARTCARD API provides application communication to SE applet method.
25 * @ingroup CAPI_NETWORK_FRAMEWORK
27 * @section CAPI_NETWORK_SMARTCARD_MODULE_HEADER Required Header
28 * \#include <smartcard.h>
30 * @section CAPI_NETWORK_SMARTCARD_MODULE_OVERVIEW Overview
31 * The SMARTCARD API provides function to communication to SE.
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
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
44 * @subsection CAPI_NETWORK_SMARTCARD_READER_MODULE_DESCRIPTION Reader
45 * The Reader api provides functions to about reader\n
47 * - open / close session\n
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
53 * - get atr (answer to reset)
55 * @subsection CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE_DESCRIPTION Channel
56 * The Channel api provide functions to about channel.
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
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
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
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
80 * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#%3Cfeature%3E-element
81 "><b>Feature Element</b>.</a>
86 * @defgroup CAPI_NETWORK_SMARTCARD_READER_MODULE Reader
87 * @brief The Reader API provides functions to reader.
88 * @ingroup CAPI_NETWORK_SMARTCARD_MODULE
90 * @section CAPI_NETWORK_SMARTCARD_READER_MODULE_HEADER Required Header
91 * \#include <smartcard.h>
92 * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_FEATURE Related Features
93 * This API is related with the following features:\n
94 * - http://tizen.org/feature/network.secure_element
95 * - http://tizen.org/feature/network.secure_element.ese
96 * - http://tizen.org/feature/network.secure_element.uicc
97 * It is recommended to design feature related codes in your application for reliability.\n
99 * 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
101 * 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
103 * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#%3Cfeature%3E-element
104 "><b>Feature Element</b>.</a>
109 * @defgroup CAPI_NETWORK_SMARTCARD_SESSION_MODULE Session
110 * @brief The Session API provides functions to session.
111 * @ingroup CAPI_NETWORK_SMARTCARD_MODULE
113 * @section CAPI_NETWORK_SMARTCARD_SESSION_MODULE_HEADER Required Header
114 * \#include <smartcard.h>
115 * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_FEATURE Related Features
116 * This API is related with the following features:\n
117 * - http://tizen.org/feature/network.secure_element
118 * - http://tizen.org/feature/network.secure_element.ese
119 * - http://tizen.org/feature/network.secure_element.uicc
120 * It is recommended to design feature related codes in your application for reliability.\n
122 * 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
124 * 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
126 * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#%3Cfeature%3E-element
127 "><b>Feature Element</b>.</a>
132 * @defgroup CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE Channel
133 * @brief The Channel API provides functions to channel.
134 * @ingroup CAPI_NETWORK_SMARTCARD_MODULE
136 * @section CAPI_NETWORK_SMARTCARD_CHANNEL_MODULE_HEADER Required Header
137 * \#include <smartcard.h>
138 * @section CAPI_NETWORK_SMARTCARD_SE_SERVICE_MODULE_FEATURE Related Features
139 * This API is related with the following features:\n
140 * - http://tizen.org/feature/network.secure_element
141 * - http://tizen.org/feature/network.secure_element.ese
142 * - http://tizen.org/feature/network.secure_element.uicc
143 * It is recommended to design feature related codes in your application for reliability.\n
145 * 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
147 * 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
149 * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#%3Cfeature%3E-element
150 "><b>Feature Element</b>.</a>