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.
64 PORTE_BYTES_DMAED
= 0U,
73 PHYE_LOSS_OF_SIGNAL
= 0U,
76 PHYE_SPINUP_HOLD
, /* hot plug SATA, no COMWAKE sent */
83 DISCE_DISCOVER_DOMAIN
= 0U,
84 DISCE_REVALIDATE_DOMAIN
,
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_device_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
];
129 int phy_change_count
;
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
;
148 u8 conf_route_table
:1;
150 u8 enclosure_logical_id
[8];
152 struct ex_phy
*ex_phy
;
153 struct sas_port
*parent_port
;
155 struct mutex cmd_mutex
;
158 /* ---------- SATA device ---------- */
159 #define ATA_RESP_FIS_SIZE 24
163 u8 port_no
; /* port number, if this is a PM (Port) */
166 struct ata_host ata_host
;
167 struct smp_resp rps_resp ____cacheline_aligned
; /* report_phy_sata_resp */
168 u8 fis
[ATA_RESP_FIS_SIZE
];
172 struct list_head eh_list_node
; /* pending a user requested eh action */
173 struct scsi_lun reset_lun
;
178 SAS_DEV_FOUND
, /* device notified to lldd */
185 struct domain_device
{
186 spinlock_t done_lock
;
187 enum sas_device_type dev_type
;
189 enum sas_linkrate linkrate
;
190 enum sas_linkrate min_linkrate
;
191 enum sas_linkrate max_linkrate
;
195 struct domain_device
*parent
;
196 struct list_head siblings
; /* devices on the same level */
197 struct asd_sas_port
*port
; /* shortcut to root of the tree */
200 struct list_head dev_list_node
;
201 struct list_head disco_list_node
; /* awaiting probe or destruct */
203 enum sas_protocol iproto
;
204 enum sas_protocol tproto
;
206 struct sas_rphy
*rphy
;
208 u8 sas_addr
[SAS_ADDR_SIZE
];
209 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
214 struct expander_device ex_dev
;
215 struct sata_device sata_dev
; /* STP & directly attached */
216 struct ssp_device ssp_dev
;
225 struct list_head drain_node
;
226 struct work_struct work
;
229 static inline void INIT_SAS_WORK(struct sas_work
*sw
, void (*fn
)(struct work_struct
*))
231 INIT_WORK(&sw
->work
, fn
);
232 INIT_LIST_HEAD(&sw
->drain_node
);
235 struct sas_discovery_event
{
236 struct sas_work work
;
237 struct asd_sas_port
*port
;
240 static inline struct sas_discovery_event
*to_sas_discovery_event(struct work_struct
*work
)
242 struct sas_discovery_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
247 struct sas_discovery
{
248 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
249 unsigned long pending
;
250 u8 fanout_sas_addr
[8];
256 /* The port struct is Class:RW, driver:RO */
257 struct asd_sas_port
{
259 struct sas_discovery disc
;
260 struct domain_device
*port_dev
;
261 spinlock_t dev_list_lock
;
262 struct list_head dev_list
;
263 struct list_head disco_list
;
264 struct list_head destroy_list
;
265 enum sas_linkrate linkrate
;
267 struct sas_work work
;
273 enum sas_class
class;
274 u8 sas_addr
[SAS_ADDR_SIZE
];
275 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
276 enum sas_protocol iproto
;
277 enum sas_protocol tproto
;
279 enum sas_oob_mode oob_mode
;
281 spinlock_t phy_list_lock
;
282 struct list_head phy_list
;
286 struct sas_ha_struct
*ha
;
288 struct sas_port
*port
;
290 void *lldd_port
; /* not touched by the sas class code */
293 struct asd_sas_event
{
294 struct sas_work work
;
295 struct asd_sas_phy
*phy
;
299 static inline struct asd_sas_event
*to_asd_sas_event(struct work_struct
*work
)
301 struct asd_sas_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
306 static inline void INIT_SAS_EVENT(struct asd_sas_event
*ev
,
307 void (*fn
)(struct work_struct
*),
308 struct asd_sas_phy
*phy
, int event
)
310 INIT_SAS_WORK(&ev
->work
, fn
);
315 #define SAS_PHY_SHUTDOWN_THRES 1024
317 /* The phy pretty much is controlled by the LLDD.
318 * The class only reads those fields.
330 /* The following are class:RO, driver:R/W */
331 int enabled
; /* must be set */
333 int id
; /* must be set */
334 enum sas_class
class;
335 enum sas_protocol iproto
;
336 enum sas_protocol tproto
;
338 enum sas_phy_type type
;
339 enum sas_phy_role role
;
340 enum sas_oob_mode oob_mode
;
341 enum sas_linkrate linkrate
;
343 u8
*sas_addr
; /* must be set */
344 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
346 spinlock_t frame_rcvd_lock
;
347 u8
*frame_rcvd
; /* must be set */
350 spinlock_t sas_prim_lock
;
353 struct list_head port_phy_el
; /* driver:RO */
354 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
356 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
358 void *lldd_phy
; /* not touched by the sas_class_code */
362 struct Scsi_Host
*shost
;
369 SAS_HA_ATA_EH_ACTIVE
,
373 struct sas_ha_struct
{
375 struct list_head defer_q
; /* work queued while draining */
376 struct mutex drain_mutex
;
380 wait_queue_head_t eh_wait_q
;
381 struct list_head eh_dev_q
;
383 struct mutex disco_mutex
;
385 struct scsi_core core
;
389 struct device
*dev
; /* should be set */
390 struct module
*lldd_module
; /* should be set */
392 u8
*sas_addr
; /* must be set */
393 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
395 spinlock_t phy_port_lock
;
396 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
397 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
398 int num_phys
; /* must be set, gt 0, static */
400 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
401 * their siblings when forming wide ports */
403 /* LLDD calls these to notify the class of an event. */
404 int (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
405 int (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
407 void *lldd_ha
; /* not touched by sas class code */
409 struct list_head eh_done_q
; /* complete via scsi_eh_flush_done_q */
410 struct list_head eh_ata_q
; /* scmds to promote from sas to ata eh */
415 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
417 static inline struct domain_device
*
418 starget_to_domain_dev(struct scsi_target
*starget
) {
419 return starget
->hostdata
;
422 static inline struct domain_device
*
423 sdev_to_domain_dev(struct scsi_device
*sdev
) {
424 return starget_to_domain_dev(sdev
->sdev_target
);
427 static inline struct ata_device
*sas_to_ata_dev(struct domain_device
*dev
)
429 return &dev
->sata_dev
.ap
->link
.device
[0];
432 static inline struct domain_device
*
433 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
435 return sdev_to_domain_dev(cmd
->device
);
438 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
440 /* Before calling a notify event, LLDD should use this function
441 * when the link is severed (possibly from its tasklet).
442 * The idea is that the Class only reads those, while the LLDD,
443 * can R/W these (thus avoiding a race).
445 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
447 phy
->oob_mode
= OOB_NOT_CONNECTED
;
448 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
451 static inline unsigned int to_sas_gpio_od(int device
, int bit
)
453 return 3 * device
+ bit
;
456 static inline void sas_put_local_phy(struct sas_phy
*phy
)
458 put_device(&phy
->dev
);
461 #ifdef CONFIG_SCSI_SAS_HOST_SMP
462 int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
);
464 static inline int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
)
470 /* ---------- Tasks ---------- */
472 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
474 ---------------------+---------------------+-----------------------+
476 DEV_NO_RESPONSE | X | X |
479 DEVICE_UNKNOWN | | X |
481 ---------------------+---------------------+-----------------------+
484 enum service_response
{
486 SAS_TASK_UNDELIVERED
= -1,
490 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
491 * them here to silence 'case value not in enumerated type' warnings
493 __SAM_STAT_CHECK_CONDITION
= SAM_STAT_CHECK_CONDITION
,
495 SAS_DEV_NO_RESPONSE
= 0x80,
511 /* When a task finishes with a response, the LLDD examines the
513 * - For an ATA task task_status_struct::stat is set to
514 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
515 * contents of struct ata_task_resp.
516 * - For SSP tasks, if no data is present or status/TMF response
517 * is valid, task_status_struct::stat is set. If data is present
518 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
519 * task_status_struct::buf_valid_size, and task_status_struct::stat is
520 * set to SAM_CHECK_COND.
522 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
525 * "frame_len" is the total frame length, which could be more or less
526 * than actually copied.
528 * Tasks ending with response, always set the residual field.
530 struct ata_task_resp
{
532 u8 ending_fis
[ATA_RESP_FIS_SIZE
]; /* dev to host or data-in */
535 #define SAS_STATUS_BUF_SIZE 96
537 struct task_status_struct
{
538 enum service_response resp
;
539 enum exec_status stat
;
542 u8 buf
[SAS_STATUS_BUF_SIZE
];
545 enum sas_open_rej_reason open_rej_reason
;
548 /* ATA and ATAPI task queuable to a SAS LLDD.
550 struct sas_ata_task
{
551 struct host_to_dev_fis fis
;
552 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
554 u8 retry_count
; /* hardware retry, should be > 0 */
556 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
561 u8 device_control_reg_update
:1;
564 struct sas_smp_task
{
565 struct scatterlist smp_req
;
566 struct scatterlist smp_resp
;
569 enum task_attribute
{
570 TASK_ATTR_SIMPLE
= 0,
572 TASK_ATTR_ORDERED
= 2,
576 struct sas_ssp_task
{
577 u8 retry_count
; /* hardware retry, should be > 0 */
580 u8 enable_first_burst
:1;
581 enum task_attribute task_attr
;
583 struct scsi_cmnd
*cmd
;
587 struct domain_device
*dev
;
589 spinlock_t task_state_lock
;
590 unsigned task_state_flags
;
592 enum sas_protocol task_proto
;
595 struct sas_ata_task ata_task
;
596 struct sas_smp_task smp_task
;
597 struct sas_ssp_task ssp_task
;
600 struct scatterlist
*scatter
;
603 u8 data_dir
:2; /* Use PCI_DMA_... */
605 struct task_status_struct task_status
;
606 void (*task_done
)(struct sas_task
*);
608 void *lldd_task
; /* for use by LLDDs */
610 struct sas_task_slow
*slow_task
;
613 struct sas_task_slow
{
614 /* standard/extra infrastructure for slow path commands (SMP and
615 * internal lldd commands
617 struct timer_list timer
;
618 struct completion completion
;
619 struct sas_task
*task
;
622 #define SAS_TASK_STATE_PENDING 1
623 #define SAS_TASK_STATE_DONE 2
624 #define SAS_TASK_STATE_ABORTED 4
625 #define SAS_TASK_NEED_DEV_RESET 8
626 #define SAS_TASK_AT_INITIATOR 16
628 extern struct sas_task
*sas_alloc_task(gfp_t flags
);
629 extern struct sas_task
*sas_alloc_slow_task(gfp_t flags
);
630 extern void sas_free_task(struct sas_task
*task
);
632 struct sas_domain_function_template
{
633 /* The class calls these to notify the LLDD of an event. */
634 void (*lldd_port_formed
)(struct asd_sas_phy
*);
635 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
637 /* The class calls these when a device is found or gone. */
638 int (*lldd_dev_found
)(struct domain_device
*);
639 void (*lldd_dev_gone
)(struct domain_device
*);
641 int (*lldd_execute_task
)(struct sas_task
*, gfp_t gfp_flags
);
643 /* Task Management Functions. Must be called from process context. */
644 int (*lldd_abort_task
)(struct sas_task
*);
645 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
646 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
647 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
648 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
649 int (*lldd_ata_check_ready
)(struct domain_device
*);
650 void (*lldd_ata_set_dmamode
)(struct domain_device
*);
651 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
652 int (*lldd_query_task
)(struct sas_task
*);
654 /* Port and Adapter management */
655 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
656 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
659 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
662 int (*lldd_write_gpio
)(struct sas_ha_struct
*, u8 reg_type
,
663 u8 reg_index
, u8 reg_count
, u8
*write_data
);
666 extern int sas_register_ha(struct sas_ha_struct
*);
667 extern int sas_unregister_ha(struct sas_ha_struct
*);
668 extern void sas_prep_resume_ha(struct sas_ha_struct
*sas_ha
);
669 extern void sas_resume_ha(struct sas_ha_struct
*sas_ha
);
670 extern void sas_suspend_ha(struct sas_ha_struct
*sas_ha
);
672 int sas_set_phy_speed(struct sas_phy
*phy
,
673 struct sas_phy_linkrates
*rates
);
674 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
675 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
676 extern int sas_target_alloc(struct scsi_target
*);
677 extern int sas_slave_configure(struct scsi_device
*);
678 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
);
679 extern int sas_bios_param(struct scsi_device
*,
680 struct block_device
*,
681 sector_t capacity
, int *hsc
);
682 extern struct scsi_transport_template
*
683 sas_domain_attach_transport(struct sas_domain_function_template
*);
684 extern struct device_attribute dev_attr_phy_event_threshold
;
686 int sas_discover_root_expander(struct domain_device
*);
688 void sas_init_ex_attr(void);
690 int sas_ex_revalidate_domain(struct domain_device
*);
692 void sas_unregister_domain_devices(struct asd_sas_port
*port
, int gone
);
693 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
694 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
696 int sas_discover_sata(struct domain_device
*);
697 int sas_discover_end_dev(struct domain_device
*);
699 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*);
701 void sas_init_dev(struct domain_device
*);
703 void sas_task_abort(struct sas_task
*);
704 int sas_eh_abort_handler(struct scsi_cmnd
*cmd
);
705 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
706 int sas_eh_target_reset_handler(struct scsi_cmnd
*cmd
);
708 extern void sas_target_destroy(struct scsi_target
*);
709 extern int sas_slave_alloc(struct scsi_device
*);
710 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
711 extern int sas_drain_work(struct sas_ha_struct
*ha
);
713 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
714 struct ssp_response_iu
*iu
);
715 struct sas_phy
*sas_get_local_phy(struct domain_device
*dev
);
717 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
719 #endif /* _SASLIB_H_ */