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,
94 /* ---------- Expander Devices ---------- */
96 #define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
97 #define to_dev_attr(_attr) container_of(_attr, struct domain_dev_attribute,\
100 enum routing_attribute
{
110 PHY_DEVICE_DISCOVERED
116 enum ex_phy_state phy_state
;
118 enum sas_dev_type attached_dev_type
;
119 enum sas_linkrate linkrate
;
121 u8 attached_sata_host
:1;
122 u8 attached_sata_dev
:1;
123 u8 attached_sata_ps
:1;
125 enum sas_protocol attached_tproto
;
126 enum sas_protocol attached_iproto
;
128 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
132 enum routing_attribute routing_attr
;
138 struct sas_port
*port
;
141 struct expander_device
{
142 struct list_head children
;
145 u16 max_route_indexes
;
150 u8 conf_route_table
:1;
152 u8 enclosure_logical_id
[8];
154 struct ex_phy
*ex_phy
;
155 struct sas_port
*parent_port
;
157 struct mutex cmd_mutex
;
160 /* ---------- SATA device ---------- */
161 enum ata_command_set
{
163 ATAPI_COMMAND_SET
= 1,
166 #define ATA_RESP_FIS_SIZE 24
169 enum ata_command_set command_set
;
170 struct smp_resp rps_resp
; /* report_phy_sata_resp */
171 u8 port_no
; /* port number, if this is a PM (Port) */
174 struct ata_host ata_host
;
175 u8 fis
[ATA_RESP_FIS_SIZE
];
179 struct list_head eh_list_node
; /* pending a user requested eh action */
180 struct scsi_lun reset_lun
;
191 struct domain_device
{
192 spinlock_t done_lock
;
193 enum sas_dev_type dev_type
;
195 enum sas_linkrate linkrate
;
196 enum sas_linkrate min_linkrate
;
197 enum sas_linkrate max_linkrate
;
201 struct domain_device
*parent
;
202 struct list_head siblings
; /* devices on the same level */
203 struct asd_sas_port
*port
; /* shortcut to root of the tree */
206 struct list_head dev_list_node
;
207 struct list_head disco_list_node
; /* awaiting probe or destruct */
209 enum sas_protocol iproto
;
210 enum sas_protocol tproto
;
212 struct sas_rphy
*rphy
;
214 u8 sas_addr
[SAS_ADDR_SIZE
];
215 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
220 struct expander_device ex_dev
;
221 struct sata_device sata_dev
; /* STP & directly attached */
222 struct ssp_device ssp_dev
;
231 struct list_head drain_node
;
232 struct work_struct work
;
235 static inline void INIT_SAS_WORK(struct sas_work
*sw
, void (*fn
)(struct work_struct
*))
237 INIT_WORK(&sw
->work
, fn
);
238 INIT_LIST_HEAD(&sw
->drain_node
);
241 struct sas_discovery_event
{
242 struct sas_work work
;
243 struct asd_sas_port
*port
;
246 static inline struct sas_discovery_event
*to_sas_discovery_event(struct work_struct
*work
)
248 struct sas_discovery_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
253 struct sas_discovery
{
254 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
255 unsigned long pending
;
256 u8 fanout_sas_addr
[8];
262 /* The port struct is Class:RW, driver:RO */
263 struct asd_sas_port
{
265 struct completion port_gone_completion
;
267 struct sas_discovery disc
;
268 struct domain_device
*port_dev
;
269 spinlock_t dev_list_lock
;
270 struct list_head dev_list
;
271 struct list_head disco_list
;
272 struct list_head destroy_list
;
273 enum sas_linkrate linkrate
;
275 struct sas_work work
;
280 enum sas_class
class;
281 u8 sas_addr
[SAS_ADDR_SIZE
];
282 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
283 enum sas_protocol iproto
;
284 enum sas_protocol tproto
;
286 enum sas_oob_mode oob_mode
;
288 spinlock_t phy_list_lock
;
289 struct list_head phy_list
;
293 struct sas_ha_struct
*ha
;
295 struct sas_port
*port
;
297 void *lldd_port
; /* not touched by the sas class code */
300 struct asd_sas_event
{
301 struct sas_work work
;
302 struct asd_sas_phy
*phy
;
305 static inline struct asd_sas_event
*to_asd_sas_event(struct work_struct
*work
)
307 struct asd_sas_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
312 /* The phy pretty much is controlled by the LLDD.
313 * The class only reads those fields.
317 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
318 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
320 unsigned long port_events_pending
;
321 unsigned long phy_events_pending
;
328 /* The following are class:RO, driver:R/W */
329 int enabled
; /* must be set */
331 int id
; /* must be set */
332 enum sas_class
class;
333 enum sas_protocol iproto
;
334 enum sas_protocol tproto
;
336 enum sas_phy_type type
;
337 enum sas_phy_role role
;
338 enum sas_oob_mode oob_mode
;
339 enum sas_linkrate linkrate
;
341 u8
*sas_addr
; /* must be set */
342 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
344 spinlock_t frame_rcvd_lock
;
345 u8
*frame_rcvd
; /* must be set */
348 spinlock_t sas_prim_lock
;
351 struct list_head port_phy_el
; /* driver:RO */
352 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
354 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
356 void *lldd_phy
; /* not touched by the sas_class_code */
360 struct Scsi_Host
*shost
;
362 struct mutex task_queue_flush
;
363 spinlock_t task_queue_lock
;
364 struct list_head task_queue
;
367 struct task_struct
*queue_thread
;
370 struct sas_ha_event
{
371 struct sas_work work
;
372 struct sas_ha_struct
*ha
;
375 static inline struct sas_ha_event
*to_sas_ha_event(struct work_struct
*work
)
377 struct sas_ha_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
385 SAS_HA_ATA_EH_ACTIVE
,
389 struct sas_ha_struct
{
391 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
392 unsigned long pending
;
394 struct list_head defer_q
; /* work queued while draining */
395 struct mutex drain_mutex
;
399 wait_queue_head_t eh_wait_q
;
400 struct list_head eh_dev_q
;
402 struct mutex disco_mutex
;
404 struct scsi_core core
;
408 struct device
*dev
; /* should be set */
409 struct module
*lldd_module
; /* should be set */
411 u8
*sas_addr
; /* must be set */
412 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
414 spinlock_t phy_port_lock
;
415 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
416 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
417 int num_phys
; /* must be set, gt 0, static */
419 /* The class calls this to send a task for execution. */
420 int lldd_max_execute_num
;
422 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
423 * their siblings when forming wide ports */
425 /* LLDD calls these to notify the class of an event. */
426 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
427 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
428 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
430 void *lldd_ha
; /* not touched by sas class code */
432 struct list_head eh_done_q
; /* complete via scsi_eh_flush_done_q */
433 struct list_head eh_ata_q
; /* scmds to promote from sas to ata eh */
436 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
438 static inline struct domain_device
*
439 starget_to_domain_dev(struct scsi_target
*starget
) {
440 return starget
->hostdata
;
443 static inline struct domain_device
*
444 sdev_to_domain_dev(struct scsi_device
*sdev
) {
445 return starget_to_domain_dev(sdev
->sdev_target
);
448 static inline struct ata_device
*sas_to_ata_dev(struct domain_device
*dev
)
450 return &dev
->sata_dev
.ap
->link
.device
[0];
453 static inline struct domain_device
*
454 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
456 return sdev_to_domain_dev(cmd
->device
);
459 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
461 /* Before calling a notify event, LLDD should use this function
462 * when the link is severed (possibly from its tasklet).
463 * The idea is that the Class only reads those, while the LLDD,
464 * can R/W these (thus avoiding a race).
466 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
468 phy
->oob_mode
= OOB_NOT_CONNECTED
;
469 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
472 static inline unsigned int to_sas_gpio_od(int device
, int bit
)
474 return 3 * device
+ bit
;
477 static inline void sas_put_local_phy(struct sas_phy
*phy
)
479 put_device(&phy
->dev
);
482 #ifdef CONFIG_SCSI_SAS_HOST_SMP
483 int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
);
485 static inline int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
)
491 /* ---------- Tasks ---------- */
493 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
495 ---------------------+---------------------+-----------------------+
497 DEV_NO_RESPONSE | X | X |
500 DEVICE_UNKNOWN | | X |
502 ---------------------+---------------------+-----------------------+
505 enum service_response
{
507 SAS_TASK_UNDELIVERED
= -1,
511 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
512 * them here to silence 'case value not in enumerated type' warnings
514 __SAM_STAT_CHECK_CONDITION
= SAM_STAT_CHECK_CONDITION
,
516 SAS_DEV_NO_RESPONSE
= 0x80,
532 /* When a task finishes with a response, the LLDD examines the
534 * - For an ATA task task_status_struct::stat is set to
535 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
536 * contents of struct ata_task_resp.
537 * - For SSP tasks, if no data is present or status/TMF response
538 * is valid, task_status_struct::stat is set. If data is present
539 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
540 * task_status_struct::buf_valid_size, and task_status_struct::stat is
541 * set to SAM_CHECK_COND.
543 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
546 * "frame_len" is the total frame length, which could be more or less
547 * than actually copied.
549 * Tasks ending with response, always set the residual field.
551 struct ata_task_resp
{
553 u8 ending_fis
[ATA_RESP_FIS_SIZE
]; /* dev to host or data-in */
556 #define SAS_STATUS_BUF_SIZE 96
558 struct task_status_struct
{
559 enum service_response resp
;
560 enum exec_status stat
;
563 u8 buf
[SAS_STATUS_BUF_SIZE
];
566 enum sas_open_rej_reason open_rej_reason
;
569 /* ATA and ATAPI task queuable to a SAS LLDD.
571 struct sas_ata_task
{
572 struct host_to_dev_fis fis
;
573 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
575 u8 retry_count
; /* hardware retry, should be > 0 */
577 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
582 u8 device_control_reg_update
:1;
585 struct sas_smp_task
{
586 struct scatterlist smp_req
;
587 struct scatterlist smp_resp
;
590 enum task_attribute
{
591 TASK_ATTR_SIMPLE
= 0,
593 TASK_ATTR_ORDERED
= 2,
597 struct sas_ssp_task
{
598 u8 retry_count
; /* hardware retry, should be > 0 */
601 u8 enable_first_burst
:1;
602 enum task_attribute task_attr
;
608 struct domain_device
*dev
;
609 struct list_head list
;
611 spinlock_t task_state_lock
;
612 unsigned task_state_flags
;
614 enum sas_protocol task_proto
;
617 struct sas_ata_task ata_task
;
618 struct sas_smp_task smp_task
;
619 struct sas_ssp_task ssp_task
;
622 struct scatterlist
*scatter
;
625 u8 data_dir
:2; /* Use PCI_DMA_... */
627 struct task_status_struct task_status
;
628 void (*task_done
)(struct sas_task
*);
630 void *lldd_task
; /* for use by LLDDs */
632 struct sas_task_slow
*slow_task
;
635 struct sas_task_slow
{
636 /* standard/extra infrastructure for slow path commands (SMP and
637 * internal lldd commands
639 struct timer_list timer
;
640 struct completion completion
;
643 #define SAS_TASK_STATE_PENDING 1
644 #define SAS_TASK_STATE_DONE 2
645 #define SAS_TASK_STATE_ABORTED 4
646 #define SAS_TASK_NEED_DEV_RESET 8
647 #define SAS_TASK_AT_INITIATOR 16
649 extern struct sas_task
*sas_alloc_task(gfp_t flags
);
650 extern struct sas_task
*sas_alloc_slow_task(gfp_t flags
);
651 extern void sas_free_task(struct sas_task
*task
);
653 struct sas_domain_function_template
{
654 /* The class calls these to notify the LLDD of an event. */
655 void (*lldd_port_formed
)(struct asd_sas_phy
*);
656 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
658 /* The class calls these when a device is found or gone. */
659 int (*lldd_dev_found
)(struct domain_device
*);
660 void (*lldd_dev_gone
)(struct domain_device
*);
662 int (*lldd_execute_task
)(struct sas_task
*, int num
,
665 /* Task Management Functions. Must be called from process context. */
666 int (*lldd_abort_task
)(struct sas_task
*);
667 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
668 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
669 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
670 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
671 int (*lldd_ata_check_ready
)(struct domain_device
*);
672 void (*lldd_ata_set_dmamode
)(struct domain_device
*);
673 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
674 int (*lldd_query_task
)(struct sas_task
*);
676 /* Port and Adapter management */
677 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
678 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
681 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
684 int (*lldd_write_gpio
)(struct sas_ha_struct
*, u8 reg_type
,
685 u8 reg_index
, u8 reg_count
, u8
*write_data
);
688 extern int sas_register_ha(struct sas_ha_struct
*);
689 extern int sas_unregister_ha(struct sas_ha_struct
*);
691 int sas_set_phy_speed(struct sas_phy
*phy
,
692 struct sas_phy_linkrates
*rates
);
693 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
694 int sas_queue_up(struct sas_task
*task
);
695 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
696 extern int sas_target_alloc(struct scsi_target
*);
697 extern int sas_slave_configure(struct scsi_device
*);
698 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
,
700 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
701 extern int sas_bios_param(struct scsi_device
*,
702 struct block_device
*,
703 sector_t capacity
, int *hsc
);
704 extern struct scsi_transport_template
*
705 sas_domain_attach_transport(struct sas_domain_function_template
*);
706 extern void sas_domain_release_transport(struct scsi_transport_template
*);
708 int sas_discover_root_expander(struct domain_device
*);
710 void sas_init_ex_attr(void);
712 int sas_ex_revalidate_domain(struct domain_device
*);
714 void sas_unregister_domain_devices(struct asd_sas_port
*port
, int gone
);
715 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
716 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
718 int sas_discover_sata(struct domain_device
*);
719 int sas_discover_end_dev(struct domain_device
*);
721 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*);
723 void sas_init_dev(struct domain_device
*);
725 void sas_task_abort(struct sas_task
*);
726 int sas_eh_abort_handler(struct scsi_cmnd
*cmd
);
727 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
728 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
730 extern void sas_target_destroy(struct scsi_target
*);
731 extern int sas_slave_alloc(struct scsi_device
*);
732 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
733 extern int sas_drain_work(struct sas_ha_struct
*ha
);
735 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
736 struct request
*req
);
738 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
739 struct ssp_response_iu
*iu
);
740 struct sas_phy
*sas_get_local_phy(struct domain_device
*dev
);
742 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
744 #endif /* _SASLIB_H_ */