1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  Copyright 2008 ioogle, Inc.  All rights reserved.
4  *
5  * Libata transport class.
6  *
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.
11  *
12  * There are 3 objects defined in in this class:
13  * - ata_port
14  * - ata_link
15  * - ata_device
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
19  * created.
20  *
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
23  * error handler runs.
24  */
25 
26 
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>
36 
37 #include "libata.h"
38 #include "libata-transport.h"
39 
40 #define ATA_PORT_ATTRS		3
41 #define ATA_LINK_ATTRS		3
42 #define ATA_DEV_ATTRS		9
43 
44 struct scsi_transport_template;
45 struct scsi_transport_template *ata_scsi_transport_template;
46 
47 struct ata_internal {
48 	struct scsi_transport_template t;
49 
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];
53 
54 	struct transport_container link_attr_cont;
55 	struct transport_container dev_attr_cont;
56 
57 	/*
58 	 * The array of null terminated pointers to attributes
59 	 * needed by scsi_sysfs.c
60 	 */
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];
64 };
65 #define to_ata_internal(tmpl)	container_of(tmpl, struct ata_internal, t)
66 
67 
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)
72 
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)
77 
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)
82 
83 
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);
87 
88 
89 /*
90  * Hack to allow attributes of the same name in different objects.
91  */
92 #define ATA_DEVICE_ATTR(_prefix,_name,_mode,_show,_store) \
93 	struct device_attribute device_attr_##_prefix##_##_name = \
94 	__ATTR(_name,_mode,_show,_store)
95 
96 #define ata_bitfield_name_match(title, table)			\
97 static ssize_t							\
98 get_ata_##title##_names(u32 table_key, char *buf)		\
99 {								\
100 	char *prefix = "";					\
101 	ssize_t len = 0;					\
102 	int i;							\
103 								\
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);		\
108 			prefix = ", ";				\
109 		}						\
110 	}							\
111 	len += sprintf(buf + len, "\n");			\
112 	return len;						\
113 }
114 
115 #define ata_bitfield_name_search(title, table)			\
116 static ssize_t							\
117 get_ata_##title##_names(u32 table_key, char *buf)		\
118 {								\
119 	ssize_t len = 0;					\
120 	int i;							\
121 								\
122 	for (i = 0; i < ARRAY_SIZE(table); i++) {		\
123 		if (table[i].value == table_key) {		\
124 			len += sprintf(buf + len, "%s",		\
125 				table[i].name);			\
126 			break;					\
127 		}						\
128 	}							\
129 	len += sprintf(buf + len, "\n");			\
130 	return len;						\
131 }
132 
133 static struct {
134 	u32		value;
135 	char		*name;
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" }
148 };
149 ata_bitfield_name_search(class, ata_class_names)
150 
151 
152 static struct {
153 	u32		value;
154 	char		*name;
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" }
167 };
168 ata_bitfield_name_match(err, ata_err_names)
169 
170 static struct {
171 	u32		value;
172 	char		*name;
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" }
198 };
199 ata_bitfield_name_search(xfer, ata_xfer_names)
200 
201 /*
202  * ATA Port attributes
203  */
204 #define ata_port_show_simple(field, name, format_string, cast)		\
205 static ssize_t								\
206 show_ata_port_##name(struct device *dev,				\
207 		     struct device_attribute *attr, char *buf)		\
208 {									\
209 	struct ata_port *ap = transport_class_to_port(dev);		\
210 									\
211 	return scnprintf(buf, 20, format_string, cast ap->field);	\
212 }
213 
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)
217 
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);
221 
222 static DECLARE_TRANSPORT_CLASS(ata_port_class,
223 			       "ata_port", NULL, NULL, NULL);
224 
225 static void ata_tport_release(struct device *dev)
226 {
227 	struct ata_port *ap = tdev_to_port(dev);
228 	ata_host_put(ap->host);
229 }
230 
231 /**
232  * ata_is_port --  check if a struct device represents a ATA port
233  * @dev:	device to check
234  *
235  * Returns:
236  *	%1 if the device represents a ATA Port, %0 else
237  */
238 static int ata_is_port(const struct device *dev)
239 {
240 	return dev->release == ata_tport_release;
241 }
242 
243 static int ata_tport_match(struct attribute_container *cont,
244 			   struct device *dev)
245 {
246 	if (!ata_is_port(dev))
247 		return 0;
248 	return &ata_scsi_transport_template->host_attrs.ac == cont;
249 }
250 
251 /**
252  * ata_tport_delete  --  remove ATA PORT
253  * @ap:	ATA PORT to remove
254  *
255  * Removes the specified ATA PORT.  Remove the associated link as well.
256  */
257 void ata_tport_delete(struct ata_port *ap)
258 {
259 	struct device *dev = &ap->tdev;
260 
261 	ata_tlink_delete(&ap->link);
262 
263 	transport_remove_device(dev);
264 	device_del(dev);
265 	transport_destroy_device(dev);
266 	put_device(dev);
267 }
268 
269 /** ata_tport_add - initialize a transport ATA port structure
270  *
271  * @parent:	parent device
272  * @ap:		existing ata_port structure
273  *
274  * Initialize a ATA port structure for sysfs.  It will be added to the device
275  * tree below the device specified by @parent which could be a PCI device.
276  *
277  * Returns %0 on success
278  */
279 int ata_tport_add(struct device *parent,
280 		  struct ata_port *ap)
281 {
282 	int error;
283 	struct device *dev = &ap->tdev;
284 
285 	device_initialize(dev);
286 	dev->type = &ata_port_type;
287 
288 	dev->parent = parent;
289 	ata_host_get(ap->host);
290 	dev->release = ata_tport_release;
291 	dev_set_name(dev, "ata%d", ap->print_id);
292 	transport_setup_device(dev);
293 	ata_acpi_bind_port(ap);
294 	error = device_add(dev);
295 	if (error) {
296 		goto tport_err;
297 	}
298 
299 	device_enable_async_suspend(dev);
300 	pm_runtime_set_active(dev);
301 	pm_runtime_enable(dev);
302 	pm_runtime_forbid(dev);
303 
304 	error = transport_add_device(dev);
305 	if (error)
306 		goto tport_transport_add_err;
307 	transport_configure_device(dev);
308 
309 	error = ata_tlink_add(&ap->link);
310 	if (error) {
311 		goto tport_link_err;
312 	}
313 	return 0;
314 
315  tport_link_err:
316 	transport_remove_device(dev);
317  tport_transport_add_err:
318 	device_del(dev);
319 
320  tport_err:
321 	transport_destroy_device(dev);
322 	put_device(dev);
323 	return error;
324 }
325 
326 
327 /*
328  * ATA link attributes
329  */
330 static int noop(int x) { return x; }
331 
332 #define ata_link_show_linkspeed(field, format)			        \
333 static ssize_t								\
334 show_ata_link_##field(struct device *dev,				\
335 		      struct device_attribute *attr, char *buf)		\
336 {									\
337 	struct ata_link *link = transport_class_to_link(dev);		\
338 									\
339 	return sprintf(buf, "%s\n", sata_spd_string(format(link->field))); \
340 }
341 
342 #define ata_link_linkspeed_attr(field, format)				\
343 	ata_link_show_linkspeed(field, format)				\
344 static DEVICE_ATTR(field, S_IRUGO, show_ata_link_##field, NULL)
345 
346 ata_link_linkspeed_attr(hw_sata_spd_limit, fls);
347 ata_link_linkspeed_attr(sata_spd_limit, fls);
348 ata_link_linkspeed_attr(sata_spd, noop);
349 
350 
351 static DECLARE_TRANSPORT_CLASS(ata_link_class,
352 		"ata_link", NULL, NULL, NULL);
353 
354 static void ata_tlink_release(struct device *dev)
355 {
356 }
357 
358 /**
359  * ata_is_link --  check if a struct device represents a ATA link
360  * @dev:	device to check
361  *
362  * Returns:
363  *	%1 if the device represents a ATA link, %0 else
364  */
365 static int ata_is_link(const struct device *dev)
366 {
367 	return dev->release == ata_tlink_release;
368 }
369 
370 static int ata_tlink_match(struct attribute_container *cont,
371 			   struct device *dev)
372 {
373 	struct ata_internal* i = to_ata_internal(ata_scsi_transport_template);
374 	if (!ata_is_link(dev))
375 		return 0;
376 	return &i->link_attr_cont.ac == cont;
377 }
378 
379 /**
380  * ata_tlink_delete  --  remove ATA LINK
381  * @link:	ATA LINK to remove
382  *
383  * Removes the specified ATA LINK.  remove associated ATA device(s) as well.
384  */
385 void ata_tlink_delete(struct ata_link *link)
386 {
387 	struct device *dev = &link->tdev;
388 	struct ata_device *ata_dev;
389 
390 	ata_for_each_dev(ata_dev, link, ALL) {
391 		ata_tdev_delete(ata_dev);
392 	}
393 
394 	transport_remove_device(dev);
395 	device_del(dev);
396 	transport_destroy_device(dev);
397 	put_device(dev);
398 }
399 
400 /**
401  * ata_tlink_add  --  initialize a transport ATA link structure
402  * @link:	allocated ata_link structure.
403  *
404  * Initialize an ATA LINK structure for sysfs.  It will be added in the
405  * device tree below the ATA PORT it belongs to.
406  *
407  * Returns %0 on success
408  */
409 int ata_tlink_add(struct ata_link *link)
410 {
411 	struct device *dev = &link->tdev;
412 	struct ata_port *ap = link->ap;
413 	struct ata_device *ata_dev;
414 	int error;
415 
416 	device_initialize(dev);
417 	dev->parent = &ap->tdev;
418 	dev->release = ata_tlink_release;
419 	if (ata_is_host_link(link))
420 		dev_set_name(dev, "link%d", ap->print_id);
421         else
422 		dev_set_name(dev, "link%d.%d", ap->print_id, link->pmp);
423 
424 	transport_setup_device(dev);
425 
426 	error = device_add(dev);
427 	if (error) {
428 		goto tlink_err;
429 	}
430 
431 	transport_add_device(dev);
432 	transport_configure_device(dev);
433 
434 	ata_for_each_dev(ata_dev, link, ALL) {
435 		error = ata_tdev_add(ata_dev);
436 		if (error) {
437 			goto tlink_dev_err;
438 		}
439 	}
440 	return 0;
441   tlink_dev_err:
442 	while (--ata_dev >= link->device) {
443 		ata_tdev_delete(ata_dev);
444 	}
445 	transport_remove_device(dev);
446 	device_del(dev);
447   tlink_err:
448 	transport_destroy_device(dev);
449 	put_device(dev);
450 	return error;
451 }
452 
453 /*
454  * ATA device attributes
455  */
456 
457 #define ata_dev_show_class(title, field)				\
458 static ssize_t								\
459 show_ata_dev_##field(struct device *dev,				\
460 		     struct device_attribute *attr, char *buf)		\
461 {									\
462 	struct ata_device *ata_dev = transport_class_to_dev(dev);	\
463 									\
464 	return get_ata_##title##_names(ata_dev->field, buf);		\
465 }
466 
467 #define ata_dev_attr(title, field)					\
468 	ata_dev_show_class(title, field)				\
469 static DEVICE_ATTR(field, S_IRUGO, show_ata_dev_##field, NULL)
470 
471 ata_dev_attr(class, class);
472 ata_dev_attr(xfer, pio_mode);
473 ata_dev_attr(xfer, dma_mode);
474 ata_dev_attr(xfer, xfer_mode);
475 
476 
477 #define ata_dev_show_simple(field, format_string, cast)		\
478 static ssize_t								\
479 show_ata_dev_##field(struct device *dev,				\
480 		     struct device_attribute *attr, char *buf)		\
481 {									\
482 	struct ata_device *ata_dev = transport_class_to_dev(dev);	\
483 									\
484 	return scnprintf(buf, 20, format_string, cast ata_dev->field);	\
485 }
486 
487 #define ata_dev_simple_attr(field, format_string, type)	\
488 	ata_dev_show_simple(field, format_string, (type))	\
489 static DEVICE_ATTR(field, S_IRUGO, 			\
490 		   show_ata_dev_##field, NULL)
491 
492 ata_dev_simple_attr(spdn_cnt, "%d\n", int);
493 
494 struct ata_show_ering_arg {
495 	char* buf;
496 	int written;
497 };
498 
499 static int ata_show_ering(struct ata_ering_entry *ent, void *void_arg)
500 {
501 	struct ata_show_ering_arg* arg = void_arg;
502 	u64 seconds;
503 	u32 rem;
504 
505 	seconds = div_u64_rem(ent->timestamp, HZ, &rem);
506 	arg->written += sprintf(arg->buf + arg->written,
507 			        "[%5llu.%09lu]", seconds,
508 				rem * NSEC_PER_SEC / HZ);
509 	arg->written += get_ata_err_names(ent->err_mask,
510 					  arg->buf + arg->written);
511 	return 0;
512 }
513 
514 static ssize_t
515 show_ata_dev_ering(struct device *dev,
516 		   struct device_attribute *attr, char *buf)
517 {
518 	struct ata_device *ata_dev = transport_class_to_dev(dev);
519 	struct ata_show_ering_arg arg = { buf, 0 };
520 
521 	ata_ering_map(&ata_dev->ering, ata_show_ering, &arg);
522 	return arg.written;
523 }
524 
525 
526 static DEVICE_ATTR(ering, S_IRUGO, show_ata_dev_ering, NULL);
527 
528 static ssize_t
529 show_ata_dev_id(struct device *dev,
530 		struct device_attribute *attr, char *buf)
531 {
532 	struct ata_device *ata_dev = transport_class_to_dev(dev);
533 	int written = 0, i = 0;
534 
535 	if (ata_dev->class == ATA_DEV_PMP)
536 		return 0;
537 	for(i=0;i<ATA_ID_WORDS;i++)  {
538 		written += scnprintf(buf+written, 20, "%04x%c",
539 				    ata_dev->id[i],
540 				    ((i+1) & 7) ? ' ' : '\n');
541 	}
542 	return written;
543 }
544 
545 static DEVICE_ATTR(id, S_IRUGO, show_ata_dev_id, NULL);
546 
547 static ssize_t
548 show_ata_dev_gscr(struct device *dev,
549 		  struct device_attribute *attr, char *buf)
550 {
551 	struct ata_device *ata_dev = transport_class_to_dev(dev);
552 	int written = 0, i = 0;
553 
554 	if (ata_dev->class != ATA_DEV_PMP)
555 		return 0;
556 	for(i=0;i<SATA_PMP_GSCR_DWORDS;i++)  {
557 		written += scnprintf(buf+written, 20, "%08x%c",
558 				    ata_dev->gscr[i],
559 				    ((i+1) & 3) ? ' ' : '\n');
560 	}
561 	if (SATA_PMP_GSCR_DWORDS & 3)
562 		buf[written-1] = '\n';
563 	return written;
564 }
565 
566 static DEVICE_ATTR(gscr, S_IRUGO, show_ata_dev_gscr, NULL);
567 
568 static ssize_t
569 show_ata_dev_trim(struct device *dev,
570 		  struct device_attribute *attr, char *buf)
571 {
572 	struct ata_device *ata_dev = transport_class_to_dev(dev);
573 	unsigned char *mode;
574 
575 	if (!ata_id_has_trim(ata_dev->id))
576 		mode = "unsupported";
577 	else if (ata_dev->horkage & ATA_HORKAGE_NOTRIM)
578 		mode = "forced_unsupported";
579 	else if (ata_dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM)
580 			mode = "forced_unqueued";
581 	else if (ata_fpdma_dsm_supported(ata_dev))
582 		mode = "queued";
583 	else
584 		mode = "unqueued";
585 
586 	return scnprintf(buf, 20, "%s\n", mode);
587 }
588 
589 static DEVICE_ATTR(trim, S_IRUGO, show_ata_dev_trim, NULL);
590 
591 static DECLARE_TRANSPORT_CLASS(ata_dev_class,
592 			       "ata_device", NULL, NULL, NULL);
593 
594 static void ata_tdev_release(struct device *dev)
595 {
596 }
597 
598 /**
599  * ata_is_ata_dev  --  check if a struct device represents a ATA device
600  * @dev:	device to check
601  *
602  * Returns:
603  *	%1 if the device represents a ATA device, %0 else
604  */
605 static int ata_is_ata_dev(const struct device *dev)
606 {
607 	return dev->release == ata_tdev_release;
608 }
609 
610 static int ata_tdev_match(struct attribute_container *cont,
611 			  struct device *dev)
612 {
613 	struct ata_internal* i = to_ata_internal(ata_scsi_transport_template);
614 	if (!ata_is_ata_dev(dev))
615 		return 0;
616 	return &i->dev_attr_cont.ac == cont;
617 }
618 
619 /**
620  * ata_tdev_free  --  free a ATA LINK
621  * @dev:	ATA PHY to free
622  *
623  * Frees the specified ATA PHY.
624  *
625  * Note:
626  *   This function must only be called on a PHY that has not
627  *   successfully been added using ata_tdev_add().
628  */
629 static void ata_tdev_free(struct ata_device *dev)
630 {
631 	transport_destroy_device(&dev->tdev);
632 	put_device(&dev->tdev);
633 }
634 
635 /**
636  * ata_tdev_delete  --  remove ATA device
637  * @ata_dev:	ATA device to remove
638  *
639  * Removes the specified ATA device.
640  */
641 static void ata_tdev_delete(struct ata_device *ata_dev)
642 {
643 	struct device *dev = &ata_dev->tdev;
644 
645 	transport_remove_device(dev);
646 	device_del(dev);
647 	ata_tdev_free(ata_dev);
648 }
649 
650 
651 /**
652  * ata_tdev_add  --  initialize a transport ATA device structure.
653  * @ata_dev:	ata_dev structure.
654  *
655  * Initialize an ATA device structure for sysfs.  It will be added in the
656  * device tree below the ATA LINK device it belongs to.
657  *
658  * Returns %0 on success
659  */
660 static int ata_tdev_add(struct ata_device *ata_dev)
661 {
662 	struct device *dev = &ata_dev->tdev;
663 	struct ata_link *link = ata_dev->link;
664 	struct ata_port *ap = link->ap;
665 	int error;
666 
667 	device_initialize(dev);
668 	dev->parent = &link->tdev;
669 	dev->release = ata_tdev_release;
670 	if (ata_is_host_link(link))
671 		dev_set_name(dev, "dev%d.%d", ap->print_id,ata_dev->devno);
672         else
673 		dev_set_name(dev, "dev%d.%d.0", ap->print_id, link->pmp);
674 
675 	transport_setup_device(dev);
676 	ata_acpi_bind_dev(ata_dev);
677 	error = device_add(dev);
678 	if (error) {
679 		ata_tdev_free(ata_dev);
680 		return error;
681 	}
682 
683 	transport_add_device(dev);
684 	transport_configure_device(dev);
685 	return 0;
686 }
687 
688 
689 /*
690  * Setup / Teardown code
691  */
692 
693 #define SETUP_TEMPLATE(attrb, field, perm, test)			\
694 	i->private_##attrb[count] = dev_attr_##field;		       	\
695 	i->private_##attrb[count].attr.mode = perm;			\
696 	i->attrb[count] = &i->private_##attrb[count];			\
697 	if (test)							\
698 		count++
699 
700 #define SETUP_LINK_ATTRIBUTE(field)					\
701 	SETUP_TEMPLATE(link_attrs, field, S_IRUGO, 1)
702 
703 #define SETUP_PORT_ATTRIBUTE(field)					\
704 	SETUP_TEMPLATE(port_attrs, field, S_IRUGO, 1)
705 
706 #define SETUP_DEV_ATTRIBUTE(field)					\
707 	SETUP_TEMPLATE(dev_attrs, field, S_IRUGO, 1)
708 
709 /**
710  * ata_attach_transport  --  instantiate ATA transport template
711  */
712 struct scsi_transport_template *ata_attach_transport(void)
713 {
714 	struct ata_internal *i;
715 	int count;
716 
717 	i = kzalloc(sizeof(struct ata_internal), GFP_KERNEL);
718 	if (!i)
719 		return NULL;
720 
721 	i->t.eh_strategy_handler	= ata_scsi_error;
722 	i->t.user_scan			= ata_scsi_user_scan;
723 
724 	i->t.host_attrs.ac.attrs = &i->port_attrs[0];
725 	i->t.host_attrs.ac.class = &ata_port_class.class;
726 	i->t.host_attrs.ac.match = ata_tport_match;
727 	transport_container_register(&i->t.host_attrs);
728 
729 	i->link_attr_cont.ac.class = &ata_link_class.class;
730 	i->link_attr_cont.ac.attrs = &i->link_attrs[0];
731 	i->link_attr_cont.ac.match = ata_tlink_match;
732 	transport_container_register(&i->link_attr_cont);
733 
734 	i->dev_attr_cont.ac.class = &ata_dev_class.class;
735 	i->dev_attr_cont.ac.attrs = &i->dev_attrs[0];
736 	i->dev_attr_cont.ac.match = ata_tdev_match;
737 	transport_container_register(&i->dev_attr_cont);
738 
739 	count = 0;
740 	SETUP_PORT_ATTRIBUTE(nr_pmp_links);
741 	SETUP_PORT_ATTRIBUTE(idle_irq);
742 	SETUP_PORT_ATTRIBUTE(port_no);
743 	BUG_ON(count > ATA_PORT_ATTRS);
744 	i->port_attrs[count] = NULL;
745 
746 	count = 0;
747 	SETUP_LINK_ATTRIBUTE(hw_sata_spd_limit);
748 	SETUP_LINK_ATTRIBUTE(sata_spd_limit);
749 	SETUP_LINK_ATTRIBUTE(sata_spd);
750 	BUG_ON(count > ATA_LINK_ATTRS);
751 	i->link_attrs[count] = NULL;
752 
753 	count = 0;
754 	SETUP_DEV_ATTRIBUTE(class);
755 	SETUP_DEV_ATTRIBUTE(pio_mode);
756 	SETUP_DEV_ATTRIBUTE(dma_mode);
757 	SETUP_DEV_ATTRIBUTE(xfer_mode);
758 	SETUP_DEV_ATTRIBUTE(spdn_cnt);
759 	SETUP_DEV_ATTRIBUTE(ering);
760 	SETUP_DEV_ATTRIBUTE(id);
761 	SETUP_DEV_ATTRIBUTE(gscr);
762 	SETUP_DEV_ATTRIBUTE(trim);
763 	BUG_ON(count > ATA_DEV_ATTRS);
764 	i->dev_attrs[count] = NULL;
765 
766 	return &i->t;
767 }
768 
769 /**
770  * ata_release_transport  --  release ATA transport template instance
771  * @t:		transport template instance
772  */
773 void ata_release_transport(struct scsi_transport_template *t)
774 {
775 	struct ata_internal *i = to_ata_internal(t);
776 
777 	transport_container_unregister(&i->t.host_attrs);
778 	transport_container_unregister(&i->link_attr_cont);
779 	transport_container_unregister(&i->dev_attr_cont);
780 
781 	kfree(i);
782 }
783 
784 __init int libata_transport_init(void)
785 {
786 	int error;
787 
788 	error = transport_class_register(&ata_link_class);
789 	if (error)
790 		goto out_unregister_transport;
791 	error = transport_class_register(&ata_port_class);
792 	if (error)
793 		goto out_unregister_link;
794 	error = transport_class_register(&ata_dev_class);
795 	if (error)
796 		goto out_unregister_port;
797 	return 0;
798 
799  out_unregister_port:
800 	transport_class_unregister(&ata_port_class);
801  out_unregister_link:
802 	transport_class_unregister(&ata_link_class);
803  out_unregister_transport:
804 	return error;
805 
806 }
807 
808 void __exit libata_transport_exit(void)
809 {
810 	transport_class_unregister(&ata_link_class);
811 	transport_class_unregister(&ata_port_class);
812 	transport_class_unregister(&ata_dev_class);
813 }
814