2 * Xilinx SystemACE device driver
4 * Copyright 2007 Secret Lab Technologies Ltd.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published
8 * by the Free Software Foundation.
12 * The SystemACE chip is designed to configure FPGAs by loading an FPGA
13 * bitstream from a file on a CF card and squirting it into FPGAs connected
14 * to the SystemACE JTAG chain. It also has the advantage of providing an
15 * MPU interface which can be used to control the FPGA configuration process
16 * and to use the attached CF card for general purpose storage.
18 * This driver is a block device driver for the SystemACE.
21 * The driver registers itself as a platform_device driver at module
22 * load time. The platform bus will take care of calling the
23 * ace_probe() method for all SystemACE instances in the system. Any
24 * number of SystemACE instances are supported. ace_probe() calls
25 * ace_setup() which initialized all data structures, reads the CF
26 * id structure and registers the device.
29 * Just about all of the heavy lifting in this driver is performed by
30 * a Finite State Machine (FSM). The driver needs to wait on a number
31 * of events; some raised by interrupts, some which need to be polled
32 * for. Describing all of the behaviour in a FSM seems to be the
33 * easiest way to keep the complexity low and make it easy to
34 * understand what the driver is doing. If the block ops or the
35 * request function need to interact with the hardware, then they
36 * simply need to flag the request and kick of FSM processing.
38 * The FSM itself is atomic-safe code which can be run from any
39 * context. The general process flow is:
40 * 1. obtain the ace->lock spinlock.
41 * 2. loop on ace_fsm_dostate() until the ace->fsm_continue flag is
43 * 3. release the lock.
45 * Individual states do not sleep in any way. If a condition needs to
46 * be waited for then the state much clear the fsm_continue flag and
47 * either schedule the FSM to be run again at a later time, or expect
48 * an interrupt to call the FSM when the desired condition is met.
50 * In normal operation, the FSM is processed at interrupt context
51 * either when the driver's tasklet is scheduled, or when an irq is
52 * raised by the hardware. The tasklet can be scheduled at any time.
53 * The request method in particular schedules the tasklet when a new
54 * request has been indicated by the block layer. Once started, the
55 * FSM proceeds as far as it can processing the request until it
56 * needs on a hardware event. At this point, it must yield execution.
58 * A state has two options when yielding execution:
60 * - Call if need to poll for event.
61 * - clears the fsm_continue flag to exit the processing loop
62 * - reschedules the tasklet to run again as soon as possible
63 * 2. ace_fsm_yieldirq()
64 * - Call if an irq is expected from the HW
65 * - clears the fsm_continue flag to exit the processing loop
66 * - does not reschedule the tasklet so the FSM will not be processed
67 * again until an irq is received.
68 * After calling a yield function, the state must return control back
69 * to the FSM main loop.
71 * Additionally, the driver maintains a kernel timer which can process
72 * the FSM. If the FSM gets stalled, typically due to a missed
73 * interrupt, then the kernel timer will expire and the driver can
74 * continue where it left off.
77 * - Add FPGA configuration control interface.
78 * - Request major number from lanana
83 #include <linux/module.h>
84 #include <linux/ctype.h>
85 #include <linux/init.h>
86 #include <linux/interrupt.h>
87 #include <linux/errno.h>
88 #include <linux/kernel.h>
89 #include <linux/delay.h>
90 #include <linux/slab.h>
91 #include <linux/blkdev.h>
92 #include <linux/hdreg.h>
93 #include <linux/platform_device.h>
94 #if defined(CONFIG_OF)
95 #include <linux/of_device.h>
96 #include <linux/of_platform.h>
99 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>");
100 MODULE_DESCRIPTION("Xilinx SystemACE device driver");
101 MODULE_LICENSE("GPL");
103 /* SystemACE register definitions */
104 #define ACE_BUSMODE (0x00)
106 #define ACE_STATUS (0x04)
107 #define ACE_STATUS_CFGLOCK (0x00000001)
108 #define ACE_STATUS_MPULOCK (0x00000002)
109 #define ACE_STATUS_CFGERROR (0x00000004) /* config controller error */
110 #define ACE_STATUS_CFCERROR (0x00000008) /* CF controller error */
111 #define ACE_STATUS_CFDETECT (0x00000010)
112 #define ACE_STATUS_DATABUFRDY (0x00000020)
113 #define ACE_STATUS_DATABUFMODE (0x00000040)
114 #define ACE_STATUS_CFGDONE (0x00000080)
115 #define ACE_STATUS_RDYFORCFCMD (0x00000100)
116 #define ACE_STATUS_CFGMODEPIN (0x00000200)
117 #define ACE_STATUS_CFGADDR_MASK (0x0000e000)
118 #define ACE_STATUS_CFBSY (0x00020000)
119 #define ACE_STATUS_CFRDY (0x00040000)
120 #define ACE_STATUS_CFDWF (0x00080000)
121 #define ACE_STATUS_CFDSC (0x00100000)
122 #define ACE_STATUS_CFDRQ (0x00200000)
123 #define ACE_STATUS_CFCORR (0x00400000)
124 #define ACE_STATUS_CFERR (0x00800000)
126 #define ACE_ERROR (0x08)
127 #define ACE_CFGLBA (0x0c)
128 #define ACE_MPULBA (0x10)
130 #define ACE_SECCNTCMD (0x14)
131 #define ACE_SECCNTCMD_RESET (0x0100)
132 #define ACE_SECCNTCMD_IDENTIFY (0x0200)
133 #define ACE_SECCNTCMD_READ_DATA (0x0300)
134 #define ACE_SECCNTCMD_WRITE_DATA (0x0400)
135 #define ACE_SECCNTCMD_ABORT (0x0600)
137 #define ACE_VERSION (0x16)
138 #define ACE_VERSION_REVISION_MASK (0x00FF)
139 #define ACE_VERSION_MINOR_MASK (0x0F00)
140 #define ACE_VERSION_MAJOR_MASK (0xF000)
142 #define ACE_CTRL (0x18)
143 #define ACE_CTRL_FORCELOCKREQ (0x0001)
144 #define ACE_CTRL_LOCKREQ (0x0002)
145 #define ACE_CTRL_FORCECFGADDR (0x0004)
146 #define ACE_CTRL_FORCECFGMODE (0x0008)
147 #define ACE_CTRL_CFGMODE (0x0010)
148 #define ACE_CTRL_CFGSTART (0x0020)
149 #define ACE_CTRL_CFGSEL (0x0040)
150 #define ACE_CTRL_CFGRESET (0x0080)
151 #define ACE_CTRL_DATABUFRDYIRQ (0x0100)
152 #define ACE_CTRL_ERRORIRQ (0x0200)
153 #define ACE_CTRL_CFGDONEIRQ (0x0400)
154 #define ACE_CTRL_RESETIRQ (0x0800)
155 #define ACE_CTRL_CFGPROG (0x1000)
156 #define ACE_CTRL_CFGADDR_MASK (0xe000)
158 #define ACE_FATSTAT (0x1c)
160 #define ACE_NUM_MINORS 16
161 #define ACE_SECTOR_SIZE (512)
162 #define ACE_FIFO_SIZE (32)
163 #define ACE_BUF_PER_SECTOR (ACE_SECTOR_SIZE / ACE_FIFO_SIZE)
165 #define ACE_BUS_WIDTH_8 0
166 #define ACE_BUS_WIDTH_16 1
171 /* driver state data */
175 struct list_head list
;
177 /* finite state machine data */
178 struct tasklet_struct fsm_tasklet
;
179 uint fsm_task
; /* Current activity (ACE_TASK_*) */
180 uint fsm_state
; /* Current state (ACE_FSM_STATE_*) */
181 uint fsm_continue_flag
; /* cleared to exit FSM mainloop */
183 struct timer_list stall_timer
;
185 /* Transfer state/result, use for both id and block request */
186 struct request
*req
; /* request being processed */
187 void *data_ptr
; /* pointer to I/O buffer */
188 int data_count
; /* number of buffers remaining */
189 int data_result
; /* Result of transfer; 0 := success */
191 int id_req_count
; /* count of id requests */
193 struct completion id_completion
; /* used when id req finishes */
196 /* Details of hardware device */
197 resource_size_t physaddr
;
198 void __iomem
*baseaddr
;
200 int bus_width
; /* 0 := 8 bit; 1 := 16 bit */
201 struct ace_reg_ops
*reg_ops
;
204 /* Block device data structures */
207 struct request_queue
*queue
;
210 /* Inserted CF card parameters */
211 struct hd_driveid cf_id
;
214 static int ace_major
;
216 /* ---------------------------------------------------------------------
217 * Low level register access
221 u16(*in
) (struct ace_device
* ace
, int reg
);
222 void (*out
) (struct ace_device
* ace
, int reg
, u16 val
);
223 void (*datain
) (struct ace_device
* ace
);
224 void (*dataout
) (struct ace_device
* ace
);
227 /* 8 Bit bus width */
228 static u16
ace_in_8(struct ace_device
*ace
, int reg
)
230 void __iomem
*r
= ace
->baseaddr
+ reg
;
231 return in_8(r
) | (in_8(r
+ 1) << 8);
234 static void ace_out_8(struct ace_device
*ace
, int reg
, u16 val
)
236 void __iomem
*r
= ace
->baseaddr
+ reg
;
238 out_8(r
+ 1, val
>> 8);
241 static void ace_datain_8(struct ace_device
*ace
)
243 void __iomem
*r
= ace
->baseaddr
+ 0x40;
244 u8
*dst
= ace
->data_ptr
;
245 int i
= ACE_FIFO_SIZE
;
251 static void ace_dataout_8(struct ace_device
*ace
)
253 void __iomem
*r
= ace
->baseaddr
+ 0x40;
254 u8
*src
= ace
->data_ptr
;
255 int i
= ACE_FIFO_SIZE
;
261 static struct ace_reg_ops ace_reg_8_ops
= {
264 .datain
= ace_datain_8
,
265 .dataout
= ace_dataout_8
,
268 /* 16 bit big endian bus attachment */
269 static u16
ace_in_be16(struct ace_device
*ace
, int reg
)
271 return in_be16(ace
->baseaddr
+ reg
);
274 static void ace_out_be16(struct ace_device
*ace
, int reg
, u16 val
)
276 out_be16(ace
->baseaddr
+ reg
, val
);
279 static void ace_datain_be16(struct ace_device
*ace
)
281 int i
= ACE_FIFO_SIZE
/ 2;
282 u16
*dst
= ace
->data_ptr
;
284 *dst
++ = in_le16(ace
->baseaddr
+ 0x40);
288 static void ace_dataout_be16(struct ace_device
*ace
)
290 int i
= ACE_FIFO_SIZE
/ 2;
291 u16
*src
= ace
->data_ptr
;
293 out_le16(ace
->baseaddr
+ 0x40, *src
++);
297 /* 16 bit little endian bus attachment */
298 static u16
ace_in_le16(struct ace_device
*ace
, int reg
)
300 return in_le16(ace
->baseaddr
+ reg
);
303 static void ace_out_le16(struct ace_device
*ace
, int reg
, u16 val
)
305 out_le16(ace
->baseaddr
+ reg
, val
);
308 static void ace_datain_le16(struct ace_device
*ace
)
310 int i
= ACE_FIFO_SIZE
/ 2;
311 u16
*dst
= ace
->data_ptr
;
313 *dst
++ = in_be16(ace
->baseaddr
+ 0x40);
317 static void ace_dataout_le16(struct ace_device
*ace
)
319 int i
= ACE_FIFO_SIZE
/ 2;
320 u16
*src
= ace
->data_ptr
;
322 out_be16(ace
->baseaddr
+ 0x40, *src
++);
326 static struct ace_reg_ops ace_reg_be16_ops
= {
329 .datain
= ace_datain_be16
,
330 .dataout
= ace_dataout_be16
,
333 static struct ace_reg_ops ace_reg_le16_ops
= {
336 .datain
= ace_datain_le16
,
337 .dataout
= ace_dataout_le16
,
340 static inline u16
ace_in(struct ace_device
*ace
, int reg
)
342 return ace
->reg_ops
->in(ace
, reg
);
345 static inline u32
ace_in32(struct ace_device
*ace
, int reg
)
347 return ace_in(ace
, reg
) | (ace_in(ace
, reg
+ 2) << 16);
350 static inline void ace_out(struct ace_device
*ace
, int reg
, u16 val
)
352 ace
->reg_ops
->out(ace
, reg
, val
);
355 static inline void ace_out32(struct ace_device
*ace
, int reg
, u32 val
)
357 ace_out(ace
, reg
, val
);
358 ace_out(ace
, reg
+ 2, val
>> 16);
361 /* ---------------------------------------------------------------------
362 * Debug support functions
366 static void ace_dump_mem(void *base
, int len
)
368 const char *ptr
= base
;
371 for (i
= 0; i
< len
; i
+= 16) {
372 printk(KERN_INFO
"%.8x:", i
);
373 for (j
= 0; j
< 16; j
++) {
376 printk("%.2x", ptr
[i
+ j
]);
379 for (j
= 0; j
< 16; j
++)
380 printk("%c", isprint(ptr
[i
+ j
]) ? ptr
[i
+ j
] : '.');
385 static inline void ace_dump_mem(void *base
, int len
)
390 static void ace_dump_regs(struct ace_device
*ace
)
392 dev_info(ace
->dev
, " ctrl: %.8x seccnt/cmd: %.4x ver:%.4x\n"
393 KERN_INFO
" status:%.8x mpu_lba:%.8x busmode:%4x\n"
394 KERN_INFO
" error: %.8x cfg_lba:%.8x fatstat:%.4x\n",
395 ace_in32(ace
, ACE_CTRL
),
396 ace_in(ace
, ACE_SECCNTCMD
),
397 ace_in(ace
, ACE_VERSION
),
398 ace_in32(ace
, ACE_STATUS
),
399 ace_in32(ace
, ACE_MPULBA
),
400 ace_in(ace
, ACE_BUSMODE
),
401 ace_in32(ace
, ACE_ERROR
),
402 ace_in32(ace
, ACE_CFGLBA
), ace_in(ace
, ACE_FATSTAT
));
405 void ace_fix_driveid(struct hd_driveid
*id
)
407 #if defined(__BIG_ENDIAN)
408 u16
*buf
= (void *)id
;
411 /* All half words have wrong byte order; swap the bytes */
412 for (i
= 0; i
< sizeof(struct hd_driveid
); i
+= 2, buf
++)
413 *buf
= le16_to_cpu(*buf
);
415 /* Some of the data values are 32bit; swap the half words */
416 id
->lba_capacity
= ((id
->lba_capacity
>> 16) & 0x0000FFFF) |
417 ((id
->lba_capacity
<< 16) & 0xFFFF0000);
418 id
->spg
= ((id
->spg
>> 16) & 0x0000FFFF) |
419 ((id
->spg
<< 16) & 0xFFFF0000);
423 /* ---------------------------------------------------------------------
424 * Finite State Machine (FSM) implementation
427 /* FSM tasks; used to direct state transitions */
428 #define ACE_TASK_IDLE 0
429 #define ACE_TASK_IDENTIFY 1
430 #define ACE_TASK_READ 2
431 #define ACE_TASK_WRITE 3
432 #define ACE_FSM_NUM_TASKS 4
434 /* FSM state definitions */
435 #define ACE_FSM_STATE_IDLE 0
436 #define ACE_FSM_STATE_REQ_LOCK 1
437 #define ACE_FSM_STATE_WAIT_LOCK 2
438 #define ACE_FSM_STATE_WAIT_CFREADY 3
439 #define ACE_FSM_STATE_IDENTIFY_PREPARE 4
440 #define ACE_FSM_STATE_IDENTIFY_TRANSFER 5
441 #define ACE_FSM_STATE_IDENTIFY_COMPLETE 6
442 #define ACE_FSM_STATE_REQ_PREPARE 7
443 #define ACE_FSM_STATE_REQ_TRANSFER 8
444 #define ACE_FSM_STATE_REQ_COMPLETE 9
445 #define ACE_FSM_STATE_ERROR 10
446 #define ACE_FSM_NUM_STATES 11
448 /* Set flag to exit FSM loop and reschedule tasklet */
449 static inline void ace_fsm_yield(struct ace_device
*ace
)
451 dev_dbg(ace
->dev
, "ace_fsm_yield()\n");
452 tasklet_schedule(&ace
->fsm_tasklet
);
453 ace
->fsm_continue_flag
= 0;
456 /* Set flag to exit FSM loop and wait for IRQ to reschedule tasklet */
457 static inline void ace_fsm_yieldirq(struct ace_device
*ace
)
459 dev_dbg(ace
->dev
, "ace_fsm_yieldirq()\n");
461 if (ace
->irq
== NO_IRQ
)
462 /* No IRQ assigned, so need to poll */
463 tasklet_schedule(&ace
->fsm_tasklet
);
464 ace
->fsm_continue_flag
= 0;
467 /* Get the next read/write request; ending requests that we don't handle */
468 struct request
*ace_get_next_request(struct request_queue
* q
)
472 while ((req
= elv_next_request(q
)) != NULL
) {
473 if (blk_fs_request(req
))
480 static void ace_fsm_dostate(struct ace_device
*ace
)
488 dev_dbg(ace
->dev
, "fsm_state=%i, id_req_count=%i\n",
489 ace
->fsm_state
, ace
->id_req_count
);
492 /* Verify that there is actually a CF in the slot. If not, then
493 * bail out back to the idle state and wake up all the waiters */
494 status
= ace_in32(ace
, ACE_STATUS
);
495 if ((status
& ACE_STATUS_CFDETECT
) == 0) {
496 ace
->fsm_state
= ACE_FSM_STATE_IDLE
;
497 ace
->media_change
= 1;
498 set_capacity(ace
->gd
, 0);
499 dev_info(ace
->dev
, "No CF in slot\n");
501 /* Drop all pending requests */
502 while ((req
= elv_next_request(ace
->queue
)) != NULL
)
505 /* Drop back to IDLE state and notify waiters */
506 ace
->fsm_state
= ACE_FSM_STATE_IDLE
;
507 ace
->id_result
= -EIO
;
508 while (ace
->id_req_count
) {
509 complete(&ace
->id_completion
);
514 switch (ace
->fsm_state
) {
515 case ACE_FSM_STATE_IDLE
:
516 /* See if there is anything to do */
517 if (ace
->id_req_count
|| ace_get_next_request(ace
->queue
)) {
519 ace
->fsm_state
= ACE_FSM_STATE_REQ_LOCK
;
520 mod_timer(&ace
->stall_timer
, jiffies
+ HZ
);
521 if (!timer_pending(&ace
->stall_timer
))
522 add_timer(&ace
->stall_timer
);
525 del_timer(&ace
->stall_timer
);
526 ace
->fsm_continue_flag
= 0;
529 case ACE_FSM_STATE_REQ_LOCK
:
530 if (ace_in(ace
, ACE_STATUS
) & ACE_STATUS_MPULOCK
) {
531 /* Already have the lock, jump to next state */
532 ace
->fsm_state
= ACE_FSM_STATE_WAIT_CFREADY
;
536 /* Request the lock */
537 val
= ace_in(ace
, ACE_CTRL
);
538 ace_out(ace
, ACE_CTRL
, val
| ACE_CTRL_LOCKREQ
);
539 ace
->fsm_state
= ACE_FSM_STATE_WAIT_LOCK
;
542 case ACE_FSM_STATE_WAIT_LOCK
:
543 if (ace_in(ace
, ACE_STATUS
) & ACE_STATUS_MPULOCK
) {
544 /* got the lock; move to next state */
545 ace
->fsm_state
= ACE_FSM_STATE_WAIT_CFREADY
;
549 /* wait a bit for the lock */
553 case ACE_FSM_STATE_WAIT_CFREADY
:
554 status
= ace_in32(ace
, ACE_STATUS
);
555 if (!(status
& ACE_STATUS_RDYFORCFCMD
) ||
556 (status
& ACE_STATUS_CFBSY
)) {
557 /* CF card isn't ready; it needs to be polled */
562 /* Device is ready for command; determine what to do next */
563 if (ace
->id_req_count
)
564 ace
->fsm_state
= ACE_FSM_STATE_IDENTIFY_PREPARE
;
566 ace
->fsm_state
= ACE_FSM_STATE_REQ_PREPARE
;
569 case ACE_FSM_STATE_IDENTIFY_PREPARE
:
570 /* Send identify command */
571 ace
->fsm_task
= ACE_TASK_IDENTIFY
;
572 ace
->data_ptr
= &ace
->cf_id
;
573 ace
->data_count
= ACE_BUF_PER_SECTOR
;
574 ace_out(ace
, ACE_SECCNTCMD
, ACE_SECCNTCMD_IDENTIFY
);
576 /* As per datasheet, put config controller in reset */
577 val
= ace_in(ace
, ACE_CTRL
);
578 ace_out(ace
, ACE_CTRL
, val
| ACE_CTRL_CFGRESET
);
580 /* irq handler takes over from this point; wait for the
581 * transfer to complete */
582 ace
->fsm_state
= ACE_FSM_STATE_IDENTIFY_TRANSFER
;
583 ace_fsm_yieldirq(ace
);
586 case ACE_FSM_STATE_IDENTIFY_TRANSFER
:
587 /* Check that the sysace is ready to receive data */
588 status
= ace_in32(ace
, ACE_STATUS
);
589 if (status
& ACE_STATUS_CFBSY
) {
590 dev_dbg(ace
->dev
, "CFBSY set; t=%i iter=%i dc=%i\n",
591 ace
->fsm_task
, ace
->fsm_iter_num
,
596 if (!(status
& ACE_STATUS_DATABUFRDY
)) {
601 /* Transfer the next buffer */
602 ace
->reg_ops
->datain(ace
);
605 /* If there are still buffers to be transfers; jump out here */
606 if (ace
->data_count
!= 0) {
607 ace_fsm_yieldirq(ace
);
611 /* transfer finished; kick state machine */
612 dev_dbg(ace
->dev
, "identify finished\n");
613 ace
->fsm_state
= ACE_FSM_STATE_IDENTIFY_COMPLETE
;
616 case ACE_FSM_STATE_IDENTIFY_COMPLETE
:
617 ace_fix_driveid(&ace
->cf_id
);
618 ace_dump_mem(&ace
->cf_id
, 512); /* Debug: Dump out disk ID */
620 if (ace
->data_result
) {
621 /* Error occured, disable the disk */
622 ace
->media_change
= 1;
623 set_capacity(ace
->gd
, 0);
624 dev_err(ace
->dev
, "error fetching CF id (%i)\n",
627 ace
->media_change
= 0;
629 /* Record disk parameters */
630 set_capacity(ace
->gd
, ace
->cf_id
.lba_capacity
);
631 dev_info(ace
->dev
, "capacity: %i sectors\n",
632 ace
->cf_id
.lba_capacity
);
635 /* We're done, drop to IDLE state and notify waiters */
636 ace
->fsm_state
= ACE_FSM_STATE_IDLE
;
637 ace
->id_result
= ace
->data_result
;
638 while (ace
->id_req_count
) {
639 complete(&ace
->id_completion
);
644 case ACE_FSM_STATE_REQ_PREPARE
:
645 req
= ace_get_next_request(ace
->queue
);
647 ace
->fsm_state
= ACE_FSM_STATE_IDLE
;
651 /* Okay, it's a data request, set it up for transfer */
653 "request: sec=%llx hcnt=%lx, ccnt=%x, dir=%i\n",
654 (unsigned long long) req
->sector
, req
->hard_nr_sectors
,
655 req
->current_nr_sectors
, rq_data_dir(req
));
658 ace
->data_ptr
= req
->buffer
;
659 ace
->data_count
= req
->current_nr_sectors
* ACE_BUF_PER_SECTOR
;
660 ace_out32(ace
, ACE_MPULBA
, req
->sector
& 0x0FFFFFFF);
662 count
= req
->hard_nr_sectors
;
663 if (rq_data_dir(req
)) {
664 /* Kick off write request */
665 dev_dbg(ace
->dev
, "write data\n");
666 ace
->fsm_task
= ACE_TASK_WRITE
;
667 ace_out(ace
, ACE_SECCNTCMD
,
668 count
| ACE_SECCNTCMD_WRITE_DATA
);
670 /* Kick off read request */
671 dev_dbg(ace
->dev
, "read data\n");
672 ace
->fsm_task
= ACE_TASK_READ
;
673 ace_out(ace
, ACE_SECCNTCMD
,
674 count
| ACE_SECCNTCMD_READ_DATA
);
677 /* As per datasheet, put config controller in reset */
678 val
= ace_in(ace
, ACE_CTRL
);
679 ace_out(ace
, ACE_CTRL
, val
| ACE_CTRL_CFGRESET
);
681 /* Move to the transfer state. The systemace will raise
682 * an interrupt once there is something to do
684 ace
->fsm_state
= ACE_FSM_STATE_REQ_TRANSFER
;
685 if (ace
->fsm_task
== ACE_TASK_READ
)
686 ace_fsm_yieldirq(ace
); /* wait for data ready */
689 case ACE_FSM_STATE_REQ_TRANSFER
:
690 /* Check that the sysace is ready to receive data */
691 status
= ace_in32(ace
, ACE_STATUS
);
692 if (status
& ACE_STATUS_CFBSY
) {
694 "CFBSY set; t=%i iter=%i c=%i dc=%i irq=%i\n",
695 ace
->fsm_task
, ace
->fsm_iter_num
,
696 ace
->req
->current_nr_sectors
* 16,
697 ace
->data_count
, ace
->in_irq
);
698 ace_fsm_yield(ace
); /* need to poll CFBSY bit */
701 if (!(status
& ACE_STATUS_DATABUFRDY
)) {
703 "DATABUF not set; t=%i iter=%i c=%i dc=%i irq=%i\n",
704 ace
->fsm_task
, ace
->fsm_iter_num
,
705 ace
->req
->current_nr_sectors
* 16,
706 ace
->data_count
, ace
->in_irq
);
707 ace_fsm_yieldirq(ace
);
711 /* Transfer the next buffer */
712 if (ace
->fsm_task
== ACE_TASK_WRITE
)
713 ace
->reg_ops
->dataout(ace
);
715 ace
->reg_ops
->datain(ace
);
718 /* If there are still buffers to be transfers; jump out here */
719 if (ace
->data_count
!= 0) {
720 ace_fsm_yieldirq(ace
);
724 /* bio finished; is there another one? */
725 if (__blk_end_request(ace
->req
, 0,
726 blk_rq_cur_bytes(ace
->req
))) {
727 /* dev_dbg(ace->dev, "next block; h=%li c=%i\n",
728 * ace->req->hard_nr_sectors,
729 * ace->req->current_nr_sectors);
731 ace
->data_ptr
= ace
->req
->buffer
;
732 ace
->data_count
= ace
->req
->current_nr_sectors
* 16;
733 ace_fsm_yieldirq(ace
);
737 ace
->fsm_state
= ACE_FSM_STATE_REQ_COMPLETE
;
740 case ACE_FSM_STATE_REQ_COMPLETE
:
743 /* Finished request; go to idle state */
744 ace
->fsm_state
= ACE_FSM_STATE_IDLE
;
748 ace
->fsm_state
= ACE_FSM_STATE_IDLE
;
753 static void ace_fsm_tasklet(unsigned long data
)
755 struct ace_device
*ace
= (void *)data
;
758 spin_lock_irqsave(&ace
->lock
, flags
);
760 /* Loop over state machine until told to stop */
761 ace
->fsm_continue_flag
= 1;
762 while (ace
->fsm_continue_flag
)
763 ace_fsm_dostate(ace
);
765 spin_unlock_irqrestore(&ace
->lock
, flags
);
768 static void ace_stall_timer(unsigned long data
)
770 struct ace_device
*ace
= (void *)data
;
774 "kicking stalled fsm; state=%i task=%i iter=%i dc=%i\n",
775 ace
->fsm_state
, ace
->fsm_task
, ace
->fsm_iter_num
,
777 spin_lock_irqsave(&ace
->lock
, flags
);
779 /* Rearm the stall timer *before* entering FSM (which may then
780 * delete the timer) */
781 mod_timer(&ace
->stall_timer
, jiffies
+ HZ
);
783 /* Loop over state machine until told to stop */
784 ace
->fsm_continue_flag
= 1;
785 while (ace
->fsm_continue_flag
)
786 ace_fsm_dostate(ace
);
788 spin_unlock_irqrestore(&ace
->lock
, flags
);
791 /* ---------------------------------------------------------------------
792 * Interrupt handling routines
794 static int ace_interrupt_checkstate(struct ace_device
*ace
)
796 u32 sreg
= ace_in32(ace
, ACE_STATUS
);
797 u16 creg
= ace_in(ace
, ACE_CTRL
);
799 /* Check for error occurance */
800 if ((sreg
& (ACE_STATUS_CFGERROR
| ACE_STATUS_CFCERROR
)) &&
801 (creg
& ACE_CTRL_ERRORIRQ
)) {
802 dev_err(ace
->dev
, "transfer failure\n");
810 static irqreturn_t
ace_interrupt(int irq
, void *dev_id
)
813 struct ace_device
*ace
= dev_id
;
815 /* be safe and get the lock */
816 spin_lock(&ace
->lock
);
819 /* clear the interrupt */
820 creg
= ace_in(ace
, ACE_CTRL
);
821 ace_out(ace
, ACE_CTRL
, creg
| ACE_CTRL_RESETIRQ
);
822 ace_out(ace
, ACE_CTRL
, creg
);
824 /* check for IO failures */
825 if (ace_interrupt_checkstate(ace
))
826 ace
->data_result
= -EIO
;
828 if (ace
->fsm_task
== 0) {
830 "spurious irq; stat=%.8x ctrl=%.8x cmd=%.4x\n",
831 ace_in32(ace
, ACE_STATUS
), ace_in32(ace
, ACE_CTRL
),
832 ace_in(ace
, ACE_SECCNTCMD
));
833 dev_err(ace
->dev
, "fsm_task=%i fsm_state=%i data_count=%i\n",
834 ace
->fsm_task
, ace
->fsm_state
, ace
->data_count
);
837 /* Loop over state machine until told to stop */
838 ace
->fsm_continue_flag
= 1;
839 while (ace
->fsm_continue_flag
)
840 ace_fsm_dostate(ace
);
842 /* done with interrupt; drop the lock */
844 spin_unlock(&ace
->lock
);
849 /* ---------------------------------------------------------------------
852 static void ace_request(struct request_queue
* q
)
855 struct ace_device
*ace
;
857 req
= ace_get_next_request(q
);
860 ace
= req
->rq_disk
->private_data
;
861 tasklet_schedule(&ace
->fsm_tasklet
);
865 static int ace_media_changed(struct gendisk
*gd
)
867 struct ace_device
*ace
= gd
->private_data
;
868 dev_dbg(ace
->dev
, "ace_media_changed(): %i\n", ace
->media_change
);
870 return ace
->media_change
;
873 static int ace_revalidate_disk(struct gendisk
*gd
)
875 struct ace_device
*ace
= gd
->private_data
;
878 dev_dbg(ace
->dev
, "ace_revalidate_disk()\n");
880 if (ace
->media_change
) {
881 dev_dbg(ace
->dev
, "requesting cf id and scheduling tasklet\n");
883 spin_lock_irqsave(&ace
->lock
, flags
);
885 spin_unlock_irqrestore(&ace
->lock
, flags
);
887 tasklet_schedule(&ace
->fsm_tasklet
);
888 wait_for_completion(&ace
->id_completion
);
891 dev_dbg(ace
->dev
, "revalidate complete\n");
892 return ace
->id_result
;
895 static int ace_open(struct block_device
*bdev
, fmode_t mode
)
897 struct ace_device
*ace
= bdev
->bd_disk
->private_data
;
900 dev_dbg(ace
->dev
, "ace_open() users=%i\n", ace
->users
+ 1);
902 spin_lock_irqsave(&ace
->lock
, flags
);
904 spin_unlock_irqrestore(&ace
->lock
, flags
);
906 check_disk_change(bdev
);
910 static int ace_release(struct gendisk
*disk
, fmode_t mode
)
912 struct ace_device
*ace
= disk
->private_data
;
916 dev_dbg(ace
->dev
, "ace_release() users=%i\n", ace
->users
- 1);
918 spin_lock_irqsave(&ace
->lock
, flags
);
920 if (ace
->users
== 0) {
921 val
= ace_in(ace
, ACE_CTRL
);
922 ace_out(ace
, ACE_CTRL
, val
& ~ACE_CTRL_LOCKREQ
);
924 spin_unlock_irqrestore(&ace
->lock
, flags
);
928 static int ace_getgeo(struct block_device
*bdev
, struct hd_geometry
*geo
)
930 struct ace_device
*ace
= bdev
->bd_disk
->private_data
;
932 dev_dbg(ace
->dev
, "ace_getgeo()\n");
934 geo
->heads
= ace
->cf_id
.heads
;
935 geo
->sectors
= ace
->cf_id
.sectors
;
936 geo
->cylinders
= ace
->cf_id
.cyls
;
941 static struct block_device_operations ace_fops
= {
942 .owner
= THIS_MODULE
,
944 .release
= ace_release
,
945 .media_changed
= ace_media_changed
,
946 .revalidate_disk
= ace_revalidate_disk
,
947 .getgeo
= ace_getgeo
,
950 /* --------------------------------------------------------------------
951 * SystemACE device setup/teardown code
953 static int __devinit
ace_setup(struct ace_device
*ace
)
959 dev_dbg(ace
->dev
, "ace_setup(ace=0x%p)\n", ace
);
960 dev_dbg(ace
->dev
, "physaddr=0x%llx irq=%i\n",
961 (unsigned long long)ace
->physaddr
, ace
->irq
);
963 spin_lock_init(&ace
->lock
);
964 init_completion(&ace
->id_completion
);
969 ace
->baseaddr
= ioremap(ace
->physaddr
, 0x80);
974 * Initialize the state machine tasklet and stall timer
976 tasklet_init(&ace
->fsm_tasklet
, ace_fsm_tasklet
, (unsigned long)ace
);
977 setup_timer(&ace
->stall_timer
, ace_stall_timer
, (unsigned long)ace
);
980 * Initialize the request queue
982 ace
->queue
= blk_init_queue(ace_request
, &ace
->lock
);
983 if (ace
->queue
== NULL
)
985 blk_queue_hardsect_size(ace
->queue
, 512);
988 * Allocate and initialize GD structure
990 ace
->gd
= alloc_disk(ACE_NUM_MINORS
);
994 ace
->gd
->major
= ace_major
;
995 ace
->gd
->first_minor
= ace
->id
* ACE_NUM_MINORS
;
996 ace
->gd
->fops
= &ace_fops
;
997 ace
->gd
->queue
= ace
->queue
;
998 ace
->gd
->private_data
= ace
;
999 snprintf(ace
->gd
->disk_name
, 32, "xs%c", ace
->id
+ 'a');
1002 if (ace
->bus_width
== ACE_BUS_WIDTH_16
) {
1003 /* 0x0101 should work regardless of endianess */
1004 ace_out_le16(ace
, ACE_BUSMODE
, 0x0101);
1006 /* read it back to determine endianess */
1007 if (ace_in_le16(ace
, ACE_BUSMODE
) == 0x0001)
1008 ace
->reg_ops
= &ace_reg_le16_ops
;
1010 ace
->reg_ops
= &ace_reg_be16_ops
;
1012 ace_out_8(ace
, ACE_BUSMODE
, 0x00);
1013 ace
->reg_ops
= &ace_reg_8_ops
;
1016 /* Make sure version register is sane */
1017 version
= ace_in(ace
, ACE_VERSION
);
1018 if ((version
== 0) || (version
== 0xFFFF))
1021 /* Put sysace in a sane state by clearing most control reg bits */
1022 ace_out(ace
, ACE_CTRL
, ACE_CTRL_FORCECFGMODE
|
1023 ACE_CTRL_DATABUFRDYIRQ
| ACE_CTRL_ERRORIRQ
);
1025 /* Now we can hook up the irq handler */
1026 if (ace
->irq
!= NO_IRQ
) {
1027 rc
= request_irq(ace
->irq
, ace_interrupt
, 0, "systemace", ace
);
1029 /* Failure - fall back to polled mode */
1030 dev_err(ace
->dev
, "request_irq failed\n");
1035 /* Enable interrupts */
1036 val
= ace_in(ace
, ACE_CTRL
);
1037 val
|= ACE_CTRL_DATABUFRDYIRQ
| ACE_CTRL_ERRORIRQ
;
1038 ace_out(ace
, ACE_CTRL
, val
);
1040 /* Print the identification */
1041 dev_info(ace
->dev
, "Xilinx SystemACE revision %i.%i.%i\n",
1042 (version
>> 12) & 0xf, (version
>> 8) & 0x0f, version
& 0xff);
1043 dev_dbg(ace
->dev
, "physaddr 0x%llx, mapped to 0x%p, irq=%i\n",
1044 (unsigned long long) ace
->physaddr
, ace
->baseaddr
, ace
->irq
);
1046 ace
->media_change
= 1;
1047 ace_revalidate_disk(ace
->gd
);
1049 /* Make the sysace device 'live' */
1057 blk_cleanup_queue(ace
->queue
);
1059 iounmap(ace
->baseaddr
);
1061 dev_info(ace
->dev
, "xsysace: error initializing device at 0x%llx\n",
1062 (unsigned long long) ace
->physaddr
);
1066 static void __devexit
ace_teardown(struct ace_device
*ace
)
1069 del_gendisk(ace
->gd
);
1074 blk_cleanup_queue(ace
->queue
);
1076 tasklet_kill(&ace
->fsm_tasklet
);
1078 if (ace
->irq
!= NO_IRQ
)
1079 free_irq(ace
->irq
, ace
);
1081 iounmap(ace
->baseaddr
);
1084 static int __devinit
1085 ace_alloc(struct device
*dev
, int id
, resource_size_t physaddr
,
1086 int irq
, int bus_width
)
1088 struct ace_device
*ace
;
1090 dev_dbg(dev
, "ace_alloc(%p)\n", dev
);
1097 /* Allocate and initialize the ace device structure */
1098 ace
= kzalloc(sizeof(struct ace_device
), GFP_KERNEL
);
1106 ace
->physaddr
= physaddr
;
1108 ace
->bus_width
= bus_width
;
1110 /* Call the setup code */
1111 rc
= ace_setup(ace
);
1115 dev_set_drvdata(dev
, ace
);
1119 dev_set_drvdata(dev
, NULL
);
1123 dev_err(dev
, "could not initialize device, err=%i\n", rc
);
1127 static void __devexit
ace_free(struct device
*dev
)
1129 struct ace_device
*ace
= dev_get_drvdata(dev
);
1130 dev_dbg(dev
, "ace_free(%p)\n", dev
);
1134 dev_set_drvdata(dev
, NULL
);
1139 /* ---------------------------------------------------------------------
1140 * Platform Bus Support
1143 static int __devinit
ace_probe(struct platform_device
*dev
)
1145 resource_size_t physaddr
= 0;
1146 int bus_width
= ACE_BUS_WIDTH_16
; /* FIXME: should not be hard coded */
1151 dev_dbg(&dev
->dev
, "ace_probe(%p)\n", dev
);
1153 for (i
= 0; i
< dev
->num_resources
; i
++) {
1154 if (dev
->resource
[i
].flags
& IORESOURCE_MEM
)
1155 physaddr
= dev
->resource
[i
].start
;
1156 if (dev
->resource
[i
].flags
& IORESOURCE_IRQ
)
1157 irq
= dev
->resource
[i
].start
;
1160 /* Call the bus-independant setup code */
1161 return ace_alloc(&dev
->dev
, id
, physaddr
, irq
, bus_width
);
1165 * Platform bus remove() method
1167 static int __devexit
ace_remove(struct platform_device
*dev
)
1169 ace_free(&dev
->dev
);
1173 static struct platform_driver ace_platform_driver
= {
1175 .remove
= __devexit_p(ace_remove
),
1177 .owner
= THIS_MODULE
,
1182 /* ---------------------------------------------------------------------
1183 * OF_Platform Bus Support
1186 #if defined(CONFIG_OF)
1187 static int __devinit
1188 ace_of_probe(struct of_device
*op
, const struct of_device_id
*match
)
1190 struct resource res
;
1191 resource_size_t physaddr
;
1193 int irq
, bus_width
, rc
;
1195 dev_dbg(&op
->dev
, "ace_of_probe(%p, %p)\n", op
, match
);
1198 id
= of_get_property(op
->node
, "port-number", NULL
);
1201 rc
= of_address_to_resource(op
->node
, 0, &res
);
1203 dev_err(&op
->dev
, "invalid address\n");
1206 physaddr
= res
.start
;
1209 irq
= irq_of_parse_and_map(op
->node
, 0);
1212 bus_width
= ACE_BUS_WIDTH_16
;
1213 if (of_find_property(op
->node
, "8-bit", NULL
))
1214 bus_width
= ACE_BUS_WIDTH_8
;
1216 /* Call the bus-independant setup code */
1217 return ace_alloc(&op
->dev
, id
? *id
: 0, physaddr
, irq
, bus_width
);
1220 static int __devexit
ace_of_remove(struct of_device
*op
)
1226 /* Match table for of_platform binding */
1227 static struct of_device_id ace_of_match
[] __devinitdata
= {
1228 { .compatible
= "xlnx,opb-sysace-1.00.b", },
1229 { .compatible
= "xlnx,opb-sysace-1.00.c", },
1230 { .compatible
= "xlnx,xps-sysace-1.00.a", },
1231 { .compatible
= "xlnx,sysace", },
1234 MODULE_DEVICE_TABLE(of
, ace_of_match
);
1236 static struct of_platform_driver ace_of_driver
= {
1237 .owner
= THIS_MODULE
,
1239 .match_table
= ace_of_match
,
1240 .probe
= ace_of_probe
,
1241 .remove
= __devexit_p(ace_of_remove
),
1247 /* Registration helpers to keep the number of #ifdefs to a minimum */
1248 static inline int __init
ace_of_register(void)
1250 pr_debug("xsysace: registering OF binding\n");
1251 return of_register_platform_driver(&ace_of_driver
);
1254 static inline void __exit
ace_of_unregister(void)
1256 of_unregister_platform_driver(&ace_of_driver
);
1258 #else /* CONFIG_OF */
1259 /* CONFIG_OF not enabled; do nothing helpers */
1260 static inline int __init
ace_of_register(void) { return 0; }
1261 static inline void __exit
ace_of_unregister(void) { }
1262 #endif /* CONFIG_OF */
1264 /* ---------------------------------------------------------------------
1265 * Module init/exit routines
1267 static int __init
ace_init(void)
1271 ace_major
= register_blkdev(ace_major
, "xsysace");
1272 if (ace_major
<= 0) {
1277 rc
= ace_of_register();
1281 pr_debug("xsysace: registering platform binding\n");
1282 rc
= platform_driver_register(&ace_platform_driver
);
1286 pr_info("Xilinx SystemACE device driver, major=%i\n", ace_major
);
1290 ace_of_unregister();
1292 unregister_blkdev(ace_major
, "xsysace");
1294 printk(KERN_ERR
"xsysace: registration failed; err=%i\n", rc
);
1298 static void __exit
ace_exit(void)
1300 pr_debug("Unregistering Xilinx SystemACE driver\n");
1301 platform_driver_unregister(&ace_platform_driver
);
1302 ace_of_unregister();
1303 unregister_blkdev(ace_major
, "xsysace");
1306 module_init(ace_init
);
1307 module_exit(ace_exit
);