Prepare RFID compilation in firmware mode
[librfid] / src / rfid_reader_openpcd.c
1 /* OpenPCD specific RC632 transport layer 
2  *
3  * (C) 2006 by Harald Welte <laforge@gnumonks.org>
4  *
5  * The OpenPCD is an Atmel AT91SAM7Sxx based USB RFID reader.
6  * It's CL RC632 is connected via SPI.  OpenPCD has multiple firmware
7  * images.  This driver is for the "main_dumbreader" firmware.
8  *
9  * TODO:
10  * - put hdl from static variable into asic transport or reader handle 
11  */
12
13 /*
14  *  This program is free software; you can redistribute it and/or modify
15  *  it under the terms of the GNU General Public License version 2 
16  *  as published by the Free Software Foundation
17  *
18  *  This program is distributed in the hope that it will be useful,
19  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  *  GNU General Public License for more details.
22  *
23  *  You should have received a copy of the GNU General Public License
24  *  along with this program; if not, write to the Free Software
25  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  */
27
28 //#define DEBUG
29
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <string.h>
33 #include <errno.h>
34
35 #include <usb.h>
36
37 #include <librfid/rfid.h>
38 #include <librfid/rfid_reader.h>
39 #include <librfid/rfid_asic.h>
40 #include <librfid/rfid_asic_rc632.h>
41 #include <librfid/rfid_reader_openpcd.h>
42 #include <librfid/rfid_layer2.h>
43 #include <librfid/rfid_protocol.h>
44
45 /* FIXME */
46 #include "rc632.h"
47
48 #define SENDBUF_LEN     (256+4+10) /* 256bytes max FSD/FSC, plus 4 bytes header,
49                                     plus 10 bytes reserve */
50 #define RECVBUF_LEN     SENDBUF_LEN
51
52 static char snd_buf[SENDBUF_LEN];
53 static char rcv_buf[RECVBUF_LEN];
54 static struct openpcd_hdr *snd_hdr;
55 static struct openpcd_hdr *rcv_hdr;
56
57
58 #ifndef LIBRFID_FIRMWARE
59
60 static struct usb_device *dev;
61 static struct usb_dev_handle *hdl;
62
63 static int openpcd_send_command(u_int8_t cmd, u_int8_t reg, u_int8_t val,
64                                 u_int16_t len, const unsigned char *data)
65 {
66         int ret;
67         u_int16_t cur;
68
69         snd_hdr->cmd = cmd;
70         snd_hdr->reg = reg;
71         snd_hdr->val = val;
72         snd_hdr->flags = OPENPCD_FLAG_RESPOND;
73         if (data && len)
74                 memcpy(snd_hdr->data, data, len);
75
76         cur = sizeof(*snd_hdr) + len;
77
78         return usb_bulk_write(hdl, OPENPCD_OUT_EP, (char *)snd_hdr, cur, 0);
79 }
80
81 static int openpcd_recv_reply(void)
82 {
83         int ret;
84
85         ret = usb_bulk_read(hdl, OPENPCD_IN_EP, rcv_buf, sizeof(rcv_buf), 1000);
86
87         return ret;
88 }
89
90 static int openpcd_xcv(u_int8_t cmd, u_int8_t reg, u_int8_t val,
91                         u_int16_t len, const unsigned char *data)
92 {
93         int ret;
94         
95         ret = openpcd_send_command(cmd, reg, val, len, data);
96         if (ret < 0)
97                 return ret;
98         if (ret < sizeof(sizeof(struct openpcd_hdr)))
99                 return -EINVAL;
100
101         return openpcd_recv_reply();
102 }
103
104 struct usb_id {
105         u_int16_t vid;
106         u_int16_t pid;
107 };
108
109 static const struct usb_id opcd_usb_ids[] = {
110         { .vid = 0x2342, .pid = 0x0001 },       /* prototypes */
111         { .vid = 0x16c0, .pid = 0x076b },       /* first official device id */
112 };
113
114 static struct usb_device *find_opcd_device(void)
115 {
116         struct usb_bus *bus;
117
118         for (bus = usb_busses; bus; bus = bus->next) {
119                 struct usb_device *dev;
120                 for (dev = bus->devices; dev; dev = dev->next) {
121                         int i;
122                         for (i = 0; i < ARRAY_SIZE(opcd_usb_ids); i++) {
123                                 const struct usb_id *id = &opcd_usb_ids[i];
124                                 if (dev->descriptor.idVendor == id->vid &&
125                                     dev->descriptor.idProduct == id->pid)
126                                         return dev;
127                         }
128                 }
129         }
130         return NULL;
131 }
132
133 /* RC632 access primitives for librfid inside reader firmware */
134
135 static int openpcd_reg_write(struct rfid_asic_transport_handle *rath,
136                              unsigned char reg, unsigned char value)
137 {
138         int ret;
139
140         DEBUGP("reg=0x%02x, val=%02x: ", reg, value);
141
142         ret = openpcd_xcv(OPENPCD_CMD_WRITE_REG, reg, value, 0, NULL);
143         if (ret < 0)
144                 DEBUGPC("ERROR sending command\n");
145         else
146                 DEBUGPC("OK\n");
147
148         return ret;
149 }
150
151 static int openpcd_reg_read(struct rfid_asic_transport_handle *rath,
152                             unsigned char reg,
153                             unsigned char *value)
154 {
155         int ret;        
156
157         DEBUGP("reg=0x%02x, ", reg);
158
159         ret = openpcd_xcv(OPENPCD_CMD_READ_REG, reg, 0, 0, NULL);
160         if (ret < 0) {
161                 DEBUGPC("ERROR sending command\n");
162                 return ret;
163         }
164
165         if (ret < sizeof(struct openpcd_hdr)) {
166                 DEBUGPC("ERROR: short packet\n");
167                 return ret;
168         }
169
170         *value = rcv_hdr->val;
171         DEBUGPC("val=%02x: OK\n", *value);
172
173         return ret;
174 }
175
176 static int openpcd_fifo_read(struct rfid_asic_transport_handle *rath,
177                              unsigned char num_bytes,
178                              unsigned char *buf)
179 {
180         int ret;
181
182         DEBUGP(" ");
183
184         ret = openpcd_xcv(OPENPCD_CMD_READ_FIFO, 0x00, num_bytes, 0, NULL);
185         if (ret < 0) {
186                 DEBUGPC("ERROR sending command\n");
187                 return ret;
188         }
189         DEBUGPC("ret = %d\n", ret);
190
191         memcpy(buf, rcv_hdr->data, ret - sizeof(struct openpcd_hdr));
192         DEBUGPC("len=%d val=%s: OK\n", ret - sizeof(struct openpcd_hdr),
193                 rfid_hexdump(rcv_hdr->data, ret - sizeof(struct openpcd_hdr)));
194
195         return ret;
196 }
197
198 static int openpcd_fifo_write(struct rfid_asic_transport_handle *rath,
199                              unsigned char len,
200                              const unsigned char *bytes,
201                              unsigned char flags)
202 {
203         int ret;
204
205         DEBUGP("len=%u, data=%s\n", len, rfid_hexdump(bytes, len));
206         ret = openpcd_xcv(OPENPCD_CMD_WRITE_FIFO, 0, 0, len, bytes);
207
208         return ret;
209 }
210
211 const struct rfid_asic_transport openpcd_rat = {
212         .name = "OpenPCD Dumb USB Protocol",
213         .priv.rc632 = {
214                 .fn = {
215                         .reg_write      = &openpcd_reg_write,
216                         .reg_read       = &openpcd_reg_read,
217                         .fifo_write     = &openpcd_fifo_write,
218                         .fifo_read      = &openpcd_fifo_read,
219                 },
220         },
221 };
222
223 #else
224 /* RC632 access primitives for librfid inside reader firmware */
225
226 static int openpcd_reg_write(struct rfid_asic_transport_handle *rath,
227                              unsigned char reg, unsigned char value)
228 {
229 }
230
231 static int openpcd_reg_read(struct rfid_asic_transport_handle *rath,
232                             unsigned char reg,
233                             unsigned char *value)
234 {
235 }
236
237
238 static int openpcd_fifo_read(struct rfid_asic_transport_handle *rath,
239                              unsigned char num_bytes,
240                              unsigned char *buf)
241 {
242 }
243
244 static int openpcd_fifo_write(struct rfid_asic_transport_handle *rath,
245                              unsigned char len,
246                              const unsigned char *bytes,
247                              unsigned char flags)
248 {
249 }
250
251 const struct rfid_asic_transport openpcd_rat = {
252         .name = "OpenPCD Firmware RC632 Access",
253         .priv.rc632 = {
254                 .fn = {
255                         .reg_write      = &openpcd_reg_write,
256                         .reg_read       = &openpcd_reg_read,
257                         .fifo_write     = &openpcd_fifo_write,
258                         .fifo_read      = &openpcd_fifo_read,
259                 },
260         },
261 };
262
263 #endif /* LIBRFID_FIRMWARE */
264
265 static int openpcd_transceive(struct rfid_reader_handle *rh,
266                              enum rfid_frametype frametype,
267                              const unsigned char *tx_data, unsigned int tx_len,
268                              unsigned char *rx_data, unsigned int *rx_len,
269                              u_int64_t timeout, unsigned int flags)
270 {
271         return rh->ah->asic->priv.rc632.fn.transceive(rh->ah, frametype,
272                                                       tx_data, tx_len, 
273                                                       rx_data, rx_len,
274                                                       timeout, flags);
275 }
276
277 static int openpcd_transceive_sf(struct rfid_reader_handle *rh,
278                                unsigned char cmd, struct iso14443a_atqa *atqa)
279 {
280         return rh->ah->asic->priv.rc632.fn.iso14443a.transceive_sf(rh->ah,
281                                                                    cmd,
282                                                                    atqa);
283 }
284
285 static int
286 openpcd_transceive_acf(struct rfid_reader_handle *rh,
287                       struct iso14443a_anticol_cmd *cmd,
288                       unsigned int *bit_of_col)
289 {
290         return rh->ah->asic->priv.rc632.fn.iso14443a.transceive_acf(rh->ah,
291                                                          cmd, bit_of_col);
292 }
293
294 static int
295 openpcd_14443a_init(struct rfid_reader_handle *rh)
296 {
297         return rh->ah->asic->priv.rc632.fn.iso14443a.init(rh->ah);
298 }
299
300 static int
301 openpcd_14443a_set_speed(struct rfid_reader_handle *rh, 
302                         unsigned int tx,
303                         unsigned int speed)
304 {
305         u_int8_t rate;
306         
307         DEBUGP("setting rate: ");
308         switch (speed) {
309         case RFID_14443A_SPEED_106K:
310                 rate = 0x00;
311                 DEBUGPC("106K\n");
312                 break;
313         case RFID_14443A_SPEED_212K:
314                 rate = 0x01;
315                 DEBUGPC("212K\n");
316                 break;
317         case RFID_14443A_SPEED_424K:
318                 rate = 0x02;
319                 DEBUGPC("424K\n");
320                 break;
321         case RFID_14443A_SPEED_848K:
322                 rate = 0x03;
323                 DEBUGPC("848K\n");
324                 break;
325         default:
326                 return -EINVAL;
327                 break;
328         }
329         return rh->ah->asic->priv.rc632.fn.iso14443a.set_speed(rh->ah,
330                                                                 tx, rate);
331 }
332
333 static int
334 openpcd_14443b_init(struct rfid_reader_handle *rh)
335 {
336         return rh->ah->asic->priv.rc632.fn.iso14443b.init(rh->ah);
337 }
338
339 static int
340 openpcd_15693_init(struct rfid_reader_handle *rh)
341 {
342         return rh->ah->asic->priv.rc632.fn.iso15693.init(rh->ah);
343 }
344
345 static int
346 openpcd_mifare_setkey(struct rfid_reader_handle *rh, const u_int8_t *key)
347 {
348         return rh->ah->asic->priv.rc632.fn.mifare_classic.setkey(rh->ah, key);
349 }
350
351 static int
352 openpcd_mifare_auth(struct rfid_reader_handle *rh, u_int8_t cmd, 
353                    u_int32_t serno, u_int8_t block)
354 {
355         return rh->ah->asic->priv.rc632.fn.mifare_classic.auth(rh->ah, 
356                                                         cmd, serno, block);
357 }
358
359 static struct rfid_reader_handle *
360 openpcd_open(void *data)
361 {
362         struct rfid_reader_handle *rh;
363         struct rfid_asic_transport_handle *rath;
364
365         snd_hdr = (struct openpcd_hdr *)snd_buf;
366         rcv_hdr = (struct openpcd_hdr *)rcv_buf;
367
368         usb_init();
369         if (usb_find_busses() < 0)
370                 return NULL;
371         if (usb_find_devices() < 0) 
372                 return NULL;
373         
374         dev = find_opcd_device();
375         if (!dev) {
376                 DEBUGP("No matching USB device found\n");
377                 return NULL;
378         }
379
380         hdl = usb_open(dev);
381         if (!hdl) {
382                 DEBUGP("Can't open USB device\n");
383                 return NULL;
384         }
385
386         if (usb_claim_interface(hdl, 0) < 0) {
387                 DEBUGP("Can't claim interface\n");
388                 usb_close(hdl);
389                 return NULL;
390         }
391
392         rh = malloc_reader_handle(sizeof(*rh));
393         if (!rh)
394                 return NULL;
395         memset(rh, 0, sizeof(*rh));
396
397         rath = malloc_rat_handle(sizeof(*rath));
398         if (!rath)
399                 goto out_rh;
400         memset(rath, 0, sizeof(*rath));
401
402         rath->rat = &openpcd_rat;
403         rh->reader = &rfid_reader_openpcd;
404
405         rh->ah = rc632_open(rath);
406         if (!rh->ah) 
407                 goto out_rath;
408
409         DEBUGP("returning %p\n", rh);
410         return rh;
411
412 out_rath:
413         free_rat_handle(rath);
414 out_rh:
415         free_reader_handle(rh);
416
417         return NULL;
418 }
419
420 static void
421 openpcd_close(struct rfid_reader_handle *rh)
422 {
423         struct rfid_asic_transport_handle *rath = rh->ah->rath;
424
425         rc632_close(rh->ah);
426         free_rat_handle(rath);
427         free_reader_handle(rh);
428
429         usb_close(hdl);
430 }
431
432 const struct rfid_reader rfid_reader_openpcd = {
433         .name   = "OpenPCD RFID Reader",
434         .id = RFID_READER_OPENPCD,
435         .open = &openpcd_open,
436         .close = &openpcd_close,
437         .transceive = &openpcd_transceive,
438         .l2_supported = (1 << RFID_LAYER2_ISO14443A) |
439                         (1 << RFID_LAYER2_ISO14443B) |
440                         (1 << RFID_LAYER2_ISO15693),
441         .proto_supported = (1 << RFID_PROTOCOL_TCL) |
442                         (1 << RFID_PROTOCOL_MIFARE_UL) |
443                         (1 << RFID_PROTOCOL_MIFARE_CLASSIC),
444         .iso14443a = {
445                 .init = &openpcd_14443a_init,
446                 .transceive_sf = &openpcd_transceive_sf,
447                 .transceive_acf = &openpcd_transceive_acf,
448                 .speed = RFID_14443A_SPEED_106K | RFID_14443A_SPEED_212K |
449                          RFID_14443A_SPEED_424K, //| RFID_14443A_SPEED_848K,
450                 .set_speed = &openpcd_14443a_set_speed,
451         },
452         .iso14443b = {
453                 .init = &openpcd_14443b_init,
454         },
455         .mifare_classic = {
456                 .setkey = &openpcd_mifare_setkey,
457                 .auth = &openpcd_mifare_auth,
458         },
459 };