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