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 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 	transport_add_device(dev);
305 	transport_configure_device(dev);
306 
307 	error = ata_tlink_add(&ap->link);
308 	if (error) {
309 		goto tport_link_err;
310 	}
311 	return 0;
312 
313  tport_link_err:
314 	transport_remove_device(dev);
315 	device_del(dev);
316 
317  tport_err:
318 	transport_destroy_device(dev);
319 	put_device(dev);
320 	return error;
321 }
322 
323 /**
324  *     ata_port_classify - determine device type based on ATA-spec signature
325  *     @ap: ATA port device on which the classification should be run
326  *     @tf: ATA taskfile register set for device to be identified
327  *
328  *     A wrapper around ata_dev_classify() to provide additional logging
329  *
330  *     RETURNS:
331  *     Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, %ATA_DEV_PMP,
332  *     %ATA_DEV_ZAC, or %ATA_DEV_UNKNOWN the event of failure.
333  */
334 unsigned int ata_port_classify(struct ata_port *ap,
335 			       const struct ata_taskfile *tf)
336 {
337 	int i;
338 	unsigned int class = ata_dev_classify(tf);
339 
340 	/* Start with index '1' to skip the 'unknown' entry */
341 	for (i = 1; i < ARRAY_SIZE(ata_class_names); i++) {
342 		if (ata_class_names[i].value == class) {
343 			ata_port_dbg(ap, "found %s device by sig\n",
344 				     ata_class_names[i].name);
345 			return class;
346 		}
347 	}
348 
349 	ata_port_info(ap, "found unknown device (class %u)\n", class);
350 	return class;
351 }
352 EXPORT_SYMBOL_GPL(ata_port_classify);
353 
354 /*
355  * ATA link attributes
356  */
357 static int noop(int x) { return x; }
358 
359 #define ata_link_show_linkspeed(field, format)				\
360 static ssize_t								\
361 show_ata_link_##field(struct device *dev,				\
362 		      struct device_attribute *attr, char *buf)		\
363 {									\
364 	struct ata_link *link = transport_class_to_link(dev);		\
365 									\
366 	return sprintf(buf, "%s\n", sata_spd_string(format(link->field))); \
367 }
368 
369 #define ata_link_linkspeed_attr(field, format)				\
370 	ata_link_show_linkspeed(field, format)				\
371 static DEVICE_ATTR(field, S_IRUGO, show_ata_link_##field, NULL)
372 
373 ata_link_linkspeed_attr(hw_sata_spd_limit, fls);
374 ata_link_linkspeed_attr(sata_spd_limit, fls);
375 ata_link_linkspeed_attr(sata_spd, noop);
376 
377 
378 static DECLARE_TRANSPORT_CLASS(ata_link_class,
379 		"ata_link", NULL, NULL, NULL);
380 
381 static void ata_tlink_release(struct device *dev)
382 {
383 }
384 
385 /**
386  * ata_is_link --  check if a struct device represents a ATA link
387  * @dev:	device to check
388  *
389  * Returns:
390  *	%1 if the device represents a ATA link, %0 else
391  */
392 static int ata_is_link(const struct device *dev)
393 {
394 	return dev->release == ata_tlink_release;
395 }
396 
397 static int ata_tlink_match(struct attribute_container *cont,
398 			   struct device *dev)
399 {
400 	struct ata_internal* i = to_ata_internal(ata_scsi_transport_template);
401 	if (!ata_is_link(dev))
402 		return 0;
403 	return &i->link_attr_cont.ac == cont;
404 }
405 
406 /**
407  * ata_tlink_delete  --  remove ATA LINK
408  * @link:	ATA LINK to remove
409  *
410  * Removes the specified ATA LINK.  remove associated ATA device(s) as well.
411  */
412 void ata_tlink_delete(struct ata_link *link)
413 {
414 	struct device *dev = &link->tdev;
415 	struct ata_device *ata_dev;
416 
417 	ata_for_each_dev(ata_dev, link, ALL) {
418 		ata_tdev_delete(ata_dev);
419 	}
420 
421 	transport_remove_device(dev);
422 	device_del(dev);
423 	transport_destroy_device(dev);
424 	put_device(dev);
425 }
426 
427 /**
428  * ata_tlink_add  --  initialize a transport ATA link structure
429  * @link:	allocated ata_link structure.
430  *
431  * Initialize an ATA LINK structure for sysfs.  It will be added in the
432  * device tree below the ATA PORT it belongs to.
433  *
434  * Returns %0 on success
435  */
436 int ata_tlink_add(struct ata_link *link)
437 {
438 	struct device *dev = &link->tdev;
439 	struct ata_port *ap = link->ap;
440 	struct ata_device *ata_dev;
441 	int error;
442 
443 	device_initialize(dev);
444 	dev->parent = &ap->tdev;
445 	dev->release = ata_tlink_release;
446 	if (ata_is_host_link(link))
447 		dev_set_name(dev, "link%d", ap->print_id);
448 	else
449 		dev_set_name(dev, "link%d.%d", ap->print_id, link->pmp);
450 
451 	transport_setup_device(dev);
452 
453 	error = device_add(dev);
454 	if (error) {
455 		goto tlink_err;
456 	}
457 
458 	transport_add_device(dev);
459 	transport_configure_device(dev);
460 
461 	ata_for_each_dev(ata_dev, link, ALL) {
462 		error = ata_tdev_add(ata_dev);
463 		if (error) {
464 			goto tlink_dev_err;
465 		}
466 	}
467 	return 0;
468   tlink_dev_err:
469 	while (--ata_dev >= link->device) {
470 		ata_tdev_delete(ata_dev);
471 	}
472 	transport_remove_device(dev);
473 	device_del(dev);
474   tlink_err:
475 	transport_destroy_device(dev);
476 	put_device(dev);
477 	return error;
478 }
479 
480 /*
481  * ATA device attributes
482  */
483 
484 #define ata_dev_show_class(title, field)				\
485 static ssize_t								\
486 show_ata_dev_##field(struct device *dev,				\
487 		     struct device_attribute *attr, char *buf)		\
488 {									\
489 	struct ata_device *ata_dev = transport_class_to_dev(dev);	\
490 									\
491 	return get_ata_##title##_names(ata_dev->field, buf);		\
492 }
493 
494 #define ata_dev_attr(title, field)					\
495 	ata_dev_show_class(title, field)				\
496 static DEVICE_ATTR(field, S_IRUGO, show_ata_dev_##field, NULL)
497 
498 ata_dev_attr(class, class);
499 ata_dev_attr(xfer, pio_mode);
500 ata_dev_attr(xfer, dma_mode);
501 ata_dev_attr(xfer, xfer_mode);
502 
503 
504 #define ata_dev_show_simple(field, format_string, cast)			\
505 static ssize_t								\
506 show_ata_dev_##field(struct device *dev,				\
507 		     struct device_attribute *attr, char *buf)		\
508 {									\
509 	struct ata_device *ata_dev = transport_class_to_dev(dev);	\
510 									\
511 	return scnprintf(buf, 20, format_string, cast ata_dev->field);	\
512 }
513 
514 #define ata_dev_simple_attr(field, format_string, type)		\
515 	ata_dev_show_simple(field, format_string, (type))	\
516 	static DEVICE_ATTR(field, S_IRUGO,			\
517 		   show_ata_dev_##field, NULL)
518 
519 ata_dev_simple_attr(spdn_cnt, "%d\n", int);
520 
521 struct ata_show_ering_arg {
522 	char* buf;
523 	int written;
524 };
525 
526 static int ata_show_ering(struct ata_ering_entry *ent, void *void_arg)
527 {
528 	struct ata_show_ering_arg* arg = void_arg;
529 	u64 seconds;
530 	u32 rem;
531 
532 	seconds = div_u64_rem(ent->timestamp, HZ, &rem);
533 	arg->written += sprintf(arg->buf + arg->written,
534 				"[%5llu.%09lu]", seconds,
535 				rem * NSEC_PER_SEC / HZ);
536 	arg->written += get_ata_err_names(ent->err_mask,
537 					  arg->buf + arg->written);
538 	return 0;
539 }
540 
541 static ssize_t
542 show_ata_dev_ering(struct device *dev,
543 		   struct device_attribute *attr, char *buf)
544 {
545 	struct ata_device *ata_dev = transport_class_to_dev(dev);
546 	struct ata_show_ering_arg arg = { buf, 0 };
547 
548 	ata_ering_map(&ata_dev->ering, ata_show_ering, &arg);
549 	return arg.written;
550 }
551 
552 
553 static DEVICE_ATTR(ering, S_IRUGO, show_ata_dev_ering, NULL);
554 
555 static ssize_t
556 show_ata_dev_id(struct device *dev,
557 		struct device_attribute *attr, char *buf)
558 {
559 	struct ata_device *ata_dev = transport_class_to_dev(dev);
560 	int written = 0, i = 0;
561 
562 	if (ata_dev->class == ATA_DEV_PMP)
563 		return 0;
564 	for(i=0;i<ATA_ID_WORDS;i++)  {
565 		written += scnprintf(buf+written, 20, "%04x%c",
566 				    ata_dev->id[i],
567 				    ((i+1) & 7) ? ' ' : '\n');
568 	}
569 	return written;
570 }
571 
572 static DEVICE_ATTR(id, S_IRUGO, show_ata_dev_id, NULL);
573 
574 static ssize_t
575 show_ata_dev_gscr(struct device *dev,
576 		  struct device_attribute *attr, char *buf)
577 {
578 	struct ata_device *ata_dev = transport_class_to_dev(dev);
579 	int written = 0, i = 0;
580 
581 	if (ata_dev->class != ATA_DEV_PMP)
582 		return 0;
583 	for(i=0;i<SATA_PMP_GSCR_DWORDS;i++)  {
584 		written += scnprintf(buf+written, 20, "%08x%c",
585 				    ata_dev->gscr[i],
586 				    ((i+1) & 3) ? ' ' : '\n');
587 	}
588 	if (SATA_PMP_GSCR_DWORDS & 3)
589 		buf[written-1] = '\n';
590 	return written;
591 }
592 
593 static DEVICE_ATTR(gscr, S_IRUGO, show_ata_dev_gscr, NULL);
594 
595 static ssize_t
596 show_ata_dev_trim(struct device *dev,
597 		  struct device_attribute *attr, char *buf)
598 {
599 	struct ata_device *ata_dev = transport_class_to_dev(dev);
600 	unsigned char *mode;
601 
602 	if (!ata_id_has_trim(ata_dev->id))
603 		mode = "unsupported";
604 	else if (ata_dev->horkage & ATA_HORKAGE_NOTRIM)
605 		mode = "forced_unsupported";
606 	else if (ata_dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM)
607 			mode = "forced_unqueued";
608 	else if (ata_fpdma_dsm_supported(ata_dev))
609 		mode = "queued";
610 	else
611 		mode = "unqueued";
612 
613 	return scnprintf(buf, 20, "%s\n", mode);
614 }
615 
616 static DEVICE_ATTR(trim, S_IRUGO, show_ata_dev_trim, NULL);
617 
618 static DECLARE_TRANSPORT_CLASS(ata_dev_class,
619 			       "ata_device", NULL, NULL, NULL);
620 
621 static void ata_tdev_release(struct device *dev)
622 {
623 }
624 
625 /**
626  * ata_is_ata_dev  --  check if a struct device represents a ATA device
627  * @dev:	device to check
628  *
629  * Returns:
630  *	%1 if the device represents a ATA device, %0 else
631  */
632 static int ata_is_ata_dev(const struct device *dev)
633 {
634 	return dev->release == ata_tdev_release;
635 }
636 
637 static int ata_tdev_match(struct attribute_container *cont,
638 			  struct device *dev)
639 {
640 	struct ata_internal* i = to_ata_internal(ata_scsi_transport_template);
641 	if (!ata_is_ata_dev(dev))
642 		return 0;
643 	return &i->dev_attr_cont.ac == cont;
644 }
645 
646 /**
647  * ata_tdev_free  --  free a ATA LINK
648  * @dev:	ATA PHY to free
649  *
650  * Frees the specified ATA PHY.
651  *
652  * Note:
653  *   This function must only be called on a PHY that has not
654  *   successfully been added using ata_tdev_add().
655  */
656 static void ata_tdev_free(struct ata_device *dev)
657 {
658 	transport_destroy_device(&dev->tdev);
659 	put_device(&dev->tdev);
660 }
661 
662 /**
663  * ata_tdev_delete  --  remove ATA device
664  * @ata_dev:	ATA device to remove
665  *
666  * Removes the specified ATA device.
667  */
668 static void ata_tdev_delete(struct ata_device *ata_dev)
669 {
670 	struct device *dev = &ata_dev->tdev;
671 
672 	transport_remove_device(dev);
673 	device_del(dev);
674 	ata_tdev_free(ata_dev);
675 }
676 
677 
678 /**
679  * ata_tdev_add  --  initialize a transport ATA device structure.
680  * @ata_dev:	ata_dev structure.
681  *
682  * Initialize an ATA device structure for sysfs.  It will be added in the
683  * device tree below the ATA LINK device it belongs to.
684  *
685  * Returns %0 on success
686  */
687 static int ata_tdev_add(struct ata_device *ata_dev)
688 {
689 	struct device *dev = &ata_dev->tdev;
690 	struct ata_link *link = ata_dev->link;
691 	struct ata_port *ap = link->ap;
692 	int error;
693 
694 	device_initialize(dev);
695 	dev->parent = &link->tdev;
696 	dev->release = ata_tdev_release;
697 	if (ata_is_host_link(link))
698 		dev_set_name(dev, "dev%d.%d", ap->print_id,ata_dev->devno);
699 	else
700 		dev_set_name(dev, "dev%d.%d.0", ap->print_id, link->pmp);
701 
702 	transport_setup_device(dev);
703 	ata_acpi_bind_dev(ata_dev);
704 	error = device_add(dev);
705 	if (error) {
706 		ata_tdev_free(ata_dev);
707 		return error;
708 	}
709 
710 	transport_add_device(dev);
711 	transport_configure_device(dev);
712 	return 0;
713 }
714 
715 
716 /*
717  * Setup / Teardown code
718  */
719 
720 #define SETUP_TEMPLATE(attrb, field, perm, test)			\
721 	i->private_##attrb[count] = dev_attr_##field;			\
722 	i->private_##attrb[count].attr.mode = perm;			\
723 	i->attrb[count] = &i->private_##attrb[count];			\
724 	if (test)							\
725 		count++
726 
727 #define SETUP_LINK_ATTRIBUTE(field)					\
728 	SETUP_TEMPLATE(link_attrs, field, S_IRUGO, 1)
729 
730 #define SETUP_PORT_ATTRIBUTE(field)					\
731 	SETUP_TEMPLATE(port_attrs, field, S_IRUGO, 1)
732 
733 #define SETUP_DEV_ATTRIBUTE(field)					\
734 	SETUP_TEMPLATE(dev_attrs, field, S_IRUGO, 1)
735 
736 /**
737  * ata_attach_transport  --  instantiate ATA transport template
738  */
739 struct scsi_transport_template *ata_attach_transport(void)
740 {
741 	struct ata_internal *i;
742 	int count;
743 
744 	i = kzalloc(sizeof(struct ata_internal), GFP_KERNEL);
745 	if (!i)
746 		return NULL;
747 
748 	i->t.eh_strategy_handler	= ata_scsi_error;
749 	i->t.user_scan			= ata_scsi_user_scan;
750 
751 	i->t.host_attrs.ac.attrs = &i->port_attrs[0];
752 	i->t.host_attrs.ac.class = &ata_port_class.class;
753 	i->t.host_attrs.ac.match = ata_tport_match;
754 	transport_container_register(&i->t.host_attrs);
755 
756 	i->link_attr_cont.ac.class = &ata_link_class.class;
757 	i->link_attr_cont.ac.attrs = &i->link_attrs[0];
758 	i->link_attr_cont.ac.match = ata_tlink_match;
759 	transport_container_register(&i->link_attr_cont);
760 
761 	i->dev_attr_cont.ac.class = &ata_dev_class.class;
762 	i->dev_attr_cont.ac.attrs = &i->dev_attrs[0];
763 	i->dev_attr_cont.ac.match = ata_tdev_match;
764 	transport_container_register(&i->dev_attr_cont);
765 
766 	count = 0;
767 	SETUP_PORT_ATTRIBUTE(nr_pmp_links);
768 	SETUP_PORT_ATTRIBUTE(idle_irq);
769 	SETUP_PORT_ATTRIBUTE(port_no);
770 	BUG_ON(count > ATA_PORT_ATTRS);
771 	i->port_attrs[count] = NULL;
772 
773 	count = 0;
774 	SETUP_LINK_ATTRIBUTE(hw_sata_spd_limit);
775 	SETUP_LINK_ATTRIBUTE(sata_spd_limit);
776 	SETUP_LINK_ATTRIBUTE(sata_spd);
777 	BUG_ON(count > ATA_LINK_ATTRS);
778 	i->link_attrs[count] = NULL;
779 
780 	count = 0;
781 	SETUP_DEV_ATTRIBUTE(class);
782 	SETUP_DEV_ATTRIBUTE(pio_mode);
783 	SETUP_DEV_ATTRIBUTE(dma_mode);
784 	SETUP_DEV_ATTRIBUTE(xfer_mode);
785 	SETUP_DEV_ATTRIBUTE(spdn_cnt);
786 	SETUP_DEV_ATTRIBUTE(ering);
787 	SETUP_DEV_ATTRIBUTE(id);
788 	SETUP_DEV_ATTRIBUTE(gscr);
789 	SETUP_DEV_ATTRIBUTE(trim);
790 	BUG_ON(count > ATA_DEV_ATTRS);
791 	i->dev_attrs[count] = NULL;
792 
793 	return &i->t;
794 }
795 
796 /**
797  * ata_release_transport  --  release ATA transport template instance
798  * @t:		transport template instance
799  */
800 void ata_release_transport(struct scsi_transport_template *t)
801 {
802 	struct ata_internal *i = to_ata_internal(t);
803 
804 	transport_container_unregister(&i->t.host_attrs);
805 	transport_container_unregister(&i->link_attr_cont);
806 	transport_container_unregister(&i->dev_attr_cont);
807 
808 	kfree(i);
809 }
810 
811 __init int libata_transport_init(void)
812 {
813 	int error;
814 
815 	error = transport_class_register(&ata_link_class);
816 	if (error)
817 		goto out_unregister_transport;
818 	error = transport_class_register(&ata_port_class);
819 	if (error)
820 		goto out_unregister_link;
821 	error = transport_class_register(&ata_dev_class);
822 	if (error)
823 		goto out_unregister_port;
824 	return 0;
825 
826  out_unregister_port:
827 	transport_class_unregister(&ata_port_class);
828  out_unregister_link:
829 	transport_class_unregister(&ata_link_class);
830  out_unregister_transport:
831 	return error;
832 
833 }
834 
835 void __exit libata_transport_exit(void)
836 {
837 	transport_class_unregister(&ata_link_class);
838 	transport_class_unregister(&ata_port_class);
839 	transport_class_unregister(&ata_dev_class);
840 }
841