<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>OpenCT: ifd.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_c35229a911af2f480aef06e8035e7826.html">openct</a>
</div>
</div>
<div class="contents">
<h1>ifd.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Core functions of the IFD handler library</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2003, Olaf Kirch <okir@suse.de></span>
<a name="l00005"></a>00005 <span class="comment"> */</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="preprocessor">#ifndef OPENCT_IFD_H</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span><span class="preprocessor">#define OPENCT_IFD_H</span>
<a name="l00009"></a>00009 <span class="preprocessor"></span>
<a name="l00010"></a>00010 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00012"></a>00012 <span class="preprocessor">#endif</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <openct/openct.h></span>
<a name="l00016"></a>00016 <span class="preprocessor">#include <openct/apdu.h></span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="keyword">typedef</span> <span class="keyword">struct </span>ifd_device ifd_device_t;
<a name="l00019"></a>00019 <span class="keyword">typedef</span> <span class="keyword">union </span><a class="code" href="unionifd__device__params.html">ifd_device_params</a> <a class="code" href="unionifd__device__params.html">ifd_device_params_t</a>;
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="keyword">enum</span> {
<a name="l00022"></a>00022 IFD_PROTOCOL_DEFAULT = -1,
<a name="l00023"></a>00023 IFD_PROTOCOL_T0 = 0,
<a name="l00024"></a>00024 IFD_PROTOCOL_T1,
<a name="l00025"></a>00025 IFD_PROTOCOL_2WIRE = 16,
<a name="l00026"></a>00026 IFD_PROTOCOL_3WIRE,
<a name="l00027"></a>00027 IFD_PROTOCOL_I2C_SHORT,
<a name="l00028"></a>00028 IFD_PROTOCOL_I2C_LONG,
<a name="l00029"></a>00029 IFD_PROTOCOL_TLP, <span class="comment">/* older Gemplus protocol */</span>
<a name="l00030"></a>00030 IFD_PROTOCOL_GBP, <span class="comment">/* Gemplus block protocol */</span>
<a name="l00031"></a>00031 IFD_PROTOCOL_EUROCHIP, <span class="comment">/* Eurochip Countercard */</span>
<a name="l00032"></a>00032 IFD_PROTOCOL_TCL, <span class="comment">/* ISO 14443-4 T=CL */</span>
<a name="l00033"></a>00033 IFD_PROTOCOL_ESCAPE, <span class="comment">/* Virtual 'escape' protocol */</span>
<a name="l00034"></a>00034 IFD_PROTOCOL_TRANSPARENT = 128
<a name="l00035"></a>00035 };
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">typedef</span> <span class="keyword">struct </span>ifd_protocol ifd_protocol_t;
<a name="l00038"></a>00038
<a name="l00039"></a><a class="code" href="structifd__driver.html">00039</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structifd__driver.html">ifd_driver</a> {
<a name="l00040"></a>00040 <span class="keyword">const</span> <span class="keywordtype">char</span> * name;
<a name="l00041"></a>00041 <span class="keyword">struct </span><a class="code" href="structifd__driver__ops.html" title="Driver operations.">ifd_driver_ops</a> * ops;
<a name="l00042"></a>00042 } <a class="code" href="structifd__driver.html">ifd_driver_t</a>;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="preprocessor">#define IFD_MAX_ATR_LEN 64</span>
<a name="l00045"></a><a class="code" href="structifd__slot.html">00045</a> <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structifd__slot.html">ifd_slot</a> {
<a name="l00046"></a>00046 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> handle;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keywordtype">int</span> status;
<a name="l00049"></a>00049 time_t next_update;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> dad; <span class="comment">/* address when using T=1 */</span>
<a name="l00052"></a>00052 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> atr_len;
<a name="l00053"></a>00053 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> atr[IFD_MAX_ATR_LEN];
<a name="l00054"></a>00054
<a name="l00055"></a>00055 ifd_protocol_t * proto;
<a name="l00056"></a>00056 <span class="keywordtype">void</span> * reader_data;
<a name="l00057"></a>00057 } <a class="code" href="structifd__slot.html">ifd_slot_t</a>;
<a name="l00058"></a>00058
<a name="l00059"></a><a class="code" href="structifd__reader.html">00059</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structifd__reader.html">ifd_reader</a> {
<a name="l00060"></a>00060 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> num;
<a name="l00061"></a>00061 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> handle;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">const</span> <span class="keywordtype">char</span> * name;
<a name="l00064"></a>00064 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags;
<a name="l00065"></a>00065 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nslots;
<a name="l00066"></a>00066 <a class="code" href="structifd__slot.html">ifd_slot_t</a> slot[OPENCT_MAX_SLOTS];
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">const</span> <a class="code" href="structifd__driver.html">ifd_driver_t</a> * driver;
<a name="l00069"></a>00069 ifd_device_t * device;
<a name="l00070"></a>00070 <a class="code" href="structct__info.html">ct_info_t</a> * status;
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">/* In case the IFD needs to keep state */</span>
<a name="l00073"></a>00073 <span class="keywordtype">void</span> * driver_data;
<a name="l00074"></a>00074 } <a class="code" href="structifd__reader.html">ifd_reader_t</a>;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="preprocessor">#define IFD_READER_ACTIVE 0x0001</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor">#define IFD_READER_HOTPLUG 0x0002</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define IFD_READER_DISPLAY 0x0100</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#define IFD_READER_KEYPAD 0x0200</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span>
<a name="l00081"></a>00081 <span class="keyword">enum</span> {
<a name="l00082"></a>00082 IFD_PROTOCOL_RECV_TIMEOUT = 0x0000,
<a name="l00083"></a>00083 IFD_PROTOCOL_BLOCK_ORIENTED,
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">/* T=0 specific parameters */</span>
<a name="l00086"></a>00086 __IFD_PROTOCOL_T0_PARAM_BASE = IFD_PROTOCOL_T0 << 16,
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">/* T=1 specific parameters */</span>
<a name="l00089"></a>00089 __IFD_PROTOCOL_T1_PARAM_BASE = IFD_PROTOCOL_T1 << 16,
<a name="l00090"></a>00090 IFD_PROTOCOL_T1_BLOCKSIZE,
<a name="l00091"></a>00091 IFD_PROTOCOL_T1_CHECKSUM_CRC,
<a name="l00092"></a>00092 IFD_PROTOCOL_T1_CHECKSUM_LRC,
<a name="l00093"></a>00093 IFD_PROTOCOL_T1_IFSC,
<a name="l00094"></a>00094 IFD_PROTOCOL_T1_IFSD,
<a name="l00095"></a>00095 IFD_PROTOCOL_T1_STATE,
<a name="l00096"></a>00096 IFD_PROTOCOL_T1_MORE
<a name="l00097"></a>00097 };
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">enum</span> {
<a name="l00100"></a>00100 IFD_DAD_HOST = 0,
<a name="l00101"></a>00101 IFD_DAD_IFD,
<a name="l00102"></a>00102 IFD_DAD_ICC1,
<a name="l00103"></a>00103 IFD_DAD_ICC2
<a name="l00104"></a>00104 };
<a name="l00105"></a>00105
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_init(<span class="keywordtype">void</span>);
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">extern</span> <a class="code" href="structifd__reader.html">ifd_reader_t</a> * ifd_open(<span class="keyword">const</span> <span class="keywordtype">char</span> *driver_name,
<a name="l00110"></a>00110 <span class="keyword">const</span> <span class="keywordtype">char</span> *device_name);
<a name="l00111"></a>00111 <span class="keyword">extern</span> <span class="keywordtype">void</span> ifd_close(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00112"></a>00112 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_reader_count(<span class="keywordtype">void</span>);
<a name="l00113"></a>00113 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_attach(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00114"></a>00114 <span class="keyword">extern</span> <span class="keywordtype">void</span> ifd_detach(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00115"></a>00115 <span class="keyword">extern</span> <a class="code" href="structifd__reader.html">ifd_reader_t</a> * ifd_reader_by_handle(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> handle);
<a name="l00116"></a>00116 <span class="keyword">extern</span> <a class="code" href="structifd__reader.html">ifd_reader_t</a> * ifd_reader_by_index(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index);
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_spawn_handler(<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keywordtype">int</span>);
<a name="l00119"></a>00119 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_scan_usb(<span class="keywordtype">void</span>);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_activate(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00122"></a>00122 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_deactivate(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00123"></a>00123 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_output(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_atr_complete(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_set_protocol(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00128"></a>00128 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00129"></a>00129 <span class="keywordtype">int</span> <span class="keywordtype">id</span>);
<a name="l00130"></a>00130 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_command(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00131"></a>00131 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00132"></a>00132 <span class="keyword">const</span> <span class="keywordtype">void</span> *sbuf, <span class="keywordtype">size_t</span> slen,
<a name="l00133"></a>00133 <span class="keywordtype">void</span> *rbuf, <span class="keywordtype">size_t</span> rlen);
<a name="l00134"></a>00134 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_status(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00135"></a>00135 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00136"></a>00136 <span class="keywordtype">int</span> *status);
<a name="l00137"></a>00137 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_reset(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00138"></a>00138 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00139"></a>00139 <span class="keywordtype">void</span> *atr_buf,
<a name="l00140"></a>00140 <span class="keywordtype">size_t</span> atr_len);
<a name="l00141"></a>00141 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_request(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00142"></a>00142 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00143"></a>00143 time_t timeout,
<a name="l00144"></a>00144 <span class="keyword">const</span> <span class="keywordtype">char</span> *message,
<a name="l00145"></a>00145 <span class="keywordtype">void</span> *atr_buf,
<a name="l00146"></a>00146 <span class="keywordtype">size_t</span> atr_len);
<a name="l00147"></a>00147 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_eject(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00148"></a>00148 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00149"></a>00149 time_t timeout,
<a name="l00150"></a>00150 <span class="keyword">const</span> <span class="keywordtype">char</span> *message);
<a name="l00151"></a>00151 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_perform_verify(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00152"></a>00152 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> slot,
<a name="l00153"></a>00153 time_t timeout,
<a name="l00154"></a>00154 <span class="keyword">const</span> <span class="keywordtype">char</span> *message,
<a name="l00155"></a>00155 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> data_len,
<a name="l00156"></a>00156 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *resp, <span class="keywordtype">size_t</span> resp_len);
<a name="l00157"></a>00157 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_read_memory(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *,
<a name="l00158"></a>00158 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>,
<a name="l00159"></a>00159 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);
<a name="l00160"></a>00160 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_card_write_memory(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *,
<a name="l00161"></a>00161 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>,
<a name="l00162"></a>00162 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="keyword">extern</span> ifd_protocol_t * ifd_protocol_new(<span class="keywordtype">int</span> <span class="keywordtype">id</span>,
<a name="l00165"></a>00165 <a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00166"></a>00166 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dad);
<a name="l00167"></a>00167 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_protocol_set_parameter(ifd_protocol_t *p,
<a name="l00168"></a>00168 <span class="keywordtype">int</span> type,
<a name="l00169"></a>00169 <span class="keywordtype">long</span> value);
<a name="l00170"></a>00170 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_protocol_get_parameter(ifd_protocol_t *p,
<a name="l00171"></a>00171 <span class="keywordtype">int</span> type,
<a name="l00172"></a>00172 <span class="keywordtype">long</span> *value);
<a name="l00173"></a>00173 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_protocol_read_memory(ifd_protocol_t *,
<a name="l00174"></a>00174 <span class="keywordtype">int</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>,
<a name="l00175"></a>00175 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);
<a name="l00176"></a>00176 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_protocol_write_memory(ifd_protocol_t *,
<a name="l00177"></a>00177 <span class="keywordtype">int</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>,
<a name="l00178"></a>00178 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *, <span class="keywordtype">size_t</span>);
<a name="l00179"></a>00179 <span class="keyword">extern</span> <span class="keywordtype">void</span> ifd_protocol_free(ifd_protocol_t *);
<a name="l00180"></a>00180 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_before_command(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00181"></a>00181 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_after_command(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00182"></a>00182 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_get_eventfd(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *, <span class="keywordtype">short</span> *);
<a name="l00183"></a>00183 <span class="keyword">extern</span> <span class="keywordtype">void</span> ifd_poll(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00184"></a>00184 <span class="keyword">extern</span> <span class="keywordtype">int</span> id_event(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="comment">/* Debugging macro */</span>
<a name="l00187"></a>00187 <span class="preprocessor">#ifdef __GNUC__</span>
<a name="l00188"></a>00188 <span class="preprocessor"></span><span class="preprocessor">#define ifd_debug(level, fmt, args...) \</span>
<a name="l00189"></a>00189 <span class="preprocessor"> do { \</span>
<a name="l00190"></a>00190 <span class="preprocessor"> if ((level) <= ct_config.debug) \</span>
<a name="l00191"></a>00191 <span class="preprocessor"> ct_debug("%s: " fmt, __FUNCTION__ , ##args); \</span>
<a name="l00192"></a>00192 <span class="preprocessor"> } while (0)</span>
<a name="l00193"></a>00193 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">void</span> ifd_debug(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);
<a name="l00195"></a>00195 <span class="preprocessor">#endif</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span>
<a name="l00197"></a>00197 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00198"></a>00198 <span class="preprocessor"></span>}
<a name="l00199"></a>00199 <span class="preprocessor">#endif</span>
<a name="l00200"></a>00200 <span class="preprocessor"></span>
<a name="l00201"></a>00201 <span class="preprocessor">#endif </span><span class="comment">/* OPENCT_IFD_H */</span>
</pre></div></div>
<hr>
<table width="100%"><tr><td>libp11, Copyright (C) 2005 Olaf Kirch <okir@lst.de></td><td align="right"><a href="http://www.opensc-project.org"><img src="opensc-logo.gif" alt="OpenSC-Project.org Logo" border="0"/></a></td></tr></table>
