*** empty log message ***
[rfid/librfid.git] / README
1 librfid - low-level RFID access library
2 (C) 2005 by Harald Welte <laforge@gnumonks.org>
3 ======================================================================
4
5 This library intends to provide a reader- and (as much as possible)
6 PICC / tag independent API for RFID applications.
7
8 1. Supported Prodocols:
9
10 At this early stage of implementaition, it offers only ISO 14443-2, ISO 14443-3
11 A and B as well as ISO 14443-4 (T=CL) support.  Other protocols, both open
12 (such as ISO 15693) and proprietary are to be added as soon as I find some more
13 time.
14
15 2. Supported Readers:
16
17 At this time only the Omnikey Cardman 5121 reader is supported. 
18
19 The cm5121 is a relatively stupid piece of hardware.  Basically a contact-based
20 cm3121 that was enhanced by putting a Philips CL RC632 reader ASIC next to it.
21 There is no RFID protocol implementation on the cm5121, everything is done on
22 the host (PC) software.  Four primitives (read/write byte/fifo) are provided
23 via simple PC_to_RDR_Escape CCID messages.
24
25 This makes it the ideal device to learn and play with RFID, since you don't
26 have any (proprietary) software interfere and puts you in full control of
27 everything.
28
29 Support for more devices shouldn't be too difficult to add, provided the
30 devices are stupid enough.  More sophisticated readers like Integrated
31 Engineering or Philips Pegoda do much of the protocol handling in firmware on a
32 Microcontroller.  This makes them (at least till now) faster, but also of
33 limited use, especially in education and research.
34
35 So if you happen to run into any other dumb RFID readers, especially those
36 based on Philips CL RC531 and RC632, adding support should be very
37 straightforward.  If you want to contract me for implementing a driver backend,
38 don't hesitate to contact me.
39
40 3. Installation
41
42 In order to run librfid, you need to provide a PC_to_RDR_Escape function to it.
43 This is the low-level transport function for communicating.   Usually that function would point to a CCID device driver.
44
45 My svn repository at
46 https://svn.gnumonks.org/trunk/omnikey_cardman/new/userspace/ has an openct
47 fork with a modified CCID driver.  It allows you to use the contact based part
48 via PC/SC, CT-API, and the contactless part via librfid simultaneously.
49
50
51 -- Harald Welte <laforge@gnumonks.org>
52