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