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