9ccc0365aa896db40bd2ca8b8fb1c4f0df1923ac
[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
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_event {
204         struct work_struct work;
205         struct asd_sas_port *port;
206 };
207
208 struct sas_discovery {
209         spinlock_t disc_event_lock;
210         struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
211         unsigned long    pending;
212         u8     fanout_sas_addr[8];
213         u8     eeds_a[8];
214         u8     eeds_b[8];
215         int    max_level;
216 };
217
218
219 /* The port struct is Class:RW, driver:RO */
220 struct asd_sas_port {
221 /* private: */
222         struct completion port_gone_completion;
223
224         struct sas_discovery disc;
225         struct domain_device *port_dev;
226         spinlock_t dev_list_lock;
227         struct list_head dev_list;
228         enum   sas_linkrate linkrate;
229
230         struct sas_phy *phy;
231         struct work_struct work;
232
233 /* public: */
234         int id;
235
236         enum sas_class   class;
237         u8               sas_addr[SAS_ADDR_SIZE];
238         u8               attached_sas_addr[SAS_ADDR_SIZE];
239         enum sas_proto   iproto;
240         enum sas_proto   tproto;
241
242         enum sas_oob_mode oob_mode;
243
244         spinlock_t       phy_list_lock;
245         struct list_head phy_list;
246         int              num_phys;
247         u32              phy_mask;
248
249         struct sas_ha_struct *ha;
250
251         struct sas_port *port;
252
253         void *lldd_port;          /* not touched by the sas class code */
254 };
255
256 struct asd_sas_event {
257         struct work_struct work;
258         struct asd_sas_phy *phy;
259 };
260
261 /* The phy pretty much is controlled by the LLDD.
262  * The class only reads those fields.
263  */
264 struct asd_sas_phy {
265 /* private: */
266         /* protected by ha->event_lock */
267         struct asd_sas_event   port_events[PORT_NUM_EVENTS];
268         struct asd_sas_event   phy_events[PHY_NUM_EVENTS];
269
270         unsigned long port_events_pending;
271         unsigned long phy_events_pending;
272
273         int error;
274
275         struct sas_phy *phy;
276
277 /* public: */
278         /* The following are class:RO, driver:R/W */
279         int            enabled;   /* must be set */
280
281         int            id;        /* must be set */
282         enum sas_class class;
283         enum sas_proto iproto;
284         enum sas_proto tproto;
285
286         enum sas_phy_type  type;
287         enum sas_phy_role  role;
288         enum sas_oob_mode  oob_mode;
289         enum sas_linkrate linkrate;
290
291         u8   *sas_addr;           /* must be set */
292         u8   attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
293
294         spinlock_t     frame_rcvd_lock;
295         u8             *frame_rcvd; /* must be set */
296         int            frame_rcvd_size;
297
298         spinlock_t     sas_prim_lock;
299         u32            sas_prim;
300
301         struct list_head port_phy_el; /* driver:RO */
302         struct asd_sas_port      *port; /* Class:RW, driver: RO */
303
304         struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
305
306         void *lldd_phy;           /* not touched by the sas_class_code */
307 };
308
309 struct scsi_core {
310         struct Scsi_Host *shost;
311
312         spinlock_t        task_queue_lock;
313         struct list_head  task_queue;
314         int               task_queue_size;
315
316         struct semaphore  queue_thread_sema;
317         int               queue_thread_kill;
318 };
319
320 struct sas_ha_event {
321         struct work_struct work;
322         struct sas_ha_struct *ha;
323 };
324
325 struct sas_ha_struct {
326 /* private: */
327         spinlock_t       event_lock;
328         struct sas_ha_event ha_events[HA_NUM_EVENTS];
329         unsigned long    pending;
330
331         struct scsi_core core;
332
333 /* public: */
334         char *sas_ha_name;
335         struct pci_dev *pcidev;   /* should be set */
336         struct module *lldd_module; /* should be set */
337
338         u8 *sas_addr;             /* must be set */
339         u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
340
341         spinlock_t      phy_port_lock;
342         struct asd_sas_phy  **sas_phy; /* array of valid pointers, must be set */
343         struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
344         int             num_phys; /* must be set, gt 0, static */
345
346         /* The class calls this to send a task for execution. */
347         int lldd_max_execute_num;
348         int lldd_queue_size;
349
350         /* LLDD calls these to notify the class of an event. */
351         void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
352         void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
353         void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
354
355         void *lldd_ha;            /* not touched by sas class code */
356 };
357
358 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
359
360 static inline struct domain_device *
361 starget_to_domain_dev(struct scsi_target *starget) {
362         return starget->hostdata;
363 }
364
365 static inline struct domain_device *
366 sdev_to_domain_dev(struct scsi_device *sdev) {
367         return starget_to_domain_dev(sdev->sdev_target);
368 }
369
370 static inline struct domain_device *
371 cmd_to_domain_dev(struct scsi_cmnd *cmd)
372 {
373         return sdev_to_domain_dev(cmd->device);
374 }
375
376 void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
377
378 /* Before calling a notify event, LLDD should use this function
379  * when the link is severed (possibly from its tasklet).
380  * The idea is that the Class only reads those, while the LLDD,
381  * can R/W these (thus avoiding a race).
382  */
383 static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
384 {
385         phy->oob_mode = OOB_NOT_CONNECTED;
386         phy->linkrate = SAS_LINK_RATE_UNKNOWN;
387 }
388
389 /* ---------- Tasks ---------- */
390 /*
391       service_response |  SAS_TASK_COMPLETE  |  SAS_TASK_UNDELIVERED |
392   exec_status          |                     |                       |
393   ---------------------+---------------------+-----------------------+
394        SAM_...         |         X           |                       |
395        DEV_NO_RESPONSE |         X           |           X           |
396        INTERRUPTED     |         X           |                       |
397        QUEUE_FULL      |                     |           X           |
398        DEVICE_UNKNOWN  |                     |           X           |
399        SG_ERR          |                     |           X           |
400   ---------------------+---------------------+-----------------------+
401  */
402
403 enum service_response {
404         SAS_TASK_COMPLETE,
405         SAS_TASK_UNDELIVERED = -1,
406 };
407
408 enum exec_status {
409         SAM_GOOD         = 0,
410         SAM_CHECK_COND   = 2,
411         SAM_COND_MET     = 4,
412         SAM_BUSY         = 8,
413         SAM_INTERMEDIATE = 0x10,
414         SAM_IM_COND_MET  = 0x12,
415         SAM_RESV_CONFLICT= 0x14,
416         SAM_TASK_SET_FULL= 0x28,
417         SAM_ACA_ACTIVE   = 0x30,
418         SAM_TASK_ABORTED = 0x40,
419
420         SAS_DEV_NO_RESPONSE = 0x80,
421         SAS_DATA_UNDERRUN,
422         SAS_DATA_OVERRUN,
423         SAS_INTERRUPTED,
424         SAS_QUEUE_FULL,
425         SAS_DEVICE_UNKNOWN,
426         SAS_SG_ERR,
427         SAS_OPEN_REJECT,
428         SAS_OPEN_TO,
429         SAS_PROTO_RESPONSE,
430         SAS_PHY_DOWN,
431         SAS_NAK_R_ERR,
432         SAS_PENDING,
433         SAS_ABORTED_TASK,
434 };
435
436 /* When a task finishes with a response, the LLDD examines the
437  * response:
438  *      - For an ATA task task_status_struct::stat is set to
439  * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
440  * contents of struct ata_task_resp.
441  *      - For SSP tasks, if no data is present or status/TMF response
442  * is valid, task_status_struct::stat is set.  If data is present
443  * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
444  * task_status_struct::buf_valid_size, and task_status_struct::stat is
445  * set to SAM_CHECK_COND.
446  *
447  * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
448  * for ATA task.
449  *
450  * "frame_len" is the total frame length, which could be more or less
451  * than actually copied.
452  *
453  * Tasks ending with response, always set the residual field.
454  */
455 struct ata_task_resp {
456         u16  frame_len;
457         u8   ending_fis[24];      /* dev to host or data-in */
458         u32  sstatus;
459         u32  serror;
460         u32  scontrol;
461         u32  sactive;
462 };
463
464 #define SAS_STATUS_BUF_SIZE 96
465
466 struct task_status_struct {
467         enum service_response resp;
468         enum exec_status      stat;
469         int  buf_valid_size;
470
471         u8   buf[SAS_STATUS_BUF_SIZE];
472
473         u32  residual;
474         enum sas_open_rej_reason open_rej_reason;
475 };
476
477 /* ATA and ATAPI task queuable to a SAS LLDD.
478  */
479 struct sas_ata_task {
480         struct host_to_dev_fis fis;
481         u8     atapi_packet[16];  /* 0 if not ATAPI task */
482
483         u8     retry_count;       /* hardware retry, should be > 0 */
484
485         u8     dma_xfer:1;        /* PIO:0 or DMA:1 */
486         u8     use_ncq:1;
487         u8     set_affil_pol:1;
488         u8     stp_affil_pol:1;
489
490         u8     device_control_reg_update:1;
491 };
492
493 struct sas_smp_task {
494         struct scatterlist smp_req;
495         struct scatterlist smp_resp;
496 };
497
498 enum task_attribute {
499         TASK_ATTR_SIMPLE = 0,
500         TASK_ATTR_HOQ    = 1,
501         TASK_ATTR_ORDERED= 2,
502         TASK_ATTR_ACA    = 4,
503 };
504
505 struct sas_ssp_task {
506         u8     retry_count;       /* hardware retry, should be > 0 */
507
508         u8     LUN[8];
509         u8     enable_first_burst:1;
510         enum   task_attribute task_attr;
511         u8     task_prio;
512         u8     cdb[16];
513 };
514
515 struct sas_task {
516         struct domain_device *dev;
517         struct list_head      list;
518
519         spinlock_t   task_state_lock;
520         unsigned     task_state_flags;
521
522         enum   sas_proto      task_proto;
523
524         /* Used by the discovery code. */
525         struct timer_list     timer;
526         struct completion     completion;
527
528         union {
529                 struct sas_ata_task ata_task;
530                 struct sas_smp_task smp_task;
531                 struct sas_ssp_task ssp_task;
532         };
533
534         struct scatterlist *scatter;
535         int    num_scatter;
536         u32    total_xfer_len;
537         u8     data_dir:2;        /* Use PCI_DMA_... */
538
539         struct task_status_struct task_status;
540         void   (*task_done)(struct sas_task *);
541
542         void   *lldd_task;        /* for use by LLDDs */
543         void   *uldd_task;
544 };
545
546
547
548 #define SAS_TASK_STATE_PENDING  1
549 #define SAS_TASK_STATE_DONE     2
550 #define SAS_TASK_STATE_ABORTED  4
551
552 static inline struct sas_task *sas_alloc_task(gfp_t flags)
553 {
554         extern kmem_cache_t *sas_task_cache;
555         struct sas_task *task = kmem_cache_alloc(sas_task_cache, flags);
556
557         if (task) {
558                 memset(task, 0, sizeof(*task));
559                 INIT_LIST_HEAD(&task->list);
560                 spin_lock_init(&task->task_state_lock);
561                 task->task_state_flags = SAS_TASK_STATE_PENDING;
562                 init_timer(&task->timer);
563                 init_completion(&task->completion);
564         }
565
566         return task;
567 }
568
569 static inline void sas_free_task(struct sas_task *task)
570 {
571         if (task) {
572                 extern kmem_cache_t *sas_task_cache;
573                 BUG_ON(!list_empty(&task->list));
574                 kmem_cache_free(sas_task_cache, task);
575         }
576 }
577
578 struct sas_domain_function_template {
579         /* The class calls these to notify the LLDD of an event. */
580         void (*lldd_port_formed)(struct asd_sas_phy *);
581         void (*lldd_port_deformed)(struct asd_sas_phy *);
582
583         /* The class calls these when a device is found or gone. */
584         int  (*lldd_dev_found)(struct domain_device *);
585         void (*lldd_dev_gone)(struct domain_device *);
586
587         int (*lldd_execute_task)(struct sas_task *, int num,
588                                  gfp_t gfp_flags);
589
590         /* Task Management Functions. Must be called from process context. */
591         int (*lldd_abort_task)(struct sas_task *);
592         int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
593         int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
594         int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
595         int (*lldd_I_T_nexus_reset)(struct domain_device *);
596         int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
597         int (*lldd_query_task)(struct sas_task *);
598
599         /* Port and Adapter management */
600         int (*lldd_clear_nexus_port)(struct asd_sas_port *);
601         int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
602
603         /* Phy management */
604         int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
605 };
606
607 extern int sas_register_ha(struct sas_ha_struct *);
608 extern int sas_unregister_ha(struct sas_ha_struct *);
609
610 extern int sas_queuecommand(struct scsi_cmnd *,
611                      void (*scsi_done)(struct scsi_cmnd *));
612 extern int sas_target_alloc(struct scsi_target *);
613 extern int sas_slave_alloc(struct scsi_device *);
614 extern int sas_slave_configure(struct scsi_device *);
615 extern void sas_slave_destroy(struct scsi_device *);
616 extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
617 extern int sas_change_queue_type(struct scsi_device *, int qt);
618 extern int sas_bios_param(struct scsi_device *,
619                           struct block_device *,
620                           sector_t capacity, int *hsc);
621 extern struct scsi_transport_template *
622 sas_domain_attach_transport(struct sas_domain_function_template *);
623 extern void sas_domain_release_transport(struct scsi_transport_template *);
624
625 int  sas_discover_root_expander(struct domain_device *);
626
627 void sas_init_ex_attr(void);
628
629 int  sas_ex_revalidate_domain(struct domain_device *);
630
631 void sas_unregister_domain_devices(struct asd_sas_port *port);
632 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
633 int  sas_discover_event(struct asd_sas_port *, enum discover_event ev);
634
635 int  sas_discover_sata(struct domain_device *);
636 int  sas_discover_end_dev(struct domain_device *);
637
638 void sas_unregister_dev(struct domain_device *);
639
640 void sas_init_dev(struct domain_device *);
641
642 #endif /* _SASLIB_H_ */