1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright 2023 Ondrej Zary
4 * based on paride.c by Grant R. Guenther <grant@torque.net>
6 #include <linux/kernel.h>
7 #include <linux/module.h>
8 #include <linux/parport.h>
9 #include "pata_parport.h"
11 #define DRV_NAME "pata_parport"
13 static DEFINE_IDR(parport_list);
14 static DEFINE_IDR(protocols);
15 static DEFINE_IDA(pata_parport_bus_dev_ids);
16 static DEFINE_MUTEX(pi_mutex);
18 static bool probe = true;
19 module_param(probe, bool, 0644);
20 MODULE_PARM_DESC(probe, "Enable automatic device probing (0=off, 1=on [default])");
23 * libata drivers cannot sleep so this driver claims parport before activating
24 * the ata host and keeps it claimed (and protocol connected) until the ata
25 * host is removed. Unfortunately, this means that you cannot use any chained
26 * devices (neither other pata_parport devices nor a printer).
28 static void pi_connect(struct pi_adapter *pi)
30 parport_claim_or_block(pi->pardev);
31 pi->proto->connect(pi);
34 static void pi_disconnect(struct pi_adapter *pi)
36 pi->proto->disconnect(pi);
37 parport_release(pi->pardev);
40 static void pata_parport_dev_select(struct ata_port *ap, unsigned int device)
42 struct pi_adapter *pi = ap->host->private_data;
48 tmp = ATA_DEVICE_OBS | ATA_DEV1;
50 pi->proto->write_regr(pi, 0, ATA_REG_DEVICE, tmp);
54 static void pata_parport_set_devctl(struct ata_port *ap, u8 ctl)
56 struct pi_adapter *pi = ap->host->private_data;
58 pi->proto->write_regr(pi, 1, 6, ctl);
61 static bool pata_parport_devchk(struct ata_port *ap, unsigned int device)
63 struct pi_adapter *pi = ap->host->private_data;
66 pata_parport_dev_select(ap, device);
68 pi->proto->write_regr(pi, 0, ATA_REG_NSECT, 0x55);
69 pi->proto->write_regr(pi, 0, ATA_REG_LBAL, 0xaa);
71 pi->proto->write_regr(pi, 0, ATA_REG_NSECT, 0xaa);
72 pi->proto->write_regr(pi, 0, ATA_REG_LBAL, 0x55);
74 pi->proto->write_regr(pi, 0, ATA_REG_NSECT, 0x55);
75 pi->proto->write_regr(pi, 0, ATA_REG_LBAL, 0xaa);
77 nsect = pi->proto->read_regr(pi, 0, ATA_REG_NSECT);
78 lbal = pi->proto->read_regr(pi, 0, ATA_REG_LBAL);
80 return (nsect == 0x55) && (lbal == 0xaa);
83 static int pata_parport_wait_after_reset(struct ata_link *link,
85 unsigned long deadline)
87 struct ata_port *ap = link->ap;
88 struct pi_adapter *pi = ap->host->private_data;
89 unsigned int dev0 = devmask & (1 << 0);
90 unsigned int dev1 = devmask & (1 << 1);
93 ata_msleep(ap, ATA_WAIT_AFTER_RESET);
95 /* always check readiness of the master device */
96 rc = ata_sff_wait_ready(link, deadline);
99 * some adapters return bogus values if master device is not
100 * present, so don't abort now if a slave device is present
108 * if device 1 was found in ata_devchk, wait for register
109 * access briefly, then wait for BSY to clear.
114 pata_parport_dev_select(ap, 1);
117 * Wait for register access. Some ATAPI devices fail
118 * to set nsect/lbal after reset, so don't waste too
119 * much time on it. We're gonna wait for !BSY anyway.
121 for (i = 0; i < 2; i++) {
124 nsect = pi->proto->read_regr(pi, 0, ATA_REG_NSECT);
125 lbal = pi->proto->read_regr(pi, 0, ATA_REG_LBAL);
126 if (nsect == 1 && lbal == 1)
128 /* give drive a breather */
132 rc = ata_sff_wait_ready(link, deadline);
140 pata_parport_dev_select(ap, 0);
142 pata_parport_dev_select(ap, 1);
144 pata_parport_dev_select(ap, 0);
149 static int pata_parport_bus_softreset(struct ata_port *ap, unsigned int devmask,
150 unsigned long deadline)
152 struct pi_adapter *pi = ap->host->private_data;
154 /* software reset. causes dev0 to be selected */
155 pi->proto->write_regr(pi, 1, 6, ap->ctl);
157 pi->proto->write_regr(pi, 1, 6, ap->ctl | ATA_SRST);
159 pi->proto->write_regr(pi, 1, 6, ap->ctl);
160 ap->last_ctl = ap->ctl;
162 /* wait the port to become ready */
163 return pata_parport_wait_after_reset(&ap->link, devmask, deadline);
166 static int pata_parport_softreset(struct ata_link *link, unsigned int *classes,
167 unsigned long deadline)
169 struct ata_port *ap = link->ap;
170 unsigned int devmask = 0;
174 /* determine if device 0/1 are present */
175 if (pata_parport_devchk(ap, 0))
177 if (pata_parport_devchk(ap, 1))
180 /* select device 0 again */
181 pata_parport_dev_select(ap, 0);
183 /* issue bus reset */
184 rc = pata_parport_bus_softreset(ap, devmask, deadline);
185 if (rc && rc != -ENODEV) {
186 ata_link_err(link, "SRST failed (errno=%d)\n", rc);
190 /* determine by signature whether we have ATA or ATAPI devices */
191 classes[0] = ata_sff_dev_classify(&link->device[0],
192 devmask & (1 << 0), &err);
194 classes[1] = ata_sff_dev_classify(&link->device[1],
195 devmask & (1 << 1), &err);
200 static u8 pata_parport_check_status(struct ata_port *ap)
202 struct pi_adapter *pi = ap->host->private_data;
204 return pi->proto->read_regr(pi, 0, ATA_REG_STATUS);
207 static u8 pata_parport_check_altstatus(struct ata_port *ap)
209 struct pi_adapter *pi = ap->host->private_data;
211 return pi->proto->read_regr(pi, 1, 6);
214 static void pata_parport_tf_load(struct ata_port *ap,
215 const struct ata_taskfile *tf)
217 struct pi_adapter *pi = ap->host->private_data;
219 if (tf->ctl != ap->last_ctl) {
220 pi->proto->write_regr(pi, 1, 6, tf->ctl);
221 ap->last_ctl = tf->ctl;
225 if (tf->flags & ATA_TFLAG_ISADDR) {
226 if (tf->flags & ATA_TFLAG_LBA48) {
227 pi->proto->write_regr(pi, 0, ATA_REG_FEATURE,
229 pi->proto->write_regr(pi, 0, ATA_REG_NSECT,
231 pi->proto->write_regr(pi, 0, ATA_REG_LBAL,
233 pi->proto->write_regr(pi, 0, ATA_REG_LBAM,
235 pi->proto->write_regr(pi, 0, ATA_REG_LBAH,
238 pi->proto->write_regr(pi, 0, ATA_REG_FEATURE, tf->feature);
239 pi->proto->write_regr(pi, 0, ATA_REG_NSECT, tf->nsect);
240 pi->proto->write_regr(pi, 0, ATA_REG_LBAL, tf->lbal);
241 pi->proto->write_regr(pi, 0, ATA_REG_LBAM, tf->lbam);
242 pi->proto->write_regr(pi, 0, ATA_REG_LBAH, tf->lbah);
245 if (tf->flags & ATA_TFLAG_DEVICE)
246 pi->proto->write_regr(pi, 0, ATA_REG_DEVICE, tf->device);
251 static void pata_parport_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
253 struct pi_adapter *pi = ap->host->private_data;
255 tf->status = pi->proto->read_regr(pi, 0, ATA_REG_STATUS);
256 tf->error = pi->proto->read_regr(pi, 0, ATA_REG_ERR);
257 tf->nsect = pi->proto->read_regr(pi, 0, ATA_REG_NSECT);
258 tf->lbal = pi->proto->read_regr(pi, 0, ATA_REG_LBAL);
259 tf->lbam = pi->proto->read_regr(pi, 0, ATA_REG_LBAM);
260 tf->lbah = pi->proto->read_regr(pi, 0, ATA_REG_LBAH);
261 tf->device = pi->proto->read_regr(pi, 0, ATA_REG_DEVICE);
263 if (tf->flags & ATA_TFLAG_LBA48) {
264 pi->proto->write_regr(pi, 1, 6, tf->ctl | ATA_HOB);
265 tf->hob_feature = pi->proto->read_regr(pi, 0, ATA_REG_ERR);
266 tf->hob_nsect = pi->proto->read_regr(pi, 0, ATA_REG_NSECT);
267 tf->hob_lbal = pi->proto->read_regr(pi, 0, ATA_REG_LBAL);
268 tf->hob_lbam = pi->proto->read_regr(pi, 0, ATA_REG_LBAM);
269 tf->hob_lbah = pi->proto->read_regr(pi, 0, ATA_REG_LBAH);
270 pi->proto->write_regr(pi, 1, 6, tf->ctl);
271 ap->last_ctl = tf->ctl;
275 static void pata_parport_exec_command(struct ata_port *ap,
276 const struct ata_taskfile *tf)
278 struct pi_adapter *pi = ap->host->private_data;
280 pi->proto->write_regr(pi, 0, ATA_REG_CMD, tf->command);
284 static unsigned int pata_parport_data_xfer(struct ata_queued_cmd *qc,
285 unsigned char *buf, unsigned int buflen, int rw)
287 struct ata_port *ap = qc->dev->link->ap;
288 struct pi_adapter *pi = ap->host->private_data;
291 pi->proto->read_block(pi, buf, buflen);
293 pi->proto->write_block(pi, buf, buflen);
298 static void pata_parport_drain_fifo(struct ata_queued_cmd *qc)
302 struct pi_adapter *pi;
305 /* We only need to flush incoming data when a command was running */
306 if (qc == NULL || qc->dma_dir == DMA_TO_DEVICE)
310 pi = ap->host->private_data;
311 /* Drain up to 64K of data before we give up this recovery method */
312 for (count = 0; (pata_parport_check_status(ap) & ATA_DRQ)
313 && count < 65536; count += 2) {
314 pi->proto->read_block(pi, junk, 2);
318 ata_port_dbg(ap, "drained %d bytes to clear DRQ\n", count);
321 static struct ata_port_operations pata_parport_port_ops = {
322 .inherits = &ata_sff_port_ops,
324 .softreset = pata_parport_softreset,
327 .sff_dev_select = pata_parport_dev_select,
328 .sff_set_devctl = pata_parport_set_devctl,
329 .sff_check_status = pata_parport_check_status,
330 .sff_check_altstatus = pata_parport_check_altstatus,
331 .sff_tf_load = pata_parport_tf_load,
332 .sff_tf_read = pata_parport_tf_read,
333 .sff_exec_command = pata_parport_exec_command,
334 .sff_data_xfer = pata_parport_data_xfer,
335 .sff_drain_fifo = pata_parport_drain_fifo,
338 static const struct ata_port_info pata_parport_port_info = {
339 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_POLLING,
340 .pio_mask = ATA_PIO0,
342 .port_ops = &pata_parport_port_ops,
345 static void pi_release(struct pi_adapter *pi)
347 parport_unregister_device(pi->pardev);
348 if (pi->proto->release_proto)
349 pi->proto->release_proto(pi);
350 module_put(pi->proto->owner);
353 static int default_test_proto(struct pi_adapter *pi)
358 pi->proto->connect(pi);
360 for (j = 0; j < 2; j++) {
361 pi->proto->write_regr(pi, 0, 6, 0xa0 + j * 0x10);
362 for (k = 0; k < 256; k++) {
363 pi->proto->write_regr(pi, 0, 2, k ^ 0xaa);
364 pi->proto->write_regr(pi, 0, 3, k ^ 0x55);
365 if (pi->proto->read_regr(pi, 0, 2) != (k ^ 0xaa))
369 pi->proto->disconnect(pi);
371 dev_dbg(&pi->dev, "%s: port 0x%x, mode %d, test=(%d,%d)\n",
372 pi->proto->name, pi->port, pi->mode, e[0], e[1]);
374 return e[0] && e[1]; /* not here if both > 0 */
377 static int pi_test_proto(struct pi_adapter *pi)
381 parport_claim_or_block(pi->pardev);
382 if (pi->proto->test_proto)
383 res = pi->proto->test_proto(pi);
385 res = default_test_proto(pi);
386 parport_release(pi->pardev);
391 static bool pi_probe_mode(struct pi_adapter *pi, int max)
395 if (pi->mode != -1) {
399 if (pi->mode >= pi->proto->epp_first)
401 if (range == 8 && pi->port % 8)
403 return !pi_test_proto(pi);
406 for (pi->mode = 0; pi->mode < max; pi->mode++) {
408 if (pi->mode >= pi->proto->epp_first)
410 if (range == 8 && pi->port % 8)
412 if (!pi_test_proto(pi))
419 static bool pi_probe_unit(struct pi_adapter *pi, int unit)
428 e = pi->proto->max_units;
431 if (pi->proto->test_port) {
432 parport_claim_or_block(pi->pardev);
433 max = pi->proto->test_port(pi);
434 parport_release(pi->pardev);
436 max = pi->proto->max_mode;
439 if (pi->proto->probe_unit) {
440 parport_claim_or_block(pi->pardev);
441 for (pi->unit = s; pi->unit < e; pi->unit++) {
442 if (pi->proto->probe_unit(pi)) {
443 parport_release(pi->pardev);
444 return pi_probe_mode(pi, max);
447 parport_release(pi->pardev);
451 return pi_probe_mode(pi, max);
454 static void pata_parport_dev_release(struct device *dev)
456 struct pi_adapter *pi = container_of(dev, struct pi_adapter, dev);
458 ida_free(&pata_parport_bus_dev_ids, dev->id);
462 static void pata_parport_bus_release(struct device *dev)
464 /* nothing to do here but required to avoid warning on device removal */
467 static struct bus_type pata_parport_bus_type = {
471 static struct device pata_parport_bus = {
472 .init_name = DRV_NAME,
473 .release = pata_parport_bus_release,
476 static const struct scsi_host_template pata_parport_sht = {
477 PATA_PARPORT_SHT("pata_parport")
480 struct pi_device_match {
481 struct parport *parport;
482 struct pi_protocol *proto;
485 static int pi_find_dev(struct device *dev, void *data)
487 struct pi_adapter *pi = container_of(dev, struct pi_adapter, dev);
488 struct pi_device_match *match = data;
490 return pi->pardev->port == match->parport && pi->proto == match->proto;
493 static struct pi_adapter *pi_init_one(struct parport *parport,
494 struct pi_protocol *pr, int mode, int unit, int delay)
496 struct pardev_cb par_cb = { };
497 const struct ata_port_info *ppi[] = { &pata_parport_port_info };
498 struct ata_host *host;
499 struct pi_adapter *pi;
500 struct pi_device_match match = { .parport = parport, .proto = pr };
504 * Abort if there's a device already registered on the same parport
505 * using the same protocol.
507 if (bus_for_each_dev(&pata_parport_bus_type, NULL, &match, pi_find_dev))
510 id = ida_alloc(&pata_parport_bus_dev_ids, GFP_KERNEL);
514 pi = kzalloc(sizeof(struct pi_adapter), GFP_KERNEL);
516 ida_free(&pata_parport_bus_dev_ids, id);
520 /* set up pi->dev before pi_probe_unit() so it can use dev_printk() */
521 pi->dev.parent = &pata_parport_bus;
522 pi->dev.bus = &pata_parport_bus_type;
523 pi->dev.driver = &pr->driver;
524 pi->dev.release = pata_parport_dev_release;
526 dev_set_name(&pi->dev, "pata_parport.%u", pi->dev.id);
527 if (device_register(&pi->dev)) {
528 put_device(&pi->dev);
529 /* pata_parport_dev_release will do ida_free(dev->id) and kfree(pi) */
535 if (!try_module_get(pi->proto->owner))
537 if (pi->proto->init_proto && pi->proto->init_proto(pi) < 0)
540 pi->delay = (delay == -1) ? pi->proto->default_delay : delay;
542 pi->port = parport->base;
545 pi->pardev = parport_register_dev_model(parport, DRV_NAME, &par_cb, id);
549 if (!pi_probe_unit(pi, unit)) {
550 dev_info(&pi->dev, "Adapter not found\n");
551 goto out_unreg_parport;
554 pi->proto->log_adapter(pi);
556 host = ata_host_alloc_pinfo(&pi->pardev->dev, ppi, 1);
558 goto out_unreg_parport;
559 dev_set_drvdata(&pi->dev, host);
560 host->private_data = pi;
562 ata_port_desc(host->ports[0], "port %s", pi->pardev->port->name);
563 ata_port_desc(host->ports[0], "protocol %s", pi->proto->name);
566 if (ata_host_activate(host, 0, NULL, 0, &pata_parport_sht))
574 parport_unregister_device(pi->pardev);
575 if (pi->proto->release_proto)
576 pi->proto->release_proto(pi);
578 module_put(pi->proto->owner);
580 device_unregister(&pi->dev);
581 /* pata_parport_dev_release will do ida_free(dev->id) and kfree(pi) */
585 int pata_parport_register_driver(struct pi_protocol *pr)
588 struct parport *parport;
591 pr->driver.bus = &pata_parport_bus_type;
592 pr->driver.name = pr->name;
593 error = driver_register(&pr->driver);
597 mutex_lock(&pi_mutex);
598 error = idr_alloc(&protocols, pr, 0, 0, GFP_KERNEL);
600 driver_unregister(&pr->driver);
601 mutex_unlock(&pi_mutex);
605 pr_info("pata_parport: protocol %s registered\n", pr->name);
608 /* probe all parports using this protocol */
609 idr_for_each_entry(&parport_list, parport, port_num)
610 pi_init_one(parport, pr, -1, -1, -1);
612 mutex_unlock(&pi_mutex);
616 EXPORT_SYMBOL_GPL(pata_parport_register_driver);
618 void pata_parport_unregister_driver(struct pi_protocol *pr)
620 struct pi_protocol *pr_iter;
623 mutex_lock(&pi_mutex);
624 idr_for_each_entry(&protocols, pr_iter, id) {
628 idr_remove(&protocols, id);
629 mutex_unlock(&pi_mutex);
630 driver_unregister(&pr->driver);
632 EXPORT_SYMBOL_GPL(pata_parport_unregister_driver);
634 static ssize_t new_device_store(const struct bus_type *bus, const char *buf, size_t count)
636 char port[12] = "auto";
637 char protocol[8] = "auto";
638 int mode = -1, unit = -1, delay = -1;
639 struct pi_protocol *pr, *pr_wanted;
640 struct device_driver *drv;
641 struct parport *parport;
642 int port_num, port_wanted, pr_num;
645 if (sscanf(buf, "%11s %7s %d %d %d",
646 port, protocol, &mode, &unit, &delay) < 1)
649 if (sscanf(port, "parport%u", &port_wanted) < 1) {
650 if (strcmp(port, "auto")) {
651 pr_err("invalid port name %s\n", port);
657 drv = driver_find(protocol, &pata_parport_bus_type);
659 if (strcmp(protocol, "auto")) {
660 pr_err("protocol %s not found\n", protocol);
665 pr_wanted = container_of(drv, struct pi_protocol, driver);
668 mutex_lock(&pi_mutex);
669 /* walk all parports */
670 idr_for_each_entry(&parport_list, parport, port_num) {
671 if (port_num == port_wanted || port_wanted == -1) {
672 parport = parport_find_number(port_num);
674 pr_err("no such port %s\n", port);
675 mutex_unlock(&pi_mutex);
678 /* walk all protocols */
679 idr_for_each_entry(&protocols, pr, pr_num) {
680 if (pr == pr_wanted || !pr_wanted)
681 if (pi_init_one(parport, pr, mode, unit,
685 parport_put_port(parport);
688 mutex_unlock(&pi_mutex);
694 static BUS_ATTR_WO(new_device);
696 static void pi_remove_one(struct device *dev)
698 struct ata_host *host = dev_get_drvdata(dev);
699 struct pi_adapter *pi = host->private_data;
701 ata_host_detach(host);
704 device_unregister(dev);
705 /* pata_parport_dev_release will do ida_free(dev->id) and kfree(pi) */
708 static ssize_t delete_device_store(const struct bus_type *bus, const char *buf, size_t count)
712 mutex_lock(&pi_mutex);
713 dev = bus_find_device_by_name(bus, NULL, buf);
715 mutex_unlock(&pi_mutex);
721 mutex_unlock(&pi_mutex);
725 static BUS_ATTR_WO(delete_device);
727 static void pata_parport_attach(struct parport *port)
729 struct pi_protocol *pr;
732 mutex_lock(&pi_mutex);
733 id = idr_alloc(&parport_list, port, port->number, port->number,
736 mutex_unlock(&pi_mutex);
741 /* probe this port using all protocols */
742 idr_for_each_entry(&protocols, pr, pr_num)
743 pi_init_one(port, pr, -1, -1, -1);
745 mutex_unlock(&pi_mutex);
748 static int pi_remove_port(struct device *dev, void *p)
750 struct ata_host *host = dev_get_drvdata(dev);
751 struct pi_adapter *pi = host->private_data;
753 if (pi->pardev->port == p)
759 static void pata_parport_detach(struct parport *port)
761 mutex_lock(&pi_mutex);
762 bus_for_each_dev(&pata_parport_bus_type, NULL, port, pi_remove_port);
763 idr_remove(&parport_list, port->number);
764 mutex_unlock(&pi_mutex);
767 static struct parport_driver pata_parport_driver = {
769 .match_port = pata_parport_attach,
770 .detach = pata_parport_detach,
774 static __init int pata_parport_init(void)
778 error = bus_register(&pata_parport_bus_type);
780 pr_err("failed to register pata_parport bus, error: %d\n", error);
784 error = device_register(&pata_parport_bus);
786 pr_err("failed to register pata_parport bus, error: %d\n", error);
787 goto out_unregister_bus;
790 error = bus_create_file(&pata_parport_bus_type, &bus_attr_new_device);
792 pr_err("unable to create sysfs file, error: %d\n", error);
793 goto out_unregister_dev;
796 error = bus_create_file(&pata_parport_bus_type, &bus_attr_delete_device);
798 pr_err("unable to create sysfs file, error: %d\n", error);
802 error = parport_register_driver(&pata_parport_driver);
804 pr_err("unable to register parport driver, error: %d\n", error);
811 bus_remove_file(&pata_parport_bus_type, &bus_attr_delete_device);
813 bus_remove_file(&pata_parport_bus_type, &bus_attr_new_device);
815 device_unregister(&pata_parport_bus);
817 bus_unregister(&pata_parport_bus_type);
821 static __exit void pata_parport_exit(void)
823 parport_unregister_driver(&pata_parport_driver);
824 bus_remove_file(&pata_parport_bus_type, &bus_attr_new_device);
825 bus_remove_file(&pata_parport_bus_type, &bus_attr_delete_device);
826 device_unregister(&pata_parport_bus);
827 bus_unregister(&pata_parport_bus_type);
830 MODULE_AUTHOR("Ondrej Zary");
831 MODULE_DESCRIPTION("driver for parallel port ATA adapters");
832 MODULE_LICENSE("GPL");
833 MODULE_ALIAS("paride");
835 module_init(pata_parport_init);
836 module_exit(pata_parport_exit);