drivers/ata/libata-transport.c

   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         error = transport_add_device(dev);
 432         if (error)
 433                 goto tlink_transport_err;
 434         transport_configure_device(dev);
 435
 436         ata_for_each_dev(ata_dev, link, ALL) {
 437                 error = ata_tdev_add(ata_dev);
 438                 if (error) {
 439                         goto tlink_dev_err;
 440                 }
 441         }
 442         return 0;
 443   tlink_dev_err:
 444         while (--ata_dev >= link->device) {
 445                 ata_tdev_delete(ata_dev);
 446         }
 447         transport_remove_device(dev);
 448   tlink_transport_err:
 449         device_del(dev);
 450   tlink_err:
 451         transport_destroy_device(dev);
 452         put_device(dev);
 453         return error;
 454 }
 455
 456 /*
 457  * ATA device attributes
 458  */
 459
 460 #define ata_dev_show_class(title, field)                                \
 461 static ssize_t                                                          \
 462 show_ata_dev_##field(struct device *dev,                                \
 463                      struct device_attribute *attr, char *buf)          \
 464 {                                                                       \
 465         struct ata_device *ata_dev = transport_class_to_dev(dev);       \
 466                                                                         \
 467         return get_ata_##title##_names(ata_dev->field, buf);            \
 468 }
 469
 470 #define ata_dev_attr(title, field)                                      \
 471         ata_dev_show_class(title, field)                                \
 472 static DEVICE_ATTR(field, S_IRUGO, show_ata_dev_##field, NULL)
 473
 474 ata_dev_attr(class, class);
 475 ata_dev_attr(xfer, pio_mode);
 476 ata_dev_attr(xfer, dma_mode);
 477 ata_dev_attr(xfer, xfer_mode);
 478
 479
 480 #define ata_dev_show_simple(field, format_string, cast)         \
 481 static ssize_t                                                          \
 482 show_ata_dev_##field(struct device *dev,                                \
 483                      struct device_attribute *attr, char *buf)          \
 484 {                                                                       \
 485         struct ata_device *ata_dev = transport_class_to_dev(dev);       \
 486                                                                         \
 487         return scnprintf(buf, 20, format_string, cast ata_dev->field);  \
 488 }
 489
 490 #define ata_dev_simple_attr(field, format_string, type) \
 491         ata_dev_show_simple(field, format_string, (type))       \
 492 static DEVICE_ATTR(field, S_IRUGO,                      \
 493                    show_ata_dev_##field, NULL)
 494
 495 ata_dev_simple_attr(spdn_cnt, "%d\n", int);
 496
 497 struct ata_show_ering_arg {
 498         char* buf;
 499         int written;
 500 };
 501
 502 static int ata_show_ering(struct ata_ering_entry *ent, void *void_arg)
 503 {
 504         struct ata_show_ering_arg* arg = void_arg;
 505         u64 seconds;
 506         u32 rem;
 507
 508         seconds = div_u64_rem(ent->timestamp, HZ, &rem);
 509         arg->written += sprintf(arg->buf + arg->written,
 510                                 "[%5llu.%09lu]", seconds,
 511                                 rem * NSEC_PER_SEC / HZ);
 512         arg->written += get_ata_err_names(ent->err_mask,
 513                                           arg->buf + arg->written);
 514         return 0;
 515 }
 516
 517 static ssize_t
 518 show_ata_dev_ering(struct device *dev,
 519                    struct device_attribute *attr, char *buf)
 520 {
 521         struct ata_device *ata_dev = transport_class_to_dev(dev);
 522         struct ata_show_ering_arg arg = { buf, 0 };
 523
 524         ata_ering_map(&ata_dev->ering, ata_show_ering, &arg);
 525         return arg.written;
 526 }
 527
 528
 529 static DEVICE_ATTR(ering, S_IRUGO, show_ata_dev_ering, NULL);
 530
 531 static ssize_t
 532 show_ata_dev_id(struct device *dev,
 533                 struct device_attribute *attr, char *buf)
 534 {
 535         struct ata_device *ata_dev = transport_class_to_dev(dev);
 536         int written = 0, i = 0;
 537
 538         if (ata_dev->class == ATA_DEV_PMP)
 539                 return 0;
 540         for(i=0;i<ATA_ID_WORDS;i++)  {
 541                 written += scnprintf(buf+written, 20, "%04x%c",
 542                                     ata_dev->id[i],
 543                                     ((i+1) & 7) ? ' ' : '\n');
 544         }
 545         return written;
 546 }
 547
 548 static DEVICE_ATTR(id, S_IRUGO, show_ata_dev_id, NULL);
 549
 550 static ssize_t
 551 show_ata_dev_gscr(struct device *dev,
 552                   struct device_attribute *attr, char *buf)
 553 {
 554         struct ata_device *ata_dev = transport_class_to_dev(dev);
 555         int written = 0, i = 0;
 556
 557         if (ata_dev->class != ATA_DEV_PMP)
 558                 return 0;
 559         for(i=0;i<SATA_PMP_GSCR_DWORDS;i++)  {
 560                 written += scnprintf(buf+written, 20, "%08x%c",
 561                                     ata_dev->gscr[i],
 562                                     ((i+1) & 3) ? ' ' : '\n');
 563         }
 564         if (SATA_PMP_GSCR_DWORDS & 3)
 565                 buf[written-1] = '\n';
 566         return written;
 567 }
 568
 569 static DEVICE_ATTR(gscr, S_IRUGO, show_ata_dev_gscr, NULL);
 570
 571 static ssize_t
 572 show_ata_dev_trim(struct device *dev,
 573                   struct device_attribute *attr, char *buf)
 574 {
 575         struct ata_device *ata_dev = transport_class_to_dev(dev);
 576         unsigned char *mode;
 577
 578         if (!ata_id_has_trim(ata_dev->id))
 579                 mode = "unsupported";
 580         else if (ata_dev->horkage & ATA_HORKAGE_NOTRIM)
 581                 mode = "forced_unsupported";
 582         else if (ata_dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM)
 583                         mode = "forced_unqueued";
 584         else if (ata_fpdma_dsm_supported(ata_dev))
 585                 mode = "queued";
 586         else
 587                 mode = "unqueued";
 588
 589         return scnprintf(buf, 20, "%s\n", mode);
 590 }
 591
 592 static DEVICE_ATTR(trim, S_IRUGO, show_ata_dev_trim, NULL);
 593
 594 static DECLARE_TRANSPORT_CLASS(ata_dev_class,
 595                                "ata_device", NULL, NULL, NULL);
 596
 597 static void ata_tdev_release(struct device *dev)
 598 {
 599 }
 600
 601 /**
 602  * ata_is_ata_dev  --  check if a struct device represents a ATA device
 603  * @dev:        device to check
 604  *
 605  * Returns:
 606  *      %1 if the device represents a ATA device, %0 else
 607  */
 608 static int ata_is_ata_dev(const struct device *dev)
 609 {
 610         return dev->release == ata_tdev_release;
 611 }
 612
 613 static int ata_tdev_match(struct attribute_container *cont,
 614                           struct device *dev)
 615 {
 616         struct ata_internal* i = to_ata_internal(ata_scsi_transport_template);
 617         if (!ata_is_ata_dev(dev))
 618                 return 0;
 619         return &i->dev_attr_cont.ac == cont;
 620 }
 621
 622 /**
 623  * ata_tdev_free  --  free a ATA LINK
 624  * @dev:        ATA PHY to free
 625  *
 626  * Frees the specified ATA PHY.
 627  *
 628  * Note:
 629  *   This function must only be called on a PHY that has not
 630  *   successfully been added using ata_tdev_add().
 631  */
 632 static void ata_tdev_free(struct ata_device *dev)
 633 {
 634         transport_destroy_device(&dev->tdev);
 635         put_device(&dev->tdev);
 636 }
 637
 638 /**
 639  * ata_tdev_delete  --  remove ATA device
 640  * @ata_dev:    ATA device to remove
 641  *
 642  * Removes the specified ATA device.
 643  */
 644 static void ata_tdev_delete(struct ata_device *ata_dev)
 645 {
 646         struct device *dev = &ata_dev->tdev;
 647
 648         transport_remove_device(dev);
 649         device_del(dev);
 650         ata_tdev_free(ata_dev);
 651 }
 652
 653
 654 /**
 655  * ata_tdev_add  --  initialize a transport ATA device structure.
 656  * @ata_dev:    ata_dev structure.
 657  *
 658  * Initialize an ATA device structure for sysfs.  It will be added in the
 659  * device tree below the ATA LINK device it belongs to.
 660  *
 661  * Returns %0 on success
 662  */
 663 static int ata_tdev_add(struct ata_device *ata_dev)
 664 {
 665         struct device *dev = &ata_dev->tdev;
 666         struct ata_link *link = ata_dev->link;
 667         struct ata_port *ap = link->ap;
 668         int error;
 669
 670         device_initialize(dev);
 671         dev->parent = &link->tdev;
 672         dev->release = ata_tdev_release;
 673         if (ata_is_host_link(link))
 674                 dev_set_name(dev, "dev%d.%d", ap->print_id,ata_dev->devno);
 675         else
 676                 dev_set_name(dev, "dev%d.%d.0", ap->print_id, link->pmp);
 677
 678         transport_setup_device(dev);
 679         ata_acpi_bind_dev(ata_dev);
 680         error = device_add(dev);
 681         if (error) {
 682                 ata_tdev_free(ata_dev);
 683                 return error;
 684         }
 685
 686         error = transport_add_device(dev);
 687         if (error) {
 688                 device_del(dev);
 689                 ata_tdev_free(ata_dev);
 690                 return error;
 691         }
 692
 693         transport_configure_device(dev);
 694         return 0;
 695 }
 696
 697
 698 /*
 699  * Setup / Teardown code
 700  */
 701
 702 #define SETUP_TEMPLATE(attrb, field, perm, test)                        \
 703         i->private_##attrb[count] = dev_attr_##field;                   \
 704         i->private_##attrb[count].attr.mode = perm;                     \
 705         i->attrb[count] = &i->private_##attrb[count];                   \
 706         if (test)                                                       \
 707                 count++
 708
 709 #define SETUP_LINK_ATTRIBUTE(field)                                     \
 710         SETUP_TEMPLATE(link_attrs, field, S_IRUGO, 1)
 711
 712 #define SETUP_PORT_ATTRIBUTE(field)                                     \
 713         SETUP_TEMPLATE(port_attrs, field, S_IRUGO, 1)
 714
 715 #define SETUP_DEV_ATTRIBUTE(field)                                      \
 716         SETUP_TEMPLATE(dev_attrs, field, S_IRUGO, 1)
 717
 718 /**
 719  * ata_attach_transport  --  instantiate ATA transport template
 720  */
 721 struct scsi_transport_template *ata_attach_transport(void)
 722 {
 723         struct ata_internal *i;
 724         int count;
 725
 726         i = kzalloc(sizeof(struct ata_internal), GFP_KERNEL);
 727         if (!i)
 728                 return NULL;
 729
 730         i->t.eh_strategy_handler        = ata_scsi_error;
 731         i->t.user_scan                  = ata_scsi_user_scan;
 732
 733         i->t.host_attrs.ac.attrs = &i->port_attrs[0];
 734         i->t.host_attrs.ac.class = &ata_port_class.class;
 735         i->t.host_attrs.ac.match = ata_tport_match;
 736         transport_container_register(&i->t.host_attrs);
 737
 738         i->link_attr_cont.ac.class = &ata_link_class.class;
 739         i->link_attr_cont.ac.attrs = &i->link_attrs[0];
 740         i->link_attr_cont.ac.match = ata_tlink_match;
 741         transport_container_register(&i->link_attr_cont);
 742
 743         i->dev_attr_cont.ac.class = &ata_dev_class.class;
 744         i->dev_attr_cont.ac.attrs = &i->dev_attrs[0];
 745         i->dev_attr_cont.ac.match = ata_tdev_match;
 746         transport_container_register(&i->dev_attr_cont);
 747
 748         count = 0;
 749         SETUP_PORT_ATTRIBUTE(nr_pmp_links);
 750         SETUP_PORT_ATTRIBUTE(idle_irq);
 751         SETUP_PORT_ATTRIBUTE(port_no);
 752         BUG_ON(count > ATA_PORT_ATTRS);
 753         i->port_attrs[count] = NULL;
 754
 755         count = 0;
 756         SETUP_LINK_ATTRIBUTE(hw_sata_spd_limit);
 757         SETUP_LINK_ATTRIBUTE(sata_spd_limit);
 758         SETUP_LINK_ATTRIBUTE(sata_spd);
 759         BUG_ON(count > ATA_LINK_ATTRS);
 760         i->link_attrs[count] = NULL;
 761
 762         count = 0;
 763         SETUP_DEV_ATTRIBUTE(class);
 764         SETUP_DEV_ATTRIBUTE(pio_mode);
 765         SETUP_DEV_ATTRIBUTE(dma_mode);
 766         SETUP_DEV_ATTRIBUTE(xfer_mode);
 767         SETUP_DEV_ATTRIBUTE(spdn_cnt);
 768         SETUP_DEV_ATTRIBUTE(ering);
 769         SETUP_DEV_ATTRIBUTE(id);
 770         SETUP_DEV_ATTRIBUTE(gscr);
 771         SETUP_DEV_ATTRIBUTE(trim);
 772         BUG_ON(count > ATA_DEV_ATTRS);
 773         i->dev_attrs[count] = NULL;
 774
 775         return &i->t;
 776 }
 777
 778 /**
 779  * ata_release_transport  --  release ATA transport template instance
 780  * @t:          transport template instance
 781  */
 782 void ata_release_transport(struct scsi_transport_template *t)
 783 {
 784         struct ata_internal *i = to_ata_internal(t);
 785
 786         transport_container_unregister(&i->t.host_attrs);
 787         transport_container_unregister(&i->link_attr_cont);
 788         transport_container_unregister(&i->dev_attr_cont);
 789
 790         kfree(i);
 791 }
 792
 793 __init int libata_transport_init(void)
 794 {
 795         int error;
 796
 797         error = transport_class_register(&ata_link_class);
 798         if (error)
 799                 goto out_unregister_transport;
 800         error = transport_class_register(&ata_port_class);
 801         if (error)
 802                 goto out_unregister_link;
 803         error = transport_class_register(&ata_dev_class);
 804         if (error)
 805                 goto out_unregister_port;
 806         return 0;
 807
 808  out_unregister_port:
 809         transport_class_unregister(&ata_port_class);
 810  out_unregister_link:
 811         transport_class_unregister(&ata_link_class);
 812  out_unregister_transport:
 813         return error;
 814
 815 }
 816
 817 void __exit libata_transport_exit(void)
 818 {
 819         transport_class_unregister(&ata_link_class);
 820         transport_class_unregister(&ata_port_class);
 821         transport_class_unregister(&ata_dev_class);
 822 }