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) */
178 struct ata_host ata_host
;
179 u8 fis
[ATA_RESP_FIS_SIZE
];
183 struct list_head eh_list_node
; /* pending a user requested eh action */
184 struct scsi_lun reset_lun
;
189 SAS_DEV_FOUND
, /* device notified to lldd */
196 struct domain_device
{
197 spinlock_t done_lock
;
198 enum sas_device_type dev_type
;
200 enum sas_linkrate linkrate
;
201 enum sas_linkrate min_linkrate
;
202 enum sas_linkrate max_linkrate
;
206 struct domain_device
*parent
;
207 struct list_head siblings
; /* devices on the same level */
208 struct asd_sas_port
*port
; /* shortcut to root of the tree */
211 struct list_head dev_list_node
;
212 struct list_head disco_list_node
; /* awaiting probe or destruct */
214 enum sas_protocol iproto
;
215 enum sas_protocol tproto
;
217 struct sas_rphy
*rphy
;
219 u8 sas_addr
[SAS_ADDR_SIZE
];
220 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
225 struct expander_device ex_dev
;
226 struct sata_device sata_dev
; /* STP & directly attached */
227 struct ssp_device ssp_dev
;
236 struct list_head drain_node
;
237 struct work_struct work
;
240 static inline void INIT_SAS_WORK(struct sas_work
*sw
, void (*fn
)(struct work_struct
*))
242 INIT_WORK(&sw
->work
, fn
);
243 INIT_LIST_HEAD(&sw
->drain_node
);
246 struct sas_discovery_event
{
247 struct sas_work work
;
248 struct asd_sas_port
*port
;
251 static inline struct sas_discovery_event
*to_sas_discovery_event(struct work_struct
*work
)
253 struct sas_discovery_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
258 struct sas_discovery
{
259 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
260 unsigned long pending
;
261 u8 fanout_sas_addr
[8];
267 /* The port struct is Class:RW, driver:RO */
268 struct asd_sas_port
{
270 struct completion port_gone_completion
;
272 struct sas_discovery disc
;
273 struct domain_device
*port_dev
;
274 spinlock_t dev_list_lock
;
275 struct list_head dev_list
;
276 struct list_head disco_list
;
277 struct list_head destroy_list
;
278 enum sas_linkrate linkrate
;
280 struct sas_work work
;
286 enum sas_class
class;
287 u8 sas_addr
[SAS_ADDR_SIZE
];
288 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
289 enum sas_protocol iproto
;
290 enum sas_protocol tproto
;
292 enum sas_oob_mode oob_mode
;
294 spinlock_t phy_list_lock
;
295 struct list_head phy_list
;
299 struct sas_ha_struct
*ha
;
301 struct sas_port
*port
;
303 void *lldd_port
; /* not touched by the sas class code */
306 struct asd_sas_event
{
307 struct sas_work work
;
308 struct asd_sas_phy
*phy
;
311 static inline struct asd_sas_event
*to_asd_sas_event(struct work_struct
*work
)
313 struct asd_sas_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
318 /* The phy pretty much is controlled by the LLDD.
319 * The class only reads those fields.
323 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
324 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
326 unsigned long port_events_pending
;
327 unsigned long phy_events_pending
;
335 /* The following are class:RO, driver:R/W */
336 int enabled
; /* must be set */
338 int id
; /* must be set */
339 enum sas_class
class;
340 enum sas_protocol iproto
;
341 enum sas_protocol tproto
;
343 enum sas_phy_type type
;
344 enum sas_phy_role role
;
345 enum sas_oob_mode oob_mode
;
346 enum sas_linkrate linkrate
;
348 u8
*sas_addr
; /* must be set */
349 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
351 spinlock_t frame_rcvd_lock
;
352 u8
*frame_rcvd
; /* must be set */
355 spinlock_t sas_prim_lock
;
358 struct list_head port_phy_el
; /* driver:RO */
359 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
361 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
363 void *lldd_phy
; /* not touched by the sas_class_code */
367 struct Scsi_Host
*shost
;
369 struct mutex task_queue_flush
;
370 spinlock_t task_queue_lock
;
371 struct list_head task_queue
;
374 struct task_struct
*queue_thread
;
377 struct sas_ha_event
{
378 struct sas_work work
;
379 struct sas_ha_struct
*ha
;
382 static inline struct sas_ha_event
*to_sas_ha_event(struct work_struct
*work
)
384 struct sas_ha_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
392 SAS_HA_ATA_EH_ACTIVE
,
396 struct sas_ha_struct
{
398 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
399 unsigned long pending
;
401 struct list_head defer_q
; /* work queued while draining */
402 struct mutex drain_mutex
;
406 wait_queue_head_t eh_wait_q
;
407 struct list_head eh_dev_q
;
409 struct mutex disco_mutex
;
411 struct scsi_core core
;
415 struct device
*dev
; /* should be set */
416 struct module
*lldd_module
; /* should be set */
418 u8
*sas_addr
; /* must be set */
419 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
421 spinlock_t phy_port_lock
;
422 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
423 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
424 int num_phys
; /* must be set, gt 0, static */
426 /* The class calls this to send a task for execution. */
427 int lldd_max_execute_num
;
429 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
430 * their siblings when forming wide ports */
432 /* LLDD calls these to notify the class of an event. */
433 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
434 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
435 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
437 void *lldd_ha
; /* not touched by sas class code */
439 struct list_head eh_done_q
; /* complete via scsi_eh_flush_done_q */
440 struct list_head eh_ata_q
; /* scmds to promote from sas to ata eh */
443 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
445 static inline struct domain_device
*
446 starget_to_domain_dev(struct scsi_target
*starget
) {
447 return starget
->hostdata
;
450 static inline struct domain_device
*
451 sdev_to_domain_dev(struct scsi_device
*sdev
) {
452 return starget_to_domain_dev(sdev
->sdev_target
);
455 static inline struct ata_device
*sas_to_ata_dev(struct domain_device
*dev
)
457 return &dev
->sata_dev
.ap
->link
.device
[0];
460 static inline struct domain_device
*
461 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
463 return sdev_to_domain_dev(cmd
->device
);
466 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
468 /* Before calling a notify event, LLDD should use this function
469 * when the link is severed (possibly from its tasklet).
470 * The idea is that the Class only reads those, while the LLDD,
471 * can R/W these (thus avoiding a race).
473 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
475 phy
->oob_mode
= OOB_NOT_CONNECTED
;
476 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
479 static inline unsigned int to_sas_gpio_od(int device
, int bit
)
481 return 3 * device
+ bit
;
484 static inline void sas_put_local_phy(struct sas_phy
*phy
)
486 put_device(&phy
->dev
);
489 #ifdef CONFIG_SCSI_SAS_HOST_SMP
490 int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
);
492 static inline int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
)
498 /* ---------- Tasks ---------- */
500 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
502 ---------------------+---------------------+-----------------------+
504 DEV_NO_RESPONSE | X | X |
507 DEVICE_UNKNOWN | | X |
509 ---------------------+---------------------+-----------------------+
512 enum service_response
{
514 SAS_TASK_UNDELIVERED
= -1,
518 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
519 * them here to silence 'case value not in enumerated type' warnings
521 __SAM_STAT_CHECK_CONDITION
= SAM_STAT_CHECK_CONDITION
,
523 SAS_DEV_NO_RESPONSE
= 0x80,
539 /* When a task finishes with a response, the LLDD examines the
541 * - For an ATA task task_status_struct::stat is set to
542 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
543 * contents of struct ata_task_resp.
544 * - For SSP tasks, if no data is present or status/TMF response
545 * is valid, task_status_struct::stat is set. If data is present
546 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
547 * task_status_struct::buf_valid_size, and task_status_struct::stat is
548 * set to SAM_CHECK_COND.
550 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
553 * "frame_len" is the total frame length, which could be more or less
554 * than actually copied.
556 * Tasks ending with response, always set the residual field.
558 struct ata_task_resp
{
560 u8 ending_fis
[ATA_RESP_FIS_SIZE
]; /* dev to host or data-in */
563 #define SAS_STATUS_BUF_SIZE 96
565 struct task_status_struct
{
566 enum service_response resp
;
567 enum exec_status stat
;
570 u8 buf
[SAS_STATUS_BUF_SIZE
];
573 enum sas_open_rej_reason open_rej_reason
;
576 /* ATA and ATAPI task queuable to a SAS LLDD.
578 struct sas_ata_task
{
579 struct host_to_dev_fis fis
;
580 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
582 u8 retry_count
; /* hardware retry, should be > 0 */
584 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
589 u8 device_control_reg_update
:1;
592 struct sas_smp_task
{
593 struct scatterlist smp_req
;
594 struct scatterlist smp_resp
;
597 enum task_attribute
{
598 TASK_ATTR_SIMPLE
= 0,
600 TASK_ATTR_ORDERED
= 2,
604 struct sas_ssp_task
{
605 u8 retry_count
; /* hardware retry, should be > 0 */
608 u8 enable_first_burst
:1;
609 enum task_attribute task_attr
;
611 struct scsi_cmnd
*cmd
;
615 struct domain_device
*dev
;
616 struct list_head list
;
618 spinlock_t task_state_lock
;
619 unsigned task_state_flags
;
621 enum sas_protocol task_proto
;
624 struct sas_ata_task ata_task
;
625 struct sas_smp_task smp_task
;
626 struct sas_ssp_task ssp_task
;
629 struct scatterlist
*scatter
;
632 u8 data_dir
:2; /* Use PCI_DMA_... */
634 struct task_status_struct task_status
;
635 void (*task_done
)(struct sas_task
*);
637 void *lldd_task
; /* for use by LLDDs */
639 struct sas_task_slow
*slow_task
;
642 struct sas_task_slow
{
643 /* standard/extra infrastructure for slow path commands (SMP and
644 * internal lldd commands
646 struct timer_list timer
;
647 struct completion completion
;
650 #define SAS_TASK_STATE_PENDING 1
651 #define SAS_TASK_STATE_DONE 2
652 #define SAS_TASK_STATE_ABORTED 4
653 #define SAS_TASK_NEED_DEV_RESET 8
654 #define SAS_TASK_AT_INITIATOR 16
656 extern struct sas_task
*sas_alloc_task(gfp_t flags
);
657 extern struct sas_task
*sas_alloc_slow_task(gfp_t flags
);
658 extern void sas_free_task(struct sas_task
*task
);
660 struct sas_domain_function_template
{
661 /* The class calls these to notify the LLDD of an event. */
662 void (*lldd_port_formed
)(struct asd_sas_phy
*);
663 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
665 /* The class calls these when a device is found or gone. */
666 int (*lldd_dev_found
)(struct domain_device
*);
667 void (*lldd_dev_gone
)(struct domain_device
*);
669 int (*lldd_execute_task
)(struct sas_task
*, int num
,
672 /* Task Management Functions. Must be called from process context. */
673 int (*lldd_abort_task
)(struct sas_task
*);
674 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
675 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
676 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
677 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
678 int (*lldd_ata_check_ready
)(struct domain_device
*);
679 void (*lldd_ata_set_dmamode
)(struct domain_device
*);
680 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
681 int (*lldd_query_task
)(struct sas_task
*);
683 /* Port and Adapter management */
684 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
685 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
688 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
691 int (*lldd_write_gpio
)(struct sas_ha_struct
*, u8 reg_type
,
692 u8 reg_index
, u8 reg_count
, u8
*write_data
);
695 extern int sas_register_ha(struct sas_ha_struct
*);
696 extern int sas_unregister_ha(struct sas_ha_struct
*);
697 extern void sas_prep_resume_ha(struct sas_ha_struct
*sas_ha
);
698 extern void sas_resume_ha(struct sas_ha_struct
*sas_ha
);
699 extern void sas_suspend_ha(struct sas_ha_struct
*sas_ha
);
701 int sas_set_phy_speed(struct sas_phy
*phy
,
702 struct sas_phy_linkrates
*rates
);
703 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
704 int sas_queue_up(struct sas_task
*task
);
705 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
706 extern int sas_target_alloc(struct scsi_target
*);
707 extern int sas_slave_configure(struct scsi_device
*);
708 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
,
710 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
711 extern int sas_bios_param(struct scsi_device
*,
712 struct block_device
*,
713 sector_t capacity
, int *hsc
);
714 extern struct scsi_transport_template
*
715 sas_domain_attach_transport(struct sas_domain_function_template
*);
716 extern void sas_domain_release_transport(struct scsi_transport_template
*);
718 int sas_discover_root_expander(struct domain_device
*);
720 void sas_init_ex_attr(void);
722 int sas_ex_revalidate_domain(struct domain_device
*);
724 void sas_unregister_domain_devices(struct asd_sas_port
*port
, int gone
);
725 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
726 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
728 int sas_discover_sata(struct domain_device
*);
729 int sas_discover_end_dev(struct domain_device
*);
731 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*);
733 void sas_init_dev(struct domain_device
*);
735 void sas_task_abort(struct sas_task
*);
736 int sas_eh_abort_handler(struct scsi_cmnd
*cmd
);
737 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
738 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
740 extern void sas_target_destroy(struct scsi_target
*);
741 extern int sas_slave_alloc(struct scsi_device
*);
742 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
743 extern int sas_drain_work(struct sas_ha_struct
*ha
);
745 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
746 struct request
*req
);
748 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
749 struct ssp_response_iu
*iu
);
750 struct sas_phy
*sas_get_local_phy(struct domain_device
*dev
);
752 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
754 #endif /* _SASLIB_H_ */