[SCSI] libsas: prevent double completion of scmds from eh
[linux-2.6.git] / 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/libata.h>
34 #include <linux/list.h>
35 #include <scsi/scsi_device.h>
36 #include <scsi/scsi_cmnd.h>
37 #include <scsi/scsi_transport_sas.h>
38 #include <linux/scatterlist.h>
39 #include <linux/slab.h>
40
41 struct block_device;
42
43 enum sas_class {
44         SAS,
45         EXPANDER
46 };
47
48 enum sas_phy_role {
49         PHY_ROLE_NONE = 0,
50         PHY_ROLE_TARGET = 0x40,
51         PHY_ROLE_INITIATOR = 0x80,
52 };
53
54 enum sas_phy_type {
55         PHY_TYPE_PHYSICAL,
56         PHY_TYPE_VIRTUAL
57 };
58
59 /* The events are mnemonically described in sas_dump.c
60  * so when updating/adding events here, please also
61  * update the other file too.
62  */
63 enum ha_event {
64         HAE_RESET             = 0U,
65         HA_NUM_EVENTS         = 1,
66 };
67
68 enum port_event {
69         PORTE_BYTES_DMAED     = 0U,
70         PORTE_BROADCAST_RCVD  = 1,
71         PORTE_LINK_RESET_ERR  = 2,
72         PORTE_TIMER_EVENT     = 3,
73         PORTE_HARD_RESET      = 4,
74         PORT_NUM_EVENTS       = 5,
75 };
76
77 enum phy_event {
78         PHYE_LOSS_OF_SIGNAL   = 0U,
79         PHYE_OOB_DONE         = 1,
80         PHYE_OOB_ERROR        = 2,
81         PHYE_SPINUP_HOLD      = 3, /* hot plug SATA, no COMWAKE sent */
82         PHY_NUM_EVENTS        = 4,
83 };
84
85 enum discover_event {
86         DISCE_DISCOVER_DOMAIN   = 0U,
87         DISCE_REVALIDATE_DOMAIN = 1,
88         DISCE_PORT_GONE         = 2,
89         DISCE_PROBE             = 3,
90         DISCE_DESTRUCT          = 4,
91         DISC_NUM_EVENTS         = 5,
92 };
93
94 /* ---------- Expander Devices ---------- */
95
96 #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
97 #define to_dev_attr(_attr)  container_of(_attr, struct domain_dev_attribute,\
98                                          attr)
99
100 enum routing_attribute {
101         DIRECT_ROUTING,
102         SUBTRACTIVE_ROUTING,
103         TABLE_ROUTING,
104 };
105
106 enum ex_phy_state {
107         PHY_EMPTY,
108         PHY_VACANT,
109         PHY_NOT_PRESENT,
110         PHY_DEVICE_DISCOVERED
111 };
112
113 struct ex_phy {
114         int    phy_id;
115
116         enum ex_phy_state phy_state;
117
118         enum sas_dev_type attached_dev_type;
119         enum sas_linkrate linkrate;
120
121         u8   attached_sata_host:1;
122         u8   attached_sata_dev:1;
123         u8   attached_sata_ps:1;
124
125         enum sas_protocol attached_tproto;
126         enum sas_protocol attached_iproto;
127
128         u8   attached_sas_addr[SAS_ADDR_SIZE];
129         u8   attached_phy_id;
130
131         u8   phy_change_count;
132         enum routing_attribute routing_attr;
133         u8   virtual:1;
134
135         int  last_da_index;
136
137         struct sas_phy *phy;
138         struct sas_port *port;
139 };
140
141 struct expander_device {
142         struct list_head children;
143
144         u16    ex_change_count;
145         u16    max_route_indexes;
146         u8     num_phys;
147
148         u8     t2t_supp:1;
149         u8     configuring:1;
150         u8     conf_route_table:1;
151
152         u8     enclosure_logical_id[8];
153
154         struct ex_phy *ex_phy;
155         struct sas_port *parent_port;
156 };
157
158 /* ---------- SATA device ---------- */
159 enum ata_command_set {
160         ATA_COMMAND_SET   = 0,
161         ATAPI_COMMAND_SET = 1,
162 };
163
164 struct sata_device {
165         enum   ata_command_set command_set;
166         struct smp_resp        rps_resp; /* report_phy_sata_resp */
167         u8     port_no;        /* port number, if this is a PM (Port) */
168         struct list_head children; /* PM Ports if this is a PM */
169
170         struct ata_port *ap;
171         struct ata_host ata_host;
172         struct ata_taskfile tf;
173 };
174
175 enum {
176         SAS_DEV_GONE,
177         SAS_DEV_DESTROY,
178 };
179
180 struct domain_device {
181         enum sas_dev_type dev_type;
182
183         enum sas_linkrate linkrate;
184         enum sas_linkrate min_linkrate;
185         enum sas_linkrate max_linkrate;
186
187         int  pathways;
188
189         struct domain_device *parent;
190         struct list_head siblings; /* devices on the same level */
191         struct asd_sas_port *port;        /* shortcut to root of the tree */
192
193         struct list_head dev_list_node;
194         struct list_head disco_list_node; /* awaiting probe or destruct */
195
196         enum sas_protocol    iproto;
197         enum sas_protocol    tproto;
198
199         struct sas_rphy *rphy;
200
201         u8  sas_addr[SAS_ADDR_SIZE];
202         u8  hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
203
204         u8  frame_rcvd[32];
205
206         union {
207                 struct expander_device ex_dev;
208                 struct sata_device     sata_dev; /* STP & directly attached */
209         };
210
211         void *lldd_dev;
212         unsigned long state;
213         struct kref kref;
214 };
215
216 struct sas_discovery_event {
217         struct work_struct work;
218         struct asd_sas_port *port;
219 };
220
221 struct sas_discovery {
222         struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
223         unsigned long    pending;
224         u8     fanout_sas_addr[8];
225         u8     eeds_a[8];
226         u8     eeds_b[8];
227         int    max_level;
228 };
229
230 /* The port struct is Class:RW, driver:RO */
231 struct asd_sas_port {
232 /* private: */
233         struct completion port_gone_completion;
234
235         struct sas_discovery disc;
236         struct domain_device *port_dev;
237         spinlock_t dev_list_lock;
238         struct list_head dev_list;
239         struct list_head disco_list;
240         struct list_head destroy_list;
241         enum   sas_linkrate linkrate;
242
243         struct sas_phy *phy;
244         struct work_struct work;
245
246 /* public: */
247         int id;
248
249         enum sas_class   class;
250         u8               sas_addr[SAS_ADDR_SIZE];
251         u8               attached_sas_addr[SAS_ADDR_SIZE];
252         enum sas_protocol   iproto;
253         enum sas_protocol   tproto;
254
255         enum sas_oob_mode oob_mode;
256
257         spinlock_t       phy_list_lock;
258         struct list_head phy_list;
259         int              num_phys;
260         u32              phy_mask;
261
262         struct sas_ha_struct *ha;
263
264         struct sas_port *port;
265
266         void *lldd_port;          /* not touched by the sas class code */
267 };
268
269 struct asd_sas_event {
270         struct work_struct work;
271         struct asd_sas_phy *phy;
272 };
273
274 /* The phy pretty much is controlled by the LLDD.
275  * The class only reads those fields.
276  */
277 struct asd_sas_phy {
278 /* private: */
279         struct asd_sas_event   port_events[PORT_NUM_EVENTS];
280         struct asd_sas_event   phy_events[PHY_NUM_EVENTS];
281
282         unsigned long port_events_pending;
283         unsigned long phy_events_pending;
284
285         int error;
286
287         struct sas_phy *phy;
288
289 /* public: */
290         /* The following are class:RO, driver:R/W */
291         int            enabled;   /* must be set */
292
293         int            id;        /* must be set */
294         enum sas_class class;
295         enum sas_protocol iproto;
296         enum sas_protocol tproto;
297
298         enum sas_phy_type  type;
299         enum sas_phy_role  role;
300         enum sas_oob_mode  oob_mode;
301         enum sas_linkrate linkrate;
302
303         u8   *sas_addr;           /* must be set */
304         u8   attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
305
306         spinlock_t     frame_rcvd_lock;
307         u8             *frame_rcvd; /* must be set */
308         int            frame_rcvd_size;
309
310         spinlock_t     sas_prim_lock;
311         u32            sas_prim;
312
313         struct list_head port_phy_el; /* driver:RO */
314         struct asd_sas_port      *port; /* Class:RW, driver: RO */
315
316         struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
317
318         void *lldd_phy;           /* not touched by the sas_class_code */
319 };
320
321 struct scsi_core {
322         struct Scsi_Host *shost;
323
324         spinlock_t        task_queue_lock;
325         struct list_head  task_queue;
326         int               task_queue_size;
327
328         struct task_struct *queue_thread;
329 };
330
331 struct sas_ha_event {
332         struct work_struct work;
333         struct sas_ha_struct *ha;
334 };
335
336 enum sas_ha_state {
337         SAS_HA_REGISTERED,
338         SAS_HA_DRAINING,
339         SAS_HA_ATA_EH_ACTIVE,
340 };
341
342 struct sas_ha_struct {
343 /* private: */
344         struct sas_ha_event ha_events[HA_NUM_EVENTS];
345         unsigned long    pending;
346
347         struct list_head  defer_q; /* work queued while draining */
348         struct mutex      drain_mutex;
349         unsigned long     state;
350         spinlock_t        state_lock;
351
352         struct mutex disco_mutex;
353
354         struct scsi_core core;
355
356 /* public: */
357         char *sas_ha_name;
358         struct device *dev;       /* should be set */
359         struct module *lldd_module; /* should be set */
360
361         u8 *sas_addr;             /* must be set */
362         u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
363
364         spinlock_t      phy_port_lock;
365         struct asd_sas_phy  **sas_phy; /* array of valid pointers, must be set */
366         struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
367         int             num_phys; /* must be set, gt 0, static */
368
369         /* The class calls this to send a task for execution. */
370         int lldd_max_execute_num;
371         int lldd_queue_size;
372         int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
373                                 * their siblings when forming wide ports */
374
375         /* LLDD calls these to notify the class of an event. */
376         void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
377         void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
378         void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
379
380         void *lldd_ha;            /* not touched by sas class code */
381
382         struct list_head eh_done_q;
383 };
384
385 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
386
387 static inline struct domain_device *
388 starget_to_domain_dev(struct scsi_target *starget) {
389         return starget->hostdata;
390 }
391
392 static inline struct domain_device *
393 sdev_to_domain_dev(struct scsi_device *sdev) {
394         return starget_to_domain_dev(sdev->sdev_target);
395 }
396
397 static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
398 {
399         return &dev->sata_dev.ap->link.device[0];
400 }
401
402 static inline struct domain_device *
403 cmd_to_domain_dev(struct scsi_cmnd *cmd)
404 {
405         return sdev_to_domain_dev(cmd->device);
406 }
407
408 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
409
410 /* Before calling a notify event, LLDD should use this function
411  * when the link is severed (possibly from its tasklet).
412  * The idea is that the Class only reads those, while the LLDD,
413  * can R/W these (thus avoiding a race).
414  */
415 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
416 {
417         phy->oob_mode = OOB_NOT_CONNECTED;
418         phy->linkrate = SAS_LINK_RATE_UNKNOWN;
419 }
420
421 static inline unsigned int to_sas_gpio_od(int device, int bit)
422 {
423         return 3 * device + bit;
424 }
425
426 #ifdef CONFIG_SCSI_SAS_HOST_SMP
427 int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
428 #else
429 static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
430 {
431         return -1;
432 }
433 #endif
434
435 /* ---------- Tasks ---------- */
436 /*
437       service_response |  SAS_TASK_COMPLETE  |  SAS_TASK_UNDELIVERED |
438   exec_status          |                     |                       |
439   ---------------------+---------------------+-----------------------+
440        SAM_...         |         X           |                       |
441        DEV_NO_RESPONSE |         X           |           X           |
442        INTERRUPTED     |         X           |                       |
443        QUEUE_FULL      |                     |           X           |
444        DEVICE_UNKNOWN  |                     |           X           |
445        SG_ERR          |                     |           X           |
446   ---------------------+---------------------+-----------------------+
447  */
448
449 enum service_response {
450         SAS_TASK_COMPLETE,
451         SAS_TASK_UNDELIVERED = -1,
452 };
453
454 enum exec_status {
455         /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
456          * them here to silence 'case value not in enumerated type' warnings
457          */
458         __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
459
460         SAS_DEV_NO_RESPONSE = 0x80,
461         SAS_DATA_UNDERRUN,
462         SAS_DATA_OVERRUN,
463         SAS_INTERRUPTED,
464         SAS_QUEUE_FULL,
465         SAS_DEVICE_UNKNOWN,
466         SAS_SG_ERR,
467         SAS_OPEN_REJECT,
468         SAS_OPEN_TO,
469         SAS_PROTO_RESPONSE,
470         SAS_PHY_DOWN,
471         SAS_NAK_R_ERR,
472         SAS_PENDING,
473         SAS_ABORTED_TASK,
474 };
475
476 /* When a task finishes with a response, the LLDD examines the
477  * response:
478  *      - For an ATA task task_status_struct::stat is set to
479  * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
480  * contents of struct ata_task_resp.
481  *      - For SSP tasks, if no data is present or status/TMF response
482  * is valid, task_status_struct::stat is set.  If data is present
483  * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
484  * task_status_struct::buf_valid_size, and task_status_struct::stat is
485  * set to SAM_CHECK_COND.
486  *
487  * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
488  * for ATA task.
489  *
490  * "frame_len" is the total frame length, which could be more or less
491  * than actually copied.
492  *
493  * Tasks ending with response, always set the residual field.
494  */
495 struct ata_task_resp {
496         u16  frame_len;
497         u8   ending_fis[24];      /* dev to host or data-in */
498 };
499
500 #define SAS_STATUS_BUF_SIZE 96
501
502 struct task_status_struct {
503         enum service_response resp;
504         enum exec_status      stat;
505         int  buf_valid_size;
506
507         u8   buf[SAS_STATUS_BUF_SIZE];
508
509         u32  residual;
510         enum sas_open_rej_reason open_rej_reason;
511 };
512
513 /* ATA and ATAPI task queuable to a SAS LLDD.
514  */
515 struct sas_ata_task {
516         struct host_to_dev_fis fis;
517         u8     atapi_packet[16];  /* 0 if not ATAPI task */
518
519         u8     retry_count;       /* hardware retry, should be > 0 */
520
521         u8     dma_xfer:1;        /* PIO:0 or DMA:1 */
522         u8     use_ncq:1;
523         u8     set_affil_pol:1;
524         u8     stp_affil_pol:1;
525
526         u8     device_control_reg_update:1;
527 };
528
529 struct sas_smp_task {
530         struct scatterlist smp_req;
531         struct scatterlist smp_resp;
532 };
533
534 enum task_attribute {
535         TASK_ATTR_SIMPLE = 0,
536         TASK_ATTR_HOQ    = 1,
537         TASK_ATTR_ORDERED= 2,
538         TASK_ATTR_ACA    = 4,
539 };
540
541 struct sas_ssp_task {
542         u8     retry_count;       /* hardware retry, should be > 0 */
543
544         u8     LUN[8];
545         u8     enable_first_burst:1;
546         enum   task_attribute task_attr;
547         u8     task_prio;
548         u8     cdb[16];
549 };
550
551 struct sas_task {
552         struct domain_device *dev;
553         struct list_head      list;
554
555         spinlock_t   task_state_lock;
556         unsigned     task_state_flags;
557
558         enum   sas_protocol      task_proto;
559
560         /* Used by the discovery code. */
561         struct timer_list     timer;
562         struct completion     completion;
563
564         union {
565                 struct sas_ata_task ata_task;
566                 struct sas_smp_task smp_task;
567                 struct sas_ssp_task ssp_task;
568         };
569
570         struct scatterlist *scatter;
571         int    num_scatter;
572         u32    total_xfer_len;
573         u8     data_dir:2;        /* Use PCI_DMA_... */
574
575         struct task_status_struct task_status;
576         void   (*task_done)(struct sas_task *);
577
578         void   *lldd_task;        /* for use by LLDDs */
579         void   *uldd_task;
580
581         struct work_struct abort_work;
582 };
583
584 #define SAS_TASK_STATE_PENDING      1
585 #define SAS_TASK_STATE_DONE         2
586 #define SAS_TASK_STATE_ABORTED      4
587 #define SAS_TASK_NEED_DEV_RESET     8
588 #define SAS_TASK_AT_INITIATOR       16
589
590 extern struct sas_task *sas_alloc_task(gfp_t flags);
591 extern void sas_free_task(struct sas_task *task);
592
593 struct sas_domain_function_template {
594         /* The class calls these to notify the LLDD of an event. */
595         void (*lldd_port_formed)(struct asd_sas_phy *);
596         void (*lldd_port_deformed)(struct asd_sas_phy *);
597
598         /* The class calls these when a device is found or gone. */
599         int  (*lldd_dev_found)(struct domain_device *);
600         void (*lldd_dev_gone)(struct domain_device *);
601
602         int (*lldd_execute_task)(struct sas_task *, int num,
603                                  gfp_t gfp_flags);
604
605         /* Task Management Functions. Must be called from process context. */
606         int (*lldd_abort_task)(struct sas_task *);
607         int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
608         int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
609         int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
610         int (*lldd_I_T_nexus_reset)(struct domain_device *);
611         int (*lldd_ata_soft_reset)(struct domain_device *);
612         void (*lldd_ata_set_dmamode)(struct domain_device *);
613         int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
614         int (*lldd_query_task)(struct sas_task *);
615
616         /* Port and Adapter management */
617         int (*lldd_clear_nexus_port)(struct asd_sas_port *);
618         int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
619
620         /* Phy management */
621         int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
622
623         /* GPIO support */
624         int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
625                                u8 reg_index, u8 reg_count, u8 *write_data);
626 };
627
628 extern int sas_register_ha(struct sas_ha_struct *);
629 extern int sas_unregister_ha(struct sas_ha_struct *);
630
631 int sas_set_phy_speed(struct sas_phy *phy,
632                       struct sas_phy_linkrates *rates);
633 int sas_phy_enable(struct sas_phy *phy, int enabled);
634 int sas_phy_reset(struct sas_phy *phy, int hard_reset);
635 int sas_queue_up(struct sas_task *task);
636 extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
637 extern int sas_target_alloc(struct scsi_target *);
638 extern int sas_slave_alloc(struct scsi_device *);
639 extern int sas_slave_configure(struct scsi_device *);
640 extern int sas_change_queue_depth(struct scsi_device *, int new_depth,
641                                   int reason);
642 extern int sas_change_queue_type(struct scsi_device *, int qt);
643 extern int sas_bios_param(struct scsi_device *,
644                           struct block_device *,
645                           sector_t capacity, int *hsc);
646 extern struct scsi_transport_template *
647 sas_domain_attach_transport(struct sas_domain_function_template *);
648 extern void sas_domain_release_transport(struct scsi_transport_template *);
649
650 int  sas_discover_root_expander(struct domain_device *);
651
652 void sas_init_ex_attr(void);
653
654 int  sas_ex_revalidate_domain(struct domain_device *);
655
656 void sas_unregister_domain_devices(struct asd_sas_port *port);
657 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
658 int  sas_discover_event(struct asd_sas_port *, enum discover_event ev);
659
660 int  sas_discover_sata(struct domain_device *);
661 int  sas_discover_end_dev(struct domain_device *);
662
663 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
664
665 void sas_init_dev(struct domain_device *);
666
667 void sas_task_abort(struct sas_task *);
668 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
669 int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd);
670
671 extern void sas_target_destroy(struct scsi_target *);
672 extern int sas_slave_alloc(struct scsi_device *);
673 extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
674 extern int sas_drain_work(struct sas_ha_struct *ha);
675
676 extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy,
677                            struct request *req);
678
679 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
680                                   struct ssp_response_iu *iu);
681 struct sas_phy *sas_find_local_phy(struct domain_device *dev);
682
683 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
684
685 #endif /* _SASLIB_H_ */