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/list.h>
34 #include <asm/semaphore.h>
35 #include <scsi/scsi_device.h>
36 #include <scsi/scsi_cmnd.h>
37 #include <scsi/scsi_transport_sas.h>
48 PHY_ROLE_TARGET
= 0x40,
49 PHY_ROLE_INITIATOR
= 0x80,
57 /* The events are mnemonically described in sas_dump.c
58 * so when updating/adding events here, please also
59 * update the other file too.
67 PORTE_BYTES_DMAED
= 0U,
68 PORTE_BROADCAST_RCVD
= 1,
69 PORTE_LINK_RESET_ERR
= 2,
70 PORTE_TIMER_EVENT
= 3,
76 PHYE_LOSS_OF_SIGNAL
= 0U,
79 PHYE_SPINUP_HOLD
= 3, /* hot plug SATA, no COMWAKE sent */
84 DISCE_DISCOVER_DOMAIN
= 0U,
85 DISCE_REVALIDATE_DOMAIN
= 1,
90 /* ---------- 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_proto attached_tproto
;
124 enum sas_proto 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
;
146 u8 conf_route_table
:1;
147 u8 enclosure_logical_id
[8];
149 struct ex_phy
*ex_phy
;
150 struct sas_port
*parent_port
;
153 /* ---------- SATA device ---------- */
154 enum ata_command_set
{
156 ATAPI_COMMAND_SET
= 1,
160 enum ata_command_set command_set
;
161 struct smp_resp rps_resp
; /* report_phy_sata_resp */
162 __le16
*identify_device
;
163 __le16
*identify_packet_device
;
165 u8 port_no
; /* port number, if this is a PM (Port) */
166 struct list_head children
; /* PM Ports if this is a PM */
169 /* ---------- Domain device ---------- */
170 struct domain_device
{
171 enum sas_dev_type dev_type
;
173 enum sas_linkrate linkrate
;
174 enum sas_linkrate min_linkrate
;
175 enum sas_linkrate max_linkrate
;
179 struct domain_device
*parent
;
180 struct list_head siblings
; /* devices on the same level */
181 struct asd_sas_port
*port
; /* shortcut to root of the tree */
183 struct list_head dev_list_node
;
185 enum sas_proto iproto
;
186 enum sas_proto tproto
;
188 struct sas_rphy
*rphy
;
190 u8 sas_addr
[SAS_ADDR_SIZE
];
191 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
196 struct expander_device ex_dev
;
197 struct sata_device sata_dev
; /* STP & directly attached */
203 struct sas_discovery
{
204 spinlock_t disc_event_lock
;
205 struct work_struct disc_work
[DISC_NUM_EVENTS
];
206 unsigned long pending
;
207 u8 fanout_sas_addr
[8];
214 /* The port struct is Class:RW, driver:RO */
215 struct asd_sas_port
{
217 struct completion port_gone_completion
;
219 struct sas_discovery disc
;
220 struct domain_device
*port_dev
;
221 spinlock_t dev_list_lock
;
222 struct list_head dev_list
;
223 enum sas_linkrate linkrate
;
226 struct work_struct work
;
231 enum sas_class
class;
232 u8 sas_addr
[SAS_ADDR_SIZE
];
233 u8 attached_sas_addr
[SAS_ADDR_SIZE
];
234 enum sas_proto iproto
;
235 enum sas_proto tproto
;
237 enum sas_oob_mode oob_mode
;
239 spinlock_t phy_list_lock
;
240 struct list_head phy_list
;
244 struct sas_ha_struct
*ha
;
246 struct sas_port
*port
;
248 void *lldd_port
; /* not touched by the sas class code */
251 /* The phy pretty much is controlled by the LLDD.
252 * The class only reads those fields.
256 /* protected by ha->event_lock */
257 struct work_struct port_events
[PORT_NUM_EVENTS
];
258 struct work_struct phy_events
[PHY_NUM_EVENTS
];
260 unsigned long port_events_pending
;
261 unsigned long phy_events_pending
;
268 /* The following are class:RO, driver:R/W */
269 int enabled
; /* must be set */
271 int id
; /* must be set */
272 enum sas_class
class;
273 enum sas_proto iproto
;
274 enum sas_proto tproto
;
276 enum sas_phy_type type
;
277 enum sas_phy_role role
;
278 enum sas_oob_mode oob_mode
;
279 enum sas_linkrate linkrate
;
281 u8
*sas_addr
; /* must be set */
282 u8 attached_sas_addr
[SAS_ADDR_SIZE
]; /* class:RO, driver: R/W */
284 spinlock_t frame_rcvd_lock
;
285 u8
*frame_rcvd
; /* must be set */
288 spinlock_t sas_prim_lock
;
291 struct list_head port_phy_el
; /* driver:RO */
292 struct asd_sas_port
*port
; /* Class:RW, driver: RO */
294 struct sas_ha_struct
*ha
; /* may be set; the class sets it anyway */
296 void *lldd_phy
; /* not touched by the sas_class_code */
300 struct Scsi_Host
*shost
;
302 spinlock_t task_queue_lock
;
303 struct list_head task_queue
;
306 struct semaphore queue_thread_sema
;
307 int queue_thread_kill
;
310 struct sas_ha_struct
{
312 spinlock_t event_lock
;
313 struct work_struct ha_events
[HA_NUM_EVENTS
];
314 unsigned long pending
;
316 struct scsi_core core
;
320 struct pci_dev
*pcidev
; /* should be set */
321 struct module
*lldd_module
; /* should be set */
323 u8
*sas_addr
; /* must be set */
324 u8 hashed_sas_addr
[HASHED_SAS_ADDR_SIZE
];
326 spinlock_t phy_port_lock
;
327 struct asd_sas_phy
**sas_phy
; /* array of valid pointers, must be set */
328 struct asd_sas_port
**sas_port
; /* array of valid pointers, must be set */
329 int num_phys
; /* must be set, gt 0, static */
331 /* The class calls this to send a task for execution. */
332 int lldd_max_execute_num
;
335 /* LLDD calls these to notify the class of an event. */
336 void (*notify_ha_event
)(struct sas_ha_struct
*, enum ha_event
);
337 void (*notify_port_event
)(struct asd_sas_phy
*, enum port_event
);
338 void (*notify_phy_event
)(struct asd_sas_phy
*, enum phy_event
);
340 void *lldd_ha
; /* not touched by sas class code */
343 #define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
345 static inline struct domain_device
*
346 starget_to_domain_dev(struct scsi_target
*starget
) {
347 return starget
->hostdata
;
350 static inline struct domain_device
*
351 sdev_to_domain_dev(struct scsi_device
*sdev
) {
352 return starget_to_domain_dev(sdev
->sdev_target
);
355 static inline struct domain_device
*
356 cmd_to_domain_dev(struct scsi_cmnd
*cmd
)
358 return sdev_to_domain_dev(cmd
->device
);
361 void sas_hash_addr(u8
*hashed
, const u8
*sas_addr
);
363 /* Before calling a notify event, LLDD should use this function
364 * when the link is severed (possibly from its tasklet).
365 * The idea is that the Class only reads those, while the LLDD,
366 * can R/W these (thus avoiding a race).
368 static inline void sas_phy_disconnected(struct asd_sas_phy
*phy
)
370 phy
->oob_mode
= OOB_NOT_CONNECTED
;
371 phy
->linkrate
= SAS_LINK_RATE_UNKNOWN
;
374 /* ---------- Tasks ---------- */
376 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
378 ---------------------+---------------------+-----------------------+
380 DEV_NO_RESPONSE | X | X |
383 DEVICE_UNKNOWN | | X |
385 ---------------------+---------------------+-----------------------+
388 enum service_response
{
390 SAS_TASK_UNDELIVERED
= -1,
398 SAM_INTERMEDIATE
= 0x10,
399 SAM_IM_COND_MET
= 0x12,
400 SAM_RESV_CONFLICT
= 0x14,
401 SAM_TASK_SET_FULL
= 0x28,
402 SAM_ACA_ACTIVE
= 0x30,
403 SAM_TASK_ABORTED
= 0x40,
405 SAS_DEV_NO_RESPONSE
= 0x80,
421 /* When a task finishes with a response, the LLDD examines the
423 * - For an ATA task task_status_struct::stat is set to
424 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
425 * contents of struct ata_task_resp.
426 * - For SSP tasks, if no data is present or status/TMF response
427 * is valid, task_status_struct::stat is set. If data is present
428 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
429 * task_status_struct::buf_valid_size, and task_status_struct::stat is
430 * set to SAM_CHECK_COND.
432 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
435 * "frame_len" is the total frame length, which could be more or less
436 * than actually copied.
438 * Tasks ending with response, always set the residual field.
440 struct ata_task_resp
{
442 u8 ending_fis
[24]; /* dev to host or data-in */
449 #define SAS_STATUS_BUF_SIZE 96
451 struct task_status_struct
{
452 enum service_response resp
;
453 enum exec_status stat
;
456 u8 buf
[SAS_STATUS_BUF_SIZE
];
459 enum sas_open_rej_reason open_rej_reason
;
462 /* ATA and ATAPI task queuable to a SAS LLDD.
464 struct sas_ata_task
{
465 struct host_to_dev_fis fis
;
466 u8 atapi_packet
[16]; /* 0 if not ATAPI task */
468 u8 retry_count
; /* hardware retry, should be > 0 */
470 u8 dma_xfer
:1; /* PIO:0 or DMA:1 */
475 u8 device_control_reg_update
:1;
478 struct sas_smp_task
{
479 struct scatterlist smp_req
;
480 struct scatterlist smp_resp
;
483 enum task_attribute
{
484 TASK_ATTR_SIMPLE
= 0,
486 TASK_ATTR_ORDERED
= 2,
490 struct sas_ssp_task
{
491 u8 retry_count
; /* hardware retry, should be > 0 */
494 u8 enable_first_burst
:1;
495 enum task_attribute task_attr
;
501 struct domain_device
*dev
;
502 struct list_head list
;
504 spinlock_t task_state_lock
;
505 unsigned task_state_flags
;
507 enum sas_proto task_proto
;
509 /* Used by the discovery code. */
510 struct timer_list timer
;
511 struct completion completion
;
514 struct sas_ata_task ata_task
;
515 struct sas_smp_task smp_task
;
516 struct sas_ssp_task ssp_task
;
519 struct scatterlist
*scatter
;
522 u8 data_dir
:2; /* Use PCI_DMA_... */
524 struct task_status_struct task_status
;
525 void (*task_done
)(struct sas_task
*);
527 void *lldd_task
; /* for use by LLDDs */
533 #define SAS_TASK_STATE_PENDING 1
534 #define SAS_TASK_STATE_DONE 2
535 #define SAS_TASK_STATE_ABORTED 4
537 static inline struct sas_task
*sas_alloc_task(unsigned long flags
)
539 extern kmem_cache_t
*sas_task_cache
;
540 struct sas_task
*task
= kmem_cache_alloc(sas_task_cache
, flags
);
543 memset(task
, 0, sizeof(*task
));
544 INIT_LIST_HEAD(&task
->list
);
545 spin_lock_init(&task
->task_state_lock
);
546 task
->task_state_flags
= SAS_TASK_STATE_PENDING
;
547 init_timer(&task
->timer
);
548 init_completion(&task
->completion
);
554 static inline void sas_free_task(struct sas_task
*task
)
557 extern kmem_cache_t
*sas_task_cache
;
558 BUG_ON(!list_empty(&task
->list
));
559 kmem_cache_free(sas_task_cache
, task
);
563 struct sas_domain_function_template
{
564 /* The class calls these to notify the LLDD of an event. */
565 void (*lldd_port_formed
)(struct asd_sas_phy
*);
566 void (*lldd_port_deformed
)(struct asd_sas_phy
*);
568 /* The class calls these when a device is found or gone. */
569 int (*lldd_dev_found
)(struct domain_device
*);
570 void (*lldd_dev_gone
)(struct domain_device
*);
572 int (*lldd_execute_task
)(struct sas_task
*, int num
,
573 unsigned long gfp_flags
);
575 /* Task Management Functions. Must be called from process context. */
576 int (*lldd_abort_task
)(struct sas_task
*);
577 int (*lldd_abort_task_set
)(struct domain_device
*, u8
*lun
);
578 int (*lldd_clear_aca
)(struct domain_device
*, u8
*lun
);
579 int (*lldd_clear_task_set
)(struct domain_device
*, u8
*lun
);
580 int (*lldd_I_T_nexus_reset
)(struct domain_device
*);
581 int (*lldd_lu_reset
)(struct domain_device
*, u8
*lun
);
582 int (*lldd_query_task
)(struct sas_task
*);
584 /* Port and Adapter management */
585 int (*lldd_clear_nexus_port
)(struct asd_sas_port
*);
586 int (*lldd_clear_nexus_ha
)(struct sas_ha_struct
*);
589 int (*lldd_control_phy
)(struct asd_sas_phy
*, enum phy_func
);
592 extern int sas_register_ha(struct sas_ha_struct
*);
593 extern int sas_unregister_ha(struct sas_ha_struct
*);
595 extern int sas_queuecommand(struct scsi_cmnd
*,
596 void (*scsi_done
)(struct scsi_cmnd
*));
597 extern int sas_target_alloc(struct scsi_target
*);
598 extern int sas_slave_alloc(struct scsi_device
*);
599 extern int sas_slave_configure(struct scsi_device
*);
600 extern void sas_slave_destroy(struct scsi_device
*);
601 extern int sas_change_queue_depth(struct scsi_device
*, int new_depth
);
602 extern int sas_change_queue_type(struct scsi_device
*, int qt
);
603 extern int sas_bios_param(struct scsi_device
*,
604 struct block_device
*,
605 sector_t capacity
, int *hsc
);
606 extern struct scsi_transport_template
*
607 sas_domain_attach_transport(struct sas_domain_function_template
*);
608 extern void sas_domain_release_transport(struct scsi_transport_template
*);
610 int sas_discover_root_expander(struct domain_device
*);
612 void sas_init_ex_attr(void);
614 int sas_ex_revalidate_domain(struct domain_device
*);
616 void sas_unregister_domain_devices(struct asd_sas_port
*port
);
617 void sas_init_disc(struct sas_discovery
*disc
, struct asd_sas_port
*);
618 int sas_discover_event(struct asd_sas_port
*, enum discover_event ev
);
620 int sas_discover_sata(struct domain_device
*);
621 int sas_discover_end_dev(struct domain_device
*);
623 void sas_unregister_dev(struct domain_device
*);
625 void sas_init_dev(struct domain_device
*);
627 #endif /* _SASLIB_H_ */