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