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