<!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: driver.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>driver.h</h1><a href="driver_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00008"></a>00008 <span class="preprocessor">#ifndef OPENCT_DRIVER_H</span>
<a name="l00009"></a>00009 <span class="preprocessor"></span><span class="preprocessor">#define OPENCT_DRIVER_H</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span>
<a name="l00011"></a>00011 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00013"></a>00013 <span class="preprocessor">#endif</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <openct/device.h></span>
<a name="l00016"></a>00016
<a name="l00020"></a><a class="code" href="structifd__driver__ops.html">00020</a> <span class="keyword">struct </span><a class="code" href="structifd__driver__ops.html" title="Driver operations.">ifd_driver_ops</a> {
<a name="l00021"></a>00021 <span class="keywordtype">int</span> default_protocol;
<a name="l00022"></a>00022
<a name="l00034"></a>00034 int (*<a class="code" href="structifd__driver__ops.html#a4d0a12472fdd8b0e191375f9e45d3e4a" title="Open the reader.">open</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00049"></a>00049 int (*<a class="code" href="structifd__driver__ops.html#a3f5997fd33b1dce217d9bd593f1ed208" title="Close the reader.">close</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> * reader);
<a name="l00076"></a>00076 int (*<a class="code" href="structifd__driver__ops.html#a7094ace2992d15ef26188b8d6df373c1" title="Change the communication protocol parity.">change_parity</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> parity);
<a name="l00087"></a>00087 int (*<a class="code" href="structifd__driver__ops.html#a6fb5b6df0df9db9160fe0b0b3e72c367" title="Change the communication protocol speed.">change_speed</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> speed);
<a name="l00102"></a>00102 int (*<a class="code" href="structifd__driver__ops.html#ac8e2637b8672bbea865187c13ff4f8a2" title="Activate the smart card reader.">activate</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader);
<a name="l00113"></a>00113 int (*<a class="code" href="structifd__driver__ops.html#a181fd5e2945a30c2061b41d754194712" title="Deactivate the smart card reader.">deactivate</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader);
<a name="l00138"></a>00138 int (*<a class="code" href="structifd__driver__ops.html#adc21d782c198d7416b92d71ea0d97722" title="Fetch the card status.">card_status</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot, <span class="keywordtype">int</span> *status);
<a name="l00154"></a>00154 int (*<a class="code" href="structifd__driver__ops.html#a90b4f3ccf6b598d6668d7139fb44915e" title="Reset the card and fetch the ATR.">card_reset</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot, <span class="keywordtype">void</span> *atr, <span class="keywordtype">size_t</span> atr_len);
<a name="l00169"></a>00169 int (*<a class="code" href="structifd__driver__ops.html#aae39b147262bb8263861d2d2864d40b3" title="Prompts the insertion of a smart card in the reader and performs a card reset.">card_request</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot,
<a name="l00170"></a>00170 time_t timeout, <span class="keyword">const</span> <span class="keywordtype">char</span> *message,
<a name="l00171"></a>00171 <span class="keywordtype">void</span> *atr, <span class="keywordtype">size_t</span> atr_len);
<a name="l00185"></a>00185 int (*<a class="code" href="structifd__driver__ops.html#a26a33942a677859fb7259b5281ef4c0c" title="Eject the smart card.">card_eject</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot,
<a name="l00186"></a>00186 time_t timeout, <span class="keyword">const</span> <span class="keywordtype">char</span> *message);
<a name="l00193"></a>00193 int (*<a class="code" href="structifd__driver__ops.html#aa7cbfedeb9e6fc32b63471bf7e2b4c2a" title="Output a message on the reader&#39;s display.">output</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keyword">const</span> <span class="keywordtype">char</span> *message);
<a name="l00209"></a>00209 int (*<a class="code" href="structifd__driver__ops.html#a8af0fbde7e571bc78c8a1375926e8685" title="Request the PIN and have the card verify it.">perform_verify</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00210"></a>00210 <span class="keywordtype">int</span> slot, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeout, <span class="keyword">const</span> <span class="keywordtype">char</span> *prompt,
<a name="l00211"></a>00211 <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="l00212"></a>00212 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *resp, <span class="keywordtype">size_t</span> resp_len);
<a name="l00230"></a>00230 int (*<a class="code" href="structifd__driver__ops.html#a80db408c857b83db3ff1bfc73634d8b0" title="Send an APDU using the currently selected protocol.">send</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00231"></a>00231 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dad,
<a name="l00232"></a>00232 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer,
<a name="l00233"></a>00233 <span class="keywordtype">size_t</span> len);
<a name="l00247"></a>00247 int (*<a class="code" href="structifd__driver__ops.html#ab2ffe9b1a6d6cd550d7b2d97967c6081" title="Receive an APDU response using the currently selected protocol.">recv</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader,
<a name="l00248"></a>00248 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dad,
<a name="l00249"></a>00249 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer,
<a name="l00250"></a>00250 <span class="keywordtype">size_t</span> len,
<a name="l00251"></a>00251 <span class="keywordtype">long</span> timeout);
<a name="l00274"></a>00274 int (*<a class="code" href="structifd__driver__ops.html#aaa842fff3552548756b1ce9ab4ac4e27" title="Select the smart card communication protocol.">set_protocol</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot, <span class="keywordtype">int</span> protocol);
<a name="l00290"></a>00290 int (*<a class="code" href="structifd__driver__ops.html#a9418fa6dad65dbe40d9e8cf9a8df8c8d" title="Transceive a protocol data unit.">transparent</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot,
<a name="l00291"></a>00291 <span class="keyword">const</span> <span class="keywordtype">void</span> *sbuf, <span class="keywordtype">size_t</span> slen,
<a name="l00292"></a>00292 <span class="keywordtype">void</span> *rbuf, <span class="keywordtype">size_t</span> rlen);
<a name="l00304"></a>00304 int (*<a class="code" href="structifd__driver__ops.html#af02fe6c2243b3d0cc8debffdbd911bb8" title="Read data from a synchronous smart card.">sync_read</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot, <span class="keywordtype">int</span> proto,
<a name="l00305"></a>00305 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> addr,
<a name="l00306"></a>00306 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *rbuf, <span class="keywordtype">size_t</span> rlen);
<a name="l00318"></a>00318 int (*<a class="code" href="structifd__driver__ops.html#ab79070efbbc2dd3315d60cc1cf73752a" title="Write data to a synchronous smart card.">sync_write</a>)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot, <span class="keywordtype">int</span> proto,
<a name="l00319"></a>00319 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> addr,
<a name="l00320"></a>00320 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *sbuf, <span class="keywordtype">size_t</span> slen);
<a name="l00321"></a>00321
<a name="l00322"></a>00322 <span class="comment">/*Support for transparent access to "escape" */</span>
<a name="l00323"></a>00323 int (*escape)(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *reader, <span class="keywordtype">int</span> slot,
<a name="l00324"></a>00324 <span class="keyword">const</span> <span class="keywordtype">void</span> *sbuf, <span class="keyword">const</span> <span class="keywordtype">size_t</span> slen,
<a name="l00325"></a>00325 <span class="keywordtype">void</span> *rbuf, <span class="keywordtype">size_t</span> rlen);
<a name="l00326"></a>00326
<a name="l00334"></a>00334 int (*<a class="code" href="structifd__driver__ops.html#a2dc4c60beed7c0d987966fd623f047a9" title="Execute before command.">before_command</a>) (<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00335"></a>00335
<a name="l00343"></a>00343 int (*<a class="code" href="structifd__driver__ops.html#a6f6294219881e4cb8a51a6e0980a416f" title="Execute after command.">after_command</a>) (<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00344"></a>00344
<a name="l00353"></a>00353 int (*<a class="code" href="structifd__driver__ops.html#a02f17628fb434fb81049e2c9311c04a6" title="Get event fd.">get_eventfd</a>) (<a class="code" href="structifd__reader.html">ifd_reader_t</a> *, <span class="keywordtype">short</span> *events);
<a name="l00354"></a>00354
<a name="l00363"></a>00363 int (*<a class="code" href="structifd__driver__ops.html#a54a0051fd2070d6ee2c8d8047ff1cfea" title="Event callback.">event</a>) (<a class="code" href="structifd__reader.html">ifd_reader_t</a> *, <span class="keywordtype">int</span> *status, <span class="keywordtype">size_t</span> status_size);
<a name="l00364"></a>00364
<a name="l00374"></a>00374 int (*<a class="code" href="structifd__driver__ops.html#a28aa6a49c53f87280d0fd6854e038313" title="Error callback.">error</a>) (<a class="code" href="structifd__reader.html">ifd_reader_t</a> *);
<a name="l00375"></a>00375 };
<a name="l00376"></a>00376
<a name="l00377"></a>00377 <span class="keyword">extern</span> <span class="keywordtype">void</span> ifd_driver_register(<span class="keyword">const</span> <span class="keywordtype">char</span> *,
<a name="l00378"></a>00378 <span class="keyword">struct</span> <a class="code" href="structifd__driver__ops.html" title="Driver operations.">ifd_driver_ops</a> *);
<a name="l00379"></a>00379 <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="structifd__driver.html">ifd_driver_t</a> *ifd_driver_get(<span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00380"></a>00380 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_driver_add_id(<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00381"></a>00381 <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * ifd_driver_for_id(<a class="code" href="structifd__devid.html">ifd_devid_t</a> *);
<a name="l00382"></a>00382
<a name="l00383"></a>00383 <span class="comment">/*</span>
<a name="l00384"></a>00384 <span class="comment"> * Protocol handling for card terminal drivers</span>
<a name="l00385"></a>00385 <span class="comment"> */</span>
<a name="l00386"></a>00386 <span class="keyword">extern</span> ifd_protocol_t * ifd_protocol_select(<a class="code" href="structifd__reader.html">ifd_reader_t</a> *, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>);
<a name="l00387"></a>00387 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_protocol_transceive(ifd_protocol_t *proto,
<a name="l00388"></a>00388 <span class="keywordtype">int</span> dad,
<a name="l00389"></a>00389 <span class="keyword">const</span> <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>,
<a name="l00390"></a>00390 <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>);
<a name="l00391"></a>00391 <span class="keyword">extern</span> <span class="keywordtype">int</span> ifd_protocol_resynchronize(ifd_protocol_t *, <span class="keywordtype">int</span>);
<a name="l00392"></a>00392
<a name="l00393"></a>00393 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00394"></a>00394 <span class="preprocessor"></span>}
<a name="l00395"></a>00395 <span class="preprocessor">#endif</span>
<a name="l00396"></a>00396 <span class="preprocessor"></span>
<a name="l00397"></a>00397 <span class="preprocessor">#endif </span><span class="comment">/* OPENCT_DRIVER_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>
