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