2 * TX4939 internal IDE driver
3 * Based on RBTX49xx patch from CELF patch archive.
5 * This file is subject to the terms and conditions of the GNU General Public
6 * License. See the file "COPYING" in the main directory of this archive
9 * (C) Copyright TOSHIBA CORPORATION 2005-2007
12 #include <linux/module.h>
13 #include <linux/types.h>
14 #include <linux/ide.h>
15 #include <linux/init.h>
16 #include <linux/delay.h>
17 #include <linux/platform_device.h>
19 #include <linux/scatterlist.h>
23 #define MODNAME "tx4939ide"
25 /* ATA Shadow Registers (8-bit except for Data which is 16-bit) */
26 #define TX4939IDE_Data 0x000
27 #define TX4939IDE_Error_Feature 0x001
28 #define TX4939IDE_Sec 0x002
29 #define TX4939IDE_LBA0 0x003
30 #define TX4939IDE_LBA1 0x004
31 #define TX4939IDE_LBA2 0x005
32 #define TX4939IDE_DevHead 0x006
33 #define TX4939IDE_Stat_Cmd 0x007
34 #define TX4939IDE_AltStat_DevCtl 0x402
35 /* H/W DMA Registers */
36 #define TX4939IDE_DMA_Cmd 0x800 /* 8-bit */
37 #define TX4939IDE_DMA_Stat 0x802 /* 8-bit */
38 #define TX4939IDE_PRD_Ptr 0x804 /* 32-bit */
39 /* ATA100 CORE Registers (16-bit) */
40 #define TX4939IDE_Sys_Ctl 0xc00
41 #define TX4939IDE_Xfer_Cnt_1 0xc08
42 #define TX4939IDE_Xfer_Cnt_2 0xc0a
43 #define TX4939IDE_Sec_Cnt 0xc10
44 #define TX4939IDE_Start_Lo_Addr 0xc18
45 #define TX4939IDE_Start_Up_Addr 0xc20
46 #define TX4939IDE_Add_Ctl 0xc28
47 #define TX4939IDE_Lo_Burst_Cnt 0xc30
48 #define TX4939IDE_Up_Burst_Cnt 0xc38
49 #define TX4939IDE_PIO_Addr 0xc88
50 #define TX4939IDE_H_Rst_Tim 0xc90
51 #define TX4939IDE_Int_Ctl 0xc98
52 #define TX4939IDE_Pkt_Cmd 0xcb8
53 #define TX4939IDE_Bxfer_Cnt_Hi 0xcc0
54 #define TX4939IDE_Bxfer_Cnt_Lo 0xcc8
55 #define TX4939IDE_Dev_TErr 0xcd0
56 #define TX4939IDE_Pkt_Xfer_Ctl 0xcd8
57 #define TX4939IDE_Start_TAddr 0xce0
59 /* bits for Int_Ctl */
60 #define TX4939IDE_INT_ADDRERR 0x80
61 #define TX4939IDE_INT_REACHMUL 0x40
62 #define TX4939IDE_INT_DEVTIMING 0x20
63 #define TX4939IDE_INT_UDMATERM 0x10
64 #define TX4939IDE_INT_TIMER 0x08
65 #define TX4939IDE_INT_BUSERR 0x04
66 #define TX4939IDE_INT_XFEREND 0x02
67 #define TX4939IDE_INT_HOST 0x01
69 #define TX4939IDE_IGNORE_INTS \
70 (TX4939IDE_INT_ADDRERR | TX4939IDE_INT_REACHMUL | \
71 TX4939IDE_INT_DEVTIMING | TX4939IDE_INT_UDMATERM | \
72 TX4939IDE_INT_TIMER | TX4939IDE_INT_XFEREND)
75 #define tx4939ide_swizzlel(a) ((a) ^ 4)
76 #define tx4939ide_swizzlew(a) ((a) ^ 6)
77 #define tx4939ide_swizzleb(a) ((a) ^ 7)
79 #define tx4939ide_swizzlel(a) (a)
80 #define tx4939ide_swizzlew(a) (a)
81 #define tx4939ide_swizzleb(a) (a)
84 static u16
tx4939ide_readw(void __iomem
*base
, u32 reg
)
86 return __raw_readw(base
+ tx4939ide_swizzlew(reg
));
88 static u8
tx4939ide_readb(void __iomem
*base
, u32 reg
)
90 return __raw_readb(base
+ tx4939ide_swizzleb(reg
));
92 static void tx4939ide_writel(u32 val
, void __iomem
*base
, u32 reg
)
94 __raw_writel(val
, base
+ tx4939ide_swizzlel(reg
));
96 static void tx4939ide_writew(u16 val
, void __iomem
*base
, u32 reg
)
98 __raw_writew(val
, base
+ tx4939ide_swizzlew(reg
));
100 static void tx4939ide_writeb(u8 val
, void __iomem
*base
, u32 reg
)
102 __raw_writeb(val
, base
+ tx4939ide_swizzleb(reg
));
105 #define TX4939IDE_BASE(hwif) ((void __iomem *)(hwif)->extra_base)
107 static void tx4939ide_set_pio_mode(ide_hwif_t
*hwif
, ide_drive_t
*drive
)
109 int is_slave
= drive
->dn
;
111 const u8 pio
= drive
->pio_mode
- XFER_PIO_0
;
115 pair
= ide_get_pair_dev(drive
);
117 safe
= min_t(u8
, safe
, pair
->pio_mode
- XFER_PIO_0
);
119 * Update Command Transfer Mode for master/slave and Data
120 * Transfer Mode for this drive.
122 mask
= is_slave
? 0x07f00000 : 0x000007f0;
123 val
= ((safe
<< 8) | (pio
<< 4)) << (is_slave
? 16 : 0);
124 hwif
->select_data
= (hwif
->select_data
& ~mask
) | val
;
125 /* tx4939ide_tf_load_fixup() will set the Sys_Ctl register */
128 static void tx4939ide_set_dma_mode(ide_hwif_t
*hwif
, ide_drive_t
*drive
)
131 const u8 mode
= drive
->dma_mode
;
133 /* Update Data Transfer Mode for this drive. */
134 if (mode
>= XFER_UDMA_0
)
135 val
= mode
- XFER_UDMA_0
+ 8;
137 val
= mode
- XFER_MW_DMA_0
+ 5;
145 hwif
->select_data
= (hwif
->select_data
& ~mask
) | val
;
146 /* tx4939ide_tf_load_fixup() will set the Sys_Ctl register */
149 static u16
tx4939ide_check_error_ints(ide_hwif_t
*hwif
)
151 void __iomem
*base
= TX4939IDE_BASE(hwif
);
152 u16 ctl
= tx4939ide_readw(base
, TX4939IDE_Int_Ctl
);
154 if (ctl
& TX4939IDE_INT_BUSERR
) {
156 u16 sysctl
= tx4939ide_readw(base
, TX4939IDE_Sys_Ctl
);
158 tx4939ide_writew(sysctl
| 0x4000, base
, TX4939IDE_Sys_Ctl
);
159 /* wait 12GBUSCLK (typ. 60ns @ GBUS200MHz, max 270ns) */
161 tx4939ide_writew(sysctl
, base
, TX4939IDE_Sys_Ctl
);
163 if (ctl
& (TX4939IDE_INT_ADDRERR
|
164 TX4939IDE_INT_DEVTIMING
| TX4939IDE_INT_BUSERR
))
165 pr_err("%s: Error interrupt %#x (%s%s%s )\n",
167 ctl
& TX4939IDE_INT_ADDRERR
? " Address-Error" : "",
168 ctl
& TX4939IDE_INT_DEVTIMING
? " DEV-Timing" : "",
169 ctl
& TX4939IDE_INT_BUSERR
? " Bus-Error" : "");
173 static void tx4939ide_clear_irq(ide_drive_t
*drive
)
180 * tx4939ide_dma_test_irq() and tx4939ide_dma_end() do all job
183 if (drive
->waiting_for_dma
)
186 base
= TX4939IDE_BASE(hwif
);
187 ctl
= tx4939ide_check_error_ints(hwif
);
188 tx4939ide_writew(ctl
, base
, TX4939IDE_Int_Ctl
);
191 static u8
tx4939ide_cable_detect(ide_hwif_t
*hwif
)
193 void __iomem
*base
= TX4939IDE_BASE(hwif
);
195 return tx4939ide_readw(base
, TX4939IDE_Sys_Ctl
) & 0x2000 ?
196 ATA_CBL_PATA40
: ATA_CBL_PATA80
;
200 static void tx4939ide_dma_host_set(ide_drive_t
*drive
, int on
)
202 ide_hwif_t
*hwif
= drive
->hwif
;
204 void __iomem
*base
= TX4939IDE_BASE(hwif
);
205 u8 dma_stat
= tx4939ide_readb(base
, TX4939IDE_DMA_Stat
);
208 dma_stat
|= (1 << (5 + unit
));
210 dma_stat
&= ~(1 << (5 + unit
));
212 tx4939ide_writeb(dma_stat
, base
, TX4939IDE_DMA_Stat
);
215 #define tx4939ide_dma_host_set ide_dma_host_set
218 static u8
tx4939ide_clear_dma_status(void __iomem
*base
)
222 /* read DMA status for INTR & ERROR flags */
223 dma_stat
= tx4939ide_readb(base
, TX4939IDE_DMA_Stat
);
224 /* clear INTR & ERROR flags */
225 tx4939ide_writeb(dma_stat
| ATA_DMA_INTR
| ATA_DMA_ERR
, base
,
227 /* recover intmask cleared by writing to bit2 of DMA_Stat */
228 tx4939ide_writew(TX4939IDE_IGNORE_INTS
<< 8, base
, TX4939IDE_Int_Ctl
);
233 /* custom ide_build_dmatable to handle swapped layout */
234 static int tx4939ide_build_dmatable(ide_drive_t
*drive
, struct ide_cmd
*cmd
)
236 ide_hwif_t
*hwif
= drive
->hwif
;
237 u32
*table
= (u32
*)hwif
->dmatable_cpu
;
238 unsigned int count
= 0;
240 struct scatterlist
*sg
;
242 for_each_sg(hwif
->sg_table
, sg
, cmd
->sg_nents
, i
) {
243 u32 cur_addr
, cur_len
, bcount
;
245 cur_addr
= sg_dma_address(sg
);
246 cur_len
= sg_dma_len(sg
);
249 * Fill in the DMA table, without crossing any 64kB boundaries.
253 if (count
++ >= PRD_ENTRIES
)
254 goto use_pio_instead
;
256 bcount
= 0x10000 - (cur_addr
& 0xffff);
257 if (bcount
> cur_len
)
260 * This workaround for zero count seems required.
261 * (standard ide_build_dmatable does it too)
263 if (bcount
== 0x10000)
265 *table
++ = bcount
& 0xffff;
273 *(table
- 2) |= 0x80000000;
278 printk(KERN_ERR
"%s: %s\n", drive
->name
,
279 count
? "DMA table too small" : "empty DMA table?");
281 return 0; /* revert to PIO for this request */
284 #define tx4939ide_build_dmatable ide_build_dmatable
287 static int tx4939ide_dma_setup(ide_drive_t
*drive
, struct ide_cmd
*cmd
)
289 ide_hwif_t
*hwif
= drive
->hwif
;
290 void __iomem
*base
= TX4939IDE_BASE(hwif
);
291 u8 rw
= (cmd
->tf_flags
& IDE_TFLAG_WRITE
) ? 0 : ATA_DMA_WR
;
293 /* fall back to PIO! */
294 if (tx4939ide_build_dmatable(drive
, cmd
) == 0)
298 tx4939ide_writel(hwif
->dmatable_dma
, base
, TX4939IDE_PRD_Ptr
);
301 tx4939ide_writeb(rw
, base
, TX4939IDE_DMA_Cmd
);
303 /* clear INTR & ERROR flags */
304 tx4939ide_clear_dma_status(base
);
306 tx4939ide_writew(SECTOR_SIZE
/ 2, base
, drive
->dn
?
307 TX4939IDE_Xfer_Cnt_2
: TX4939IDE_Xfer_Cnt_1
);
309 tx4939ide_writew(blk_rq_sectors(cmd
->rq
), base
, TX4939IDE_Sec_Cnt
);
314 static int tx4939ide_dma_end(ide_drive_t
*drive
)
316 ide_hwif_t
*hwif
= drive
->hwif
;
317 u8 dma_stat
, dma_cmd
;
318 void __iomem
*base
= TX4939IDE_BASE(hwif
);
319 u16 ctl
= tx4939ide_readw(base
, TX4939IDE_Int_Ctl
);
321 /* get DMA command mode */
322 dma_cmd
= tx4939ide_readb(base
, TX4939IDE_DMA_Cmd
);
324 tx4939ide_writeb(dma_cmd
& ~ATA_DMA_START
, base
, TX4939IDE_DMA_Cmd
);
326 /* read and clear the INTR & ERROR bits */
327 dma_stat
= tx4939ide_clear_dma_status(base
);
329 #define CHECK_DMA_MASK (ATA_DMA_ACTIVE | ATA_DMA_ERR | ATA_DMA_INTR)
331 /* verify good DMA status */
332 if ((dma_stat
& CHECK_DMA_MASK
) == 0 &&
333 (ctl
& (TX4939IDE_INT_XFEREND
| TX4939IDE_INT_HOST
)) ==
334 (TX4939IDE_INT_XFEREND
| TX4939IDE_INT_HOST
))
335 /* INT_IDE lost... bug? */
337 return ((dma_stat
& CHECK_DMA_MASK
) !=
338 ATA_DMA_INTR
) ? 0x10 | dma_stat
: 0;
341 /* returns 1 if DMA IRQ issued, 0 otherwise */
342 static int tx4939ide_dma_test_irq(ide_drive_t
*drive
)
344 ide_hwif_t
*hwif
= drive
->hwif
;
345 void __iomem
*base
= TX4939IDE_BASE(hwif
);
350 ctl
= tx4939ide_check_error_ints(hwif
);
351 ide_int
= ctl
& (TX4939IDE_INT_XFEREND
| TX4939IDE_INT_HOST
);
353 case TX4939IDE_INT_HOST
:
354 /* On error, XFEREND might not be asserted. */
355 stat
= tx4939ide_readb(base
, TX4939IDE_AltStat_DevCtl
);
356 if ((stat
& (ATA_BUSY
| ATA_DRQ
| ATA_ERR
)) == ATA_ERR
)
359 /* Wait for XFEREND (Mask HOST and unmask XFEREND) */
360 ctl
&= ~TX4939IDE_INT_XFEREND
<< 8;
363 case TX4939IDE_INT_HOST
| TX4939IDE_INT_XFEREND
:
364 dma_stat
= tx4939ide_readb(base
, TX4939IDE_DMA_Stat
);
365 if (!(dma_stat
& ATA_DMA_INTR
))
366 pr_warn("%s: weird interrupt status. "
367 "DMA_Stat %#02x int_ctl %#04x\n",
368 hwif
->name
, dma_stat
, ctl
);
373 * Do not clear XFEREND, HOST now. They will be cleared by
374 * clearing bit2 of DMA_Stat.
377 tx4939ide_writew(ctl
, base
, TX4939IDE_Int_Ctl
);
382 static u8
tx4939ide_dma_sff_read_status(ide_hwif_t
*hwif
)
384 void __iomem
*base
= TX4939IDE_BASE(hwif
);
386 return tx4939ide_readb(base
, TX4939IDE_DMA_Stat
);
389 #define tx4939ide_dma_sff_read_status ide_dma_sff_read_status
392 static void tx4939ide_init_hwif(ide_hwif_t
*hwif
)
394 void __iomem
*base
= TX4939IDE_BASE(hwif
);
397 tx4939ide_writew(0x8000, base
, TX4939IDE_Sys_Ctl
);
398 /* at least 20 GBUSCLK (typ. 100ns @ GBUS200MHz, max 450ns) */
400 tx4939ide_writew(0x0000, base
, TX4939IDE_Sys_Ctl
);
401 /* mask some interrupts and clear all interrupts */
402 tx4939ide_writew((TX4939IDE_IGNORE_INTS
<< 8) | 0xff, base
,
405 tx4939ide_writew(0x0008, base
, TX4939IDE_Lo_Burst_Cnt
);
406 tx4939ide_writew(0, base
, TX4939IDE_Up_Burst_Cnt
);
409 static int tx4939ide_init_dma(ide_hwif_t
*hwif
, const struct ide_port_info
*d
)
412 hwif
->extra_base
+ tx4939ide_swizzleb(TX4939IDE_DMA_Cmd
);
414 * Note that we cannot use ATA_DMA_TABLE_OFS, ATA_DMA_STATUS
417 return ide_allocate_dma_engine(hwif
);
420 static void tx4939ide_tf_load_fixup(ide_drive_t
*drive
)
422 ide_hwif_t
*hwif
= drive
->hwif
;
423 void __iomem
*base
= TX4939IDE_BASE(hwif
);
424 u16 sysctl
= hwif
->select_data
>> (drive
->dn
? 16 : 0);
427 * Fix ATA100 CORE System Control Register. (The write to the
428 * Device/Head register may write wrong data to the System
430 * While Sys_Ctl is written here, dev_select() is not needed.
432 tx4939ide_writew(sysctl
, base
, TX4939IDE_Sys_Ctl
);
435 static void tx4939ide_tf_load(ide_drive_t
*drive
, struct ide_taskfile
*tf
,
438 ide_tf_load(drive
, tf
, valid
);
440 if (valid
& IDE_VALID_DEVICE
)
441 tx4939ide_tf_load_fixup(drive
);
446 /* custom iops (independent from SWAP_IO_SPACE) */
447 static void tx4939ide_input_data_swap(ide_drive_t
*drive
, struct ide_cmd
*cmd
,
448 void *buf
, unsigned int len
)
450 unsigned long port
= drive
->hwif
->io_ports
.data_addr
;
451 unsigned short *ptr
= buf
;
452 unsigned int count
= (len
+ 1) / 2;
455 *ptr
++ = cpu_to_le16(__raw_readw((void __iomem
*)port
));
456 __ide_flush_dcache_range((unsigned long)buf
, roundup(len
, 2));
459 static void tx4939ide_output_data_swap(ide_drive_t
*drive
, struct ide_cmd
*cmd
,
460 void *buf
, unsigned int len
)
462 unsigned long port
= drive
->hwif
->io_ports
.data_addr
;
463 unsigned short *ptr
= buf
;
464 unsigned int count
= (len
+ 1) / 2;
467 __raw_writew(le16_to_cpu(*ptr
), (void __iomem
*)port
);
470 __ide_flush_dcache_range((unsigned long)buf
, roundup(len
, 2));
473 static const struct ide_tp_ops tx4939ide_tp_ops
= {
474 .exec_command
= ide_exec_command
,
475 .read_status
= ide_read_status
,
476 .read_altstatus
= ide_read_altstatus
,
477 .write_devctl
= ide_write_devctl
,
479 .dev_select
= ide_dev_select
,
480 .tf_load
= tx4939ide_tf_load
,
481 .tf_read
= ide_tf_read
,
483 .input_data
= tx4939ide_input_data_swap
,
484 .output_data
= tx4939ide_output_data_swap
,
487 #else /* __LITTLE_ENDIAN */
489 static const struct ide_tp_ops tx4939ide_tp_ops
= {
490 .exec_command
= ide_exec_command
,
491 .read_status
= ide_read_status
,
492 .read_altstatus
= ide_read_altstatus
,
493 .write_devctl
= ide_write_devctl
,
495 .dev_select
= ide_dev_select
,
496 .tf_load
= tx4939ide_tf_load
,
497 .tf_read
= ide_tf_read
,
499 .input_data
= ide_input_data
,
500 .output_data
= ide_output_data
,
503 #endif /* __LITTLE_ENDIAN */
505 static const struct ide_port_ops tx4939ide_port_ops
= {
506 .set_pio_mode
= tx4939ide_set_pio_mode
,
507 .set_dma_mode
= tx4939ide_set_dma_mode
,
508 .clear_irq
= tx4939ide_clear_irq
,
509 .cable_detect
= tx4939ide_cable_detect
,
512 static const struct ide_dma_ops tx4939ide_dma_ops
= {
513 .dma_host_set
= tx4939ide_dma_host_set
,
514 .dma_setup
= tx4939ide_dma_setup
,
515 .dma_start
= ide_dma_start
,
516 .dma_end
= tx4939ide_dma_end
,
517 .dma_test_irq
= tx4939ide_dma_test_irq
,
518 .dma_lost_irq
= ide_dma_lost_irq
,
519 .dma_timer_expiry
= ide_dma_sff_timer_expiry
,
520 .dma_sff_read_status
= tx4939ide_dma_sff_read_status
,
523 static const struct ide_port_info tx4939ide_port_info __initconst
= {
524 .init_hwif
= tx4939ide_init_hwif
,
525 .init_dma
= tx4939ide_init_dma
,
526 .port_ops
= &tx4939ide_port_ops
,
527 .dma_ops
= &tx4939ide_dma_ops
,
528 .tp_ops
= &tx4939ide_tp_ops
,
529 .host_flags
= IDE_HFLAG_MMIO
,
530 .pio_mask
= ATA_PIO4
,
531 .mwdma_mask
= ATA_MWDMA2
,
532 .udma_mask
= ATA_UDMA5
,
533 .chipset
= ide_generic
,
536 static int __init
tx4939ide_probe(struct platform_device
*pdev
)
538 struct ide_hw hw
, *hws
[] = { &hw
};
539 struct ide_host
*host
;
540 struct resource
*res
;
542 unsigned long mapbase
;
544 irq
= platform_get_irq(pdev
, 0);
547 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
551 if (!devm_request_mem_region(&pdev
->dev
, res
->start
,
552 resource_size(res
), MODNAME
))
554 mapbase
= (unsigned long)devm_ioremap(&pdev
->dev
, res
->start
,
558 memset(&hw
, 0, sizeof(hw
));
559 hw
.io_ports
.data_addr
=
560 mapbase
+ tx4939ide_swizzlew(TX4939IDE_Data
);
561 hw
.io_ports
.error_addr
=
562 mapbase
+ tx4939ide_swizzleb(TX4939IDE_Error_Feature
);
563 hw
.io_ports
.nsect_addr
=
564 mapbase
+ tx4939ide_swizzleb(TX4939IDE_Sec
);
565 hw
.io_ports
.lbal_addr
=
566 mapbase
+ tx4939ide_swizzleb(TX4939IDE_LBA0
);
567 hw
.io_ports
.lbam_addr
=
568 mapbase
+ tx4939ide_swizzleb(TX4939IDE_LBA1
);
569 hw
.io_ports
.lbah_addr
=
570 mapbase
+ tx4939ide_swizzleb(TX4939IDE_LBA2
);
571 hw
.io_ports
.device_addr
=
572 mapbase
+ tx4939ide_swizzleb(TX4939IDE_DevHead
);
573 hw
.io_ports
.command_addr
=
574 mapbase
+ tx4939ide_swizzleb(TX4939IDE_Stat_Cmd
);
575 hw
.io_ports
.ctl_addr
=
576 mapbase
+ tx4939ide_swizzleb(TX4939IDE_AltStat_DevCtl
);
580 pr_info("TX4939 IDE interface (base %#lx, irq %d)\n", mapbase
, irq
);
581 host
= ide_host_alloc(&tx4939ide_port_info
, hws
, 1);
584 /* use extra_base for base address of the all registers */
585 host
->ports
[0]->extra_base
= mapbase
;
586 ret
= ide_host_register(host
, &tx4939ide_port_info
, hws
);
591 platform_set_drvdata(pdev
, host
);
595 static int __exit
tx4939ide_remove(struct platform_device
*pdev
)
597 struct ide_host
*host
= platform_get_drvdata(pdev
);
599 ide_host_remove(host
);
604 static int tx4939ide_resume(struct platform_device
*dev
)
606 struct ide_host
*host
= platform_get_drvdata(dev
);
607 ide_hwif_t
*hwif
= host
->ports
[0];
609 tx4939ide_init_hwif(hwif
);
613 #define tx4939ide_resume NULL
616 static struct platform_driver tx4939ide_driver
= {
620 .remove
= __exit_p(tx4939ide_remove
),
621 .resume
= tx4939ide_resume
,
624 module_platform_driver_probe(tx4939ide_driver
, tx4939ide_probe
);
626 MODULE_DESCRIPTION("TX4939 internal IDE driver");
627 MODULE_LICENSE("GPL");
628 MODULE_ALIAS("platform:tx4939ide");