2 * Copyright 2008 ioogle, Inc. All rights reserved.
3 * Released under GPL v2.
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_NONE
, "none" }
148 ata_bitfield_name_search(class, ata_class_names
)
154 } ata_err_names
[] = {
155 { AC_ERR_DEV
, "DeviceError" },
156 { AC_ERR_HSM
, "HostStateMachineError" },
157 { AC_ERR_TIMEOUT
, "Timeout" },
158 { AC_ERR_MEDIA
, "MediaError" },
159 { AC_ERR_ATA_BUS
, "BusError" },
160 { AC_ERR_HOST_BUS
, "HostBusError" },
161 { AC_ERR_SYSTEM
, "SystemError" },
162 { AC_ERR_INVALID
, "InvalidArg" },
163 { AC_ERR_OTHER
, "Unknown" },
164 { AC_ERR_NODEV_HINT
, "NoDeviceHint" },
165 { AC_ERR_NCQ
, "NCQError" }
167 ata_bitfield_name_match(err
, ata_err_names
)
172 } ata_xfer_names
[] = {
173 { XFER_UDMA_7
, "XFER_UDMA_7" },
174 { XFER_UDMA_6
, "XFER_UDMA_6" },
175 { XFER_UDMA_5
, "XFER_UDMA_5" },
176 { XFER_UDMA_4
, "XFER_UDMA_4" },
177 { XFER_UDMA_3
, "XFER_UDMA_3" },
178 { XFER_UDMA_2
, "XFER_UDMA_2" },
179 { XFER_UDMA_1
, "XFER_UDMA_1" },
180 { XFER_UDMA_0
, "XFER_UDMA_0" },
181 { XFER_MW_DMA_4
, "XFER_MW_DMA_4" },
182 { XFER_MW_DMA_3
, "XFER_MW_DMA_3" },
183 { XFER_MW_DMA_2
, "XFER_MW_DMA_2" },
184 { XFER_MW_DMA_1
, "XFER_MW_DMA_1" },
185 { XFER_MW_DMA_0
, "XFER_MW_DMA_0" },
186 { XFER_SW_DMA_2
, "XFER_SW_DMA_2" },
187 { XFER_SW_DMA_1
, "XFER_SW_DMA_1" },
188 { XFER_SW_DMA_0
, "XFER_SW_DMA_0" },
189 { XFER_PIO_6
, "XFER_PIO_6" },
190 { XFER_PIO_5
, "XFER_PIO_5" },
191 { XFER_PIO_4
, "XFER_PIO_4" },
192 { XFER_PIO_3
, "XFER_PIO_3" },
193 { XFER_PIO_2
, "XFER_PIO_2" },
194 { XFER_PIO_1
, "XFER_PIO_1" },
195 { XFER_PIO_0
, "XFER_PIO_0" },
196 { XFER_PIO_SLOW
, "XFER_PIO_SLOW" }
198 ata_bitfield_name_match(xfer
,ata_xfer_names
)
201 * ATA Port attributes
203 #define ata_port_show_simple(field, name, format_string, cast) \
205 show_ata_port_##name(struct device *dev, \
206 struct device_attribute *attr, char *buf) \
208 struct ata_port *ap = transport_class_to_port(dev); \
210 return snprintf(buf, 20, format_string, cast ap->field); \
213 #define ata_port_simple_attr(field, name, format_string, type) \
214 ata_port_show_simple(field, name, format_string, (type)) \
215 static DEVICE_ATTR(name, S_IRUGO, show_ata_port_##name, NULL)
217 ata_port_simple_attr(nr_pmp_links
, nr_pmp_links
, "%d\n", int);
218 ata_port_simple_attr(stats
.idle_irq
, idle_irq
, "%ld\n", unsigned long);
219 ata_port_simple_attr(local_port_no
, port_no
, "%u\n", unsigned int);
221 static DECLARE_TRANSPORT_CLASS(ata_port_class
,
222 "ata_port", NULL
, NULL
, NULL
);
224 static void ata_tport_release(struct device
*dev
)
226 put_device(dev
->parent
);
230 * ata_is_port -- check if a struct device represents a ATA port
231 * @dev: device to check
234 * %1 if the device represents a ATA Port, %0 else
236 static int ata_is_port(const struct device
*dev
)
238 return dev
->release
== ata_tport_release
;
241 static int ata_tport_match(struct attribute_container
*cont
,
244 if (!ata_is_port(dev
))
246 return &ata_scsi_transport_template
->host_attrs
.ac
== cont
;
250 * ata_tport_delete -- remove ATA PORT
251 * @port: ATA PORT to remove
253 * Removes the specified ATA PORT. Remove the associated link as well.
255 void ata_tport_delete(struct ata_port
*ap
)
257 struct device
*dev
= &ap
->tdev
;
259 ata_tlink_delete(&ap
->link
);
261 transport_remove_device(dev
);
263 transport_destroy_device(dev
);
267 /** ata_tport_add - initialize a transport ATA port structure
269 * @parent: parent device
270 * @ap: existing ata_port structure
272 * Initialize a ATA port structure for sysfs. It will be added to the device
273 * tree below the device specified by @parent which could be a PCI device.
275 * Returns %0 on success
277 int ata_tport_add(struct device
*parent
,
281 struct device
*dev
= &ap
->tdev
;
283 device_initialize(dev
);
284 dev
->type
= &ata_port_type
;
286 dev
->parent
= get_device(parent
);
287 dev
->release
= ata_tport_release
;
288 dev_set_name(dev
, "ata%d", ap
->print_id
);
289 transport_setup_device(dev
);
290 ata_acpi_bind_port(ap
);
291 error
= device_add(dev
);
296 device_enable_async_suspend(dev
);
297 pm_runtime_set_active(dev
);
298 pm_runtime_enable(dev
);
299 pm_runtime_forbid(dev
);
301 transport_add_device(dev
);
302 transport_configure_device(dev
);
304 error
= ata_tlink_add(&ap
->link
);
311 transport_remove_device(dev
);
315 transport_destroy_device(dev
);
322 * ATA link attributes
324 static int noop(int x
) { return x
; }
326 #define ata_link_show_linkspeed(field, format) \
328 show_ata_link_##field(struct device *dev, \
329 struct device_attribute *attr, char *buf) \
331 struct ata_link *link = transport_class_to_link(dev); \
333 return sprintf(buf, "%s\n", sata_spd_string(format(link->field))); \
336 #define ata_link_linkspeed_attr(field, format) \
337 ata_link_show_linkspeed(field, format) \
338 static DEVICE_ATTR(field, S_IRUGO, show_ata_link_##field, NULL)
340 ata_link_linkspeed_attr(hw_sata_spd_limit
, fls
);
341 ata_link_linkspeed_attr(sata_spd_limit
, fls
);
342 ata_link_linkspeed_attr(sata_spd
, noop
);
345 static DECLARE_TRANSPORT_CLASS(ata_link_class
,
346 "ata_link", NULL
, NULL
, NULL
);
348 static void ata_tlink_release(struct device
*dev
)
350 put_device(dev
->parent
);
354 * ata_is_link -- check if a struct device represents a ATA link
355 * @dev: device to check
358 * %1 if the device represents a ATA link, %0 else
360 static int ata_is_link(const struct device
*dev
)
362 return dev
->release
== ata_tlink_release
;
365 static int ata_tlink_match(struct attribute_container
*cont
,
368 struct ata_internal
* i
= to_ata_internal(ata_scsi_transport_template
);
369 if (!ata_is_link(dev
))
371 return &i
->link_attr_cont
.ac
== cont
;
375 * ata_tlink_delete -- remove ATA LINK
376 * @port: ATA LINK to remove
378 * Removes the specified ATA LINK. remove associated ATA device(s) as well.
380 void ata_tlink_delete(struct ata_link
*link
)
382 struct device
*dev
= &link
->tdev
;
383 struct ata_device
*ata_dev
;
385 ata_for_each_dev(ata_dev
, link
, ALL
) {
386 ata_tdev_delete(ata_dev
);
389 transport_remove_device(dev
);
391 transport_destroy_device(dev
);
396 * ata_tlink_add -- initialize a transport ATA link structure
397 * @link: allocated ata_link structure.
399 * Initialize an ATA LINK structure for sysfs. It will be added in the
400 * device tree below the ATA PORT it belongs to.
402 * Returns %0 on success
404 int ata_tlink_add(struct ata_link
*link
)
406 struct device
*dev
= &link
->tdev
;
407 struct ata_port
*ap
= link
->ap
;
408 struct ata_device
*ata_dev
;
411 device_initialize(dev
);
412 dev
->parent
= get_device(&ap
->tdev
);
413 dev
->release
= ata_tlink_release
;
414 if (ata_is_host_link(link
))
415 dev_set_name(dev
, "link%d", ap
->print_id
);
417 dev_set_name(dev
, "link%d.%d", ap
->print_id
, link
->pmp
);
419 transport_setup_device(dev
);
421 error
= device_add(dev
);
426 transport_add_device(dev
);
427 transport_configure_device(dev
);
429 ata_for_each_dev(ata_dev
, link
, ALL
) {
430 error
= ata_tdev_add(ata_dev
);
437 while (--ata_dev
>= link
->device
) {
438 ata_tdev_delete(ata_dev
);
440 transport_remove_device(dev
);
443 transport_destroy_device(dev
);
449 * ATA device attributes
452 #define ata_dev_show_class(title, field) \
454 show_ata_dev_##field(struct device *dev, \
455 struct device_attribute *attr, char *buf) \
457 struct ata_device *ata_dev = transport_class_to_dev(dev); \
459 return get_ata_##title##_names(ata_dev->field, buf); \
462 #define ata_dev_attr(title, field) \
463 ata_dev_show_class(title, field) \
464 static DEVICE_ATTR(field, S_IRUGO, show_ata_dev_##field, NULL)
466 ata_dev_attr(class, class);
467 ata_dev_attr(xfer
, pio_mode
);
468 ata_dev_attr(xfer
, dma_mode
);
469 ata_dev_attr(xfer
, xfer_mode
);
472 #define ata_dev_show_simple(field, format_string, cast) \
474 show_ata_dev_##field(struct device *dev, \
475 struct device_attribute *attr, char *buf) \
477 struct ata_device *ata_dev = transport_class_to_dev(dev); \
479 return snprintf(buf, 20, format_string, cast ata_dev->field); \
482 #define ata_dev_simple_attr(field, format_string, type) \
483 ata_dev_show_simple(field, format_string, (type)) \
484 static DEVICE_ATTR(field, S_IRUGO, \
485 show_ata_dev_##field, NULL)
487 ata_dev_simple_attr(spdn_cnt
, "%d\n", int);
489 struct ata_show_ering_arg
{
494 static int ata_show_ering(struct ata_ering_entry
*ent
, void *void_arg
)
496 struct ata_show_ering_arg
* arg
= void_arg
;
497 struct timespec time
;
499 jiffies_to_timespec(ent
->timestamp
,&time
);
500 arg
->written
+= sprintf(arg
->buf
+ arg
->written
,
502 time
.tv_sec
, time
.tv_nsec
);
503 arg
->written
+= get_ata_err_names(ent
->err_mask
,
504 arg
->buf
+ arg
->written
);
509 show_ata_dev_ering(struct device
*dev
,
510 struct device_attribute
*attr
, char *buf
)
512 struct ata_device
*ata_dev
= transport_class_to_dev(dev
);
513 struct ata_show_ering_arg arg
= { buf
, 0 };
515 ata_ering_map(&ata_dev
->ering
, ata_show_ering
, &arg
);
520 static DEVICE_ATTR(ering
, S_IRUGO
, show_ata_dev_ering
, NULL
);
523 show_ata_dev_id(struct device
*dev
,
524 struct device_attribute
*attr
, char *buf
)
526 struct ata_device
*ata_dev
= transport_class_to_dev(dev
);
527 int written
= 0, i
= 0;
529 if (ata_dev
->class == ATA_DEV_PMP
)
531 for(i
=0;i
<ATA_ID_WORDS
;i
++) {
532 written
+= snprintf(buf
+written
, 20, "%04x%c",
534 ((i
+1) & 7) ? ' ' : '\n');
539 static DEVICE_ATTR(id
, S_IRUGO
, show_ata_dev_id
, NULL
);
542 show_ata_dev_gscr(struct device
*dev
,
543 struct device_attribute
*attr
, char *buf
)
545 struct ata_device
*ata_dev
= transport_class_to_dev(dev
);
546 int written
= 0, i
= 0;
548 if (ata_dev
->class != ATA_DEV_PMP
)
550 for(i
=0;i
<SATA_PMP_GSCR_DWORDS
;i
++) {
551 written
+= snprintf(buf
+written
, 20, "%08x%c",
553 ((i
+1) & 3) ? ' ' : '\n');
555 if (SATA_PMP_GSCR_DWORDS
& 3)
556 buf
[written
-1] = '\n';
560 static DEVICE_ATTR(gscr
, S_IRUGO
, show_ata_dev_gscr
, NULL
);
562 static DECLARE_TRANSPORT_CLASS(ata_dev_class
,
563 "ata_device", NULL
, NULL
, NULL
);
565 static void ata_tdev_release(struct device
*dev
)
567 put_device(dev
->parent
);
571 * ata_is_ata_dev -- check if a struct device represents a ATA device
572 * @dev: device to check
575 * %1 if the device represents a ATA device, %0 else
577 static int ata_is_ata_dev(const struct device
*dev
)
579 return dev
->release
== ata_tdev_release
;
582 static int ata_tdev_match(struct attribute_container
*cont
,
585 struct ata_internal
* i
= to_ata_internal(ata_scsi_transport_template
);
586 if (!ata_is_ata_dev(dev
))
588 return &i
->dev_attr_cont
.ac
== cont
;
592 * ata_tdev_free -- free a ATA LINK
593 * @dev: ATA PHY to free
595 * Frees the specified ATA PHY.
598 * This function must only be called on a PHY that has not
599 * successfully been added using ata_tdev_add().
601 static void ata_tdev_free(struct ata_device
*dev
)
603 transport_destroy_device(&dev
->tdev
);
604 put_device(&dev
->tdev
);
608 * ata_tdev_delete -- remove ATA device
609 * @port: ATA PORT to remove
611 * Removes the specified ATA device.
613 static void ata_tdev_delete(struct ata_device
*ata_dev
)
615 struct device
*dev
= &ata_dev
->tdev
;
617 transport_remove_device(dev
);
619 ata_tdev_free(ata_dev
);
624 * ata_tdev_add -- initialize a transport ATA device structure.
625 * @ata_dev: ata_dev structure.
627 * Initialize an ATA device structure for sysfs. It will be added in the
628 * device tree below the ATA LINK device it belongs to.
630 * Returns %0 on success
632 static int ata_tdev_add(struct ata_device
*ata_dev
)
634 struct device
*dev
= &ata_dev
->tdev
;
635 struct ata_link
*link
= ata_dev
->link
;
636 struct ata_port
*ap
= link
->ap
;
639 device_initialize(dev
);
640 dev
->parent
= get_device(&link
->tdev
);
641 dev
->release
= ata_tdev_release
;
642 if (ata_is_host_link(link
))
643 dev_set_name(dev
, "dev%d.%d", ap
->print_id
,ata_dev
->devno
);
645 dev_set_name(dev
, "dev%d.%d.0", ap
->print_id
, link
->pmp
);
647 transport_setup_device(dev
);
648 ata_acpi_bind_dev(ata_dev
);
649 error
= device_add(dev
);
651 ata_tdev_free(ata_dev
);
655 transport_add_device(dev
);
656 transport_configure_device(dev
);
662 * Setup / Teardown code
665 #define SETUP_TEMPLATE(attrb, field, perm, test) \
666 i->private_##attrb[count] = dev_attr_##field; \
667 i->private_##attrb[count].attr.mode = perm; \
668 i->attrb[count] = &i->private_##attrb[count]; \
672 #define SETUP_LINK_ATTRIBUTE(field) \
673 SETUP_TEMPLATE(link_attrs, field, S_IRUGO, 1)
675 #define SETUP_PORT_ATTRIBUTE(field) \
676 SETUP_TEMPLATE(port_attrs, field, S_IRUGO, 1)
678 #define SETUP_DEV_ATTRIBUTE(field) \
679 SETUP_TEMPLATE(dev_attrs, field, S_IRUGO, 1)
682 * ata_attach_transport -- instantiate ATA transport template
684 struct scsi_transport_template
*ata_attach_transport(void)
686 struct ata_internal
*i
;
689 i
= kzalloc(sizeof(struct ata_internal
), GFP_KERNEL
);
693 i
->t
.eh_strategy_handler
= ata_scsi_error
;
694 i
->t
.eh_timed_out
= ata_scsi_timed_out
;
695 i
->t
.user_scan
= ata_scsi_user_scan
;
697 i
->t
.host_attrs
.ac
.attrs
= &i
->port_attrs
[0];
698 i
->t
.host_attrs
.ac
.class = &ata_port_class
.class;
699 i
->t
.host_attrs
.ac
.match
= ata_tport_match
;
700 transport_container_register(&i
->t
.host_attrs
);
702 i
->link_attr_cont
.ac
.class = &ata_link_class
.class;
703 i
->link_attr_cont
.ac
.attrs
= &i
->link_attrs
[0];
704 i
->link_attr_cont
.ac
.match
= ata_tlink_match
;
705 transport_container_register(&i
->link_attr_cont
);
707 i
->dev_attr_cont
.ac
.class = &ata_dev_class
.class;
708 i
->dev_attr_cont
.ac
.attrs
= &i
->dev_attrs
[0];
709 i
->dev_attr_cont
.ac
.match
= ata_tdev_match
;
710 transport_container_register(&i
->dev_attr_cont
);
713 SETUP_PORT_ATTRIBUTE(nr_pmp_links
);
714 SETUP_PORT_ATTRIBUTE(idle_irq
);
715 SETUP_PORT_ATTRIBUTE(port_no
);
716 BUG_ON(count
> ATA_PORT_ATTRS
);
717 i
->port_attrs
[count
] = NULL
;
720 SETUP_LINK_ATTRIBUTE(hw_sata_spd_limit
);
721 SETUP_LINK_ATTRIBUTE(sata_spd_limit
);
722 SETUP_LINK_ATTRIBUTE(sata_spd
);
723 BUG_ON(count
> ATA_LINK_ATTRS
);
724 i
->link_attrs
[count
] = NULL
;
727 SETUP_DEV_ATTRIBUTE(class);
728 SETUP_DEV_ATTRIBUTE(pio_mode
);
729 SETUP_DEV_ATTRIBUTE(dma_mode
);
730 SETUP_DEV_ATTRIBUTE(xfer_mode
);
731 SETUP_DEV_ATTRIBUTE(spdn_cnt
);
732 SETUP_DEV_ATTRIBUTE(ering
);
733 SETUP_DEV_ATTRIBUTE(id
);
734 SETUP_DEV_ATTRIBUTE(gscr
);
735 BUG_ON(count
> ATA_DEV_ATTRS
);
736 i
->dev_attrs
[count
] = NULL
;
742 * ata_release_transport -- release ATA transport template instance
743 * @t: transport template instance
745 void ata_release_transport(struct scsi_transport_template
*t
)
747 struct ata_internal
*i
= to_ata_internal(t
);
749 transport_container_unregister(&i
->t
.host_attrs
);
750 transport_container_unregister(&i
->link_attr_cont
);
751 transport_container_unregister(&i
->dev_attr_cont
);
756 __init
int libata_transport_init(void)
760 error
= transport_class_register(&ata_link_class
);
762 goto out_unregister_transport
;
763 error
= transport_class_register(&ata_port_class
);
765 goto out_unregister_link
;
766 error
= transport_class_register(&ata_dev_class
);
768 goto out_unregister_port
;
772 transport_class_unregister(&ata_port_class
);
774 transport_class_unregister(&ata_link_class
);
775 out_unregister_transport
:
780 void __exit
libata_transport_exit(void)
782 transport_class_unregister(&ata_link_class
);
783 transport_class_unregister(&ata_port_class
);
784 transport_class_unregister(&ata_dev_class
);