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
;
148 u8 conf_route_table
:1;
150 u8 enclosure_logical_id
[8];
152 struct ex_phy
*ex_phy
;
153 struct sas_port
*parent_port
;
156 /* ---------- SATA device ---------- */
157 enum ata_command_set
{
159 ATAPI_COMMAND_SET
= 1,
163 enum ata_command_set command_set
;
164 struct smp_resp rps_resp
; /* report_phy_sata_resp */
165 __le16
*identify_device
;
166 __le16
*identify_packet_device
;
168 u8 port_no
; /* port number, if this is a PM (Port) */
169 struct list_head children
; /* PM Ports if this is a PM */
172 struct ata_host ata_host
;
173 struct ata_taskfile tf
;
179 /* ---------- Domain device ---------- */
180 struct domain_device
{
181 enum sas_dev_type dev_type
;
183 enum sas_linkrate linkrate
;
184 enum sas_linkrate min_linkrate
;
185 enum sas_linkrate max_linkrate
;
189 struct domain_device
*parent
;
190 struct list_head siblings
; /* devices on the same level */
191 struct asd_sas_port
*port
; /* shortcut to root of the tree */
193 struct list_head dev_list_node
;
195 enum sas_protocol iproto
;
196 enum sas_protocol tproto
;
198 struct sas_rphy
*rphy
;
200 u8 sas_addr
[SAS_ADDR_SIZE
];
201 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
206 struct expander_device ex_dev
;
207 struct sata_device sata_dev
; /* STP & directly attached */
214 struct sas_discovery_event
{
215 struct work_struct work
;
216 struct asd_sas_port
*port
;
219 struct sas_discovery
{
220 spinlock_t disc_event_lock
;
221 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
222 unsigned long pending
;
223 u8 fanout_sas_addr
[8];
230 /* The port struct is Class:RW, driver:RO */
231 struct asd_sas_port
{
233 struct completion port_gone_completion
;
235 struct sas_discovery disc
;
236 struct domain_device
*port_dev
;
237 spinlock_t dev_list_lock
;
238 struct list_head dev_list
;
239 enum sas_linkrate linkrate
;
242 struct work_struct work
;
247 enum sas_class
class;
248 u8 sas_addr
[SAS_ADDR_SIZE
];
249 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
250 enum sas_protocol iproto
;
251 enum sas_protocol tproto
;
253 enum sas_oob_mode oob_mode
;
255 spinlock_t phy_list_lock
;
256 struct list_head phy_list
;
260 struct sas_ha_struct
*ha
;
262 struct sas_port
*port
;
264 void *lldd_port
; /* not touched by the sas class code */
267 struct asd_sas_event
{
268 struct work_struct work
;
269 struct asd_sas_phy
*phy
;
272 /* The phy pretty much is controlled by the LLDD.
273 * The class only reads those fields.
277 /* protected by ha->event_lock */
278 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
279 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
281 unsigned long port_events_pending
;
282 unsigned long phy_events_pending
;
289 /* The following are class:RO, driver:R/W */
290 int enabled
; /* must be set */
292 int id
; /* must be set */
293 enum sas_class
class;
294 enum sas_protocol iproto
;
295 enum sas_protocol tproto
;
297 enum sas_phy_type type
;
298 enum sas_phy_role role
;
299 enum sas_oob_mode oob_mode
;
300 enum sas_linkrate linkrate
;
302 u8
*sas_addr
; /* must be set */
303 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
305 spinlock_t frame_rcvd_lock
;
306 u8
*frame_rcvd
; /* must be set */
309 spinlock_t sas_prim_lock
;
312 struct list_head port_phy_el
; /* driver:RO */
313 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
315 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
317 void *lldd_phy
; /* not touched by the sas_class_code */
321 struct Scsi_Host
*shost
;
323 spinlock_t task_queue_lock
;
324 struct list_head task_queue
;
327 struct task_struct
*queue_thread
;
330 struct sas_ha_event
{
331 struct work_struct work
;
332 struct sas_ha_struct
*ha
;
340 struct sas_ha_struct
{
342 spinlock_t event_lock
;
343 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
344 unsigned long pending
;
346 enum sas_ha_state state
;
347 spinlock_t state_lock
;
349 struct scsi_core core
;
353 struct device
*dev
; /* should be set */
354 struct module
*lldd_module
; /* should be set */
356 u8
*sas_addr
; /* must be set */
357 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
359 spinlock_t phy_port_lock
;
360 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
361 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
362 int num_phys
; /* must be set, gt 0, static */
364 /* The class calls this to send a task for execution. */
365 int lldd_max_execute_num
;
367 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
368 * their siblings when forming wide ports */
370 /* LLDD calls these to notify the class of an event. */
371 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
372 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
373 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
375 void *lldd_ha
; /* not touched by sas class code */
377 struct list_head eh_done_q
;
380 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
382 static inline struct domain_device
*
383 starget_to_domain_dev(struct scsi_target
*starget
) {
384 return starget
->hostdata
;
387 static inline struct domain_device
*
388 sdev_to_domain_dev(struct scsi_device
*sdev
) {
389 return starget_to_domain_dev(sdev
->sdev_target
);
392 static inline struct ata_device
*sas_to_ata_dev(struct domain_device
*dev
)
394 return &dev
->sata_dev
.ap
->link
.device
[0];
397 static inline struct domain_device
*
398 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
400 return sdev_to_domain_dev(cmd
->device
);
403 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
405 /* Before calling a notify event, LLDD should use this function
406 * when the link is severed (possibly from its tasklet).
407 * The idea is that the Class only reads those, while the LLDD,
408 * can R/W these (thus avoiding a race).
410 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
412 phy
->oob_mode
= OOB_NOT_CONNECTED
;
413 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
416 static inline unsigned int to_sas_gpio_od(int device
, int bit
)
418 return 3 * device
+ bit
;
421 #ifdef CONFIG_SCSI_SAS_HOST_SMP
422 int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
);
424 static inline int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
)
430 /* ---------- Tasks ---------- */
432 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
434 ---------------------+---------------------+-----------------------+
436 DEV_NO_RESPONSE | X | X |
439 DEVICE_UNKNOWN | | X |
441 ---------------------+---------------------+-----------------------+
444 enum service_response
{
446 SAS_TASK_UNDELIVERED
= -1,
450 /* The SAM_STAT_.. codes fit in the lower 6 bits */
452 SAS_DEV_NO_RESPONSE
= 0x80,
468 /* When a task finishes with a response, the LLDD examines the
470 * - For an ATA task task_status_struct::stat is set to
471 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
472 * contents of struct ata_task_resp.
473 * - For SSP tasks, if no data is present or status/TMF response
474 * is valid, task_status_struct::stat is set. If data is present
475 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
476 * task_status_struct::buf_valid_size, and task_status_struct::stat is
477 * set to SAM_CHECK_COND.
479 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
482 * "frame_len" is the total frame length, which could be more or less
483 * than actually copied.
485 * Tasks ending with response, always set the residual field.
487 struct ata_task_resp
{
489 u8 ending_fis
[24]; /* dev to host or data-in */
496 #define SAS_STATUS_BUF_SIZE 96
498 struct task_status_struct
{
499 enum service_response resp
;
500 enum exec_status stat
;
503 u8 buf
[SAS_STATUS_BUF_SIZE
];
506 enum sas_open_rej_reason open_rej_reason
;
509 /* ATA and ATAPI task queuable to a SAS LLDD.
511 struct sas_ata_task
{
512 struct host_to_dev_fis fis
;
513 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
515 u8 retry_count
; /* hardware retry, should be > 0 */
517 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
522 u8 device_control_reg_update
:1;
525 struct sas_smp_task
{
526 struct scatterlist smp_req
;
527 struct scatterlist smp_resp
;
530 enum task_attribute
{
531 TASK_ATTR_SIMPLE
= 0,
533 TASK_ATTR_ORDERED
= 2,
537 struct sas_ssp_task
{
538 u8 retry_count
; /* hardware retry, should be > 0 */
541 u8 enable_first_burst
:1;
542 enum task_attribute task_attr
;
548 struct domain_device
*dev
;
549 struct list_head list
;
551 spinlock_t task_state_lock
;
552 unsigned task_state_flags
;
554 enum sas_protocol task_proto
;
556 /* Used by the discovery code. */
557 struct timer_list timer
;
558 struct completion completion
;
561 struct sas_ata_task ata_task
;
562 struct sas_smp_task smp_task
;
563 struct sas_ssp_task ssp_task
;
566 struct scatterlist
*scatter
;
569 u8 data_dir
:2; /* Use PCI_DMA_... */
571 struct task_status_struct task_status
;
572 void (*task_done
)(struct sas_task
*);
574 void *lldd_task
; /* for use by LLDDs */
577 struct work_struct abort_work
;
580 #define SAS_TASK_STATE_PENDING 1
581 #define SAS_TASK_STATE_DONE 2
582 #define SAS_TASK_STATE_ABORTED 4
583 #define SAS_TASK_NEED_DEV_RESET 8
584 #define SAS_TASK_AT_INITIATOR 16
586 extern struct sas_task
*sas_alloc_task(gfp_t flags
);
587 extern void sas_free_task(struct sas_task
*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 int (*lldd_write_gpio
)(struct sas_ha_struct
*, u8 reg_type
,
620 u8 reg_index
, u8 reg_count
, u8
*write_data
);
623 extern int sas_register_ha(struct sas_ha_struct
*);
624 extern int sas_unregister_ha(struct sas_ha_struct
*);
626 int sas_set_phy_speed(struct sas_phy
*phy
,
627 struct sas_phy_linkrates
*rates
);
628 int sas_phy_enable(struct sas_phy
*phy
, int enabled
);
629 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
630 int sas_queue_up(struct sas_task
*task
);
631 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
632 extern int sas_target_alloc(struct scsi_target
*);
633 extern int sas_slave_alloc(struct scsi_device
*);
634 extern int sas_slave_configure(struct scsi_device
*);
635 extern void sas_slave_destroy(struct scsi_device
*);
636 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
,
638 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
639 extern int sas_bios_param(struct scsi_device
*,
640 struct block_device
*,
641 sector_t capacity
, int *hsc
);
642 extern struct scsi_transport_template
*
643 sas_domain_attach_transport(struct sas_domain_function_template
*);
644 extern void sas_domain_release_transport(struct scsi_transport_template
*);
646 int sas_discover_root_expander(struct domain_device
*);
648 void sas_init_ex_attr(void);
650 int sas_ex_revalidate_domain(struct domain_device
*);
652 void sas_unregister_domain_devices(struct asd_sas_port
*port
);
653 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
654 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
656 int sas_discover_sata(struct domain_device
*);
657 int sas_discover_end_dev(struct domain_device
*);
659 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*);
661 void sas_init_dev(struct domain_device
*);
663 void sas_task_abort(struct sas_task
*);
664 int __sas_task_abort(struct sas_task
*);
665 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
666 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
668 extern void sas_target_destroy(struct scsi_target
*);
669 extern int sas_slave_alloc(struct scsi_device
*);
670 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
672 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
673 struct request
*req
);
675 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
676 struct ssp_response_iu
*iu
);
677 struct sas_phy
*sas_find_local_phy(struct domain_device
*dev
);
679 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
681 #endif /* _SASLIB_H_ */