1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41#include <linux/module.h>
42#include <linux/kernel.h>
43#include <linux/init.h>
44#include <linux/delay.h>
45
46#include "hermes.h"
47
48
49#define CMD_BUSY_TIMEOUT (100)
50#define CMD_INIT_TIMEOUT (50000)
51#define CMD_COMPL_TIMEOUT (20000)
52#define ALLOC_COMPL_TIMEOUT (1000)
53
54
55
56
57
58
59#define HERMES_AUX_ENABLE 0x8000
60#define HERMES_AUX_DISABLE 0x4000
61#define HERMES_AUX_ENABLED 0xC000
62#define HERMES_AUX_DISABLED 0x0000
63
64#define HERMES_AUX_PW0 0xFE01
65#define HERMES_AUX_PW1 0xDC23
66#define HERMES_AUX_PW2 0xBA45
67
68
69#define HERMES_PROGRAM_DISABLE (0x0000 | HERMES_CMD_DOWNLD)
70#define HERMES_PROGRAM_ENABLE_VOLATILE (0x0100 | HERMES_CMD_DOWNLD)
71#define HERMES_PROGRAM_ENABLE_NON_VOLATILE (0x0200 | HERMES_CMD_DOWNLD)
72#define HERMES_PROGRAM_NON_VOLATILE (0x0300 | HERMES_CMD_DOWNLD)
73
74
75
76
77
78#define DMSG(stuff...) do {printk(KERN_DEBUG "hermes @ %p: " , hw->iobase); \
79 printk(stuff); } while (0)
80
81#undef HERMES_DEBUG
82#ifdef HERMES_DEBUG
83#include <stdarg.h>
84
85#define DEBUG(lvl, stuff...) if ((lvl) <= HERMES_DEBUG) DMSG(stuff)
86
87#else
88
89#define DEBUG(lvl, stuff...) do { } while (0)
90
91#endif
92
93static const struct hermes_ops hermes_ops_local;
94
95
96
97
98
99
100
101
102
103
104
105
106static int hermes_issue_cmd(hermes_t *hw, u16 cmd, u16 param0,
107 u16 param1, u16 param2)
108{
109 int k = CMD_BUSY_TIMEOUT;
110 u16 reg;
111
112
113 reg = hermes_read_regn(hw, CMD);
114 while ((reg & HERMES_CMD_BUSY) && k) {
115 k--;
116 udelay(1);
117 reg = hermes_read_regn(hw, CMD);
118 }
119 if (reg & HERMES_CMD_BUSY)
120 return -EBUSY;
121
122 hermes_write_regn(hw, PARAM2, param2);
123 hermes_write_regn(hw, PARAM1, param1);
124 hermes_write_regn(hw, PARAM0, param0);
125 hermes_write_regn(hw, CMD, cmd);
126
127 return 0;
128}
129
130
131
132
133
134
135static int hermes_doicmd_wait(hermes_t *hw, u16 cmd,
136 u16 parm0, u16 parm1, u16 parm2,
137 struct hermes_response *resp)
138{
139 int err = 0;
140 int k;
141 u16 status, reg;
142
143 err = hermes_issue_cmd(hw, cmd, parm0, parm1, parm2);
144 if (err)
145 return err;
146
147 reg = hermes_read_regn(hw, EVSTAT);
148 k = CMD_INIT_TIMEOUT;
149 while ((!(reg & HERMES_EV_CMD)) && k) {
150 k--;
151 udelay(10);
152 reg = hermes_read_regn(hw, EVSTAT);
153 }
154
155 hermes_write_regn(hw, SWSUPPORT0, HERMES_MAGIC);
156
157 if (!hermes_present(hw)) {
158 DEBUG(0, "hermes @ 0x%x: Card removed during reset.\n",
159 hw->iobase);
160 err = -ENODEV;
161 goto out;
162 }
163
164 if (!(reg & HERMES_EV_CMD)) {
165 printk(KERN_ERR "hermes @ %p: "
166 "Timeout waiting for card to reset (reg=0x%04x)!\n",
167 hw->iobase, reg);
168 err = -ETIMEDOUT;
169 goto out;
170 }
171
172 status = hermes_read_regn(hw, STATUS);
173 if (resp) {
174 resp->status = status;
175 resp->resp0 = hermes_read_regn(hw, RESP0);
176 resp->resp1 = hermes_read_regn(hw, RESP1);
177 resp->resp2 = hermes_read_regn(hw, RESP2);
178 }
179
180 hermes_write_regn(hw, EVACK, HERMES_EV_CMD);
181
182 if (status & HERMES_STATUS_RESULT)
183 err = -EIO;
184out:
185 return err;
186}
187
188void hermes_struct_init(hermes_t *hw, void __iomem *address, int reg_spacing)
189{
190 hw->iobase = address;
191 hw->reg_spacing = reg_spacing;
192 hw->inten = 0x0;
193 hw->eeprom_pda = false;
194 hw->ops = &hermes_ops_local;
195}
196EXPORT_SYMBOL(hermes_struct_init);
197
198static int hermes_init(hermes_t *hw)
199{
200 u16 reg;
201 int err = 0;
202 int k;
203
204
205 hw->inten = 0x0;
206 hermes_write_regn(hw, INTEN, 0);
207 hermes_write_regn(hw, EVACK, 0xffff);
208
209
210
211
212
213
214
215 k = CMD_BUSY_TIMEOUT;
216 reg = hermes_read_regn(hw, CMD);
217 while (k && (reg & HERMES_CMD_BUSY)) {
218 if (reg == 0xffff)
219
220 return -ENODEV;
221
222 k--;
223 udelay(1);
224 reg = hermes_read_regn(hw, CMD);
225 }
226
227
228
229
230
231
232
233 reg = hermes_read_regn(hw, EVSTAT);
234 hermes_write_regn(hw, EVACK, reg);
235
236
237
238 err = hermes_doicmd_wait(hw, HERMES_CMD_INIT, 0, 0, 0, NULL);
239
240 return err;
241}
242
243
244
245
246
247
248
249
250
251
252static int hermes_docmd_wait(hermes_t *hw, u16 cmd, u16 parm0,
253 struct hermes_response *resp)
254{
255 int err;
256 int k;
257 u16 reg;
258 u16 status;
259
260 err = hermes_issue_cmd(hw, cmd, parm0, 0, 0);
261 if (err) {
262 if (!hermes_present(hw)) {
263 if (net_ratelimit())
264 printk(KERN_WARNING "hermes @ %p: "
265 "Card removed while issuing command "
266 "0x%04x.\n", hw->iobase, cmd);
267 err = -ENODEV;
268 } else
269 if (net_ratelimit())
270 printk(KERN_ERR "hermes @ %p: "
271 "Error %d issuing command 0x%04x.\n",
272 hw->iobase, err, cmd);
273 goto out;
274 }
275
276 reg = hermes_read_regn(hw, EVSTAT);
277 k = CMD_COMPL_TIMEOUT;
278 while ((!(reg & HERMES_EV_CMD)) && k) {
279 k--;
280 udelay(10);
281 reg = hermes_read_regn(hw, EVSTAT);
282 }
283
284 if (!hermes_present(hw)) {
285 printk(KERN_WARNING "hermes @ %p: Card removed "
286 "while waiting for command 0x%04x completion.\n",
287 hw->iobase, cmd);
288 err = -ENODEV;
289 goto out;
290 }
291
292 if (!(reg & HERMES_EV_CMD)) {
293 printk(KERN_ERR "hermes @ %p: Timeout waiting for "
294 "command 0x%04x completion.\n", hw->iobase, cmd);
295 err = -ETIMEDOUT;
296 goto out;
297 }
298
299 status = hermes_read_regn(hw, STATUS);
300 if (resp) {
301 resp->status = status;
302 resp->resp0 = hermes_read_regn(hw, RESP0);
303 resp->resp1 = hermes_read_regn(hw, RESP1);
304 resp->resp2 = hermes_read_regn(hw, RESP2);
305 }
306
307 hermes_write_regn(hw, EVACK, HERMES_EV_CMD);
308
309 if (status & HERMES_STATUS_RESULT)
310 err = -EIO;
311
312 out:
313 return err;
314}
315
316static int hermes_allocate(hermes_t *hw, u16 size, u16 *fid)
317{
318 int err = 0;
319 int k;
320 u16 reg;
321
322 if ((size < HERMES_ALLOC_LEN_MIN) || (size > HERMES_ALLOC_LEN_MAX))
323 return -EINVAL;
324
325 err = hermes_docmd_wait(hw, HERMES_CMD_ALLOC, size, NULL);
326 if (err)
327 return err;
328
329 reg = hermes_read_regn(hw, EVSTAT);
330 k = ALLOC_COMPL_TIMEOUT;
331 while ((!(reg & HERMES_EV_ALLOC)) && k) {
332 k--;
333 udelay(10);
334 reg = hermes_read_regn(hw, EVSTAT);
335 }
336
337 if (!hermes_present(hw)) {
338 printk(KERN_WARNING "hermes @ %p: "
339 "Card removed waiting for frame allocation.\n",
340 hw->iobase);
341 return -ENODEV;
342 }
343
344 if (!(reg & HERMES_EV_ALLOC)) {
345 printk(KERN_ERR "hermes @ %p: "
346 "Timeout waiting for frame allocation\n",
347 hw->iobase);
348 return -ETIMEDOUT;
349 }
350
351 *fid = hermes_read_regn(hw, ALLOCFID);
352 hermes_write_regn(hw, EVACK, HERMES_EV_ALLOC);
353
354 return 0;
355}
356
357
358
359
360
361
362
363
364
365
366static int hermes_bap_seek(hermes_t *hw, int bap, u16 id, u16 offset)
367{
368 int sreg = bap ? HERMES_SELECT1 : HERMES_SELECT0;
369 int oreg = bap ? HERMES_OFFSET1 : HERMES_OFFSET0;
370 int k;
371 u16 reg;
372
373
374 if ((offset > HERMES_BAP_OFFSET_MAX) || (offset % 2))
375 return -EINVAL;
376
377 k = HERMES_BAP_BUSY_TIMEOUT;
378 reg = hermes_read_reg(hw, oreg);
379 while ((reg & HERMES_OFFSET_BUSY) && k) {
380 k--;
381 udelay(1);
382 reg = hermes_read_reg(hw, oreg);
383 }
384
385 if (reg & HERMES_OFFSET_BUSY)
386 return -ETIMEDOUT;
387
388
389 hermes_write_reg(hw, sreg, id);
390 hermes_write_reg(hw, oreg, offset);
391
392
393 k = HERMES_BAP_BUSY_TIMEOUT;
394 reg = hermes_read_reg(hw, oreg);
395 while ((reg & (HERMES_OFFSET_BUSY | HERMES_OFFSET_ERR)) && k) {
396 k--;
397 udelay(1);
398 reg = hermes_read_reg(hw, oreg);
399 }
400
401 if (reg != offset) {
402 printk(KERN_ERR "hermes @ %p: BAP%d offset %s: "
403 "reg=0x%x id=0x%x offset=0x%x\n", hw->iobase, bap,
404 (reg & HERMES_OFFSET_BUSY) ? "timeout" : "error",
405 reg, id, offset);
406
407 if (reg & HERMES_OFFSET_BUSY)
408 return -ETIMEDOUT;
409
410 return -EIO;
411 }
412
413 return 0;
414}
415
416
417
418
419
420
421
422
423
424
425static int hermes_bap_pread(hermes_t *hw, int bap, void *buf, int len,
426 u16 id, u16 offset)
427{
428 int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
429 int err = 0;
430
431 if ((len < 0) || (len % 2))
432 return -EINVAL;
433
434 err = hermes_bap_seek(hw, bap, id, offset);
435 if (err)
436 goto out;
437
438
439 hermes_read_words(hw, dreg, buf, len/2);
440
441 out:
442 return err;
443}
444
445
446
447
448
449
450
451
452
453static int hermes_bap_pwrite(hermes_t *hw, int bap, const void *buf, int len,
454 u16 id, u16 offset)
455{
456 int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
457 int err = 0;
458
459 if (len < 0)
460 return -EINVAL;
461
462 err = hermes_bap_seek(hw, bap, id, offset);
463 if (err)
464 goto out;
465
466
467 hermes_write_bytes(hw, dreg, buf, len);
468
469 out:
470 return err;
471}
472
473
474
475
476
477
478
479
480
481static int hermes_read_ltv(hermes_t *hw, int bap, u16 rid, unsigned bufsize,
482 u16 *length, void *buf)
483{
484 int err = 0;
485 int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
486 u16 rlength, rtype;
487 unsigned nwords;
488
489 if (bufsize % 2)
490 return -EINVAL;
491
492 err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS, rid, NULL);
493 if (err)
494 return err;
495
496 err = hermes_bap_seek(hw, bap, rid, 0);
497 if (err)
498 return err;
499
500 rlength = hermes_read_reg(hw, dreg);
501
502 if (!rlength)
503 return -ENODATA;
504
505 rtype = hermes_read_reg(hw, dreg);
506
507 if (length)
508 *length = rlength;
509
510 if (rtype != rid)
511 printk(KERN_WARNING "hermes @ %p: %s(): "
512 "rid (0x%04x) does not match type (0x%04x)\n",
513 hw->iobase, __func__, rid, rtype);
514 if (HERMES_RECLEN_TO_BYTES(rlength) > bufsize)
515 printk(KERN_WARNING "hermes @ %p: "
516 "Truncating LTV record from %d to %d bytes. "
517 "(rid=0x%04x, len=0x%04x)\n", hw->iobase,
518 HERMES_RECLEN_TO_BYTES(rlength), bufsize, rid, rlength);
519
520 nwords = min((unsigned)rlength - 1, bufsize / 2);
521 hermes_read_words(hw, dreg, buf, nwords);
522
523 return 0;
524}
525
526static int hermes_write_ltv(hermes_t *hw, int bap, u16 rid,
527 u16 length, const void *value)
528{
529 int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
530 int err = 0;
531 unsigned count;
532
533 if (length == 0)
534 return -EINVAL;
535
536 err = hermes_bap_seek(hw, bap, rid, 0);
537 if (err)
538 return err;
539
540 hermes_write_reg(hw, dreg, length);
541 hermes_write_reg(hw, dreg, rid);
542
543 count = length - 1;
544
545 hermes_write_bytes(hw, dreg, value, count << 1);
546
547 err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS | HERMES_CMD_WRITE,
548 rid, NULL);
549
550 return err;
551}
552
553
554
555static inline void
556hermes_aux_setaddr(hermes_t *hw, u32 addr)
557{
558 hermes_write_reg(hw, HERMES_AUXPAGE, (u16) (addr >> 7));
559 hermes_write_reg(hw, HERMES_AUXOFFSET, (u16) (addr & 0x7F));
560}
561
562static inline int
563hermes_aux_control(hermes_t *hw, int enabled)
564{
565 int desired_state = enabled ? HERMES_AUX_ENABLED : HERMES_AUX_DISABLED;
566 int action = enabled ? HERMES_AUX_ENABLE : HERMES_AUX_DISABLE;
567 int i;
568
569
570 if (hermes_read_reg(hw, HERMES_CONTROL) == desired_state)
571 return 0;
572
573 hermes_write_reg(hw, HERMES_PARAM0, HERMES_AUX_PW0);
574 hermes_write_reg(hw, HERMES_PARAM1, HERMES_AUX_PW1);
575 hermes_write_reg(hw, HERMES_PARAM2, HERMES_AUX_PW2);
576 hermes_write_reg(hw, HERMES_CONTROL, action);
577
578 for (i = 0; i < 20; i++) {
579 udelay(10);
580 if (hermes_read_reg(hw, HERMES_CONTROL) ==
581 desired_state)
582 return 0;
583 }
584
585 return -EBUSY;
586}
587
588
589
590
591
592
593
594
595
596
597static int hermesi_program_init(hermes_t *hw, u32 offset)
598{
599 int err;
600
601
602
603
604
605
606
607 hermes_write_regn(hw, EVACK, 0xFFFF);
608
609
610 err = hw->ops->init_cmd_wait(hw,
611 0x0100 | HERMES_CMD_INIT,
612 0, 0, 0, NULL);
613 if (err)
614 return err;
615
616 err = hw->ops->init_cmd_wait(hw,
617 0x0000 | HERMES_CMD_INIT,
618 0, 0, 0, NULL);
619 if (err)
620 return err;
621
622 err = hermes_aux_control(hw, 1);
623 pr_debug("AUX enable returned %d\n", err);
624
625 if (err)
626 return err;
627
628 pr_debug("Enabling volatile, EP 0x%08x\n", offset);
629 err = hw->ops->init_cmd_wait(hw,
630 HERMES_PROGRAM_ENABLE_VOLATILE,
631 offset & 0xFFFFu,
632 offset >> 16,
633 0,
634 NULL);
635 pr_debug("PROGRAM_ENABLE returned %d\n", err);
636
637 return err;
638}
639
640
641
642
643
644
645
646static int hermesi_program_end(hermes_t *hw)
647{
648 struct hermes_response resp;
649 int rc = 0;
650 int err;
651
652 rc = hw->ops->cmd_wait(hw, HERMES_PROGRAM_DISABLE, 0, &resp);
653
654 pr_debug("PROGRAM_DISABLE returned %d, "
655 "r0 0x%04x, r1 0x%04x, r2 0x%04x\n",
656 rc, resp.resp0, resp.resp1, resp.resp2);
657
658 if ((rc == 0) &&
659 ((resp.status & HERMES_STATUS_CMDCODE) != HERMES_CMD_DOWNLD))
660 rc = -EIO;
661
662 err = hermes_aux_control(hw, 0);
663 pr_debug("AUX disable returned %d\n", err);
664
665
666 hermes_write_regn(hw, EVACK, 0xFFFF);
667
668
669 (void) hw->ops->init_cmd_wait(hw, 0x0000 | HERMES_CMD_INIT,
670 0, 0, 0, NULL);
671
672 return rc ? rc : err;
673}
674
675static int hermes_program_bytes(struct hermes *hw, const char *data,
676 u32 addr, u32 len)
677{
678
679
680
681 hermes_aux_setaddr(hw, addr);
682 hermes_write_bytes(hw, HERMES_AUXDATA, data, len);
683 return 0;
684}
685
686
687static int hermes_read_pda(hermes_t *hw, __le16 *pda, u32 pda_addr, u16 pda_len)
688{
689 int ret;
690 u16 pda_size;
691 u16 data_len = pda_len;
692 __le16 *data = pda;
693
694 if (hw->eeprom_pda) {
695
696
697
698 ret = hw->ops->cmd_wait(hw, HERMES_CMD_READMIF, 0, NULL);
699 if (ret)
700 return ret;
701 } else {
702
703
704
705 pda[0] = cpu_to_le16(pda_len - 2);
706
707 pda[1] = cpu_to_le16(0x0800);
708 data_len = pda_len - 4;
709 data = pda + 2;
710 }
711
712
713 ret = hermes_aux_control(hw, 1);
714 pr_debug("AUX enable returned %d\n", ret);
715 if (ret)
716 return ret;
717
718
719 hermes_aux_setaddr(hw, pda_addr);
720 hermes_read_words(hw, HERMES_AUXDATA, data, data_len / 2);
721
722
723 ret = hermes_aux_control(hw, 0);
724 pr_debug("AUX disable returned %d\n", ret);
725
726
727 pda_size = le16_to_cpu(pda[0]);
728 pr_debug("Actual PDA length %d, Max allowed %d\n",
729 pda_size, pda_len);
730 if (pda_size > pda_len)
731 return -EINVAL;
732
733 return 0;
734}
735
736static void hermes_lock_irqsave(spinlock_t *lock,
737 unsigned long *flags) __acquires(lock)
738{
739 spin_lock_irqsave(lock, *flags);
740}
741
742static void hermes_unlock_irqrestore(spinlock_t *lock,
743 unsigned long *flags) __releases(lock)
744{
745 spin_unlock_irqrestore(lock, *flags);
746}
747
748static void hermes_lock_irq(spinlock_t *lock) __acquires(lock)
749{
750 spin_lock_irq(lock);
751}
752
753static void hermes_unlock_irq(spinlock_t *lock) __releases(lock)
754{
755 spin_unlock_irq(lock);
756}
757
758
759static const struct hermes_ops hermes_ops_local = {
760 .init = hermes_init,
761 .cmd_wait = hermes_docmd_wait,
762 .init_cmd_wait = hermes_doicmd_wait,
763 .allocate = hermes_allocate,
764 .read_ltv = hermes_read_ltv,
765 .write_ltv = hermes_write_ltv,
766 .bap_pread = hermes_bap_pread,
767 .bap_pwrite = hermes_bap_pwrite,
768 .read_pda = hermes_read_pda,
769 .program_init = hermesi_program_init,
770 .program_end = hermesi_program_end,
771 .program = hermes_program_bytes,
772 .lock_irqsave = hermes_lock_irqsave,
773 .unlock_irqrestore = hermes_unlock_irqrestore,
774 .lock_irq = hermes_lock_irq,
775 .unlock_irq = hermes_unlock_irq,
776};
777