Convert trailing spaces and periods in path components
[linux/fpc-iii.git] / drivers / ata / pata_samsung_cf.c
blob3da0e8e302861364b2bbbcab10236cad44974a32
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Copyright (c) 2010 Samsung Electronics Co., Ltd.
4 * http://www.samsung.com
6 * PATA driver for Samsung SoCs.
7 * Supports CF Interface in True IDE mode. Currently only PIO mode has been
8 * implemented; UDMA support has to be added.
10 * Based on:
11 * PATA driver for AT91SAM9260 Static Memory Controller
12 * PATA driver for Toshiba SCC controller
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/mod_devicetable.h>
18 #include <linux/init.h>
19 #include <linux/clk.h>
20 #include <linux/libata.h>
21 #include <linux/platform_device.h>
22 #include <linux/slab.h>
24 #include <linux/platform_data/ata-samsung_cf.h>
26 #define DRV_NAME "pata_samsung_cf"
27 #define DRV_VERSION "0.1"
29 #define S3C_CFATA_REG(x) (x)
30 #define S3C_CFATA_MUX S3C_CFATA_REG(0x0)
31 #define S3C_ATA_CTRL S3C_CFATA_REG(0x0)
32 #define S3C_ATA_CMD S3C_CFATA_REG(0x8)
33 #define S3C_ATA_IRQ S3C_CFATA_REG(0x10)
34 #define S3C_ATA_IRQ_MSK S3C_CFATA_REG(0x14)
35 #define S3C_ATA_CFG S3C_CFATA_REG(0x18)
37 #define S3C_ATA_PIO_TIME S3C_CFATA_REG(0x2c)
38 #define S3C_ATA_PIO_DTR S3C_CFATA_REG(0x54)
39 #define S3C_ATA_PIO_FED S3C_CFATA_REG(0x58)
40 #define S3C_ATA_PIO_SCR S3C_CFATA_REG(0x5c)
41 #define S3C_ATA_PIO_LLR S3C_CFATA_REG(0x60)
42 #define S3C_ATA_PIO_LMR S3C_CFATA_REG(0x64)
43 #define S3C_ATA_PIO_LHR S3C_CFATA_REG(0x68)
44 #define S3C_ATA_PIO_DVR S3C_CFATA_REG(0x6c)
45 #define S3C_ATA_PIO_CSD S3C_CFATA_REG(0x70)
46 #define S3C_ATA_PIO_DAD S3C_CFATA_REG(0x74)
47 #define S3C_ATA_PIO_RDATA S3C_CFATA_REG(0x7c)
49 #define S3C_CFATA_MUX_TRUEIDE 0x01
50 #define S3C_ATA_CFG_SWAP 0x40
51 #define S3C_ATA_CFG_IORDYEN 0x02
53 enum s3c_cpu_type {
54 TYPE_S3C64XX,
55 TYPE_S5PV210,
59 * struct s3c_ide_info - S3C PATA instance.
60 * @clk: The clock resource for this controller.
61 * @ide_addr: The area mapped for the hardware registers.
62 * @sfr_addr: The area mapped for the special function registers.
63 * @irq: The IRQ number we are using.
64 * @cpu_type: The exact type of this controller.
65 * @fifo_status_reg: The ATA_FIFO_STATUS register offset.
67 struct s3c_ide_info {
68 struct clk *clk;
69 void __iomem *ide_addr;
70 void __iomem *sfr_addr;
71 int irq;
72 enum s3c_cpu_type cpu_type;
73 unsigned int fifo_status_reg;
76 static void pata_s3c_set_endian(void __iomem *s3c_ide_regbase, u8 mode)
78 u32 reg = readl(s3c_ide_regbase + S3C_ATA_CFG);
79 reg = mode ? (reg & ~S3C_ATA_CFG_SWAP) : (reg | S3C_ATA_CFG_SWAP);
80 writel(reg, s3c_ide_regbase + S3C_ATA_CFG);
83 static void pata_s3c_cfg_mode(void __iomem *s3c_ide_sfrbase)
85 /* Select true-ide as the internal operating mode */
86 writel(readl(s3c_ide_sfrbase + S3C_CFATA_MUX) | S3C_CFATA_MUX_TRUEIDE,
87 s3c_ide_sfrbase + S3C_CFATA_MUX);
90 static unsigned long
91 pata_s3c_setup_timing(struct s3c_ide_info *info, const struct ata_timing *ata)
93 int t1 = ata->setup;
94 int t2 = ata->act8b;
95 int t2i = ata->rec8b;
96 ulong piotime;
98 piotime = ((t2i & 0xff) << 12) | ((t2 & 0xff) << 4) | (t1 & 0xf);
100 return piotime;
103 static void pata_s3c_set_piomode(struct ata_port *ap, struct ata_device *adev)
105 struct s3c_ide_info *info = ap->host->private_data;
106 struct ata_timing timing;
107 int cycle_time;
108 ulong ata_cfg = readl(info->ide_addr + S3C_ATA_CFG);
109 ulong piotime;
111 /* Enables IORDY if mode requires it */
112 if (ata_pio_need_iordy(adev))
113 ata_cfg |= S3C_ATA_CFG_IORDYEN;
114 else
115 ata_cfg &= ~S3C_ATA_CFG_IORDYEN;
117 cycle_time = (int)(1000000000UL / clk_get_rate(info->clk));
119 ata_timing_compute(adev, adev->pio_mode, &timing,
120 cycle_time * 1000, 0);
122 piotime = pata_s3c_setup_timing(info, &timing);
124 writel(ata_cfg, info->ide_addr + S3C_ATA_CFG);
125 writel(piotime, info->ide_addr + S3C_ATA_PIO_TIME);
129 * Waits until the IDE controller is able to perform next read/write
130 * operation to the disk. Needed for 64XX series boards only.
132 static int wait_for_host_ready(struct s3c_ide_info *info)
134 ulong timeout;
135 void __iomem *fifo_reg = info->ide_addr + info->fifo_status_reg;
137 /* wait for maximum of 20 msec */
138 timeout = jiffies + msecs_to_jiffies(20);
139 while (time_before(jiffies, timeout)) {
140 if ((readl(fifo_reg) >> 28) == 0)
141 return 0;
143 return -EBUSY;
147 * Writes to one of the task file registers.
149 static void ata_outb(struct ata_host *host, u8 addr, void __iomem *reg)
151 struct s3c_ide_info *info = host->private_data;
153 wait_for_host_ready(info);
154 writeb(addr, reg);
158 * Reads from one of the task file registers.
160 static u8 ata_inb(struct ata_host *host, void __iomem *reg)
162 struct s3c_ide_info *info = host->private_data;
163 u8 temp;
165 wait_for_host_ready(info);
166 (void) readb(reg);
167 wait_for_host_ready(info);
168 temp = readb(info->ide_addr + S3C_ATA_PIO_RDATA);
169 return temp;
173 * pata_s3c_tf_load - send taskfile registers to host controller
175 static void pata_s3c_tf_load(struct ata_port *ap,
176 const struct ata_taskfile *tf)
178 struct ata_ioports *ioaddr = &ap->ioaddr;
179 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
181 if (tf->ctl != ap->last_ctl) {
182 ata_outb(ap->host, tf->ctl, ioaddr->ctl_addr);
183 ap->last_ctl = tf->ctl;
184 ata_wait_idle(ap);
187 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
188 ata_outb(ap->host, tf->hob_feature, ioaddr->feature_addr);
189 ata_outb(ap->host, tf->hob_nsect, ioaddr->nsect_addr);
190 ata_outb(ap->host, tf->hob_lbal, ioaddr->lbal_addr);
191 ata_outb(ap->host, tf->hob_lbam, ioaddr->lbam_addr);
192 ata_outb(ap->host, tf->hob_lbah, ioaddr->lbah_addr);
195 if (is_addr) {
196 ata_outb(ap->host, tf->feature, ioaddr->feature_addr);
197 ata_outb(ap->host, tf->nsect, ioaddr->nsect_addr);
198 ata_outb(ap->host, tf->lbal, ioaddr->lbal_addr);
199 ata_outb(ap->host, tf->lbam, ioaddr->lbam_addr);
200 ata_outb(ap->host, tf->lbah, ioaddr->lbah_addr);
203 if (tf->flags & ATA_TFLAG_DEVICE)
204 ata_outb(ap->host, tf->device, ioaddr->device_addr);
206 ata_wait_idle(ap);
210 * pata_s3c_tf_read - input device's ATA taskfile shadow registers
212 static void pata_s3c_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
214 struct ata_ioports *ioaddr = &ap->ioaddr;
216 tf->feature = ata_inb(ap->host, ioaddr->error_addr);
217 tf->nsect = ata_inb(ap->host, ioaddr->nsect_addr);
218 tf->lbal = ata_inb(ap->host, ioaddr->lbal_addr);
219 tf->lbam = ata_inb(ap->host, ioaddr->lbam_addr);
220 tf->lbah = ata_inb(ap->host, ioaddr->lbah_addr);
221 tf->device = ata_inb(ap->host, ioaddr->device_addr);
223 if (tf->flags & ATA_TFLAG_LBA48) {
224 ata_outb(ap->host, tf->ctl | ATA_HOB, ioaddr->ctl_addr);
225 tf->hob_feature = ata_inb(ap->host, ioaddr->error_addr);
226 tf->hob_nsect = ata_inb(ap->host, ioaddr->nsect_addr);
227 tf->hob_lbal = ata_inb(ap->host, ioaddr->lbal_addr);
228 tf->hob_lbam = ata_inb(ap->host, ioaddr->lbam_addr);
229 tf->hob_lbah = ata_inb(ap->host, ioaddr->lbah_addr);
230 ata_outb(ap->host, tf->ctl, ioaddr->ctl_addr);
231 ap->last_ctl = tf->ctl;
236 * pata_s3c_exec_command - issue ATA command to host controller
238 static void pata_s3c_exec_command(struct ata_port *ap,
239 const struct ata_taskfile *tf)
241 ata_outb(ap->host, tf->command, ap->ioaddr.command_addr);
242 ata_sff_pause(ap);
246 * pata_s3c_check_status - Read device status register
248 static u8 pata_s3c_check_status(struct ata_port *ap)
250 return ata_inb(ap->host, ap->ioaddr.status_addr);
254 * pata_s3c_check_altstatus - Read alternate device status register
256 static u8 pata_s3c_check_altstatus(struct ata_port *ap)
258 return ata_inb(ap->host, ap->ioaddr.altstatus_addr);
262 * pata_s3c_data_xfer - Transfer data by PIO
264 static unsigned int pata_s3c_data_xfer(struct ata_queued_cmd *qc,
265 unsigned char *buf, unsigned int buflen, int rw)
267 struct ata_port *ap = qc->dev->link->ap;
268 struct s3c_ide_info *info = ap->host->private_data;
269 void __iomem *data_addr = ap->ioaddr.data_addr;
270 unsigned int words = buflen >> 1, i;
271 u16 *data_ptr = (u16 *)buf;
273 /* Requires wait same as in ata_inb/ata_outb */
274 if (rw == READ)
275 for (i = 0; i < words; i++, data_ptr++) {
276 wait_for_host_ready(info);
277 (void) readw(data_addr);
278 wait_for_host_ready(info);
279 *data_ptr = readw(info->ide_addr
280 + S3C_ATA_PIO_RDATA);
282 else
283 for (i = 0; i < words; i++, data_ptr++) {
284 wait_for_host_ready(info);
285 writew(*data_ptr, data_addr);
288 if (buflen & 0x01)
289 dev_err(ap->dev, "unexpected trailing data\n");
291 return words << 1;
295 * pata_s3c_dev_select - Select device on ATA bus
297 static void pata_s3c_dev_select(struct ata_port *ap, unsigned int device)
299 u8 tmp = ATA_DEVICE_OBS;
301 if (device != 0)
302 tmp |= ATA_DEV1;
304 ata_outb(ap->host, tmp, ap->ioaddr.device_addr);
305 ata_sff_pause(ap);
309 * pata_s3c_devchk - PATA device presence detection
311 static unsigned int pata_s3c_devchk(struct ata_port *ap,
312 unsigned int device)
314 struct ata_ioports *ioaddr = &ap->ioaddr;
315 u8 nsect, lbal;
317 pata_s3c_dev_select(ap, device);
319 ata_outb(ap->host, 0x55, ioaddr->nsect_addr);
320 ata_outb(ap->host, 0xaa, ioaddr->lbal_addr);
322 ata_outb(ap->host, 0xaa, ioaddr->nsect_addr);
323 ata_outb(ap->host, 0x55, ioaddr->lbal_addr);
325 ata_outb(ap->host, 0x55, ioaddr->nsect_addr);
326 ata_outb(ap->host, 0xaa, ioaddr->lbal_addr);
328 nsect = ata_inb(ap->host, ioaddr->nsect_addr);
329 lbal = ata_inb(ap->host, ioaddr->lbal_addr);
331 if ((nsect == 0x55) && (lbal == 0xaa))
332 return 1; /* we found a device */
334 return 0; /* nothing found */
338 * pata_s3c_wait_after_reset - wait for devices to become ready after reset
340 static int pata_s3c_wait_after_reset(struct ata_link *link,
341 unsigned long deadline)
343 int rc;
345 ata_msleep(link->ap, ATA_WAIT_AFTER_RESET);
347 /* always check readiness of the master device */
348 rc = ata_sff_wait_ready(link, deadline);
349 /* -ENODEV means the odd clown forgot the D7 pulldown resistor
350 * and TF status is 0xff, bail out on it too.
352 if (rc)
353 return rc;
355 return 0;
359 * pata_s3c_bus_softreset - PATA device software reset
361 static int pata_s3c_bus_softreset(struct ata_port *ap,
362 unsigned long deadline)
364 struct ata_ioports *ioaddr = &ap->ioaddr;
366 /* software reset. causes dev0 to be selected */
367 ata_outb(ap->host, ap->ctl, ioaddr->ctl_addr);
368 udelay(20);
369 ata_outb(ap->host, ap->ctl | ATA_SRST, ioaddr->ctl_addr);
370 udelay(20);
371 ata_outb(ap->host, ap->ctl, ioaddr->ctl_addr);
372 ap->last_ctl = ap->ctl;
374 return pata_s3c_wait_after_reset(&ap->link, deadline);
378 * pata_s3c_softreset - reset host port via ATA SRST
380 static int pata_s3c_softreset(struct ata_link *link, unsigned int *classes,
381 unsigned long deadline)
383 struct ata_port *ap = link->ap;
384 unsigned int devmask = 0;
385 int rc;
386 u8 err;
388 /* determine if device 0 is present */
389 if (pata_s3c_devchk(ap, 0))
390 devmask |= (1 << 0);
392 /* select device 0 again */
393 pata_s3c_dev_select(ap, 0);
395 /* issue bus reset */
396 rc = pata_s3c_bus_softreset(ap, deadline);
397 /* if link is occupied, -ENODEV too is an error */
398 if (rc && rc != -ENODEV) {
399 ata_link_err(link, "SRST failed (errno=%d)\n", rc);
400 return rc;
403 /* determine by signature whether we have ATA or ATAPI devices */
404 classes[0] = ata_sff_dev_classify(&ap->link.device[0],
405 devmask & (1 << 0), &err);
407 return 0;
411 * pata_s3c_set_devctl - Write device control register
413 static void pata_s3c_set_devctl(struct ata_port *ap, u8 ctl)
415 ata_outb(ap->host, ctl, ap->ioaddr.ctl_addr);
418 static struct scsi_host_template pata_s3c_sht = {
419 ATA_PIO_SHT(DRV_NAME),
422 static struct ata_port_operations pata_s3c_port_ops = {
423 .inherits = &ata_sff_port_ops,
424 .sff_check_status = pata_s3c_check_status,
425 .sff_check_altstatus = pata_s3c_check_altstatus,
426 .sff_tf_load = pata_s3c_tf_load,
427 .sff_tf_read = pata_s3c_tf_read,
428 .sff_data_xfer = pata_s3c_data_xfer,
429 .sff_exec_command = pata_s3c_exec_command,
430 .sff_dev_select = pata_s3c_dev_select,
431 .sff_set_devctl = pata_s3c_set_devctl,
432 .softreset = pata_s3c_softreset,
433 .set_piomode = pata_s3c_set_piomode,
436 static struct ata_port_operations pata_s5p_port_ops = {
437 .inherits = &ata_sff_port_ops,
438 .set_piomode = pata_s3c_set_piomode,
441 static void pata_s3c_enable(void __iomem *s3c_ide_regbase, bool state)
443 u32 temp = readl(s3c_ide_regbase + S3C_ATA_CTRL);
444 temp = state ? (temp | 1) : (temp & ~1);
445 writel(temp, s3c_ide_regbase + S3C_ATA_CTRL);
448 static irqreturn_t pata_s3c_irq(int irq, void *dev_instance)
450 struct ata_host *host = dev_instance;
451 struct s3c_ide_info *info = host->private_data;
452 u32 reg;
454 reg = readl(info->ide_addr + S3C_ATA_IRQ);
455 writel(reg, info->ide_addr + S3C_ATA_IRQ);
457 return ata_sff_interrupt(irq, dev_instance);
460 static void pata_s3c_hwinit(struct s3c_ide_info *info,
461 struct s3c_ide_platdata *pdata)
463 switch (info->cpu_type) {
464 case TYPE_S3C64XX:
465 /* Configure as big endian */
466 pata_s3c_cfg_mode(info->sfr_addr);
467 pata_s3c_set_endian(info->ide_addr, 1);
468 pata_s3c_enable(info->ide_addr, true);
469 msleep(100);
471 /* Remove IRQ Status */
472 writel(0x1f, info->ide_addr + S3C_ATA_IRQ);
473 writel(0x1b, info->ide_addr + S3C_ATA_IRQ_MSK);
474 break;
476 case TYPE_S5PV210:
477 /* Configure as little endian */
478 pata_s3c_set_endian(info->ide_addr, 0);
479 pata_s3c_enable(info->ide_addr, true);
480 msleep(100);
482 /* Remove IRQ Status */
483 writel(0x3f, info->ide_addr + S3C_ATA_IRQ);
484 writel(0x3f, info->ide_addr + S3C_ATA_IRQ_MSK);
485 break;
487 default:
488 BUG();
492 static int __init pata_s3c_probe(struct platform_device *pdev)
494 struct s3c_ide_platdata *pdata = dev_get_platdata(&pdev->dev);
495 struct device *dev = &pdev->dev;
496 struct s3c_ide_info *info;
497 struct resource *res;
498 struct ata_port *ap;
499 struct ata_host *host;
500 enum s3c_cpu_type cpu_type;
501 int ret;
503 cpu_type = platform_get_device_id(pdev)->driver_data;
505 info = devm_kzalloc(dev, sizeof(*info), GFP_KERNEL);
506 if (!info)
507 return -ENOMEM;
509 info->irq = platform_get_irq(pdev, 0);
511 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
513 info->ide_addr = devm_ioremap_resource(dev, res);
514 if (IS_ERR(info->ide_addr))
515 return PTR_ERR(info->ide_addr);
517 info->clk = devm_clk_get(&pdev->dev, "cfcon");
518 if (IS_ERR(info->clk)) {
519 dev_err(dev, "failed to get access to cf controller clock\n");
520 ret = PTR_ERR(info->clk);
521 info->clk = NULL;
522 return ret;
525 clk_enable(info->clk);
527 /* init ata host */
528 host = ata_host_alloc(dev, 1);
529 if (!host) {
530 dev_err(dev, "failed to allocate ide host\n");
531 ret = -ENOMEM;
532 goto stop_clk;
535 ap = host->ports[0];
536 ap->pio_mask = ATA_PIO4;
538 if (cpu_type == TYPE_S3C64XX) {
539 ap->ops = &pata_s3c_port_ops;
540 info->sfr_addr = info->ide_addr + 0x1800;
541 info->ide_addr += 0x1900;
542 info->fifo_status_reg = 0x94;
543 } else {
544 ap->ops = &pata_s5p_port_ops;
545 info->fifo_status_reg = 0x84;
548 info->cpu_type = cpu_type;
550 if (info->irq <= 0) {
551 ap->flags |= ATA_FLAG_PIO_POLLING;
552 info->irq = 0;
553 ata_port_desc(ap, "no IRQ, using PIO polling\n");
556 ap->ioaddr.cmd_addr = info->ide_addr + S3C_ATA_CMD;
557 ap->ioaddr.data_addr = info->ide_addr + S3C_ATA_PIO_DTR;
558 ap->ioaddr.error_addr = info->ide_addr + S3C_ATA_PIO_FED;
559 ap->ioaddr.feature_addr = info->ide_addr + S3C_ATA_PIO_FED;
560 ap->ioaddr.nsect_addr = info->ide_addr + S3C_ATA_PIO_SCR;
561 ap->ioaddr.lbal_addr = info->ide_addr + S3C_ATA_PIO_LLR;
562 ap->ioaddr.lbam_addr = info->ide_addr + S3C_ATA_PIO_LMR;
563 ap->ioaddr.lbah_addr = info->ide_addr + S3C_ATA_PIO_LHR;
564 ap->ioaddr.device_addr = info->ide_addr + S3C_ATA_PIO_DVR;
565 ap->ioaddr.status_addr = info->ide_addr + S3C_ATA_PIO_CSD;
566 ap->ioaddr.command_addr = info->ide_addr + S3C_ATA_PIO_CSD;
567 ap->ioaddr.altstatus_addr = info->ide_addr + S3C_ATA_PIO_DAD;
568 ap->ioaddr.ctl_addr = info->ide_addr + S3C_ATA_PIO_DAD;
570 ata_port_desc(ap, "mmio cmd 0x%llx ",
571 (unsigned long long)res->start);
573 host->private_data = info;
575 if (pdata && pdata->setup_gpio)
576 pdata->setup_gpio();
578 /* Set endianness and enable the interface */
579 pata_s3c_hwinit(info, pdata);
581 ret = ata_host_activate(host, info->irq,
582 info->irq ? pata_s3c_irq : NULL,
583 0, &pata_s3c_sht);
584 if (ret)
585 goto stop_clk;
587 return 0;
589 stop_clk:
590 clk_disable(info->clk);
591 return ret;
594 static int __exit pata_s3c_remove(struct platform_device *pdev)
596 struct ata_host *host = platform_get_drvdata(pdev);
597 struct s3c_ide_info *info = host->private_data;
599 ata_host_detach(host);
601 clk_disable(info->clk);
603 return 0;
606 #ifdef CONFIG_PM_SLEEP
607 static int pata_s3c_suspend(struct device *dev)
609 struct ata_host *host = dev_get_drvdata(dev);
611 return ata_host_suspend(host, PMSG_SUSPEND);
614 static int pata_s3c_resume(struct device *dev)
616 struct ata_host *host = dev_get_drvdata(dev);
617 struct s3c_ide_platdata *pdata = dev_get_platdata(dev);
618 struct s3c_ide_info *info = host->private_data;
620 pata_s3c_hwinit(info, pdata);
621 ata_host_resume(host);
623 return 0;
626 static const struct dev_pm_ops pata_s3c_pm_ops = {
627 .suspend = pata_s3c_suspend,
628 .resume = pata_s3c_resume,
630 #endif
632 /* driver device registration */
633 static const struct platform_device_id pata_s3c_driver_ids[] = {
635 .name = "s3c64xx-pata",
636 .driver_data = TYPE_S3C64XX,
637 }, {
638 .name = "s5pv210-pata",
639 .driver_data = TYPE_S5PV210,
644 MODULE_DEVICE_TABLE(platform, pata_s3c_driver_ids);
646 static struct platform_driver pata_s3c_driver = {
647 .remove = __exit_p(pata_s3c_remove),
648 .id_table = pata_s3c_driver_ids,
649 .driver = {
650 .name = DRV_NAME,
651 #ifdef CONFIG_PM_SLEEP
652 .pm = &pata_s3c_pm_ops,
653 #endif
657 module_platform_driver_probe(pata_s3c_driver, pata_s3c_probe);
659 MODULE_AUTHOR("Abhilash Kesavan, <a.kesavan@samsung.com>");
660 MODULE_DESCRIPTION("low-level driver for Samsung PATA controller");
661 MODULE_LICENSE("GPL");
662 MODULE_VERSION(DRV_VERSION);