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