1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright 2008 ioogle, Inc. All rights reserved.
5 * Libata transport class.
7 * The ATA transport class contains common code to deal with ATA HBAs,
8 * an approximated representation of ATA topologies in the driver model,
9 * and various sysfs attributes to expose these topologies and management
10 * interfaces to user-space.
12 * There are 3 objects defined in in this class:
16 * Each port has a link object. Each link can have up to two devices for PATA
17 * and generally one for SATA.
18 * If there is SATA port multiplier [PMP], 15 additional ata_link object are
21 * These objects are created when the ata host is initialized and when a PMP is
22 * found. They are removed only when the HBA is removed, cleaned before the
27 #include <linux/kernel.h>
28 #include <linux/blkdev.h>
29 #include <linux/spinlock.h>
30 #include <linux/slab.h>
31 #include <scsi/scsi_transport.h>
32 #include <linux/libata.h>
33 #include <linux/hdreg.h>
34 #include <linux/uaccess.h>
35 #include <linux/pm_runtime.h>
38 #include "libata-transport.h"
40 #define ATA_PORT_ATTRS 3
41 #define ATA_LINK_ATTRS 3
42 #define ATA_DEV_ATTRS 9
44 struct scsi_transport_template;
45 struct scsi_transport_template *ata_scsi_transport_template;
48 struct scsi_transport_template t;
50 struct device_attribute private_port_attrs[ATA_PORT_ATTRS];
51 struct device_attribute private_link_attrs[ATA_LINK_ATTRS];
52 struct device_attribute private_dev_attrs[ATA_DEV_ATTRS];
54 struct transport_container link_attr_cont;
55 struct transport_container dev_attr_cont;
58 * The array of null terminated pointers to attributes
59 * needed by scsi_sysfs.c
61 struct device_attribute *link_attrs[ATA_LINK_ATTRS + 1];
62 struct device_attribute *port_attrs[ATA_PORT_ATTRS + 1];
63 struct device_attribute *dev_attrs[ATA_DEV_ATTRS + 1];
65 #define to_ata_internal(tmpl) container_of(tmpl, struct ata_internal, t)
68 #define tdev_to_device(d) \
69 container_of((d), struct ata_device, tdev)
70 #define transport_class_to_dev(dev) \
71 tdev_to_device((dev)->parent)
73 #define tdev_to_link(d) \
74 container_of((d), struct ata_link, tdev)
75 #define transport_class_to_link(dev) \
76 tdev_to_link((dev)->parent)
78 #define tdev_to_port(d) \
79 container_of((d), struct ata_port, tdev)
80 #define transport_class_to_port(dev) \
81 tdev_to_port((dev)->parent)
84 /* Device objects are always created whit link objects */
85 static int ata_tdev_add(struct ata_device *dev);
86 static void ata_tdev_delete(struct ata_device *dev);
90 * Hack to allow attributes of the same name in different objects.
92 #define ATA_DEVICE_ATTR(_prefix,_name,_mode,_show,_store) \
93 struct device_attribute device_attr_##_prefix##_##_name = \
94 __ATTR(_name,_mode,_show,_store)
96 #define ata_bitfield_name_match(title, table) \
98 get_ata_##title##_names(u32 table_key, char *buf) \
104 for (i = 0; i < ARRAY_SIZE(table); i++) { \
105 if (table[i].value & table_key) { \
106 len += sprintf(buf + len, "%s%s", \
107 prefix, table[i].name); \
111 len += sprintf(buf + len, "\n"); \
115 #define ata_bitfield_name_search(title, table) \
117 get_ata_##title##_names(u32 table_key, char *buf) \
122 for (i = 0; i < ARRAY_SIZE(table); i++) { \
123 if (table[i].value == table_key) { \
124 len += sprintf(buf + len, "%s", \
129 len += sprintf(buf + len, "\n"); \
136 } ata_class_names[] = {
137 { ATA_DEV_UNKNOWN, "unknown" },
138 { ATA_DEV_ATA, "ata" },
139 { ATA_DEV_ATA_UNSUP, "ata" },
140 { ATA_DEV_ATAPI, "atapi" },
141 { ATA_DEV_ATAPI_UNSUP, "atapi" },
142 { ATA_DEV_PMP, "pmp" },
143 { ATA_DEV_PMP_UNSUP, "pmp" },
144 { ATA_DEV_SEMB, "semb" },
145 { ATA_DEV_SEMB_UNSUP, "semb" },
146 { ATA_DEV_ZAC, "zac" },
147 { ATA_DEV_NONE, "none" }
149 ata_bitfield_name_search(class, ata_class_names)
155 } ata_err_names[] = {
156 { AC_ERR_DEV, "DeviceError" },
157 { AC_ERR_HSM, "HostStateMachineError" },
158 { AC_ERR_TIMEOUT, "Timeout" },
159 { AC_ERR_MEDIA, "MediaError" },
160 { AC_ERR_ATA_BUS, "BusError" },
161 { AC_ERR_HOST_BUS, "HostBusError" },
162 { AC_ERR_SYSTEM, "SystemError" },
163 { AC_ERR_INVALID, "InvalidArg" },
164 { AC_ERR_OTHER, "Unknown" },
165 { AC_ERR_NODEV_HINT, "NoDeviceHint" },
166 { AC_ERR_NCQ, "NCQError" }
168 ata_bitfield_name_match(err, ata_err_names)
173 } ata_xfer_names[] = {
174 { XFER_UDMA_7, "XFER_UDMA_7" },
175 { XFER_UDMA_6, "XFER_UDMA_6" },
176 { XFER_UDMA_5, "XFER_UDMA_5" },
177 { XFER_UDMA_4, "XFER_UDMA_4" },
178 { XFER_UDMA_3, "XFER_UDMA_3" },
179 { XFER_UDMA_2, "XFER_UDMA_2" },
180 { XFER_UDMA_1, "XFER_UDMA_1" },
181 { XFER_UDMA_0, "XFER_UDMA_0" },
182 { XFER_MW_DMA_4, "XFER_MW_DMA_4" },
183 { XFER_MW_DMA_3, "XFER_MW_DMA_3" },
184 { XFER_MW_DMA_2, "XFER_MW_DMA_2" },
185 { XFER_MW_DMA_1, "XFER_MW_DMA_1" },
186 { XFER_MW_DMA_0, "XFER_MW_DMA_0" },
187 { XFER_SW_DMA_2, "XFER_SW_DMA_2" },
188 { XFER_SW_DMA_1, "XFER_SW_DMA_1" },
189 { XFER_SW_DMA_0, "XFER_SW_DMA_0" },
190 { XFER_PIO_6, "XFER_PIO_6" },
191 { XFER_PIO_5, "XFER_PIO_5" },
192 { XFER_PIO_4, "XFER_PIO_4" },
193 { XFER_PIO_3, "XFER_PIO_3" },
194 { XFER_PIO_2, "XFER_PIO_2" },
195 { XFER_PIO_1, "XFER_PIO_1" },
196 { XFER_PIO_0, "XFER_PIO_0" },
197 { XFER_PIO_SLOW, "XFER_PIO_SLOW" }
199 ata_bitfield_name_search(xfer, ata_xfer_names)
202 * ATA Port attributes
204 #define ata_port_show_simple(field, name, format_string, cast) \
206 show_ata_port_##name(struct device *dev, \
207 struct device_attribute *attr, char *buf) \
209 struct ata_port *ap = transport_class_to_port(dev); \
211 return scnprintf(buf, 20, format_string, cast ap->field); \
214 #define ata_port_simple_attr(field, name, format_string, type) \
215 ata_port_show_simple(field, name, format_string, (type)) \
216 static DEVICE_ATTR(name, S_IRUGO, show_ata_port_##name, NULL)
218 ata_port_simple_attr(nr_pmp_links, nr_pmp_links, "%d\n", int);
219 ata_port_simple_attr(stats.idle_irq, idle_irq, "%ld\n", unsigned long);
220 ata_port_simple_attr(local_port_no, port_no, "%u\n", unsigned int);
222 static DECLARE_TRANSPORT_CLASS(ata_port_class,
223 "ata_port", NULL, NULL, NULL);
225 static void ata_tport_release(struct device *dev)
227 struct ata_port *ap = tdev_to_port(dev);
228 ata_host_put(ap->host);
232 * ata_is_port -- check if a struct device represents a ATA port
233 * @dev: device to check
236 * %1 if the device represents a ATA Port, %0 else
238 static int ata_is_port(const struct device *dev)
240 return dev->release == ata_tport_release;
243 static int ata_tport_match(struct attribute_container *cont,
246 if (!ata_is_port(dev))
248 return &ata_scsi_transport_template->host_attrs.ac == cont;
252 * ata_tport_delete -- remove ATA PORT
253 * @port: ATA PORT to remove
255 * Removes the specified ATA PORT. Remove the associated link as well.
257 void ata_tport_delete(struct ata_port *ap)
259 struct device *dev = &ap->tdev;
261 ata_tlink_delete(&ap->link);
263 transport_remove_device(dev);
265 transport_destroy_device(dev);
269 static const struct device_type ata_port_sas_type = {
270 .name = ATA_PORT_TYPE_NAME,
273 /** ata_tport_add - initialize a transport ATA port structure
275 * @parent: parent device
276 * @ap: existing ata_port structure
278 * Initialize a ATA port structure for sysfs. It will be added to the device
279 * tree below the device specified by @parent which could be a PCI device.
281 * Returns %0 on success
283 int ata_tport_add(struct device *parent,
287 struct device *dev = &ap->tdev;
289 device_initialize(dev);
290 if (ap->flags & ATA_FLAG_SAS_HOST)
291 dev->type = &ata_port_sas_type;
293 dev->type = &ata_port_type;
295 dev->parent = parent;
296 ata_host_get(ap->host);
297 dev->release = ata_tport_release;
298 dev_set_name(dev, "ata%d", ap->print_id);
299 transport_setup_device(dev);
300 ata_acpi_bind_port(ap);
301 error = device_add(dev);
306 device_enable_async_suspend(dev);
307 pm_runtime_set_active(dev);
308 pm_runtime_enable(dev);
309 pm_runtime_forbid(dev);
311 error = transport_add_device(dev);
313 goto tport_transport_add_err;
314 transport_configure_device(dev);
316 error = ata_tlink_add(&ap->link);
323 transport_remove_device(dev);
324 tport_transport_add_err:
328 transport_destroy_device(dev);
335 * ATA link attributes
337 static int noop(int x) { return x; }
339 #define ata_link_show_linkspeed(field, format) \
341 show_ata_link_##field(struct device *dev, \
342 struct device_attribute *attr, char *buf) \
344 struct ata_link *link = transport_class_to_link(dev); \
346 return sprintf(buf, "%s\n", sata_spd_string(format(link->field))); \
349 #define ata_link_linkspeed_attr(field, format) \
350 ata_link_show_linkspeed(field, format) \
351 static DEVICE_ATTR(field, S_IRUGO, show_ata_link_##field, NULL)
353 ata_link_linkspeed_attr(hw_sata_spd_limit, fls);
354 ata_link_linkspeed_attr(sata_spd_limit, fls);
355 ata_link_linkspeed_attr(sata_spd, noop);
358 static DECLARE_TRANSPORT_CLASS(ata_link_class,
359 "ata_link", NULL, NULL, NULL);
361 static void ata_tlink_release(struct device *dev)
366 * ata_is_link -- check if a struct device represents a ATA link
367 * @dev: device to check
370 * %1 if the device represents a ATA link, %0 else
372 static int ata_is_link(const struct device *dev)
374 return dev->release == ata_tlink_release;
377 static int ata_tlink_match(struct attribute_container *cont,
380 struct ata_internal* i = to_ata_internal(ata_scsi_transport_template);
381 if (!ata_is_link(dev))
383 return &i->link_attr_cont.ac == cont;
387 * ata_tlink_delete -- remove ATA LINK
388 * @port: ATA LINK to remove
390 * Removes the specified ATA LINK. remove associated ATA device(s) as well.
392 void ata_tlink_delete(struct ata_link *link)
394 struct device *dev = &link->tdev;
395 struct ata_device *ata_dev;
397 ata_for_each_dev(ata_dev, link, ALL) {
398 ata_tdev_delete(ata_dev);
401 transport_remove_device(dev);
403 transport_destroy_device(dev);
408 * ata_tlink_add -- initialize a transport ATA link structure
409 * @link: allocated ata_link structure.
411 * Initialize an ATA LINK structure for sysfs. It will be added in the
412 * device tree below the ATA PORT it belongs to.
414 * Returns %0 on success
416 int ata_tlink_add(struct ata_link *link)
418 struct device *dev = &link->tdev;
419 struct ata_port *ap = link->ap;
420 struct ata_device *ata_dev;
423 device_initialize(dev);
424 dev->parent = &ap->tdev;
425 dev->release = ata_tlink_release;
426 if (ata_is_host_link(link))
427 dev_set_name(dev, "link%d", ap->print_id);
429 dev_set_name(dev, "link%d.%d", ap->print_id, link->pmp);
431 transport_setup_device(dev);
433 error = device_add(dev);
438 error = transport_add_device(dev);
440 goto tlink_transport_err;
441 transport_configure_device(dev);
443 ata_for_each_dev(ata_dev, link, ALL) {
444 error = ata_tdev_add(ata_dev);
451 while (--ata_dev >= link->device) {
452 ata_tdev_delete(ata_dev);
454 transport_remove_device(dev);
458 transport_destroy_device(dev);
464 * ATA device attributes
467 #define ata_dev_show_class(title, field) \
469 show_ata_dev_##field(struct device *dev, \
470 struct device_attribute *attr, char *buf) \
472 struct ata_device *ata_dev = transport_class_to_dev(dev); \
474 return get_ata_##title##_names(ata_dev->field, buf); \
477 #define ata_dev_attr(title, field) \
478 ata_dev_show_class(title, field) \
479 static DEVICE_ATTR(field, S_IRUGO, show_ata_dev_##field, NULL)
481 ata_dev_attr(class, class);
482 ata_dev_attr(xfer, pio_mode);
483 ata_dev_attr(xfer, dma_mode);
484 ata_dev_attr(xfer, xfer_mode);
487 #define ata_dev_show_simple(field, format_string, cast) \
489 show_ata_dev_##field(struct device *dev, \
490 struct device_attribute *attr, char *buf) \
492 struct ata_device *ata_dev = transport_class_to_dev(dev); \
494 return scnprintf(buf, 20, format_string, cast ata_dev->field); \
497 #define ata_dev_simple_attr(field, format_string, type) \
498 ata_dev_show_simple(field, format_string, (type)) \
499 static DEVICE_ATTR(field, S_IRUGO, \
500 show_ata_dev_##field, NULL)
502 ata_dev_simple_attr(spdn_cnt, "%d\n", int);
504 struct ata_show_ering_arg {
509 static int ata_show_ering(struct ata_ering_entry *ent, void *void_arg)
511 struct ata_show_ering_arg* arg = void_arg;
515 seconds = div_u64_rem(ent->timestamp, HZ, &rem);
516 arg->written += sprintf(arg->buf + arg->written,
517 "[%5llu.%09lu]", seconds,
518 rem * NSEC_PER_SEC / HZ);
519 arg->written += get_ata_err_names(ent->err_mask,
520 arg->buf + arg->written);
525 show_ata_dev_ering(struct device *dev,
526 struct device_attribute *attr, char *buf)
528 struct ata_device *ata_dev = transport_class_to_dev(dev);
529 struct ata_show_ering_arg arg = { buf, 0 };
531 ata_ering_map(&ata_dev->ering, ata_show_ering, &arg);
536 static DEVICE_ATTR(ering, S_IRUGO, show_ata_dev_ering, NULL);
539 show_ata_dev_id(struct device *dev,
540 struct device_attribute *attr, char *buf)
542 struct ata_device *ata_dev = transport_class_to_dev(dev);
543 int written = 0, i = 0;
545 if (ata_dev->class == ATA_DEV_PMP)
547 for(i=0;i<ATA_ID_WORDS;i++) {
548 written += scnprintf(buf+written, 20, "%04x%c",
550 ((i+1) & 7) ? ' ' : '\n');
555 static DEVICE_ATTR(id, S_IRUGO, show_ata_dev_id, NULL);
558 show_ata_dev_gscr(struct device *dev,
559 struct device_attribute *attr, char *buf)
561 struct ata_device *ata_dev = transport_class_to_dev(dev);
562 int written = 0, i = 0;
564 if (ata_dev->class != ATA_DEV_PMP)
566 for(i=0;i<SATA_PMP_GSCR_DWORDS;i++) {
567 written += scnprintf(buf+written, 20, "%08x%c",
569 ((i+1) & 3) ? ' ' : '\n');
571 if (SATA_PMP_GSCR_DWORDS & 3)
572 buf[written-1] = '\n';
576 static DEVICE_ATTR(gscr, S_IRUGO, show_ata_dev_gscr, NULL);
579 show_ata_dev_trim(struct device *dev,
580 struct device_attribute *attr, char *buf)
582 struct ata_device *ata_dev = transport_class_to_dev(dev);
585 if (!ata_id_has_trim(ata_dev->id))
586 mode = "unsupported";
587 else if (ata_dev->horkage & ATA_HORKAGE_NOTRIM)
588 mode = "forced_unsupported";
589 else if (ata_dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM)
590 mode = "forced_unqueued";
591 else if (ata_fpdma_dsm_supported(ata_dev))
596 return scnprintf(buf, 20, "%s\n", mode);
599 static DEVICE_ATTR(trim, S_IRUGO, show_ata_dev_trim, NULL);
601 static DECLARE_TRANSPORT_CLASS(ata_dev_class,
602 "ata_device", NULL, NULL, NULL);
604 static void ata_tdev_release(struct device *dev)
609 * ata_is_ata_dev -- check if a struct device represents a ATA device
610 * @dev: device to check
613 * %1 if the device represents a ATA device, %0 else
615 static int ata_is_ata_dev(const struct device *dev)
617 return dev->release == ata_tdev_release;
620 static int ata_tdev_match(struct attribute_container *cont,
623 struct ata_internal* i = to_ata_internal(ata_scsi_transport_template);
624 if (!ata_is_ata_dev(dev))
626 return &i->dev_attr_cont.ac == cont;
630 * ata_tdev_free -- free a ATA LINK
631 * @dev: ATA PHY to free
633 * Frees the specified ATA PHY.
636 * This function must only be called on a PHY that has not
637 * successfully been added using ata_tdev_add().
639 static void ata_tdev_free(struct ata_device *dev)
641 transport_destroy_device(&dev->tdev);
642 put_device(&dev->tdev);
646 * ata_tdev_delete -- remove ATA device
647 * @port: ATA PORT to remove
649 * Removes the specified ATA device.
651 static void ata_tdev_delete(struct ata_device *ata_dev)
653 struct device *dev = &ata_dev->tdev;
655 transport_remove_device(dev);
657 ata_tdev_free(ata_dev);
662 * ata_tdev_add -- initialize a transport ATA device structure.
663 * @ata_dev: ata_dev structure.
665 * Initialize an ATA device structure for sysfs. It will be added in the
666 * device tree below the ATA LINK device it belongs to.
668 * Returns %0 on success
670 static int ata_tdev_add(struct ata_device *ata_dev)
672 struct device *dev = &ata_dev->tdev;
673 struct ata_link *link = ata_dev->link;
674 struct ata_port *ap = link->ap;
677 device_initialize(dev);
678 dev->parent = &link->tdev;
679 dev->release = ata_tdev_release;
680 if (ata_is_host_link(link))
681 dev_set_name(dev, "dev%d.%d", ap->print_id,ata_dev->devno);
683 dev_set_name(dev, "dev%d.%d.0", ap->print_id, link->pmp);
685 transport_setup_device(dev);
686 ata_acpi_bind_dev(ata_dev);
687 error = device_add(dev);
689 ata_tdev_free(ata_dev);
693 error = transport_add_device(dev);
696 ata_tdev_free(ata_dev);
700 transport_configure_device(dev);
706 * Setup / Teardown code
709 #define SETUP_TEMPLATE(attrb, field, perm, test) \
710 i->private_##attrb[count] = dev_attr_##field; \
711 i->private_##attrb[count].attr.mode = perm; \
712 i->attrb[count] = &i->private_##attrb[count]; \
716 #define SETUP_LINK_ATTRIBUTE(field) \
717 SETUP_TEMPLATE(link_attrs, field, S_IRUGO, 1)
719 #define SETUP_PORT_ATTRIBUTE(field) \
720 SETUP_TEMPLATE(port_attrs, field, S_IRUGO, 1)
722 #define SETUP_DEV_ATTRIBUTE(field) \
723 SETUP_TEMPLATE(dev_attrs, field, S_IRUGO, 1)
726 * ata_attach_transport -- instantiate ATA transport template
728 struct scsi_transport_template *ata_attach_transport(void)
730 struct ata_internal *i;
733 i = kzalloc(sizeof(struct ata_internal), GFP_KERNEL);
737 i->t.eh_strategy_handler = ata_scsi_error;
738 i->t.user_scan = ata_scsi_user_scan;
740 i->t.host_attrs.ac.attrs = &i->port_attrs[0];
741 i->t.host_attrs.ac.class = &ata_port_class.class;
742 i->t.host_attrs.ac.match = ata_tport_match;
743 transport_container_register(&i->t.host_attrs);
745 i->link_attr_cont.ac.class = &ata_link_class.class;
746 i->link_attr_cont.ac.attrs = &i->link_attrs[0];
747 i->link_attr_cont.ac.match = ata_tlink_match;
748 transport_container_register(&i->link_attr_cont);
750 i->dev_attr_cont.ac.class = &ata_dev_class.class;
751 i->dev_attr_cont.ac.attrs = &i->dev_attrs[0];
752 i->dev_attr_cont.ac.match = ata_tdev_match;
753 transport_container_register(&i->dev_attr_cont);
756 SETUP_PORT_ATTRIBUTE(nr_pmp_links);
757 SETUP_PORT_ATTRIBUTE(idle_irq);
758 SETUP_PORT_ATTRIBUTE(port_no);
759 BUG_ON(count > ATA_PORT_ATTRS);
760 i->port_attrs[count] = NULL;
763 SETUP_LINK_ATTRIBUTE(hw_sata_spd_limit);
764 SETUP_LINK_ATTRIBUTE(sata_spd_limit);
765 SETUP_LINK_ATTRIBUTE(sata_spd);
766 BUG_ON(count > ATA_LINK_ATTRS);
767 i->link_attrs[count] = NULL;
770 SETUP_DEV_ATTRIBUTE(class);
771 SETUP_DEV_ATTRIBUTE(pio_mode);
772 SETUP_DEV_ATTRIBUTE(dma_mode);
773 SETUP_DEV_ATTRIBUTE(xfer_mode);
774 SETUP_DEV_ATTRIBUTE(spdn_cnt);
775 SETUP_DEV_ATTRIBUTE(ering);
776 SETUP_DEV_ATTRIBUTE(id);
777 SETUP_DEV_ATTRIBUTE(gscr);
778 SETUP_DEV_ATTRIBUTE(trim);
779 BUG_ON(count > ATA_DEV_ATTRS);
780 i->dev_attrs[count] = NULL;
786 * ata_release_transport -- release ATA transport template instance
787 * @t: transport template instance
789 void ata_release_transport(struct scsi_transport_template *t)
791 struct ata_internal *i = to_ata_internal(t);
793 transport_container_unregister(&i->t.host_attrs);
794 transport_container_unregister(&i->link_attr_cont);
795 transport_container_unregister(&i->dev_attr_cont);
800 __init int libata_transport_init(void)
804 error = transport_class_register(&ata_link_class);
806 goto out_unregister_transport;
807 error = transport_class_register(&ata_port_class);
809 goto out_unregister_link;
810 error = transport_class_register(&ata_dev_class);
812 goto out_unregister_port;
816 transport_class_unregister(&ata_port_class);
818 transport_class_unregister(&ata_link_class);
819 out_unregister_transport:
824 void __exit libata_transport_exit(void)
826 transport_class_unregister(&ata_link_class);
827 transport_class_unregister(&ata_port_class);
828 transport_class_unregister(&ata_dev_class);