include/scsi/libsas.h

   1 /*
   2  * SAS host prototypes and structures header file
   3  *
   4  * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
   5  * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
   6  *
   7  * This file is licensed under GPLv2.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of the
  12  * License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22  * USA
  23  *
  24  */
  25
  26 #ifndef _LIBSAS_H_
  27 #define _LIBSAS_H_
  28
  29
  30 #include <linux/timer.h>
  31 #include <linux/pci.h>
  32 #include <scsi/sas.h>
  33 #include <linux/list.h>
  34 #include <asm/semaphore.h>
  35 #include <scsi/scsi_device.h>
  36 #include <scsi/scsi_cmnd.h>
  37 #include <scsi/scsi_transport_sas.h>
  38
  39 struct block_device;
  40
  41 enum sas_class {
  42         SAS,
  43         EXPANDER
  44 };
  45
  46 enum sas_phy_role {
  47         PHY_ROLE_NONE = 0,
  48         PHY_ROLE_TARGET = 0x40,
  49         PHY_ROLE_INITIATOR = 0x80,
  50 };
  51
  52 enum sas_phy_type {
  53         PHY_TYPE_PHYSICAL,
  54         PHY_TYPE_VIRTUAL
  55 };
  56
  57 /* The events are mnemonically described in sas_dump.c
  58  * so when updating/adding events here, please also
  59  * update the other file too.
  60  */
  61 enum ha_event {
  62         HAE_RESET             = 0U,
  63         HA_NUM_EVENTS         = 1,
  64 };
  65
  66 enum port_event {
  67         PORTE_BYTES_DMAED     = 0U,
  68         PORTE_BROADCAST_RCVD  = 1,
  69         PORTE_LINK_RESET_ERR  = 2,
  70         PORTE_TIMER_EVENT     = 3,
  71         PORTE_HARD_RESET      = 4,
  72         PORT_NUM_EVENTS       = 5,
  73 };
  74
  75 enum phy_event {
  76         PHYE_LOSS_OF_SIGNAL   = 0U,
  77         PHYE_OOB_DONE         = 1,
  78         PHYE_OOB_ERROR        = 2,
  79         PHYE_SPINUP_HOLD      = 3, /* hot plug SATA, no COMWAKE sent */
  80         PHY_NUM_EVENTS        = 4,
  81 };
  82
  83 enum discover_event {
  84         DISCE_DISCOVER_DOMAIN   = 0U,
  85         DISCE_REVALIDATE_DOMAIN = 1,
  86         DISCE_PORT_GONE         = 2,
  87         DISC_NUM_EVENTS         = 3,
  88 };
  89
  90 /* ---------- Expander Devices ---------- */
  91
  92 #define ETASK 0xFA
  93
  94 #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
  95 #define to_dev_attr(_attr)  container_of(_attr, struct domain_dev_attribute,\
  96                                          attr)
  97
  98 enum routing_attribute {
  99         DIRECT_ROUTING,
 100         SUBTRACTIVE_ROUTING,
 101         TABLE_ROUTING,
 102 };
 103
 104 enum ex_phy_state {
 105         PHY_EMPTY,
 106         PHY_VACANT,
 107         PHY_NOT_PRESENT,
 108         PHY_DEVICE_DISCOVERED
 109 };
 110
 111 struct ex_phy {
 112         int    phy_id;
 113
 114         enum ex_phy_state phy_state;
 115
 116         enum sas_dev_type attached_dev_type;
 117         enum sas_linkrate linkrate;
 118
 119         u8   attached_sata_host:1;
 120         u8   attached_sata_dev:1;
 121         u8   attached_sata_ps:1;
 122
 123         enum sas_proto attached_tproto;
 124         enum sas_proto attached_iproto;
 125
 126         u8   attached_sas_addr[SAS_ADDR_SIZE];
 127         u8   attached_phy_id;
 128
 129         u8   phy_change_count;
 130         enum routing_attribute routing_attr;
 131         u8   virtual:1;
 132
 133         int  last_da_index;
 134
 135         struct sas_phy *phy;
 136         struct sas_port *port;
 137 };
 138
 139 struct expander_device {
 140         struct list_head children;
 141
 142         u16    ex_change_count;
 143         u16    max_route_indexes;
 144         u8     num_phys;
 145         u8     configuring:1;
 146         u8     conf_route_table:1;
 147         u8     enclosure_logical_id[8];
 148
 149         struct ex_phy *ex_phy;
 150         struct sas_port *parent_port;
 151 };
 152
 153 /* ---------- SATA device ---------- */
 154 enum ata_command_set {
 155         ATA_COMMAND_SET   = 0,
 156         ATAPI_COMMAND_SET = 1,
 157 };
 158
 159 struct sata_device {
 160         enum   ata_command_set command_set;
 161         struct smp_resp        rps_resp; /* report_phy_sata_resp */
 162         __le16 *identify_device;
 163         __le16 *identify_packet_device;
 164
 165         u8     port_no;        /* port number, if this is a PM (Port) */
 166         struct list_head children; /* PM Ports if this is a PM */
 167 };
 168
 169 /* ---------- Domain device ---------- */
 170 struct domain_device {
 171         enum sas_dev_type dev_type;
 172
 173         enum sas_linkrate linkrate;
 174         enum sas_linkrate min_linkrate;
 175         enum sas_linkrate max_linkrate;
 176
 177         int  pathways;
 178
 179         struct domain_device *parent;
 180         struct list_head siblings; /* devices on the same level */
 181         struct asd_sas_port *port;        /* shortcut to root of the tree */
 182
 183         struct list_head dev_list_node;
 184
 185         enum sas_proto    iproto;
 186         enum sas_proto    tproto;
 187
 188         struct sas_rphy *rphy;
 189
 190         u8  sas_addr[SAS_ADDR_SIZE];
 191         u8  hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
 192
 193         u8  frame_rcvd[32];
 194
 195         union {
 196                 struct expander_device ex_dev;
 197                 struct sata_device     sata_dev; /* STP & directly attached */
 198         };
 199
 200         void *lldd_dev;
 201 };
 202
 203 struct sas_discovery {
 204         spinlock_t disc_event_lock;
 205         struct work_struct disc_work[DISC_NUM_EVENTS];
 206         unsigned long    pending;
 207         u8     fanout_sas_addr[8];
 208         u8     eeds_a[8];
 209         u8     eeds_b[8];
 210         int    max_level;
 211 };
 212
 213
 214 /* The port struct is Class:RW, driver:RO */
 215 struct asd_sas_port {
 216 /* private: */
 217         struct completion port_gone_completion;
 218
 219         struct sas_discovery disc;
 220         struct domain_device *port_dev;
 221         spinlock_t dev_list_lock;
 222         struct list_head dev_list;
 223         enum   sas_linkrate linkrate;
 224
 225         struct sas_phy *phy;
 226         struct work_struct work;
 227
 228 /* public: */
 229         int id;
 230
 231         enum sas_class   class;
 232         u8               sas_addr[SAS_ADDR_SIZE];
 233         u8               attached_sas_addr[SAS_ADDR_SIZE];
 234         enum sas_proto   iproto;
 235         enum sas_proto   tproto;
 236
 237         enum sas_oob_mode oob_mode;
 238
 239         spinlock_t       phy_list_lock;
 240         struct list_head phy_list;
 241         int              num_phys;
 242         u32              phy_mask;
 243
 244         struct sas_ha_struct *ha;
 245
 246         struct sas_port *port;
 247
 248         void *lldd_port;          /* not touched by the sas class code */
 249 };
 250
 251 /* The phy pretty much is controlled by the LLDD.
 252  * The class only reads those fields.
 253  */
 254 struct asd_sas_phy {
 255 /* private: */
 256         /* protected by ha->event_lock */
 257         struct work_struct   port_events[PORT_NUM_EVENTS];
 258         struct work_struct   phy_events[PHY_NUM_EVENTS];
 259
 260         unsigned long port_events_pending;
 261         unsigned long phy_events_pending;
 262
 263         int error;
 264
 265         struct sas_phy *phy;
 266
 267 /* public: */
 268         /* The following are class:RO, driver:R/W */
 269         int            enabled;   /* must be set */
 270
 271         int            id;        /* must be set */
 272         enum sas_class class;
 273         enum sas_proto iproto;
 274         enum sas_proto tproto;
 275
 276         enum sas_phy_type  type;
 277         enum sas_phy_role  role;
 278         enum sas_oob_mode  oob_mode;
 279         enum sas_linkrate linkrate;
 280
 281         u8   *sas_addr;           /* must be set */
 282         u8   attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
 283
 284         spinlock_t     frame_rcvd_lock;
 285         u8             *frame_rcvd; /* must be set */
 286         int            frame_rcvd_size;
 287
 288         spinlock_t     sas_prim_lock;
 289         u32            sas_prim;
 290
 291         struct list_head port_phy_el; /* driver:RO */
 292         struct asd_sas_port      *port; /* Class:RW, driver: RO */
 293
 294         struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
 295
 296         void *lldd_phy;           /* not touched by the sas_class_code */
 297 };
 298
 299 struct scsi_core {
 300         struct Scsi_Host *shost;
 301
 302         spinlock_t        task_queue_lock;
 303         struct list_head  task_queue;
 304         int               task_queue_size;
 305
 306         struct semaphore  queue_thread_sema;
 307         int               queue_thread_kill;
 308 };
 309
 310 struct sas_ha_struct {
 311 /* private: */
 312         spinlock_t       event_lock;
 313         struct work_struct ha_events[HA_NUM_EVENTS];
 314         unsigned long    pending;
 315
 316         struct scsi_core core;
 317
 318 /* public: */
 319         char *sas_ha_name;
 320         struct pci_dev *pcidev;   /* should be set */
 321         struct module *lldd_module; /* should be set */
 322
 323         u8 *sas_addr;             /* must be set */
 324         u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
 325
 326         spinlock_t      phy_port_lock;
 327         struct asd_sas_phy  **sas_phy; /* array of valid pointers, must be set */
 328         struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
 329         int             num_phys; /* must be set, gt 0, static */
 330
 331         /* The class calls this to send a task for execution. */
 332         int lldd_max_execute_num;
 333         int lldd_queue_size;
 334
 335         /* LLDD calls these to notify the class of an event. */
 336         void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
 337         void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
 338         void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
 339
 340         void *lldd_ha;            /* not touched by sas class code */
 341 };
 342
 343 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
 344
 345 static inline struct domain_device *
 346 starget_to_domain_dev(struct scsi_target *starget) {
 347         return starget->hostdata;
 348 }
 349
 350 static inline struct domain_device *
 351 sdev_to_domain_dev(struct scsi_device *sdev) {
 352         return starget_to_domain_dev(sdev->sdev_target);
 353 }
 354
 355 static inline struct domain_device *
 356 cmd_to_domain_dev(struct scsi_cmnd *cmd)
 357 {
 358         return sdev_to_domain_dev(cmd->device);
 359 }
 360
 361 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
 362
 363 /* Before calling a notify event, LLDD should use this function
 364  * when the link is severed (possibly from its tasklet).
 365  * The idea is that the Class only reads those, while the LLDD,
 366  * can R/W these (thus avoiding a race).
 367  */
 368 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
 369 {
 370         phy->oob_mode = OOB_NOT_CONNECTED;
 371         phy->linkrate = SAS_LINK_RATE_UNKNOWN;
 372 }
 373
 374 /* ---------- Tasks ---------- */
 375 /*
 376       service_response |  SAS_TASK_COMPLETE  |  SAS_TASK_UNDELIVERED |
 377   exec_status          |                     |                       |
 378   ---------------------+---------------------+-----------------------+
 379        SAM_...         |         X           |                       |
 380        DEV_NO_RESPONSE |         X           |           X           |
 381        INTERRUPTED     |         X           |                       |
 382        QUEUE_FULL      |                     |           X           |
 383        DEVICE_UNKNOWN  |                     |           X           |
 384        SG_ERR          |                     |           X           |
 385   ---------------------+---------------------+-----------------------+
 386  */
 387
 388 enum service_response {
 389         SAS_TASK_COMPLETE,
 390         SAS_TASK_UNDELIVERED = -1,
 391 };
 392
 393 enum exec_status {
 394         SAM_GOOD         = 0,
 395         SAM_CHECK_COND   = 2,
 396         SAM_COND_MET     = 4,
 397         SAM_BUSY         = 8,
 398         SAM_INTERMEDIATE = 0x10,
 399         SAM_IM_COND_MET  = 0x12,
 400         SAM_RESV_CONFLICT= 0x14,
 401         SAM_TASK_SET_FULL= 0x28,
 402         SAM_ACA_ACTIVE   = 0x30,
 403         SAM_TASK_ABORTED = 0x40,
 404
 405         SAS_DEV_NO_RESPONSE = 0x80,
 406         SAS_DATA_UNDERRUN,
 407         SAS_DATA_OVERRUN,
 408         SAS_INTERRUPTED,
 409         SAS_QUEUE_FULL,
 410         SAS_DEVICE_UNKNOWN,
 411         SAS_SG_ERR,
 412         SAS_OPEN_REJECT,
 413         SAS_OPEN_TO,
 414         SAS_PROTO_RESPONSE,
 415         SAS_PHY_DOWN,
 416         SAS_NAK_R_ERR,
 417         SAS_PENDING,
 418         SAS_ABORTED_TASK,
 419 };
 420
 421 /* When a task finishes with a response, the LLDD examines the
 422  * response:
 423  *      - For an ATA task task_status_struct::stat is set to
 424  * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
 425  * contents of struct ata_task_resp.
 426  *      - For SSP tasks, if no data is present or status/TMF response
 427  * is valid, task_status_struct::stat is set.  If data is present
 428  * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
 429  * task_status_struct::buf_valid_size, and task_status_struct::stat is
 430  * set to SAM_CHECK_COND.
 431  *
 432  * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
 433  * for ATA task.
 434  *
 435  * "frame_len" is the total frame length, which could be more or less
 436  * than actually copied.
 437  *
 438  * Tasks ending with response, always set the residual field.
 439  */
 440 struct ata_task_resp {
 441         u16  frame_len;
 442         u8   ending_fis[24];      /* dev to host or data-in */
 443         u32  sstatus;
 444         u32  serror;
 445         u32  scontrol;
 446         u32  sactive;
 447 };
 448
 449 #define SAS_STATUS_BUF_SIZE 96
 450
 451 struct task_status_struct {
 452         enum service_response resp;
 453         enum exec_status      stat;
 454         int  buf_valid_size;
 455
 456         u8   buf[SAS_STATUS_BUF_SIZE];
 457
 458         u32  residual;
 459         enum sas_open_rej_reason open_rej_reason;
 460 };
 461
 462 /* ATA and ATAPI task queuable to a SAS LLDD.
 463  */
 464 struct sas_ata_task {
 465         struct host_to_dev_fis fis;
 466         u8     atapi_packet[16];  /* 0 if not ATAPI task */
 467
 468         u8     retry_count;       /* hardware retry, should be > 0 */
 469
 470         u8     dma_xfer:1;        /* PIO:0 or DMA:1 */
 471         u8     use_ncq:1;
 472         u8     set_affil_pol:1;
 473         u8     stp_affil_pol:1;
 474
 475         u8     device_control_reg_update:1;
 476 };
 477
 478 struct sas_smp_task {
 479         struct scatterlist smp_req;
 480         struct scatterlist smp_resp;
 481 };
 482
 483 enum task_attribute {
 484         TASK_ATTR_SIMPLE = 0,
 485         TASK_ATTR_HOQ    = 1,
 486         TASK_ATTR_ORDERED= 2,
 487         TASK_ATTR_ACA    = 4,
 488 };
 489
 490 struct sas_ssp_task {
 491         u8     retry_count;       /* hardware retry, should be > 0 */
 492
 493         u8     LUN[8];
 494         u8     enable_first_burst:1;
 495         enum   task_attribute task_attr;
 496         u8     task_prio;
 497         u8     cdb[16];
 498 };
 499
 500 struct sas_task {
 501         struct domain_device *dev;
 502         struct list_head      list;
 503
 504         spinlock_t   task_state_lock;
 505         unsigned     task_state_flags;
 506
 507         enum   sas_proto      task_proto;
 508
 509         /* Used by the discovery code. */
 510         struct timer_list     timer;
 511         struct completion     completion;
 512
 513         union {
 514                 struct sas_ata_task ata_task;
 515                 struct sas_smp_task smp_task;
 516                 struct sas_ssp_task ssp_task;
 517         };
 518
 519         struct scatterlist *scatter;
 520         int    num_scatter;
 521         u32    total_xfer_len;
 522         u8     data_dir:2;        /* Use PCI_DMA_... */
 523
 524         struct task_status_struct task_status;
 525         void   (*task_done)(struct sas_task *);
 526
 527         void   *lldd_task;        /* for use by LLDDs */
 528         void   *uldd_task;
 529 };
 530
 531
 532
 533 #define SAS_TASK_STATE_PENDING  1
 534 #define SAS_TASK_STATE_DONE     2
 535 #define SAS_TASK_STATE_ABORTED  4
 536
 537 static inline struct sas_task *sas_alloc_task(gfp_t flags)
 538 {
 539         extern kmem_cache_t *sas_task_cache;
 540         struct sas_task *task = kmem_cache_alloc(sas_task_cache, flags);
 541
 542         if (task) {
 543                 memset(task, 0, sizeof(*task));
 544                 INIT_LIST_HEAD(&task->list);
 545                 spin_lock_init(&task->task_state_lock);
 546                 task->task_state_flags = SAS_TASK_STATE_PENDING;
 547                 init_timer(&task->timer);
 548                 init_completion(&task->completion);
 549         }
 550
 551         return task;
 552 }
 553
 554 static inline void sas_free_task(struct sas_task *task)
 555 {
 556         if (task) {
 557                 extern kmem_cache_t *sas_task_cache;
 558                 BUG_ON(!list_empty(&task->list));
 559                 kmem_cache_free(sas_task_cache, task);
 560         }
 561 }
 562
 563 struct sas_domain_function_template {
 564         /* The class calls these to notify the LLDD of an event. */
 565         void (*lldd_port_formed)(struct asd_sas_phy *);
 566         void (*lldd_port_deformed)(struct asd_sas_phy *);
 567
 568         /* The class calls these when a device is found or gone. */
 569         int  (*lldd_dev_found)(struct domain_device *);
 570         void (*lldd_dev_gone)(struct domain_device *);
 571
 572         int (*lldd_execute_task)(struct sas_task *, int num,
 573                                  gfp_t gfp_flags);
 574
 575         /* Task Management Functions. Must be called from process context. */
 576         int (*lldd_abort_task)(struct sas_task *);
 577         int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
 578         int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
 579         int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
 580         int (*lldd_I_T_nexus_reset)(struct domain_device *);
 581         int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
 582         int (*lldd_query_task)(struct sas_task *);
 583
 584         /* Port and Adapter management */
 585         int (*lldd_clear_nexus_port)(struct asd_sas_port *);
 586         int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
 587
 588         /* Phy management */
 589         int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
 590 };
 591
 592 extern int sas_register_ha(struct sas_ha_struct *);
 593 extern int sas_unregister_ha(struct sas_ha_struct *);
 594
 595 extern int sas_queuecommand(struct scsi_cmnd *,
 596                      void (*scsi_done)(struct scsi_cmnd *));
 597 extern int sas_target_alloc(struct scsi_target *);
 598 extern int sas_slave_alloc(struct scsi_device *);
 599 extern int sas_slave_configure(struct scsi_device *);
 600 extern void sas_slave_destroy(struct scsi_device *);
 601 extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
 602 extern int sas_change_queue_type(struct scsi_device *, int qt);
 603 extern int sas_bios_param(struct scsi_device *,
 604                           struct block_device *,
 605                           sector_t capacity, int *hsc);
 606 extern struct scsi_transport_template *
 607 sas_domain_attach_transport(struct sas_domain_function_template *);
 608 extern void sas_domain_release_transport(struct scsi_transport_template *);
 609
 610 int  sas_discover_root_expander(struct domain_device *);
 611
 612 void sas_init_ex_attr(void);
 613
 614 int  sas_ex_revalidate_domain(struct domain_device *);
 615
 616 void sas_unregister_domain_devices(struct asd_sas_port *port);
 617 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
 618 int  sas_discover_event(struct asd_sas_port *, enum discover_event ev);
 619
 620 int  sas_discover_sata(struct domain_device *);
 621 int  sas_discover_end_dev(struct domain_device *);
 622
 623 void sas_unregister_dev(struct domain_device *);
 624
 625 void sas_init_dev(struct domain_device *);
 626
 627 #endif /* _SASLIB_H_ */