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
;
158 /* ---------- SATA device ---------- */
159 enum ata_command_set
{
161 ATAPI_COMMAND_SET
= 1,
165 enum ata_command_set command_set
;
166 struct smp_resp rps_resp
; /* report_phy_sata_resp */
167 __le16
*identify_device
;
168 __le16
*identify_packet_device
;
170 u8 port_no
; /* port number, if this is a PM (Port) */
171 struct list_head children
; /* PM Ports if this is a PM */
174 struct ata_host ata_host
;
175 struct ata_taskfile tf
;
183 struct domain_device
{
184 enum sas_dev_type dev_type
;
186 enum sas_linkrate linkrate
;
187 enum sas_linkrate min_linkrate
;
188 enum sas_linkrate max_linkrate
;
192 struct domain_device
*parent
;
193 struct list_head siblings
; /* devices on the same level */
194 struct asd_sas_port
*port
; /* shortcut to root of the tree */
196 struct list_head dev_list_node
;
197 struct list_head disco_list_node
; /* awaiting probe or destruct */
199 enum sas_protocol iproto
;
200 enum sas_protocol tproto
;
202 struct sas_rphy
*rphy
;
204 u8 sas_addr
[SAS_ADDR_SIZE
];
205 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
210 struct expander_device ex_dev
;
211 struct sata_device sata_dev
; /* STP & directly attached */
219 struct sas_discovery_event
{
220 struct work_struct work
;
221 struct asd_sas_port
*port
;
224 struct sas_discovery
{
225 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
226 unsigned long pending
;
227 u8 fanout_sas_addr
[8];
233 /* The port struct is Class:RW, driver:RO */
234 struct asd_sas_port
{
236 struct completion port_gone_completion
;
238 struct sas_discovery disc
;
239 struct domain_device
*port_dev
;
240 spinlock_t dev_list_lock
;
241 struct list_head dev_list
;
242 struct list_head disco_list
;
243 struct list_head destroy_list
;
244 enum sas_linkrate linkrate
;
247 struct work_struct work
;
252 enum sas_class
class;
253 u8 sas_addr
[SAS_ADDR_SIZE
];
254 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
255 enum sas_protocol iproto
;
256 enum sas_protocol tproto
;
258 enum sas_oob_mode oob_mode
;
260 spinlock_t phy_list_lock
;
261 struct list_head phy_list
;
265 struct sas_ha_struct
*ha
;
267 struct sas_port
*port
;
269 void *lldd_port
; /* not touched by the sas class code */
272 struct asd_sas_event
{
273 struct work_struct work
;
274 struct asd_sas_phy
*phy
;
277 /* The phy pretty much is controlled by the LLDD.
278 * The class only reads those fields.
282 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
283 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
285 unsigned long port_events_pending
;
286 unsigned long phy_events_pending
;
293 /* The following are class:RO, driver:R/W */
294 int enabled
; /* must be set */
296 int id
; /* must be set */
297 enum sas_class
class;
298 enum sas_protocol iproto
;
299 enum sas_protocol tproto
;
301 enum sas_phy_type type
;
302 enum sas_phy_role role
;
303 enum sas_oob_mode oob_mode
;
304 enum sas_linkrate linkrate
;
306 u8
*sas_addr
; /* must be set */
307 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
309 spinlock_t frame_rcvd_lock
;
310 u8
*frame_rcvd
; /* must be set */
313 spinlock_t sas_prim_lock
;
316 struct list_head port_phy_el
; /* driver:RO */
317 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
319 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
321 void *lldd_phy
; /* not touched by the sas_class_code */
325 struct Scsi_Host
*shost
;
327 spinlock_t task_queue_lock
;
328 struct list_head task_queue
;
331 struct task_struct
*queue_thread
;
334 struct sas_ha_event
{
335 struct work_struct work
;
336 struct sas_ha_struct
*ha
;
342 SAS_HA_ATA_EH_ACTIVE
,
345 struct sas_ha_struct
{
347 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
348 unsigned long pending
;
350 struct list_head defer_q
; /* work queued while draining */
351 struct mutex drain_mutex
;
353 spinlock_t state_lock
;
355 struct mutex disco_mutex
;
357 struct scsi_core core
;
361 struct device
*dev
; /* should be set */
362 struct module
*lldd_module
; /* should be set */
364 u8
*sas_addr
; /* must be set */
365 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
367 spinlock_t phy_port_lock
;
368 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
369 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
370 int num_phys
; /* must be set, gt 0, static */
372 /* The class calls this to send a task for execution. */
373 int lldd_max_execute_num
;
375 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
376 * their siblings when forming wide ports */
378 /* LLDD calls these to notify the class of an event. */
379 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
380 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
381 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
383 void *lldd_ha
; /* not touched by sas class code */
385 struct list_head eh_done_q
;
388 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
390 static inline struct domain_device
*
391 starget_to_domain_dev(struct scsi_target
*starget
) {
392 return starget
->hostdata
;
395 static inline struct domain_device
*
396 sdev_to_domain_dev(struct scsi_device
*sdev
) {
397 return starget_to_domain_dev(sdev
->sdev_target
);
400 static inline struct ata_device
*sas_to_ata_dev(struct domain_device
*dev
)
402 return &dev
->sata_dev
.ap
->link
.device
[0];
405 static inline struct domain_device
*
406 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
408 return sdev_to_domain_dev(cmd
->device
);
411 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
413 /* Before calling a notify event, LLDD should use this function
414 * when the link is severed (possibly from its tasklet).
415 * The idea is that the Class only reads those, while the LLDD,
416 * can R/W these (thus avoiding a race).
418 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
420 phy
->oob_mode
= OOB_NOT_CONNECTED
;
421 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
424 static inline unsigned int to_sas_gpio_od(int device
, int bit
)
426 return 3 * device
+ bit
;
429 #ifdef CONFIG_SCSI_SAS_HOST_SMP
430 int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
);
432 static inline int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
)
438 /* ---------- Tasks ---------- */
440 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
442 ---------------------+---------------------+-----------------------+
444 DEV_NO_RESPONSE | X | X |
447 DEVICE_UNKNOWN | | X |
449 ---------------------+---------------------+-----------------------+
452 enum service_response
{
454 SAS_TASK_UNDELIVERED
= -1,
458 /* The SAM_STAT_.. codes fit in the lower 6 bits */
460 SAS_DEV_NO_RESPONSE
= 0x80,
476 /* When a task finishes with a response, the LLDD examines the
478 * - For an ATA task task_status_struct::stat is set to
479 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
480 * contents of struct ata_task_resp.
481 * - For SSP tasks, if no data is present or status/TMF response
482 * is valid, task_status_struct::stat is set. If data is present
483 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
484 * task_status_struct::buf_valid_size, and task_status_struct::stat is
485 * set to SAM_CHECK_COND.
487 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
490 * "frame_len" is the total frame length, which could be more or less
491 * than actually copied.
493 * Tasks ending with response, always set the residual field.
495 struct ata_task_resp
{
497 u8 ending_fis
[24]; /* dev to host or data-in */
500 #define SAS_STATUS_BUF_SIZE 96
502 struct task_status_struct
{
503 enum service_response resp
;
504 enum exec_status stat
;
507 u8 buf
[SAS_STATUS_BUF_SIZE
];
510 enum sas_open_rej_reason open_rej_reason
;
513 /* ATA and ATAPI task queuable to a SAS LLDD.
515 struct sas_ata_task
{
516 struct host_to_dev_fis fis
;
517 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
519 u8 retry_count
; /* hardware retry, should be > 0 */
521 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
526 u8 device_control_reg_update
:1;
529 struct sas_smp_task
{
530 struct scatterlist smp_req
;
531 struct scatterlist smp_resp
;
534 enum task_attribute
{
535 TASK_ATTR_SIMPLE
= 0,
537 TASK_ATTR_ORDERED
= 2,
541 struct sas_ssp_task
{
542 u8 retry_count
; /* hardware retry, should be > 0 */
545 u8 enable_first_burst
:1;
546 enum task_attribute task_attr
;
552 struct domain_device
*dev
;
553 struct list_head list
;
555 spinlock_t task_state_lock
;
556 unsigned task_state_flags
;
558 enum sas_protocol task_proto
;
560 /* Used by the discovery code. */
561 struct timer_list timer
;
562 struct completion completion
;
565 struct sas_ata_task ata_task
;
566 struct sas_smp_task smp_task
;
567 struct sas_ssp_task ssp_task
;
570 struct scatterlist
*scatter
;
573 u8 data_dir
:2; /* Use PCI_DMA_... */
575 struct task_status_struct task_status
;
576 void (*task_done
)(struct sas_task
*);
578 void *lldd_task
; /* for use by LLDDs */
581 struct work_struct abort_work
;
584 #define SAS_TASK_STATE_PENDING 1
585 #define SAS_TASK_STATE_DONE 2
586 #define SAS_TASK_STATE_ABORTED 4
587 #define SAS_TASK_NEED_DEV_RESET 8
588 #define SAS_TASK_AT_INITIATOR 16
590 extern struct sas_task
*sas_alloc_task(gfp_t flags
);
591 extern void sas_free_task(struct sas_task
*task
);
593 struct sas_domain_function_template
{
594 /* The class calls these to notify the LLDD of an event. */
595 void (*lldd_port_formed
)(struct asd_sas_phy
*);
596 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
598 /* The class calls these when a device is found or gone. */
599 int (*lldd_dev_found
)(struct domain_device
*);
600 void (*lldd_dev_gone
)(struct domain_device
*);
602 int (*lldd_execute_task
)(struct sas_task
*, int num
,
605 /* Task Management Functions. Must be called from process context. */
606 int (*lldd_abort_task
)(struct sas_task
*);
607 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
608 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
609 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
610 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
611 int (*lldd_ata_soft_reset
)(struct domain_device
*);
612 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
613 int (*lldd_query_task
)(struct sas_task
*);
615 /* Port and Adapter management */
616 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
617 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
620 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
623 int (*lldd_write_gpio
)(struct sas_ha_struct
*, u8 reg_type
,
624 u8 reg_index
, u8 reg_count
, u8
*write_data
);
627 extern int sas_register_ha(struct sas_ha_struct
*);
628 extern int sas_unregister_ha(struct sas_ha_struct
*);
630 int sas_set_phy_speed(struct sas_phy
*phy
,
631 struct sas_phy_linkrates
*rates
);
632 int sas_phy_enable(struct sas_phy
*phy
, int enabled
);
633 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
634 int sas_queue_up(struct sas_task
*task
);
635 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
636 extern int sas_target_alloc(struct scsi_target
*);
637 extern int sas_slave_alloc(struct scsi_device
*);
638 extern int sas_slave_configure(struct scsi_device
*);
639 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
,
641 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
642 extern int sas_bios_param(struct scsi_device
*,
643 struct block_device
*,
644 sector_t capacity
, int *hsc
);
645 extern struct scsi_transport_template
*
646 sas_domain_attach_transport(struct sas_domain_function_template
*);
647 extern void sas_domain_release_transport(struct scsi_transport_template
*);
649 int sas_discover_root_expander(struct domain_device
*);
651 void sas_init_ex_attr(void);
653 int sas_ex_revalidate_domain(struct domain_device
*);
655 void sas_unregister_domain_devices(struct asd_sas_port
*port
);
656 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
657 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
659 int sas_discover_sata(struct domain_device
*);
660 int sas_discover_end_dev(struct domain_device
*);
662 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*);
664 void sas_init_dev(struct domain_device
*);
666 void sas_task_abort(struct sas_task
*);
667 int __sas_task_abort(struct sas_task
*);
668 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
669 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
671 extern void sas_target_destroy(struct scsi_target
*);
672 extern int sas_slave_alloc(struct scsi_device
*);
673 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
674 extern int sas_drain_work(struct sas_ha_struct
*ha
);
676 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
677 struct request
*req
);
679 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
680 struct ssp_response_iu
*iu
);
681 struct sas_phy
*sas_find_local_phy(struct domain_device
*dev
);
683 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
685 #endif /* _SASLIB_H_ */