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