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 */
82 PHYE_RESUME_TIMEOUT
= 4,
87 DISCE_DISCOVER_DOMAIN
= 0U,
88 DISCE_REVALIDATE_DOMAIN
= 1,
97 /* ---------- Expander Devices ---------- */
99 #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
100 #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\
103 enum routing_attribute
{
113 PHY_DEVICE_DISCOVERED
119 enum ex_phy_state phy_state
;
121 enum sas_device_type attached_dev_type
;
122 enum sas_linkrate linkrate
;
124 u8 attached_sata_host
:1;
125 u8 attached_sata_dev
:1;
126 u8 attached_sata_ps
:1;
128 enum sas_protocol attached_tproto
;
129 enum sas_protocol attached_iproto
;
131 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
134 int phy_change_count
;
135 enum routing_attribute routing_attr
;
141 struct sas_port
*port
;
144 struct expander_device
{
145 struct list_head children
;
148 u16 max_route_indexes
;
153 u8 conf_route_table
:1;
155 u8 enclosure_logical_id
[8];
157 struct ex_phy
*ex_phy
;
158 struct sas_port
*parent_port
;
160 struct mutex cmd_mutex
;
163 /* ---------- SATA device ---------- */
164 enum ata_command_set
{
166 ATAPI_COMMAND_SET
= 1,
169 #define ATA_RESP_FIS_SIZE 24
172 enum ata_command_set command_set
;
173 struct smp_resp rps_resp
; /* report_phy_sata_resp */
174 u8 port_no
; /* port number, if this is a PM (Port) */
177 struct ata_host ata_host
;
178 u8 fis
[ATA_RESP_FIS_SIZE
];
182 struct list_head eh_list_node
; /* pending a user requested eh action */
183 struct scsi_lun reset_lun
;
188 SAS_DEV_FOUND
, /* device notified to lldd */
195 struct domain_device
{
196 spinlock_t done_lock
;
197 enum sas_device_type dev_type
;
199 enum sas_linkrate linkrate
;
200 enum sas_linkrate min_linkrate
;
201 enum sas_linkrate max_linkrate
;
205 struct domain_device
*parent
;
206 struct list_head siblings
; /* devices on the same level */
207 struct asd_sas_port
*port
; /* shortcut to root of the tree */
210 struct list_head dev_list_node
;
211 struct list_head disco_list_node
; /* awaiting probe or destruct */
213 enum sas_protocol iproto
;
214 enum sas_protocol tproto
;
216 struct sas_rphy
*rphy
;
218 u8 sas_addr
[SAS_ADDR_SIZE
];
219 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
224 struct expander_device ex_dev
;
225 struct sata_device sata_dev
; /* STP & directly attached */
226 struct ssp_device ssp_dev
;
235 struct list_head drain_node
;
236 struct work_struct work
;
239 static inline void INIT_SAS_WORK(struct sas_work
*sw
, void (*fn
)(struct work_struct
*))
241 INIT_WORK(&sw
->work
, fn
);
242 INIT_LIST_HEAD(&sw
->drain_node
);
245 struct sas_discovery_event
{
246 struct sas_work work
;
247 struct asd_sas_port
*port
;
250 static inline struct sas_discovery_event
*to_sas_discovery_event(struct work_struct
*work
)
252 struct sas_discovery_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
257 struct sas_discovery
{
258 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
259 unsigned long pending
;
260 u8 fanout_sas_addr
[8];
266 /* The port struct is Class:RW, driver:RO */
267 struct asd_sas_port
{
269 struct completion port_gone_completion
;
271 struct sas_discovery disc
;
272 struct domain_device
*port_dev
;
273 spinlock_t dev_list_lock
;
274 struct list_head dev_list
;
275 struct list_head disco_list
;
276 struct list_head destroy_list
;
277 enum sas_linkrate linkrate
;
279 struct sas_work work
;
285 enum sas_class
class;
286 u8 sas_addr
[SAS_ADDR_SIZE
];
287 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
288 enum sas_protocol iproto
;
289 enum sas_protocol tproto
;
291 enum sas_oob_mode oob_mode
;
293 spinlock_t phy_list_lock
;
294 struct list_head phy_list
;
298 struct sas_ha_struct
*ha
;
300 struct sas_port
*port
;
302 void *lldd_port
; /* not touched by the sas class code */
305 struct asd_sas_event
{
306 struct sas_work work
;
307 struct asd_sas_phy
*phy
;
310 static inline struct asd_sas_event
*to_asd_sas_event(struct work_struct
*work
)
312 struct asd_sas_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
317 /* The phy pretty much is controlled by the LLDD.
318 * The class only reads those fields.
322 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
323 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
325 unsigned long port_events_pending
;
326 unsigned long phy_events_pending
;
334 /* The following are class:RO, driver:R/W */
335 int enabled
; /* must be set */
337 int id
; /* must be set */
338 enum sas_class
class;
339 enum sas_protocol iproto
;
340 enum sas_protocol tproto
;
342 enum sas_phy_type type
;
343 enum sas_phy_role role
;
344 enum sas_oob_mode oob_mode
;
345 enum sas_linkrate linkrate
;
347 u8
*sas_addr
; /* must be set */
348 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
350 spinlock_t frame_rcvd_lock
;
351 u8
*frame_rcvd
; /* must be set */
354 spinlock_t sas_prim_lock
;
357 struct list_head port_phy_el
; /* driver:RO */
358 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
360 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
362 void *lldd_phy
; /* not touched by the sas_class_code */
366 struct Scsi_Host
*shost
;
368 struct mutex task_queue_flush
;
369 spinlock_t task_queue_lock
;
370 struct list_head task_queue
;
373 struct task_struct
*queue_thread
;
376 struct sas_ha_event
{
377 struct sas_work work
;
378 struct sas_ha_struct
*ha
;
381 static inline struct sas_ha_event
*to_sas_ha_event(struct work_struct
*work
)
383 struct sas_ha_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
391 SAS_HA_ATA_EH_ACTIVE
,
395 struct sas_ha_struct
{
397 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
398 unsigned long pending
;
400 struct list_head defer_q
; /* work queued while draining */
401 struct mutex drain_mutex
;
405 wait_queue_head_t eh_wait_q
;
406 struct list_head eh_dev_q
;
408 struct mutex disco_mutex
;
410 struct scsi_core core
;
414 struct device
*dev
; /* should be set */
415 struct module
*lldd_module
; /* should be set */
417 u8
*sas_addr
; /* must be set */
418 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
420 spinlock_t phy_port_lock
;
421 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
422 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
423 int num_phys
; /* must be set, gt 0, static */
425 /* The class calls this to send a task for execution. */
426 int lldd_max_execute_num
;
428 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
429 * their siblings when forming wide ports */
431 /* LLDD calls these to notify the class of an event. */
432 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
433 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
434 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
436 void *lldd_ha
; /* not touched by sas class code */
438 struct list_head eh_done_q
; /* complete via scsi_eh_flush_done_q */
439 struct list_head eh_ata_q
; /* scmds to promote from sas to ata eh */
442 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
444 static inline struct domain_device
*
445 starget_to_domain_dev(struct scsi_target
*starget
) {
446 return starget
->hostdata
;
449 static inline struct domain_device
*
450 sdev_to_domain_dev(struct scsi_device
*sdev
) {
451 return starget_to_domain_dev(sdev
->sdev_target
);
454 static inline struct ata_device
*sas_to_ata_dev(struct domain_device
*dev
)
456 return &dev
->sata_dev
.ap
->link
.device
[0];
459 static inline struct domain_device
*
460 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
462 return sdev_to_domain_dev(cmd
->device
);
465 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
467 /* Before calling a notify event, LLDD should use this function
468 * when the link is severed (possibly from its tasklet).
469 * The idea is that the Class only reads those, while the LLDD,
470 * can R/W these (thus avoiding a race).
472 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
474 phy
->oob_mode
= OOB_NOT_CONNECTED
;
475 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
478 static inline unsigned int to_sas_gpio_od(int device
, int bit
)
480 return 3 * device
+ bit
;
483 static inline void sas_put_local_phy(struct sas_phy
*phy
)
485 put_device(&phy
->dev
);
488 #ifdef CONFIG_SCSI_SAS_HOST_SMP
489 int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
);
491 static inline int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
)
497 /* ---------- Tasks ---------- */
499 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
501 ---------------------+---------------------+-----------------------+
503 DEV_NO_RESPONSE | X | X |
506 DEVICE_UNKNOWN | | X |
508 ---------------------+---------------------+-----------------------+
511 enum service_response
{
513 SAS_TASK_UNDELIVERED
= -1,
517 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
518 * them here to silence 'case value not in enumerated type' warnings
520 __SAM_STAT_CHECK_CONDITION
= SAM_STAT_CHECK_CONDITION
,
522 SAS_DEV_NO_RESPONSE
= 0x80,
538 /* When a task finishes with a response, the LLDD examines the
540 * - For an ATA task task_status_struct::stat is set to
541 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
542 * contents of struct ata_task_resp.
543 * - For SSP tasks, if no data is present or status/TMF response
544 * is valid, task_status_struct::stat is set. If data is present
545 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
546 * task_status_struct::buf_valid_size, and task_status_struct::stat is
547 * set to SAM_CHECK_COND.
549 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
552 * "frame_len" is the total frame length, which could be more or less
553 * than actually copied.
555 * Tasks ending with response, always set the residual field.
557 struct ata_task_resp
{
559 u8 ending_fis
[ATA_RESP_FIS_SIZE
]; /* dev to host or data-in */
562 #define SAS_STATUS_BUF_SIZE 96
564 struct task_status_struct
{
565 enum service_response resp
;
566 enum exec_status stat
;
569 u8 buf
[SAS_STATUS_BUF_SIZE
];
572 enum sas_open_rej_reason open_rej_reason
;
575 /* ATA and ATAPI task queuable to a SAS LLDD.
577 struct sas_ata_task
{
578 struct host_to_dev_fis fis
;
579 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
581 u8 retry_count
; /* hardware retry, should be > 0 */
583 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
588 u8 device_control_reg_update
:1;
591 struct sas_smp_task
{
592 struct scatterlist smp_req
;
593 struct scatterlist smp_resp
;
596 enum task_attribute
{
597 TASK_ATTR_SIMPLE
= 0,
599 TASK_ATTR_ORDERED
= 2,
603 struct sas_ssp_task
{
604 u8 retry_count
; /* hardware retry, should be > 0 */
607 u8 enable_first_burst
:1;
608 enum task_attribute task_attr
;
610 struct scsi_cmnd
*cmd
;
614 struct domain_device
*dev
;
615 struct list_head list
;
617 spinlock_t task_state_lock
;
618 unsigned task_state_flags
;
620 enum sas_protocol task_proto
;
623 struct sas_ata_task ata_task
;
624 struct sas_smp_task smp_task
;
625 struct sas_ssp_task ssp_task
;
628 struct scatterlist
*scatter
;
631 u8 data_dir
:2; /* Use PCI_DMA_... */
633 struct task_status_struct task_status
;
634 void (*task_done
)(struct sas_task
*);
636 void *lldd_task
; /* for use by LLDDs */
638 struct sas_task_slow
*slow_task
;
641 struct sas_task_slow
{
642 /* standard/extra infrastructure for slow path commands (SMP and
643 * internal lldd commands
645 struct timer_list timer
;
646 struct completion completion
;
649 #define SAS_TASK_STATE_PENDING 1
650 #define SAS_TASK_STATE_DONE 2
651 #define SAS_TASK_STATE_ABORTED 4
652 #define SAS_TASK_NEED_DEV_RESET 8
653 #define SAS_TASK_AT_INITIATOR 16
655 extern struct sas_task
*sas_alloc_task(gfp_t flags
);
656 extern struct sas_task
*sas_alloc_slow_task(gfp_t flags
);
657 extern void sas_free_task(struct sas_task
*task
);
659 struct sas_domain_function_template
{
660 /* The class calls these to notify the LLDD of an event. */
661 void (*lldd_port_formed
)(struct asd_sas_phy
*);
662 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
664 /* The class calls these when a device is found or gone. */
665 int (*lldd_dev_found
)(struct domain_device
*);
666 void (*lldd_dev_gone
)(struct domain_device
*);
668 int (*lldd_execute_task
)(struct sas_task
*, int num
,
671 /* Task Management Functions. Must be called from process context. */
672 int (*lldd_abort_task
)(struct sas_task
*);
673 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
674 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
675 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
676 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
677 int (*lldd_ata_check_ready
)(struct domain_device
*);
678 void (*lldd_ata_set_dmamode
)(struct domain_device
*);
679 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
680 int (*lldd_query_task
)(struct sas_task
*);
682 /* Port and Adapter management */
683 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
684 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
687 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
690 int (*lldd_write_gpio
)(struct sas_ha_struct
*, u8 reg_type
,
691 u8 reg_index
, u8 reg_count
, u8
*write_data
);
694 extern int sas_register_ha(struct sas_ha_struct
*);
695 extern int sas_unregister_ha(struct sas_ha_struct
*);
696 extern void sas_prep_resume_ha(struct sas_ha_struct
*sas_ha
);
697 extern void sas_resume_ha(struct sas_ha_struct
*sas_ha
);
698 extern void sas_suspend_ha(struct sas_ha_struct
*sas_ha
);
700 int sas_set_phy_speed(struct sas_phy
*phy
,
701 struct sas_phy_linkrates
*rates
);
702 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
703 int sas_queue_up(struct sas_task
*task
);
704 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
705 extern int sas_target_alloc(struct scsi_target
*);
706 extern int sas_slave_configure(struct scsi_device
*);
707 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
,
709 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
710 extern int sas_bios_param(struct scsi_device
*,
711 struct block_device
*,
712 sector_t capacity
, int *hsc
);
713 extern struct scsi_transport_template
*
714 sas_domain_attach_transport(struct sas_domain_function_template
*);
715 extern void sas_domain_release_transport(struct scsi_transport_template
*);
717 int sas_discover_root_expander(struct domain_device
*);
719 void sas_init_ex_attr(void);
721 int sas_ex_revalidate_domain(struct domain_device
*);
723 void sas_unregister_domain_devices(struct asd_sas_port
*port
, int gone
);
724 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
725 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
727 int sas_discover_sata(struct domain_device
*);
728 int sas_discover_end_dev(struct domain_device
*);
730 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*);
732 void sas_init_dev(struct domain_device
*);
734 void sas_task_abort(struct sas_task
*);
735 int sas_eh_abort_handler(struct scsi_cmnd
*cmd
);
736 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
737 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
739 extern void sas_target_destroy(struct scsi_target
*);
740 extern int sas_slave_alloc(struct scsi_device
*);
741 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
742 extern int sas_drain_work(struct sas_ha_struct
*ha
);
744 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
745 struct request
*req
);
747 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
748 struct ssp_response_iu
*iu
);
749 struct sas_phy
*sas_get_local_phy(struct domain_device
*dev
);
751 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
753 #endif /* _SASLIB_H_ */