2 * SAS host prototypes and structures header file
4 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
7 * This file is licensed under GPLv2.
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.
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.
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
30 #include <linux/timer.h>
31 #include <linux/pci.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>
50 PHY_ROLE_TARGET
= 0x40,
51 PHY_ROLE_INITIATOR
= 0x80,
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.
69 PORTE_BYTES_DMAED
= 0U,
70 PORTE_BROADCAST_RCVD
= 1,
71 PORTE_LINK_RESET_ERR
= 2,
72 PORTE_TIMER_EVENT
= 3,
78 PHYE_LOSS_OF_SIGNAL
= 0U,
81 PHYE_SPINUP_HOLD
= 3, /* hot plug SATA, no COMWAKE sent */
86 DISCE_DISCOVER_DOMAIN
= 0U,
87 DISCE_REVALIDATE_DOMAIN
= 1,
92 /* ---------- Expander Devices ---------- */
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,\
98 enum routing_attribute
{
108 PHY_DEVICE_DISCOVERED
114 enum ex_phy_state phy_state
;
116 enum sas_dev_type attached_dev_type
;
117 enum sas_linkrate linkrate
;
119 u8 attached_sata_host
:1;
120 u8 attached_sata_dev
:1;
121 u8 attached_sata_ps
:1;
123 enum sas_protocol attached_tproto
;
124 enum sas_protocol attached_iproto
;
126 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
130 enum routing_attribute routing_attr
;
136 struct sas_port
*port
;
139 struct expander_device
{
140 struct list_head children
;
143 u16 max_route_indexes
;
146 u8 conf_route_table
:1;
147 u8 enclosure_logical_id
[8];
149 struct ex_phy
*ex_phy
;
150 struct sas_port
*parent_port
;
153 /* ---------- SATA device ---------- */
154 enum ata_command_set
{
156 ATAPI_COMMAND_SET
= 1,
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
;
165 u8 port_no
; /* port number, if this is a PM (Port) */
166 struct list_head children
; /* PM Ports if this is a PM */
169 struct ata_host ata_host
;
170 struct ata_taskfile tf
;
176 /* ---------- Domain device ---------- */
177 struct domain_device
{
178 enum sas_dev_type dev_type
;
180 enum sas_linkrate linkrate
;
181 enum sas_linkrate min_linkrate
;
182 enum sas_linkrate max_linkrate
;
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 */
190 struct list_head dev_list_node
;
192 enum sas_protocol iproto
;
193 enum sas_protocol tproto
;
195 struct sas_rphy
*rphy
;
197 u8 sas_addr
[SAS_ADDR_SIZE
];
198 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
203 struct expander_device ex_dev
;
204 struct sata_device sata_dev
; /* STP & directly attached */
210 struct sas_discovery_event
{
211 struct work_struct work
;
212 struct asd_sas_port
*port
;
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];
226 /* The port struct is Class:RW, driver:RO */
227 struct asd_sas_port
{
229 struct completion port_gone_completion
;
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
;
238 struct work_struct work
;
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
;
249 enum sas_oob_mode oob_mode
;
251 spinlock_t phy_list_lock
;
252 struct list_head phy_list
;
256 struct sas_ha_struct
*ha
;
258 struct sas_port
*port
;
260 void *lldd_port
; /* not touched by the sas class code */
263 struct asd_sas_event
{
264 struct work_struct work
;
265 struct asd_sas_phy
*phy
;
268 /* The phy pretty much is controlled by the LLDD.
269 * The class only reads those fields.
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
];
277 unsigned long port_events_pending
;
278 unsigned long phy_events_pending
;
285 /* The following are class:RO, driver:R/W */
286 int enabled
; /* must be set */
288 int id
; /* must be set */
289 enum sas_class
class;
290 enum sas_protocol iproto
;
291 enum sas_protocol tproto
;
293 enum sas_phy_type type
;
294 enum sas_phy_role role
;
295 enum sas_oob_mode oob_mode
;
296 enum sas_linkrate linkrate
;
298 u8
*sas_addr
; /* must be set */
299 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
301 spinlock_t frame_rcvd_lock
;
302 u8
*frame_rcvd
; /* must be set */
305 spinlock_t sas_prim_lock
;
308 struct list_head port_phy_el
; /* driver:RO */
309 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
311 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
313 void *lldd_phy
; /* not touched by the sas_class_code */
317 struct Scsi_Host
*shost
;
319 spinlock_t task_queue_lock
;
320 struct list_head task_queue
;
323 struct task_struct
*queue_thread
;
326 struct sas_ha_event
{
327 struct work_struct work
;
328 struct sas_ha_struct
*ha
;
336 struct sas_ha_struct
{
338 spinlock_t event_lock
;
339 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
340 unsigned long pending
;
342 enum sas_ha_state state
;
343 spinlock_t state_lock
;
345 struct scsi_core core
;
349 struct device
*dev
; /* should be set */
350 struct module
*lldd_module
; /* should be set */
352 u8
*sas_addr
; /* must be set */
353 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
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 */
360 /* The class calls this to send a task for execution. */
361 int lldd_max_execute_num
;
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
);
369 void *lldd_ha
; /* not touched by sas class code */
371 struct list_head eh_done_q
;
374 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
376 static inline struct domain_device
*
377 starget_to_domain_dev(struct scsi_target
*starget
) {
378 return starget
->hostdata
;
381 static inline struct domain_device
*
382 sdev_to_domain_dev(struct scsi_device
*sdev
) {
383 return starget_to_domain_dev(sdev
->sdev_target
);
386 static inline struct domain_device
*
387 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
389 return sdev_to_domain_dev(cmd
->device
);
392 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
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).
399 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
401 phy
->oob_mode
= OOB_NOT_CONNECTED
;
402 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
405 /* ---------- Tasks ---------- */
407 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
409 ---------------------+---------------------+-----------------------+
411 DEV_NO_RESPONSE | X | X |
414 DEVICE_UNKNOWN | | X |
416 ---------------------+---------------------+-----------------------+
419 enum service_response
{
421 SAS_TASK_UNDELIVERED
= -1,
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,
436 SAS_DEV_NO_RESPONSE
= 0x80,
452 /* When a task finishes with a response, the LLDD examines the
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.
463 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
466 * "frame_len" is the total frame length, which could be more or less
467 * than actually copied.
469 * Tasks ending with response, always set the residual field.
471 struct ata_task_resp
{
473 u8 ending_fis
[24]; /* dev to host or data-in */
480 #define SAS_STATUS_BUF_SIZE 96
482 struct task_status_struct
{
483 enum service_response resp
;
484 enum exec_status stat
;
487 u8 buf
[SAS_STATUS_BUF_SIZE
];
490 enum sas_open_rej_reason open_rej_reason
;
493 /* ATA and ATAPI task queuable to a SAS LLDD.
495 struct sas_ata_task
{
496 struct host_to_dev_fis fis
;
497 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
499 u8 retry_count
; /* hardware retry, should be > 0 */
501 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
506 u8 device_control_reg_update
:1;
509 struct sas_smp_task
{
510 struct scatterlist smp_req
;
511 struct scatterlist smp_resp
;
514 enum task_attribute
{
515 TASK_ATTR_SIMPLE
= 0,
517 TASK_ATTR_ORDERED
= 2,
521 struct sas_ssp_task
{
522 u8 retry_count
; /* hardware retry, should be > 0 */
525 u8 enable_first_burst
:1;
526 enum task_attribute task_attr
;
532 struct domain_device
*dev
;
533 struct list_head list
;
535 spinlock_t task_state_lock
;
536 unsigned task_state_flags
;
538 enum sas_protocol task_proto
;
540 /* Used by the discovery code. */
541 struct timer_list timer
;
542 struct completion completion
;
545 struct sas_ata_task ata_task
;
546 struct sas_smp_task smp_task
;
547 struct sas_ssp_task ssp_task
;
550 struct scatterlist
*scatter
;
553 u8 data_dir
:2; /* Use PCI_DMA_... */
555 struct task_status_struct task_status
;
556 void (*task_done
)(struct sas_task
*);
558 void *lldd_task
; /* for use by LLDDs */
561 struct work_struct abort_work
;
564 extern struct kmem_cache
*sas_task_cache
;
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
572 static inline struct sas_task
*sas_alloc_task(gfp_t flags
)
574 struct sas_task
*task
= kmem_cache_zalloc(sas_task_cache
, flags
);
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
);
587 static inline void sas_free_task(struct sas_task
*task
)
590 BUG_ON(!list_empty(&task
->list
));
591 kmem_cache_free(sas_task_cache
, task
);
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
*);
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
*);
604 int (*lldd_execute_task
)(struct sas_task
*, int num
,
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
*);
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
*);
621 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
624 extern int sas_register_ha(struct sas_ha_struct
*);
625 extern int sas_unregister_ha(struct sas_ha_struct
*);
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
,
640 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
641 extern int sas_bios_param(struct scsi_device
*,
642 struct block_device
*,
643 sector_t capacity
, int *hsc
);
644 extern struct scsi_transport_template
*
645 sas_domain_attach_transport(struct sas_domain_function_template
*);
646 extern void sas_domain_release_transport(struct scsi_transport_template
*);
648 int sas_discover_root_expander(struct domain_device
*);
650 void sas_init_ex_attr(void);
652 int sas_ex_revalidate_domain(struct domain_device
*);
654 void sas_unregister_domain_devices(struct asd_sas_port
*port
);
655 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
656 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
658 int sas_discover_sata(struct domain_device
*);
659 int sas_discover_end_dev(struct domain_device
*);
661 void sas_unregister_dev(struct domain_device
*);
663 void sas_init_dev(struct domain_device
*);
665 void sas_task_abort(struct sas_task
*);
666 int __sas_task_abort(struct sas_task
*);
667 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
668 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
670 extern void sas_target_destroy(struct scsi_target
*);
671 extern int sas_slave_alloc(struct scsi_device
*);
672 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
674 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
675 struct request
*req
);
677 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
678 struct ssp_response_iu
*iu
);
679 struct sas_phy
*sas_find_local_phy(struct domain_device
*dev
);
681 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
683 #endif /* _SASLIB_H_ */