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 <asm/semaphore.h>
36 #include <scsi/scsi_device.h>
37 #include <scsi/scsi_cmnd.h>
38 #include <scsi/scsi_transport_sas.h>
39 #include <asm/scatterlist.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 ---------- */
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_proto attached_tproto
;
126 enum sas_proto 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
;
148 u8 conf_route_table
:1;
149 u8 enclosure_logical_id
[8];
151 struct ex_phy
*ex_phy
;
152 struct sas_port
*parent_port
;
155 /* ---------- SATA device ---------- */
156 enum ata_command_set
{
158 ATAPI_COMMAND_SET
= 1,
162 enum ata_command_set command_set
;
163 struct smp_resp rps_resp
; /* report_phy_sata_resp */
164 __le16
*identify_device
;
165 __le16
*identify_packet_device
;
167 u8 port_no
; /* port number, if this is a PM (Port) */
168 struct list_head children
; /* PM Ports if this is a PM */
171 struct ata_host ata_host
;
172 struct ata_taskfile tf
;
178 /* ---------- Domain device ---------- */
179 struct domain_device
{
180 enum sas_dev_type dev_type
;
182 enum sas_linkrate linkrate
;
183 enum sas_linkrate min_linkrate
;
184 enum sas_linkrate max_linkrate
;
188 struct domain_device
*parent
;
189 struct list_head siblings
; /* devices on the same level */
190 struct asd_sas_port
*port
; /* shortcut to root of the tree */
192 struct list_head dev_list_node
;
194 enum sas_proto iproto
;
195 enum sas_proto tproto
;
197 struct sas_rphy
*rphy
;
199 u8 sas_addr
[SAS_ADDR_SIZE
];
200 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
205 struct expander_device ex_dev
;
206 struct sata_device sata_dev
; /* STP & directly attached */
212 struct sas_discovery_event
{
213 struct work_struct work
;
214 struct asd_sas_port
*port
;
217 struct sas_discovery
{
218 spinlock_t disc_event_lock
;
219 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
220 unsigned long pending
;
221 u8 fanout_sas_addr
[8];
228 /* The port struct is Class:RW, driver:RO */
229 struct asd_sas_port
{
231 struct completion port_gone_completion
;
233 struct sas_discovery disc
;
234 struct domain_device
*port_dev
;
235 spinlock_t dev_list_lock
;
236 struct list_head dev_list
;
237 enum sas_linkrate linkrate
;
240 struct work_struct work
;
245 enum sas_class
class;
246 u8 sas_addr
[SAS_ADDR_SIZE
];
247 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
248 enum sas_proto iproto
;
249 enum sas_proto tproto
;
251 enum sas_oob_mode oob_mode
;
253 spinlock_t phy_list_lock
;
254 struct list_head phy_list
;
258 struct sas_ha_struct
*ha
;
260 struct sas_port
*port
;
262 void *lldd_port
; /* not touched by the sas class code */
265 struct asd_sas_event
{
266 struct work_struct work
;
267 struct asd_sas_phy
*phy
;
270 /* The phy pretty much is controlled by the LLDD.
271 * The class only reads those fields.
275 /* protected by ha->event_lock */
276 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
277 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
279 unsigned long port_events_pending
;
280 unsigned long phy_events_pending
;
287 /* The following are class:RO, driver:R/W */
288 int enabled
; /* must be set */
290 int id
; /* must be set */
291 enum sas_class
class;
292 enum sas_proto iproto
;
293 enum sas_proto tproto
;
295 enum sas_phy_type type
;
296 enum sas_phy_role role
;
297 enum sas_oob_mode oob_mode
;
298 enum sas_linkrate linkrate
;
300 u8
*sas_addr
; /* must be set */
301 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
303 spinlock_t frame_rcvd_lock
;
304 u8
*frame_rcvd
; /* must be set */
307 spinlock_t sas_prim_lock
;
310 struct list_head port_phy_el
; /* driver:RO */
311 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
313 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
315 void *lldd_phy
; /* not touched by the sas_class_code */
319 struct Scsi_Host
*shost
;
321 spinlock_t task_queue_lock
;
322 struct list_head task_queue
;
325 struct task_struct
*queue_thread
;
328 struct sas_ha_event
{
329 struct work_struct work
;
330 struct sas_ha_struct
*ha
;
338 struct sas_ha_struct
{
340 spinlock_t event_lock
;
341 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
342 unsigned long pending
;
344 enum sas_ha_state state
;
345 spinlock_t state_lock
;
347 struct scsi_core core
;
351 struct device
*dev
; /* should be set */
352 struct module
*lldd_module
; /* should be set */
354 u8
*sas_addr
; /* must be set */
355 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
357 spinlock_t phy_port_lock
;
358 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
359 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
360 int num_phys
; /* must be set, gt 0, static */
362 /* The class calls this to send a task for execution. */
363 int lldd_max_execute_num
;
366 /* LLDD calls these to notify the class of an event. */
367 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
368 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
369 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
371 void *lldd_ha
; /* not touched by sas class code */
373 struct list_head eh_done_q
;
376 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
378 static inline struct domain_device
*
379 starget_to_domain_dev(struct scsi_target
*starget
) {
380 return starget
->hostdata
;
383 static inline struct domain_device
*
384 sdev_to_domain_dev(struct scsi_device
*sdev
) {
385 return starget_to_domain_dev(sdev
->sdev_target
);
388 static inline struct domain_device
*
389 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
391 return sdev_to_domain_dev(cmd
->device
);
394 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
396 /* Before calling a notify event, LLDD should use this function
397 * when the link is severed (possibly from its tasklet).
398 * The idea is that the Class only reads those, while the LLDD,
399 * can R/W these (thus avoiding a race).
401 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
403 phy
->oob_mode
= OOB_NOT_CONNECTED
;
404 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
407 /* ---------- Tasks ---------- */
409 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
411 ---------------------+---------------------+-----------------------+
413 DEV_NO_RESPONSE | X | X |
416 DEVICE_UNKNOWN | | X |
418 ---------------------+---------------------+-----------------------+
421 enum service_response
{
423 SAS_TASK_UNDELIVERED
= -1,
431 SAM_INTERMEDIATE
= 0x10,
432 SAM_IM_COND_MET
= 0x12,
433 SAM_RESV_CONFLICT
= 0x14,
434 SAM_TASK_SET_FULL
= 0x28,
435 SAM_ACA_ACTIVE
= 0x30,
436 SAM_TASK_ABORTED
= 0x40,
438 SAS_DEV_NO_RESPONSE
= 0x80,
454 /* When a task finishes with a response, the LLDD examines the
456 * - For an ATA task task_status_struct::stat is set to
457 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
458 * contents of struct ata_task_resp.
459 * - For SSP tasks, if no data is present or status/TMF response
460 * is valid, task_status_struct::stat is set. If data is present
461 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
462 * task_status_struct::buf_valid_size, and task_status_struct::stat is
463 * set to SAM_CHECK_COND.
465 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
468 * "frame_len" is the total frame length, which could be more or less
469 * than actually copied.
471 * Tasks ending with response, always set the residual field.
473 struct ata_task_resp
{
475 u8 ending_fis
[24]; /* dev to host or data-in */
482 #define SAS_STATUS_BUF_SIZE 96
484 struct task_status_struct
{
485 enum service_response resp
;
486 enum exec_status stat
;
489 u8 buf
[SAS_STATUS_BUF_SIZE
];
492 enum sas_open_rej_reason open_rej_reason
;
495 /* ATA and ATAPI task queuable to a SAS LLDD.
497 struct sas_ata_task
{
498 struct host_to_dev_fis fis
;
499 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
501 u8 retry_count
; /* hardware retry, should be > 0 */
503 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
508 u8 device_control_reg_update
:1;
511 struct sas_smp_task
{
512 struct scatterlist smp_req
;
513 struct scatterlist smp_resp
;
516 enum task_attribute
{
517 TASK_ATTR_SIMPLE
= 0,
519 TASK_ATTR_ORDERED
= 2,
523 struct sas_ssp_task
{
524 u8 retry_count
; /* hardware retry, should be > 0 */
527 u8 enable_first_burst
:1;
528 enum task_attribute task_attr
;
534 struct domain_device
*dev
;
535 struct list_head list
;
537 spinlock_t task_state_lock
;
538 unsigned task_state_flags
;
540 enum sas_proto task_proto
;
542 /* Used by the discovery code. */
543 struct timer_list timer
;
544 struct completion completion
;
547 struct sas_ata_task ata_task
;
548 struct sas_smp_task smp_task
;
549 struct sas_ssp_task ssp_task
;
552 struct scatterlist
*scatter
;
555 u8 data_dir
:2; /* Use PCI_DMA_... */
557 struct task_status_struct task_status
;
558 void (*task_done
)(struct sas_task
*);
560 void *lldd_task
; /* for use by LLDDs */
563 struct work_struct abort_work
;
568 #define SAS_TASK_STATE_PENDING 1
569 #define SAS_TASK_STATE_DONE 2
570 #define SAS_TASK_STATE_ABORTED 4
571 #define SAS_TASK_NEED_DEV_RESET 8
572 #define SAS_TASK_AT_INITIATOR 16
574 static inline struct sas_task
*sas_alloc_task(gfp_t flags
)
576 extern struct kmem_cache
*sas_task_cache
;
577 struct sas_task
*task
= kmem_cache_zalloc(sas_task_cache
, flags
);
580 INIT_LIST_HEAD(&task
->list
);
581 spin_lock_init(&task
->task_state_lock
);
582 task
->task_state_flags
= SAS_TASK_STATE_PENDING
;
583 init_timer(&task
->timer
);
584 init_completion(&task
->completion
);
590 static inline void sas_free_task(struct sas_task
*task
)
593 extern struct kmem_cache
*sas_task_cache
;
594 BUG_ON(!list_empty(&task
->list
));
595 kmem_cache_free(sas_task_cache
, task
);
599 struct sas_domain_function_template
{
600 /* The class calls these to notify the LLDD of an event. */
601 void (*lldd_port_formed
)(struct asd_sas_phy
*);
602 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
604 /* The class calls these when a device is found or gone. */
605 int (*lldd_dev_found
)(struct domain_device
*);
606 void (*lldd_dev_gone
)(struct domain_device
*);
608 int (*lldd_execute_task
)(struct sas_task
*, int num
,
611 /* Task Management Functions. Must be called from process context. */
612 int (*lldd_abort_task
)(struct sas_task
*);
613 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
614 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
615 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
616 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
617 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
618 int (*lldd_query_task
)(struct sas_task
*);
620 /* Port and Adapter management */
621 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
622 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
625 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
628 extern int sas_register_ha(struct sas_ha_struct
*);
629 extern int sas_unregister_ha(struct sas_ha_struct
*);
631 int sas_set_phy_speed(struct sas_phy
*phy
,
632 struct sas_phy_linkrates
*rates
);
633 int sas_phy_enable(struct sas_phy
*phy
, int enabled
);
634 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
635 int sas_queue_up(struct sas_task
*task
);
636 extern int sas_queuecommand(struct scsi_cmnd
*,
637 void (*scsi_done
)(struct scsi_cmnd
*));
638 extern int sas_target_alloc(struct scsi_target
*);
639 extern int sas_slave_alloc(struct scsi_device
*);
640 extern int sas_slave_configure(struct scsi_device
*);
641 extern void sas_slave_destroy(struct scsi_device
*);
642 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
);
643 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
644 extern int sas_bios_param(struct scsi_device
*,
645 struct block_device
*,
646 sector_t capacity
, int *hsc
);
647 extern struct scsi_transport_template
*
648 sas_domain_attach_transport(struct sas_domain_function_template
*);
649 extern void sas_domain_release_transport(struct scsi_transport_template
*);
651 int sas_discover_root_expander(struct domain_device
*);
653 void sas_init_ex_attr(void);
655 int sas_ex_revalidate_domain(struct domain_device
*);
657 void sas_unregister_domain_devices(struct asd_sas_port
*port
);
658 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
659 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
661 int sas_discover_sata(struct domain_device
*);
662 int sas_discover_end_dev(struct domain_device
*);
664 void sas_unregister_dev(struct domain_device
*);
666 void sas_init_dev(struct domain_device
*);
668 void sas_task_abort(struct sas_task
*);
669 int __sas_task_abort(struct sas_task
*);
670 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
671 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
673 extern void sas_target_destroy(struct scsi_target
*);
674 extern int sas_slave_alloc(struct scsi_device
*);
675 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
677 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
678 struct request
*req
);
679 #endif /* _SASLIB_H_ */