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 */
211 struct sas_discovery_event
{
212 struct work_struct work
;
213 struct asd_sas_port
*port
;
216 struct sas_discovery
{
217 spinlock_t disc_event_lock
;
218 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
219 unsigned long pending
;
220 u8 fanout_sas_addr
[8];
227 /* The port struct is Class:RW, driver:RO */
228 struct asd_sas_port
{
230 struct completion port_gone_completion
;
232 struct sas_discovery disc
;
233 struct domain_device
*port_dev
;
234 spinlock_t dev_list_lock
;
235 struct list_head dev_list
;
236 enum sas_linkrate linkrate
;
239 struct work_struct work
;
244 enum sas_class
class;
245 u8 sas_addr
[SAS_ADDR_SIZE
];
246 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
247 enum sas_protocol iproto
;
248 enum sas_protocol tproto
;
250 enum sas_oob_mode oob_mode
;
252 spinlock_t phy_list_lock
;
253 struct list_head phy_list
;
257 struct sas_ha_struct
*ha
;
259 struct sas_port
*port
;
261 void *lldd_port
; /* not touched by the sas class code */
264 struct asd_sas_event
{
265 struct work_struct work
;
266 struct asd_sas_phy
*phy
;
269 /* The phy pretty much is controlled by the LLDD.
270 * The class only reads those fields.
274 /* protected by ha->event_lock */
275 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
276 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
278 unsigned long port_events_pending
;
279 unsigned long phy_events_pending
;
286 /* The following are class:RO, driver:R/W */
287 int enabled
; /* must be set */
289 int id
; /* must be set */
290 enum sas_class
class;
291 enum sas_protocol iproto
;
292 enum sas_protocol tproto
;
294 enum sas_phy_type type
;
295 enum sas_phy_role role
;
296 enum sas_oob_mode oob_mode
;
297 enum sas_linkrate linkrate
;
299 u8
*sas_addr
; /* must be set */
300 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
302 spinlock_t frame_rcvd_lock
;
303 u8
*frame_rcvd
; /* must be set */
306 spinlock_t sas_prim_lock
;
309 struct list_head port_phy_el
; /* driver:RO */
310 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
312 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
314 void *lldd_phy
; /* not touched by the sas_class_code */
318 struct Scsi_Host
*shost
;
320 spinlock_t task_queue_lock
;
321 struct list_head task_queue
;
324 struct task_struct
*queue_thread
;
327 struct sas_ha_event
{
328 struct work_struct work
;
329 struct sas_ha_struct
*ha
;
337 struct sas_ha_struct
{
339 spinlock_t event_lock
;
340 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
341 unsigned long pending
;
343 enum sas_ha_state state
;
344 spinlock_t state_lock
;
346 struct scsi_core core
;
350 struct device
*dev
; /* should be set */
351 struct module
*lldd_module
; /* should be set */
353 u8
*sas_addr
; /* must be set */
354 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
356 spinlock_t phy_port_lock
;
357 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
358 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
359 int num_phys
; /* must be set, gt 0, static */
361 /* The class calls this to send a task for execution. */
362 int lldd_max_execute_num
;
364 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
365 * their siblings when forming wide ports */
367 /* LLDD calls these to notify the class of an event. */
368 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
369 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
370 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
372 void *lldd_ha
; /* not touched by sas class code */
374 struct list_head eh_done_q
;
377 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
379 static inline struct domain_device
*
380 starget_to_domain_dev(struct scsi_target
*starget
) {
381 return starget
->hostdata
;
384 static inline struct domain_device
*
385 sdev_to_domain_dev(struct scsi_device
*sdev
) {
386 return starget_to_domain_dev(sdev
->sdev_target
);
389 static inline struct domain_device
*
390 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
392 return sdev_to_domain_dev(cmd
->device
);
395 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
397 /* Before calling a notify event, LLDD should use this function
398 * when the link is severed (possibly from its tasklet).
399 * The idea is that the Class only reads those, while the LLDD,
400 * can R/W these (thus avoiding a race).
402 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
404 phy
->oob_mode
= OOB_NOT_CONNECTED
;
405 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
408 /* ---------- Tasks ---------- */
410 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
412 ---------------------+---------------------+-----------------------+
414 DEV_NO_RESPONSE | X | X |
417 DEVICE_UNKNOWN | | X |
419 ---------------------+---------------------+-----------------------+
422 enum service_response
{
424 SAS_TASK_UNDELIVERED
= -1,
428 /* The SAM_STAT_.. codes fit in the lower 6 bits */
430 SAS_DEV_NO_RESPONSE
= 0x80,
446 /* When a task finishes with a response, the LLDD examines the
448 * - For an ATA task task_status_struct::stat is set to
449 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
450 * contents of struct ata_task_resp.
451 * - For SSP tasks, if no data is present or status/TMF response
452 * is valid, task_status_struct::stat is set. If data is present
453 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
454 * task_status_struct::buf_valid_size, and task_status_struct::stat is
455 * set to SAM_CHECK_COND.
457 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
460 * "frame_len" is the total frame length, which could be more or less
461 * than actually copied.
463 * Tasks ending with response, always set the residual field.
465 struct ata_task_resp
{
467 u8 ending_fis
[24]; /* dev to host or data-in */
474 #define SAS_STATUS_BUF_SIZE 96
476 struct task_status_struct
{
477 enum service_response resp
;
478 enum exec_status stat
;
481 u8 buf
[SAS_STATUS_BUF_SIZE
];
484 enum sas_open_rej_reason open_rej_reason
;
487 /* ATA and ATAPI task queuable to a SAS LLDD.
489 struct sas_ata_task
{
490 struct host_to_dev_fis fis
;
491 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
493 u8 retry_count
; /* hardware retry, should be > 0 */
495 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
500 u8 device_control_reg_update
:1;
503 struct sas_smp_task
{
504 struct scatterlist smp_req
;
505 struct scatterlist smp_resp
;
508 enum task_attribute
{
509 TASK_ATTR_SIMPLE
= 0,
511 TASK_ATTR_ORDERED
= 2,
515 struct sas_ssp_task
{
516 u8 retry_count
; /* hardware retry, should be > 0 */
519 u8 enable_first_burst
:1;
520 enum task_attribute task_attr
;
526 struct domain_device
*dev
;
527 struct list_head list
;
529 spinlock_t task_state_lock
;
530 unsigned task_state_flags
;
532 enum sas_protocol task_proto
;
534 /* Used by the discovery code. */
535 struct timer_list timer
;
536 struct completion completion
;
539 struct sas_ata_task ata_task
;
540 struct sas_smp_task smp_task
;
541 struct sas_ssp_task ssp_task
;
544 struct scatterlist
*scatter
;
547 u8 data_dir
:2; /* Use PCI_DMA_... */
549 struct task_status_struct task_status
;
550 void (*task_done
)(struct sas_task
*);
552 void *lldd_task
; /* for use by LLDDs */
555 struct work_struct abort_work
;
558 extern struct kmem_cache
*sas_task_cache
;
560 #define SAS_TASK_STATE_PENDING 1
561 #define SAS_TASK_STATE_DONE 2
562 #define SAS_TASK_STATE_ABORTED 4
563 #define SAS_TASK_NEED_DEV_RESET 8
564 #define SAS_TASK_AT_INITIATOR 16
566 static inline struct sas_task
*sas_alloc_task(gfp_t flags
)
568 struct sas_task
*task
= kmem_cache_zalloc(sas_task_cache
, flags
);
571 INIT_LIST_HEAD(&task
->list
);
572 spin_lock_init(&task
->task_state_lock
);
573 task
->task_state_flags
= SAS_TASK_STATE_PENDING
;
574 init_timer(&task
->timer
);
575 init_completion(&task
->completion
);
581 static inline void sas_free_task(struct sas_task
*task
)
584 BUG_ON(!list_empty(&task
->list
));
585 kmem_cache_free(sas_task_cache
, task
);
589 struct sas_domain_function_template
{
590 /* The class calls these to notify the LLDD of an event. */
591 void (*lldd_port_formed
)(struct asd_sas_phy
*);
592 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
594 /* The class calls these when a device is found or gone. */
595 int (*lldd_dev_found
)(struct domain_device
*);
596 void (*lldd_dev_gone
)(struct domain_device
*);
598 int (*lldd_execute_task
)(struct sas_task
*, int num
,
601 /* Task Management Functions. Must be called from process context. */
602 int (*lldd_abort_task
)(struct sas_task
*);
603 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
604 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
605 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
606 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
607 int (*lldd_ata_soft_reset
)(struct domain_device
*);
608 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
609 int (*lldd_query_task
)(struct sas_task
*);
611 /* Port and Adapter management */
612 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
613 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
616 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
619 extern int sas_register_ha(struct sas_ha_struct
*);
620 extern int sas_unregister_ha(struct sas_ha_struct
*);
622 int sas_set_phy_speed(struct sas_phy
*phy
,
623 struct sas_phy_linkrates
*rates
);
624 int sas_phy_enable(struct sas_phy
*phy
, int enabled
);
625 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
626 int sas_queue_up(struct sas_task
*task
);
627 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
628 extern int sas_target_alloc(struct scsi_target
*);
629 extern int sas_slave_alloc(struct scsi_device
*);
630 extern int sas_slave_configure(struct scsi_device
*);
631 extern void sas_slave_destroy(struct scsi_device
*);
632 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
,
634 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
635 extern int sas_bios_param(struct scsi_device
*,
636 struct block_device
*,
637 sector_t capacity
, int *hsc
);
638 extern struct scsi_transport_template
*
639 sas_domain_attach_transport(struct sas_domain_function_template
*);
640 extern void sas_domain_release_transport(struct scsi_transport_template
*);
642 int sas_discover_root_expander(struct domain_device
*);
644 void sas_init_ex_attr(void);
646 int sas_ex_revalidate_domain(struct domain_device
*);
648 void sas_unregister_domain_devices(struct asd_sas_port
*port
);
649 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
650 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
652 int sas_discover_sata(struct domain_device
*);
653 int sas_discover_end_dev(struct domain_device
*);
655 void sas_unregister_dev(struct domain_device
*);
657 void sas_init_dev(struct domain_device
*);
659 void sas_task_abort(struct sas_task
*);
660 int __sas_task_abort(struct sas_task
*);
661 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
662 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
664 extern void sas_target_destroy(struct scsi_target
*);
665 extern int sas_slave_alloc(struct scsi_device
*);
666 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
668 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
669 struct request
*req
);
671 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
672 struct ssp_response_iu
*iu
);
673 struct sas_phy
*sas_find_local_phy(struct domain_device
*dev
);
675 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
677 #endif /* _SASLIB_H_ */