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