[SCSI] libsas: prevent domain rediscovery competing with ata error handling
[deliverable/linux.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 __le16 *identify_device;
168 __le16 *identify_packet_device;
169
170 u8 port_no; /* port number, if this is a PM (Port) */
171 struct list_head children; /* PM Ports if this is a PM */
172
173 struct ata_port *ap;
174 struct ata_host ata_host;
175 struct ata_taskfile tf;
176 };
177
178 enum {
179 SAS_DEV_GONE,
180 SAS_DEV_DESTROY,
181 };
182
183 struct domain_device {
184 enum sas_dev_type dev_type;
185
186 enum sas_linkrate linkrate;
187 enum sas_linkrate min_linkrate;
188 enum sas_linkrate max_linkrate;
189
190 int pathways;
191
192 struct domain_device *parent;
193 struct list_head siblings; /* devices on the same level */
194 struct asd_sas_port *port; /* shortcut to root of the tree */
195
196 struct list_head dev_list_node;
197 struct list_head disco_list_node; /* awaiting probe or destruct */
198
199 enum sas_protocol iproto;
200 enum sas_protocol tproto;
201
202 struct sas_rphy *rphy;
203
204 u8 sas_addr[SAS_ADDR_SIZE];
205 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
206
207 u8 frame_rcvd[32];
208
209 union {
210 struct expander_device ex_dev;
211 struct sata_device sata_dev; /* STP & directly attached */
212 };
213
214 void *lldd_dev;
215 unsigned long state;
216 struct kref kref;
217 };
218
219 struct sas_discovery_event {
220 struct work_struct work;
221 struct asd_sas_port *port;
222 };
223
224 struct sas_discovery {
225 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
226 unsigned long pending;
227 u8 fanout_sas_addr[8];
228 u8 eeds_a[8];
229 u8 eeds_b[8];
230 int max_level;
231 };
232
233 /* The port struct is Class:RW, driver:RO */
234 struct asd_sas_port {
235 /* private: */
236 struct completion port_gone_completion;
237
238 struct sas_discovery disc;
239 struct domain_device *port_dev;
240 spinlock_t dev_list_lock;
241 struct list_head dev_list;
242 struct list_head disco_list;
243 struct list_head destroy_list;
244 enum sas_linkrate linkrate;
245
246 struct sas_phy *phy;
247 struct work_struct work;
248
249 /* public: */
250 int id;
251
252 enum sas_class class;
253 u8 sas_addr[SAS_ADDR_SIZE];
254 u8 attached_sas_addr[SAS_ADDR_SIZE];
255 enum sas_protocol iproto;
256 enum sas_protocol tproto;
257
258 enum sas_oob_mode oob_mode;
259
260 spinlock_t phy_list_lock;
261 struct list_head phy_list;
262 int num_phys;
263 u32 phy_mask;
264
265 struct sas_ha_struct *ha;
266
267 struct sas_port *port;
268
269 void *lldd_port; /* not touched by the sas class code */
270 };
271
272 struct asd_sas_event {
273 struct work_struct work;
274 struct asd_sas_phy *phy;
275 };
276
277 /* The phy pretty much is controlled by the LLDD.
278 * The class only reads those fields.
279 */
280 struct asd_sas_phy {
281 /* private: */
282 struct asd_sas_event port_events[PORT_NUM_EVENTS];
283 struct asd_sas_event phy_events[PHY_NUM_EVENTS];
284
285 unsigned long port_events_pending;
286 unsigned long phy_events_pending;
287
288 int error;
289
290 struct sas_phy *phy;
291
292 /* public: */
293 /* The following are class:RO, driver:R/W */
294 int enabled; /* must be set */
295
296 int id; /* must be set */
297 enum sas_class class;
298 enum sas_protocol iproto;
299 enum sas_protocol tproto;
300
301 enum sas_phy_type type;
302 enum sas_phy_role role;
303 enum sas_oob_mode oob_mode;
304 enum sas_linkrate linkrate;
305
306 u8 *sas_addr; /* must be set */
307 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
308
309 spinlock_t frame_rcvd_lock;
310 u8 *frame_rcvd; /* must be set */
311 int frame_rcvd_size;
312
313 spinlock_t sas_prim_lock;
314 u32 sas_prim;
315
316 struct list_head port_phy_el; /* driver:RO */
317 struct asd_sas_port *port; /* Class:RW, driver: RO */
318
319 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
320
321 void *lldd_phy; /* not touched by the sas_class_code */
322 };
323
324 struct scsi_core {
325 struct Scsi_Host *shost;
326
327 spinlock_t task_queue_lock;
328 struct list_head task_queue;
329 int task_queue_size;
330
331 struct task_struct *queue_thread;
332 };
333
334 struct sas_ha_event {
335 struct work_struct work;
336 struct sas_ha_struct *ha;
337 };
338
339 enum sas_ha_state {
340 SAS_HA_REGISTERED,
341 SAS_HA_DRAINING,
342 SAS_HA_ATA_EH_ACTIVE,
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 */
459
460 SAS_DEV_NO_RESPONSE = 0x80,
461 SAS_DATA_UNDERRUN,
462 SAS_DATA_OVERRUN,
463 SAS_INTERRUPTED,
464 SAS_QUEUE_FULL,
465 SAS_DEVICE_UNKNOWN,
466 SAS_SG_ERR,
467 SAS_OPEN_REJECT,
468 SAS_OPEN_TO,
469 SAS_PROTO_RESPONSE,
470 SAS_PHY_DOWN,
471 SAS_NAK_R_ERR,
472 SAS_PENDING,
473 SAS_ABORTED_TASK,
474 };
475
476 /* When a task finishes with a response, the LLDD examines the
477 * response:
478 * - For an ATA task task_status_struct::stat is set to
479 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
480 * contents of struct ata_task_resp.
481 * - For SSP tasks, if no data is present or status/TMF response
482 * is valid, task_status_struct::stat is set. If data is present
483 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
484 * task_status_struct::buf_valid_size, and task_status_struct::stat is
485 * set to SAM_CHECK_COND.
486 *
487 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
488 * for ATA task.
489 *
490 * "frame_len" is the total frame length, which could be more or less
491 * than actually copied.
492 *
493 * Tasks ending with response, always set the residual field.
494 */
495 struct ata_task_resp {
496 u16 frame_len;
497 u8 ending_fis[24]; /* dev to host or data-in */
498 };
499
500 #define SAS_STATUS_BUF_SIZE 96
501
502 struct task_status_struct {
503 enum service_response resp;
504 enum exec_status stat;
505 int buf_valid_size;
506
507 u8 buf[SAS_STATUS_BUF_SIZE];
508
509 u32 residual;
510 enum sas_open_rej_reason open_rej_reason;
511 };
512
513 /* ATA and ATAPI task queuable to a SAS LLDD.
514 */
515 struct sas_ata_task {
516 struct host_to_dev_fis fis;
517 u8 atapi_packet[16]; /* 0 if not ATAPI task */
518
519 u8 retry_count; /* hardware retry, should be > 0 */
520
521 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
522 u8 use_ncq:1;
523 u8 set_affil_pol:1;
524 u8 stp_affil_pol:1;
525
526 u8 device_control_reg_update:1;
527 };
528
529 struct sas_smp_task {
530 struct scatterlist smp_req;
531 struct scatterlist smp_resp;
532 };
533
534 enum task_attribute {
535 TASK_ATTR_SIMPLE = 0,
536 TASK_ATTR_HOQ = 1,
537 TASK_ATTR_ORDERED= 2,
538 TASK_ATTR_ACA = 4,
539 };
540
541 struct sas_ssp_task {
542 u8 retry_count; /* hardware retry, should be > 0 */
543
544 u8 LUN[8];
545 u8 enable_first_burst:1;
546 enum task_attribute task_attr;
547 u8 task_prio;
548 u8 cdb[16];
549 };
550
551 struct sas_task {
552 struct domain_device *dev;
553 struct list_head list;
554
555 spinlock_t task_state_lock;
556 unsigned task_state_flags;
557
558 enum sas_protocol task_proto;
559
560 /* Used by the discovery code. */
561 struct timer_list timer;
562 struct completion completion;
563
564 union {
565 struct sas_ata_task ata_task;
566 struct sas_smp_task smp_task;
567 struct sas_ssp_task ssp_task;
568 };
569
570 struct scatterlist *scatter;
571 int num_scatter;
572 u32 total_xfer_len;
573 u8 data_dir:2; /* Use PCI_DMA_... */
574
575 struct task_status_struct task_status;
576 void (*task_done)(struct sas_task *);
577
578 void *lldd_task; /* for use by LLDDs */
579 void *uldd_task;
580
581 struct work_struct abort_work;
582 };
583
584 #define SAS_TASK_STATE_PENDING 1
585 #define SAS_TASK_STATE_DONE 2
586 #define SAS_TASK_STATE_ABORTED 4
587 #define SAS_TASK_NEED_DEV_RESET 8
588 #define SAS_TASK_AT_INITIATOR 16
589
590 extern struct sas_task *sas_alloc_task(gfp_t flags);
591 extern void sas_free_task(struct sas_task *task);
592
593 struct sas_domain_function_template {
594 /* The class calls these to notify the LLDD of an event. */
595 void (*lldd_port_formed)(struct asd_sas_phy *);
596 void (*lldd_port_deformed)(struct asd_sas_phy *);
597
598 /* The class calls these when a device is found or gone. */
599 int (*lldd_dev_found)(struct domain_device *);
600 void (*lldd_dev_gone)(struct domain_device *);
601
602 int (*lldd_execute_task)(struct sas_task *, int num,
603 gfp_t gfp_flags);
604
605 /* Task Management Functions. Must be called from process context. */
606 int (*lldd_abort_task)(struct sas_task *);
607 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
608 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
609 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
610 int (*lldd_I_T_nexus_reset)(struct domain_device *);
611 int (*lldd_ata_soft_reset)(struct domain_device *);
612 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
613 int (*lldd_query_task)(struct sas_task *);
614
615 /* Port and Adapter management */
616 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
617 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
618
619 /* Phy management */
620 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
621
622 /* GPIO support */
623 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
624 u8 reg_index, u8 reg_count, u8 *write_data);
625 };
626
627 extern int sas_register_ha(struct sas_ha_struct *);
628 extern int sas_unregister_ha(struct sas_ha_struct *);
629
630 int sas_set_phy_speed(struct sas_phy *phy,
631 struct sas_phy_linkrates *rates);
632 int sas_phy_enable(struct sas_phy *phy, int enabled);
633 int sas_phy_reset(struct sas_phy *phy, int hard_reset);
634 int sas_queue_up(struct sas_task *task);
635 extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
636 extern int sas_target_alloc(struct scsi_target *);
637 extern int sas_slave_alloc(struct scsi_device *);
638 extern int sas_slave_configure(struct scsi_device *);
639 extern int sas_change_queue_depth(struct scsi_device *, int new_depth,
640 int reason);
641 extern int sas_change_queue_type(struct scsi_device *, int qt);
642 extern int sas_bios_param(struct scsi_device *,
643 struct block_device *,
644 sector_t capacity, int *hsc);
645 extern struct scsi_transport_template *
646 sas_domain_attach_transport(struct sas_domain_function_template *);
647 extern void sas_domain_release_transport(struct scsi_transport_template *);
648
649 int sas_discover_root_expander(struct domain_device *);
650
651 void sas_init_ex_attr(void);
652
653 int sas_ex_revalidate_domain(struct domain_device *);
654
655 void sas_unregister_domain_devices(struct asd_sas_port *port);
656 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
657 int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
658
659 int sas_discover_sata(struct domain_device *);
660 int sas_discover_end_dev(struct domain_device *);
661
662 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
663
664 void sas_init_dev(struct domain_device *);
665
666 void sas_task_abort(struct sas_task *);
667 int __sas_task_abort(struct sas_task *);
668 int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
669 int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd);
670
671 extern void sas_target_destroy(struct scsi_target *);
672 extern int sas_slave_alloc(struct scsi_device *);
673 extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
674 extern int sas_drain_work(struct sas_ha_struct *ha);
675
676 extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy,
677 struct request *req);
678
679 extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
680 struct ssp_response_iu *iu);
681 struct sas_phy *sas_find_local_phy(struct domain_device *dev);
682
683 int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
684
685 #endif /* _SASLIB_H_ */
This page took 0.043587 seconds and 6 git commands to generate.