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) */
172 struct list_head children
; /* PM Ports if this is a PM */
175 struct ata_host ata_host
;
176 u8 fis
[ATA_RESP_FIS_SIZE
];
184 struct domain_device
{
185 spinlock_t done_lock
;
186 enum sas_dev_type dev_type
;
188 enum sas_linkrate linkrate
;
189 enum sas_linkrate min_linkrate
;
190 enum sas_linkrate max_linkrate
;
194 struct domain_device
*parent
;
195 struct list_head siblings
; /* devices on the same level */
196 struct asd_sas_port
*port
; /* shortcut to root of the tree */
199 struct list_head dev_list_node
;
200 struct list_head disco_list_node
; /* awaiting probe or destruct */
202 enum sas_protocol iproto
;
203 enum sas_protocol tproto
;
205 struct sas_rphy
*rphy
;
207 u8 sas_addr
[SAS_ADDR_SIZE
];
208 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
213 struct expander_device ex_dev
;
214 struct sata_device sata_dev
; /* STP & directly attached */
223 struct list_head drain_node
;
224 struct work_struct work
;
227 static inline void INIT_SAS_WORK(struct sas_work
*sw
, void (*fn
)(struct work_struct
*))
229 INIT_WORK(&sw
->work
, fn
);
230 INIT_LIST_HEAD(&sw
->drain_node
);
233 struct sas_discovery_event
{
234 struct sas_work work
;
235 struct asd_sas_port
*port
;
238 static inline struct sas_discovery_event
*to_sas_discovery_event(struct work_struct
*work
)
240 struct sas_discovery_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
245 struct sas_discovery
{
246 struct sas_discovery_event disc_work
[DISC_NUM_EVENTS
];
247 unsigned long pending
;
248 u8 fanout_sas_addr
[8];
254 /* The port struct is Class:RW, driver:RO */
255 struct asd_sas_port
{
257 struct completion port_gone_completion
;
259 struct sas_discovery disc
;
260 struct domain_device
*port_dev
;
261 spinlock_t dev_list_lock
;
262 struct list_head dev_list
;
263 struct list_head disco_list
;
264 struct list_head destroy_list
;
265 enum sas_linkrate linkrate
;
267 struct sas_work work
;
272 enum sas_class
class;
273 u8 sas_addr
[SAS_ADDR_SIZE
];
274 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
275 enum sas_protocol iproto
;
276 enum sas_protocol tproto
;
278 enum sas_oob_mode oob_mode
;
280 spinlock_t phy_list_lock
;
281 struct list_head phy_list
;
285 struct sas_ha_struct
*ha
;
287 struct sas_port
*port
;
289 void *lldd_port
; /* not touched by the sas class code */
292 struct asd_sas_event
{
293 struct sas_work work
;
294 struct asd_sas_phy
*phy
;
297 static inline struct asd_sas_event
*to_asd_sas_event(struct work_struct
*work
)
299 struct asd_sas_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
304 /* The phy pretty much is controlled by the LLDD.
305 * The class only reads those fields.
309 struct asd_sas_event port_events
[PORT_NUM_EVENTS
];
310 struct asd_sas_event phy_events
[PHY_NUM_EVENTS
];
312 unsigned long port_events_pending
;
313 unsigned long phy_events_pending
;
320 /* The following are class:RO, driver:R/W */
321 int enabled
; /* must be set */
323 int id
; /* must be set */
324 enum sas_class
class;
325 enum sas_protocol iproto
;
326 enum sas_protocol tproto
;
328 enum sas_phy_type type
;
329 enum sas_phy_role role
;
330 enum sas_oob_mode oob_mode
;
331 enum sas_linkrate linkrate
;
333 u8
*sas_addr
; /* must be set */
334 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
336 spinlock_t frame_rcvd_lock
;
337 u8
*frame_rcvd
; /* must be set */
340 spinlock_t sas_prim_lock
;
343 struct list_head port_phy_el
; /* driver:RO */
344 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
346 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
348 void *lldd_phy
; /* not touched by the sas_class_code */
352 struct Scsi_Host
*shost
;
354 struct mutex task_queue_flush
;
355 spinlock_t task_queue_lock
;
356 struct list_head task_queue
;
359 struct task_struct
*queue_thread
;
362 struct sas_ha_event
{
363 struct sas_work work
;
364 struct sas_ha_struct
*ha
;
367 static inline struct sas_ha_event
*to_sas_ha_event(struct work_struct
*work
)
369 struct sas_ha_event
*ev
= container_of(work
, typeof(*ev
), work
.work
);
377 SAS_HA_ATA_EH_ACTIVE
,
381 struct sas_ha_struct
{
383 struct sas_ha_event ha_events
[HA_NUM_EVENTS
];
384 unsigned long pending
;
386 struct list_head defer_q
; /* work queued while draining */
387 struct mutex drain_mutex
;
389 spinlock_t state_lock
;
391 struct mutex disco_mutex
;
393 struct scsi_core core
;
397 struct device
*dev
; /* should be set */
398 struct module
*lldd_module
; /* should be set */
400 u8
*sas_addr
; /* must be set */
401 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
403 spinlock_t phy_port_lock
;
404 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
405 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
406 int num_phys
; /* must be set, gt 0, static */
408 /* The class calls this to send a task for execution. */
409 int lldd_max_execute_num
;
411 int strict_wide_ports
; /* both sas_addr and attached_sas_addr must match
412 * their siblings when forming wide ports */
414 /* LLDD calls these to notify the class of an event. */
415 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
416 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
417 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
419 void *lldd_ha
; /* not touched by sas class code */
421 struct list_head eh_done_q
; /* complete via scsi_eh_flush_done_q */
422 struct list_head eh_ata_q
; /* scmds to promote from sas to ata eh */
425 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
427 static inline struct domain_device
*
428 starget_to_domain_dev(struct scsi_target
*starget
) {
429 return starget
->hostdata
;
432 static inline struct domain_device
*
433 sdev_to_domain_dev(struct scsi_device
*sdev
) {
434 return starget_to_domain_dev(sdev
->sdev_target
);
437 static inline struct ata_device
*sas_to_ata_dev(struct domain_device
*dev
)
439 return &dev
->sata_dev
.ap
->link
.device
[0];
442 static inline struct domain_device
*
443 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
445 return sdev_to_domain_dev(cmd
->device
);
448 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
450 /* Before calling a notify event, LLDD should use this function
451 * when the link is severed (possibly from its tasklet).
452 * The idea is that the Class only reads those, while the LLDD,
453 * can R/W these (thus avoiding a race).
455 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
457 phy
->oob_mode
= OOB_NOT_CONNECTED
;
458 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
461 static inline unsigned int to_sas_gpio_od(int device
, int bit
)
463 return 3 * device
+ bit
;
466 static inline void sas_put_local_phy(struct sas_phy
*phy
)
468 put_device(&phy
->dev
);
471 #ifdef CONFIG_SCSI_SAS_HOST_SMP
472 int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
);
474 static inline int try_test_sas_gpio_gp_bit(unsigned int od
, u8
*data
, u8 index
, u8 count
)
480 /* ---------- Tasks ---------- */
482 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
484 ---------------------+---------------------+-----------------------+
486 DEV_NO_RESPONSE | X | X |
489 DEVICE_UNKNOWN | | X |
491 ---------------------+---------------------+-----------------------+
494 enum service_response
{
496 SAS_TASK_UNDELIVERED
= -1,
500 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
501 * them here to silence 'case value not in enumerated type' warnings
503 __SAM_STAT_CHECK_CONDITION
= SAM_STAT_CHECK_CONDITION
,
505 SAS_DEV_NO_RESPONSE
= 0x80,
521 /* When a task finishes with a response, the LLDD examines the
523 * - For an ATA task task_status_struct::stat is set to
524 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
525 * contents of struct ata_task_resp.
526 * - For SSP tasks, if no data is present or status/TMF response
527 * is valid, task_status_struct::stat is set. If data is present
528 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
529 * task_status_struct::buf_valid_size, and task_status_struct::stat is
530 * set to SAM_CHECK_COND.
532 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
535 * "frame_len" is the total frame length, which could be more or less
536 * than actually copied.
538 * Tasks ending with response, always set the residual field.
540 struct ata_task_resp
{
542 u8 ending_fis
[ATA_RESP_FIS_SIZE
]; /* dev to host or data-in */
545 #define SAS_STATUS_BUF_SIZE 96
547 struct task_status_struct
{
548 enum service_response resp
;
549 enum exec_status stat
;
552 u8 buf
[SAS_STATUS_BUF_SIZE
];
555 enum sas_open_rej_reason open_rej_reason
;
558 /* ATA and ATAPI task queuable to a SAS LLDD.
560 struct sas_ata_task
{
561 struct host_to_dev_fis fis
;
562 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
564 u8 retry_count
; /* hardware retry, should be > 0 */
566 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
571 u8 device_control_reg_update
:1;
574 struct sas_smp_task
{
575 struct scatterlist smp_req
;
576 struct scatterlist smp_resp
;
579 enum task_attribute
{
580 TASK_ATTR_SIMPLE
= 0,
582 TASK_ATTR_ORDERED
= 2,
586 struct sas_ssp_task
{
587 u8 retry_count
; /* hardware retry, should be > 0 */
590 u8 enable_first_burst
:1;
591 enum task_attribute task_attr
;
597 struct domain_device
*dev
;
598 struct list_head list
;
600 spinlock_t task_state_lock
;
601 unsigned task_state_flags
;
603 enum sas_protocol task_proto
;
605 /* Used by the discovery code. */
606 struct timer_list timer
;
607 struct completion completion
;
610 struct sas_ata_task ata_task
;
611 struct sas_smp_task smp_task
;
612 struct sas_ssp_task ssp_task
;
615 struct scatterlist
*scatter
;
618 u8 data_dir
:2; /* Use PCI_DMA_... */
620 struct task_status_struct task_status
;
621 void (*task_done
)(struct sas_task
*);
623 void *lldd_task
; /* for use by LLDDs */
626 struct work_struct abort_work
;
629 #define SAS_TASK_STATE_PENDING 1
630 #define SAS_TASK_STATE_DONE 2
631 #define SAS_TASK_STATE_ABORTED 4
632 #define SAS_TASK_NEED_DEV_RESET 8
633 #define SAS_TASK_AT_INITIATOR 16
635 extern struct sas_task
*sas_alloc_task(gfp_t flags
);
636 extern void sas_free_task(struct sas_task
*task
);
638 struct sas_domain_function_template
{
639 /* The class calls these to notify the LLDD of an event. */
640 void (*lldd_port_formed
)(struct asd_sas_phy
*);
641 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
643 /* The class calls these when a device is found or gone. */
644 int (*lldd_dev_found
)(struct domain_device
*);
645 void (*lldd_dev_gone
)(struct domain_device
*);
647 int (*lldd_execute_task
)(struct sas_task
*, int num
,
650 /* Task Management Functions. Must be called from process context. */
651 int (*lldd_abort_task
)(struct sas_task
*);
652 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
653 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
654 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
655 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
656 int (*lldd_ata_check_ready
)(struct domain_device
*);
657 void (*lldd_ata_set_dmamode
)(struct domain_device
*);
658 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
659 int (*lldd_query_task
)(struct sas_task
*);
661 /* Port and Adapter management */
662 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
663 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
666 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
, void *);
669 int (*lldd_write_gpio
)(struct sas_ha_struct
*, u8 reg_type
,
670 u8 reg_index
, u8 reg_count
, u8
*write_data
);
673 extern int sas_register_ha(struct sas_ha_struct
*);
674 extern int sas_unregister_ha(struct sas_ha_struct
*);
676 int sas_set_phy_speed(struct sas_phy
*phy
,
677 struct sas_phy_linkrates
*rates
);
678 int sas_phy_reset(struct sas_phy
*phy
, int hard_reset
);
679 int sas_queue_up(struct sas_task
*task
);
680 extern int sas_queuecommand(struct Scsi_Host
* ,struct scsi_cmnd
*);
681 extern int sas_target_alloc(struct scsi_target
*);
682 extern int sas_slave_configure(struct scsi_device
*);
683 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
,
685 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
686 extern int sas_bios_param(struct scsi_device
*,
687 struct block_device
*,
688 sector_t capacity
, int *hsc
);
689 extern struct scsi_transport_template
*
690 sas_domain_attach_transport(struct sas_domain_function_template
*);
691 extern void sas_domain_release_transport(struct scsi_transport_template
*);
693 int sas_discover_root_expander(struct domain_device
*);
695 void sas_init_ex_attr(void);
697 int sas_ex_revalidate_domain(struct domain_device
*);
699 void sas_unregister_domain_devices(struct asd_sas_port
*port
, int gone
);
700 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
701 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
703 int sas_discover_sata(struct domain_device
*);
704 int sas_discover_end_dev(struct domain_device
*);
706 void sas_unregister_dev(struct asd_sas_port
*port
, struct domain_device
*);
708 void sas_init_dev(struct domain_device
*);
710 void sas_task_abort(struct sas_task
*);
711 int sas_eh_device_reset_handler(struct scsi_cmnd
*cmd
);
712 int sas_eh_bus_reset_handler(struct scsi_cmnd
*cmd
);
714 extern void sas_target_destroy(struct scsi_target
*);
715 extern int sas_slave_alloc(struct scsi_device
*);
716 extern int sas_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
717 extern int sas_drain_work(struct sas_ha_struct
*ha
);
719 extern int sas_smp_handler(struct Scsi_Host
*shost
, struct sas_rphy
*rphy
,
720 struct request
*req
);
722 extern void sas_ssp_task_response(struct device
*dev
, struct sas_task
*task
,
723 struct ssp_response_iu
*iu
);
724 struct sas_phy
*sas_get_local_phy(struct domain_device
*dev
);
726 int sas_request_addr(struct Scsi_Host
*shost
, u8
*addr
);
728 #endif /* _SASLIB_H_ */