Linux Audio

Check our new training course

Loading...
v6.2
  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/*
  3 * SAS host prototypes and structures header file
  4 *
  5 * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
  6 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  7 */
  8
  9#ifndef _LIBSAS_H_
 10#define _LIBSAS_H_
 11
 12
 13#include <linux/timer.h>
 14#include <linux/pci.h>
 15#include <scsi/sas.h>
 16#include <linux/libata.h>
 17#include <linux/list.h>
 18#include <scsi/scsi_device.h>
 19#include <scsi/scsi_cmnd.h>
 20#include <scsi/scsi_transport_sas.h>
 21#include <linux/scatterlist.h>
 22#include <linux/slab.h>
 23
 24struct block_device;
 25
 26enum sas_class {
 27	SAS,
 28	EXPANDER
 29};
 30
 31enum sas_phy_role {
 32	PHY_ROLE_NONE = 0,
 33	PHY_ROLE_TARGET = 0x40,
 34	PHY_ROLE_INITIATOR = 0x80,
 35};
 36
 37enum sas_phy_type {
 38	PHY_TYPE_PHYSICAL,
 39	PHY_TYPE_VIRTUAL
 40};
 41
 42/* The events are mnemonically described in sas_dump.c
 43 * so when updating/adding events here, please also
 44 * update the other file too.
 45 */
 
 
 
 
 
 46enum port_event {
 47	PORTE_BYTES_DMAED     = 0U,
 48	PORTE_BROADCAST_RCVD,
 49	PORTE_LINK_RESET_ERR,
 50	PORTE_TIMER_EVENT,
 51	PORTE_HARD_RESET,
 52	PORT_NUM_EVENTS,
 53};
 54
 55enum phy_event {
 56	PHYE_LOSS_OF_SIGNAL   = 0U,
 57	PHYE_OOB_DONE,
 58	PHYE_OOB_ERROR,
 59	PHYE_SPINUP_HOLD,             /* hot plug SATA, no COMWAKE sent */
 60	PHYE_RESUME_TIMEOUT,
 61	PHYE_SHUTDOWN,
 62	PHY_NUM_EVENTS,
 63};
 64
 65enum discover_event {
 66	DISCE_DISCOVER_DOMAIN   = 0U,
 67	DISCE_REVALIDATE_DOMAIN,
 68	DISCE_SUSPEND,
 69	DISCE_RESUME,
 70	DISC_NUM_EVENTS,
 
 
 
 71};
 72
 73/* ---------- Expander Devices ---------- */
 74
 75#define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
 76#define to_dev_attr(_attr)  container_of(_attr, struct domain_dev_attribute,\
 77					 attr)
 78
 79enum routing_attribute {
 80	DIRECT_ROUTING,
 81	SUBTRACTIVE_ROUTING,
 82	TABLE_ROUTING,
 83};
 84
 85enum ex_phy_state {
 86	PHY_EMPTY,
 87	PHY_VACANT,
 88	PHY_NOT_PRESENT,
 89	PHY_DEVICE_DISCOVERED
 90};
 91
 92struct ex_phy {
 93	int    phy_id;
 94
 95	enum ex_phy_state phy_state;
 96
 97	enum sas_device_type attached_dev_type;
 98	enum sas_linkrate linkrate;
 99
100	u8   attached_sata_host:1;
101	u8   attached_sata_dev:1;
102	u8   attached_sata_ps:1;
103
104	enum sas_protocol attached_tproto;
105	enum sas_protocol attached_iproto;
106
107	u8   attached_sas_addr[SAS_ADDR_SIZE];
108	u8   attached_phy_id;
109
110	int phy_change_count;
111	enum routing_attribute routing_attr;
112	u8   virtual:1;
113
114	int  last_da_index;
115
116	struct sas_phy *phy;
117	struct sas_port *port;
118};
119
120struct expander_device {
121	struct list_head children;
122
123	int    ex_change_count;
124	u16    max_route_indexes;
125	u8     num_phys;
126
127	u8     t2t_supp:1;
128	u8     configuring:1;
129	u8     conf_route_table:1;
130
131	u8     enclosure_logical_id[8];
132
133	struct ex_phy *ex_phy;
134	struct sas_port *parent_port;
135
136	struct mutex cmd_mutex;
137};
138
139/* ---------- SATA device ---------- */
 
 
 
 
 
140#define ATA_RESP_FIS_SIZE 24
141
142struct sata_device {
143	unsigned int class;
144	u8     port_no;        /* port number, if this is a PM (Port) */
 
145
146	struct ata_port *ap;
147	struct ata_host *ata_host;
148	struct smp_rps_resp rps_resp ____cacheline_aligned; /* report_phy_sata_resp */
149	u8     fis[ATA_RESP_FIS_SIZE];
150};
151
152struct ssp_device {
153	struct list_head eh_list_node; /* pending a user requested eh action */
154	struct scsi_lun reset_lun;
155};
156
157enum {
158	SAS_DEV_GONE,
159	SAS_DEV_FOUND, /* device notified to lldd */
160	SAS_DEV_DESTROY,
161	SAS_DEV_EH_PENDING,
162	SAS_DEV_LU_RESET,
163	SAS_DEV_RESET,
164};
165
166struct domain_device {
167	spinlock_t done_lock;
168	enum sas_device_type dev_type;
169
170	enum sas_linkrate linkrate;
171	enum sas_linkrate min_linkrate;
172	enum sas_linkrate max_linkrate;
173
174	int  pathways;
175
176	struct domain_device *parent;
177	struct list_head siblings; /* devices on the same level */
178	struct asd_sas_port *port;        /* shortcut to root of the tree */
179	struct sas_phy *phy;
180
181	struct list_head dev_list_node;
182	struct list_head disco_list_node; /* awaiting probe or destruct */
183
184	enum sas_protocol    iproto;
185	enum sas_protocol    tproto;
186
187	struct sas_rphy *rphy;
188
189	u8  sas_addr[SAS_ADDR_SIZE];
190	u8  hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
191
192	u8  frame_rcvd[32];
193
194	union {
195		struct expander_device ex_dev;
196		struct sata_device     sata_dev; /* STP & directly attached */
197		struct ssp_device      ssp_dev;
198	};
199
200	void *lldd_dev;
201	unsigned long state;
202	struct kref kref;
203};
204
205struct sas_work {
206	struct list_head drain_node;
207	struct work_struct work;
208};
209
210static inline bool dev_is_expander(enum sas_device_type type)
211{
212	return type == SAS_EDGE_EXPANDER_DEVICE ||
213	       type == SAS_FANOUT_EXPANDER_DEVICE;
214}
215
216static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
217{
218	INIT_WORK(&sw->work, fn);
219	INIT_LIST_HEAD(&sw->drain_node);
220}
221
222struct sas_discovery_event {
223	struct sas_work work;
224	struct asd_sas_port *port;
225};
226
227static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
228{
229	struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
230
231	return ev;
232}
233
234struct sas_discovery {
235	struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
236	unsigned long    pending;
237	u8     fanout_sas_addr[SAS_ADDR_SIZE];
238	u8     eeds_a[SAS_ADDR_SIZE];
239	u8     eeds_b[SAS_ADDR_SIZE];
240	int    max_level;
241};
242
243/* The port struct is Class:RW, driver:RO */
244struct asd_sas_port {
245/* private: */
 
 
246	struct sas_discovery disc;
247	struct domain_device *port_dev;
248	spinlock_t dev_list_lock;
249	struct list_head dev_list;
250	struct list_head disco_list;
251	struct list_head destroy_list;
252	struct list_head sas_port_del_list;
253	enum   sas_linkrate linkrate;
254
255	struct sas_work work;
256	int suspended;
257
258/* public: */
259	int id;
260
261	enum sas_class   class;
262	u8               sas_addr[SAS_ADDR_SIZE];
263	u8               attached_sas_addr[SAS_ADDR_SIZE];
264	enum sas_protocol   iproto;
265	enum sas_protocol   tproto;
266
267	enum sas_oob_mode oob_mode;
268
269	spinlock_t       phy_list_lock;
270	struct list_head phy_list;
271	int              num_phys;
272	u32              phy_mask;
273
274	struct sas_ha_struct *ha;
275
276	struct sas_port	*port;
277
278	void *lldd_port;	  /* not touched by the sas class code */
279};
280
281struct asd_sas_event {
282	struct sas_work work;
283	struct asd_sas_phy *phy;
284	int event;
285};
286
287static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
288{
289	struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
290
291	return ev;
292}
293
294static inline void INIT_SAS_EVENT(struct asd_sas_event *ev,
295		void (*fn)(struct work_struct *),
296		struct asd_sas_phy *phy, int event)
297{
298	INIT_SAS_WORK(&ev->work, fn);
299	ev->phy = phy;
300	ev->event = event;
301}
302
303#define SAS_PHY_SHUTDOWN_THRES   1024
304
305/* The phy pretty much is controlled by the LLDD.
306 * The class only reads those fields.
307 */
308struct asd_sas_phy {
309/* private: */
310	atomic_t event_nr;
311	int in_shutdown;
 
 
 
 
312	int error;
313	int suspended;
314
315	struct sas_phy *phy;
316
317/* public: */
318	/* The following are class:RO, driver:R/W */
319	int            enabled;	  /* must be set */
320
321	int            id;	  /* must be set */
322	enum sas_class class;
323	enum sas_protocol iproto;
324	enum sas_protocol tproto;
325
326	enum sas_phy_type  type;
327	enum sas_phy_role  role;
328	enum sas_oob_mode  oob_mode;
329	enum sas_linkrate linkrate;
330
331	u8   *sas_addr;		  /* must be set */
332	u8   attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
333
334	spinlock_t     frame_rcvd_lock;
335	u8             *frame_rcvd; /* must be set */
336	int            frame_rcvd_size;
337
338	spinlock_t     sas_prim_lock;
339	u32            sas_prim;
340
341	struct list_head port_phy_el; /* driver:RO */
342	struct asd_sas_port      *port; /* Class:RW, driver: RO */
343
344	struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
345
346	void *lldd_phy;		  /* not touched by the sas_class_code */
347};
348
349struct scsi_core {
350	struct Scsi_Host *shost;
351
 
 
 
 
 
 
 
 
 
 
 
352};
353
 
 
 
 
 
 
 
354enum sas_ha_state {
355	SAS_HA_REGISTERED,
356	SAS_HA_DRAINING,
357	SAS_HA_ATA_EH_ACTIVE,
358	SAS_HA_FROZEN,
359	SAS_HA_RESUMING,
360};
361
362struct sas_ha_struct {
363/* private: */
 
 
 
364	struct list_head  defer_q; /* work queued while draining */
365	struct mutex	  drain_mutex;
366	unsigned long	  state;
367	spinlock_t	  lock;
368	int		  eh_active;
369	wait_queue_head_t eh_wait_q;
370	struct list_head  eh_dev_q;
371
372	struct mutex disco_mutex;
373
374	struct scsi_core core;
375
376/* public: */
377	char *sas_ha_name;
378	struct device *dev;	  /* should be set */
379	struct module *lldd_module; /* should be set */
380
381	struct workqueue_struct *event_q;
382	struct workqueue_struct *disco_q;
383
384	u8 *sas_addr;		  /* must be set */
385	u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
386
387	spinlock_t      phy_port_lock;
388	struct asd_sas_phy  **sas_phy; /* array of valid pointers, must be set */
389	struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
390	int             num_phys; /* must be set, gt 0, static */
391
 
 
 
392	int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
393				* their siblings when forming wide ports */
394
 
 
 
 
 
395	void *lldd_ha;		  /* not touched by sas class code */
396
397	struct list_head eh_done_q;  /* complete via scsi_eh_flush_done_q */
398	struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */
399
400	int event_thres;
401};
402
403#define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
404
405static inline struct domain_device *
406starget_to_domain_dev(struct scsi_target *starget) {
407	return starget->hostdata;
408}
409
410static inline struct domain_device *
411sdev_to_domain_dev(struct scsi_device *sdev) {
412	return starget_to_domain_dev(sdev->sdev_target);
413}
414
415static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
416{
417	return &dev->sata_dev.ap->link.device[0];
418}
419
420static inline struct domain_device *
421cmd_to_domain_dev(struct scsi_cmnd *cmd)
422{
423	return sdev_to_domain_dev(cmd->device);
424}
425
426void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
427
428/* Before calling a notify event, LLDD should use this function
429 * when the link is severed (possibly from its tasklet).
430 * The idea is that the Class only reads those, while the LLDD,
431 * can R/W these (thus avoiding a race).
432 */
433static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
434{
435	phy->oob_mode = OOB_NOT_CONNECTED;
436	phy->linkrate = SAS_LINK_RATE_UNKNOWN;
437}
438
439static inline unsigned int to_sas_gpio_od(int device, int bit)
440{
441	return 3 * device + bit;
442}
443
444static inline void sas_put_local_phy(struct sas_phy *phy)
445{
446	put_device(&phy->dev);
447}
448
449#ifdef CONFIG_SCSI_SAS_HOST_SMP
450int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
451#else
452static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
453{
454	return -1;
455}
456#endif
457
458/* ---------- Tasks ---------- */
459/*
460      service_response |  SAS_TASK_COMPLETE  |  SAS_TASK_UNDELIVERED |
461  exec_status          |                     |                       |
462  ---------------------+---------------------+-----------------------+
463       SAM_...         |         X           |                       |
464       DEV_NO_RESPONSE |         X           |           X           |
465       INTERRUPTED     |         X           |                       |
466       QUEUE_FULL      |                     |           X           |
467       DEVICE_UNKNOWN  |                     |           X           |
468       SG_ERR          |                     |           X           |
469  ---------------------+---------------------+-----------------------+
470 */
471
472enum service_response {
473	SAS_TASK_COMPLETE,
474	SAS_TASK_UNDELIVERED = -1,
475};
476
477enum exec_status {
478	/*
479	 * Values 0..0x7f are used to return the SAM_STAT_* codes.  To avoid
480	 * 'case value not in enumerated type' compiler warnings every value
481	 * returned through the exec_status enum needs an alias with the SAS_
482	 * prefix here.
483	 */
484	SAS_SAM_STAT_GOOD = SAM_STAT_GOOD,
485	SAS_SAM_STAT_BUSY = SAM_STAT_BUSY,
486	SAS_SAM_STAT_TASK_ABORTED = SAM_STAT_TASK_ABORTED,
487	SAS_SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
488
489	SAS_DEV_NO_RESPONSE = 0x80,
490	SAS_DATA_UNDERRUN,
491	SAS_DATA_OVERRUN,
492	SAS_INTERRUPTED,
493	SAS_QUEUE_FULL,
494	SAS_DEVICE_UNKNOWN,
 
495	SAS_OPEN_REJECT,
496	SAS_OPEN_TO,
497	SAS_PROTO_RESPONSE,
498	SAS_PHY_DOWN,
499	SAS_NAK_R_ERR,
500	SAS_PENDING,
501	SAS_ABORTED_TASK,
502};
503
504/* When a task finishes with a response, the LLDD examines the
505 * response:
506 *	- For an ATA task task_status_struct::stat is set to
507 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
508 * contents of struct ata_task_resp.
509 *	- For SSP tasks, if no data is present or status/TMF response
510 * is valid, task_status_struct::stat is set.  If data is present
511 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
512 * task_status_struct::buf_valid_size, and task_status_struct::stat is
513 * set to SAM_CHECK_COND.
514 *
515 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
516 * for ATA task.
517 *
518 * "frame_len" is the total frame length, which could be more or less
519 * than actually copied.
520 *
521 * Tasks ending with response, always set the residual field.
522 */
523struct ata_task_resp {
524	u16  frame_len;
525	u8   ending_fis[ATA_RESP_FIS_SIZE];	  /* dev to host or data-in */
526};
527
528#define SAS_STATUS_BUF_SIZE 96
529
530struct task_status_struct {
531	enum service_response resp;
532	enum exec_status      stat;
533	int  buf_valid_size;
534
535	u8   buf[SAS_STATUS_BUF_SIZE];
536
537	u32  residual;
538	enum sas_open_rej_reason open_rej_reason;
539};
540
541/* ATA and ATAPI task queuable to a SAS LLDD.
542 */
543struct sas_ata_task {
544	struct host_to_dev_fis fis;
545	u8     atapi_packet[16];  /* 0 if not ATAPI task */
546
547	u8     retry_count;	  /* hardware retry, should be > 0 */
548
549	u8     dma_xfer:1;	  /* PIO:0 or DMA:1 */
550	u8     use_ncq:1;
551	u8     set_affil_pol:1;
552	u8     stp_affil_pol:1;
553
554	u8     device_control_reg_update:1;
555
556	bool   force_phy;
557	int    force_phy_id;
558};
559
560/* LLDDs rely on these values */
561enum sas_internal_abort {
562	SAS_INTERNAL_ABORT_SINGLE	= 0,
563	SAS_INTERNAL_ABORT_DEV		= 1,
564};
565
566struct sas_internal_abort_task {
567	enum sas_internal_abort type;
568	unsigned int qid;
569	u16 tag;
570};
571
572struct sas_smp_task {
573	struct scatterlist smp_req;
574	struct scatterlist smp_resp;
575};
576
577enum task_attribute {
578	TASK_ATTR_SIMPLE = 0,
579	TASK_ATTR_HOQ    = 1,
580	TASK_ATTR_ORDERED= 2,
581	TASK_ATTR_ACA    = 4,
582};
583
584struct sas_ssp_task {
585	u8     retry_count;	  /* hardware retry, should be > 0 */
586
587	u8     LUN[8];
588	u8     enable_first_burst:1;
589	enum   task_attribute task_attr;
590	u8     task_prio;
591	struct scsi_cmnd *cmd;
592};
593
594struct sas_tmf_task {
595	u8 tmf;
596	u16 tag_of_task_to_be_managed;
597};
598
599struct sas_task {
600	struct domain_device *dev;
 
601
602	spinlock_t   task_state_lock;
603	unsigned     task_state_flags;
604
605	enum   sas_protocol      task_proto;
606
607	union {
608		struct sas_ata_task ata_task;
609		struct sas_smp_task smp_task;
610		struct sas_ssp_task ssp_task;
611		struct sas_internal_abort_task abort_task;
612	};
613
614	struct scatterlist *scatter;
615	int    num_scatter;
616	u32    total_xfer_len;
617	u8     data_dir:2;	  /* Use PCI_DMA_... */
618
619	struct task_status_struct task_status;
620	void   (*task_done)(struct sas_task *);
621
622	void   *lldd_task;	  /* for use by LLDDs */
623	void   *uldd_task;
624	struct sas_task_slow *slow_task;
625	struct sas_tmf_task *tmf;
626};
627
628struct sas_task_slow {
629	/* standard/extra infrastructure for slow path commands (SMP and
630	 * internal lldd commands
631	 */
632	struct timer_list     timer;
633	struct completion     completion;
634	struct sas_task       *task;
635};
636
637#define SAS_TASK_STATE_PENDING      1
638#define SAS_TASK_STATE_DONE         2
639#define SAS_TASK_STATE_ABORTED      4
640#define SAS_TASK_NEED_DEV_RESET     8
 
641
642static inline bool sas_is_internal_abort(struct sas_task *task)
643{
644	return task->task_proto == SAS_PROTOCOL_INTERNAL_ABORT;
645}
646
647static inline struct request *sas_task_find_rq(struct sas_task *task)
648{
649	struct scsi_cmnd *scmd;
650
651	if (task->task_proto & SAS_PROTOCOL_STP_ALL) {
652		struct ata_queued_cmd *qc = task->uldd_task;
653
654		scmd = qc ? qc->scsicmd : NULL;
655	} else {
656		scmd = task->uldd_task;
657	}
658
659	if (!scmd)
660		return NULL;
661
662	return scsi_cmd_to_rq(scmd);
663}
664
665struct sas_domain_function_template {
666	/* The class calls these to notify the LLDD of an event. */
667	void (*lldd_port_formed)(struct asd_sas_phy *);
668	void (*lldd_port_deformed)(struct asd_sas_phy *);
669
670	/* The class calls these when a device is found or gone. */
671	int  (*lldd_dev_found)(struct domain_device *);
672	void (*lldd_dev_gone)(struct domain_device *);
673
674	int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags);
 
675
676	/* Task Management Functions. Must be called from process context. */
677	int (*lldd_abort_task)(struct sas_task *);
678	int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
 
679	int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
680	int (*lldd_I_T_nexus_reset)(struct domain_device *);
681	int (*lldd_ata_check_ready)(struct domain_device *);
682	void (*lldd_ata_set_dmamode)(struct domain_device *);
683	int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
684	int (*lldd_query_task)(struct sas_task *);
685
686	/* Special TMF callbacks */
687	void (*lldd_tmf_exec_complete)(struct domain_device *dev);
688	void (*lldd_tmf_aborted)(struct sas_task *task);
689	bool (*lldd_abort_timeout)(struct sas_task *task, void *data);
690
691	/* Port and Adapter management */
692	int (*lldd_clear_nexus_port)(struct asd_sas_port *);
693	int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
694
695	/* Phy management */
696	int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
697
698	/* GPIO support */
699	int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
700			       u8 reg_index, u8 reg_count, u8 *write_data);
701};
702
703extern int sas_register_ha(struct sas_ha_struct *);
704extern int sas_unregister_ha(struct sas_ha_struct *);
705extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
706extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
707extern void sas_resume_ha_no_sync(struct sas_ha_struct *sas_ha);
708extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
709
710int sas_set_phy_speed(struct sas_phy *phy, struct sas_phy_linkrates *rates);
 
711int sas_phy_reset(struct sas_phy *phy, int hard_reset);
712int sas_phy_enable(struct sas_phy *phy, int enable);
713extern int sas_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
714extern int sas_target_alloc(struct scsi_target *);
715extern int sas_slave_configure(struct scsi_device *);
716extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
717extern int sas_bios_param(struct scsi_device *, struct block_device *,
 
 
 
718			  sector_t capacity, int *hsc);
719int sas_execute_internal_abort_single(struct domain_device *device,
720				      u16 tag, unsigned int qid,
721				      void *data);
722int sas_execute_internal_abort_dev(struct domain_device *device,
723				   unsigned int qid, void *data);
724extern struct scsi_transport_template *
725sas_domain_attach_transport(struct sas_domain_function_template *);
726extern struct device_attribute dev_attr_phy_event_threshold;
727
728int  sas_discover_root_expander(struct domain_device *);
729
730void sas_init_ex_attr(void);
731
732int  sas_ex_revalidate_domain(struct domain_device *);
733
734void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
735void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
736void sas_discover_event(struct asd_sas_port *, enum discover_event ev);
737
738int  sas_discover_sata(struct domain_device *);
739int  sas_discover_end_dev(struct domain_device *);
740
741void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
742
743void sas_init_dev(struct domain_device *);
744
745void sas_task_abort(struct sas_task *);
746int sas_eh_abort_handler(struct scsi_cmnd *cmd);
747int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
748int sas_eh_target_reset_handler(struct scsi_cmnd *cmd);
749
750extern void sas_target_destroy(struct scsi_target *);
751extern int sas_slave_alloc(struct scsi_device *);
752extern int sas_ioctl(struct scsi_device *sdev, unsigned int cmd,
753		     void __user *arg);
754extern int sas_drain_work(struct sas_ha_struct *ha);
755
 
 
 
756extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
757				  struct ssp_response_iu *iu);
758struct sas_phy *sas_get_local_phy(struct domain_device *dev);
759
760int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
761
762int sas_abort_task_set(struct domain_device *dev, u8 *lun);
763int sas_clear_task_set(struct domain_device *dev, u8 *lun);
764int sas_lu_reset(struct domain_device *dev, u8 *lun);
765int sas_query_task(struct sas_task *task, u16 tag);
766int sas_abort_task(struct sas_task *task, u16 tag);
767int sas_find_attached_phy_id(struct expander_device *ex_dev,
768			     struct domain_device *dev);
769
770void sas_notify_port_event(struct asd_sas_phy *phy, enum port_event event,
771			   gfp_t gfp_flags);
772void sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event,
773			   gfp_t gfp_flags);
774
775#endif /* _SASLIB_H_ */
v3.15
 
  1/*
  2 * SAS host prototypes and structures header file
  3 *
  4 * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
  5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
  6 *
  7 * This file is licensed under GPLv2.
  8 *
  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.
 13 *
 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.
 18 *
 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
 22 * USA
 23 *
 24 */
 25
 26#ifndef _LIBSAS_H_
 27#define _LIBSAS_H_
 28
 29
 30#include <linux/timer.h>
 31#include <linux/pci.h>
 32#include <scsi/sas.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>
 40
 41struct block_device;
 42
 43enum sas_class {
 44	SAS,
 45	EXPANDER
 46};
 47
 48enum sas_phy_role {
 49	PHY_ROLE_NONE = 0,
 50	PHY_ROLE_TARGET = 0x40,
 51	PHY_ROLE_INITIATOR = 0x80,
 52};
 53
 54enum sas_phy_type {
 55        PHY_TYPE_PHYSICAL,
 56        PHY_TYPE_VIRTUAL
 57};
 58
 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.
 62 */
 63enum ha_event {
 64	HAE_RESET             = 0U,
 65	HA_NUM_EVENTS         = 1,
 66};
 67
 68enum port_event {
 69	PORTE_BYTES_DMAED     = 0U,
 70	PORTE_BROADCAST_RCVD  = 1,
 71	PORTE_LINK_RESET_ERR  = 2,
 72	PORTE_TIMER_EVENT     = 3,
 73	PORTE_HARD_RESET      = 4,
 74	PORT_NUM_EVENTS       = 5,
 75};
 76
 77enum phy_event {
 78	PHYE_LOSS_OF_SIGNAL   = 0U,
 79	PHYE_OOB_DONE         = 1,
 80	PHYE_OOB_ERROR        = 2,
 81	PHYE_SPINUP_HOLD      = 3, /* hot plug SATA, no COMWAKE sent */
 82	PHYE_RESUME_TIMEOUT   = 4,
 83	PHY_NUM_EVENTS        = 5,
 
 84};
 85
 86enum discover_event {
 87	DISCE_DISCOVER_DOMAIN   = 0U,
 88	DISCE_REVALIDATE_DOMAIN = 1,
 89	DISCE_PORT_GONE         = 2,
 90	DISCE_PROBE		= 3,
 91	DISCE_SUSPEND		= 4,
 92	DISCE_RESUME		= 5,
 93	DISCE_DESTRUCT		= 6,
 94	DISC_NUM_EVENTS		= 7,
 95};
 96
 97/* ---------- Expander Devices ---------- */
 98
 99#define to_dom_device(_obj) container_of(_obj, struct domain_device, dev_obj)
100#define to_dev_attr(_attr)  container_of(_attr, struct domain_dev_attribute,\
101                                         attr)
102
103enum routing_attribute {
104	DIRECT_ROUTING,
105	SUBTRACTIVE_ROUTING,
106	TABLE_ROUTING,
107};
108
109enum ex_phy_state {
110	PHY_EMPTY,
111	PHY_VACANT,
112	PHY_NOT_PRESENT,
113	PHY_DEVICE_DISCOVERED
114};
115
116struct ex_phy {
117	int    phy_id;
118
119	enum ex_phy_state phy_state;
120
121	enum sas_device_type attached_dev_type;
122	enum sas_linkrate linkrate;
123
124	u8   attached_sata_host:1;
125	u8   attached_sata_dev:1;
126	u8   attached_sata_ps:1;
127
128	enum sas_protocol attached_tproto;
129	enum sas_protocol attached_iproto;
130
131	u8   attached_sas_addr[SAS_ADDR_SIZE];
132	u8   attached_phy_id;
133
134	int phy_change_count;
135	enum routing_attribute routing_attr;
136	u8   virtual:1;
137
138	int  last_da_index;
139
140	struct sas_phy *phy;
141	struct sas_port *port;
142};
143
144struct expander_device {
145	struct list_head children;
146
147	int    ex_change_count;
148	u16    max_route_indexes;
149	u8     num_phys;
150
151	u8     t2t_supp:1;
152	u8     configuring:1;
153	u8     conf_route_table:1;
154
155	u8     enclosure_logical_id[8];
156
157	struct ex_phy *ex_phy;
158	struct sas_port *parent_port;
159
160	struct mutex cmd_mutex;
161};
162
163/* ---------- SATA device ---------- */
164enum ata_command_set {
165        ATA_COMMAND_SET   = 0,
166        ATAPI_COMMAND_SET = 1,
167};
168
169#define ATA_RESP_FIS_SIZE 24
170
171struct sata_device {
172        enum   ata_command_set command_set;
173        struct smp_resp        rps_resp; /* report_phy_sata_resp */
174        u8     port_no;        /* port number, if this is a PM (Port) */
175
176	struct ata_port *ap;
177	struct ata_host ata_host;
 
178	u8     fis[ATA_RESP_FIS_SIZE];
179};
180
181struct ssp_device {
182	struct list_head eh_list_node; /* pending a user requested eh action */
183	struct scsi_lun reset_lun;
184};
185
186enum {
187	SAS_DEV_GONE,
188	SAS_DEV_FOUND, /* device notified to lldd */
189	SAS_DEV_DESTROY,
190	SAS_DEV_EH_PENDING,
191	SAS_DEV_LU_RESET,
192	SAS_DEV_RESET,
193};
194
195struct domain_device {
196	spinlock_t done_lock;
197	enum sas_device_type dev_type;
198
199        enum sas_linkrate linkrate;
200        enum sas_linkrate min_linkrate;
201        enum sas_linkrate max_linkrate;
202
203        int  pathways;
204
205        struct domain_device *parent;
206        struct list_head siblings; /* devices on the same level */
207        struct asd_sas_port *port;        /* shortcut to root of the tree */
208	struct sas_phy *phy;
209
210        struct list_head dev_list_node;
211	struct list_head disco_list_node; /* awaiting probe or destruct */
212
213        enum sas_protocol    iproto;
214        enum sas_protocol    tproto;
215
216        struct sas_rphy *rphy;
217
218        u8  sas_addr[SAS_ADDR_SIZE];
219        u8  hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
220
221        u8  frame_rcvd[32];
222
223        union {
224                struct expander_device ex_dev;
225                struct sata_device     sata_dev; /* STP & directly attached */
226		struct ssp_device      ssp_dev;
227        };
228
229        void *lldd_dev;
230	unsigned long state;
231	struct kref kref;
232};
233
234struct sas_work {
235	struct list_head drain_node;
236	struct work_struct work;
237};
238
 
 
 
 
 
 
239static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
240{
241	INIT_WORK(&sw->work, fn);
242	INIT_LIST_HEAD(&sw->drain_node);
243}
244
245struct sas_discovery_event {
246	struct sas_work work;
247	struct asd_sas_port *port;
248};
249
250static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
251{
252	struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
253
254	return ev;
255}
256
257struct sas_discovery {
258	struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
259	unsigned long    pending;
260	u8     fanout_sas_addr[8];
261	u8     eeds_a[8];
262	u8     eeds_b[8];
263	int    max_level;
264};
265
266/* The port struct is Class:RW, driver:RO */
267struct asd_sas_port {
268/* private: */
269	struct completion port_gone_completion;
270
271	struct sas_discovery disc;
272	struct domain_device *port_dev;
273	spinlock_t dev_list_lock;
274	struct list_head dev_list;
275	struct list_head disco_list;
276	struct list_head destroy_list;
 
277	enum   sas_linkrate linkrate;
278
279	struct sas_work work;
280	int suspended;
281
282/* public: */
283	int id;
284
285	enum sas_class   class;
286	u8               sas_addr[SAS_ADDR_SIZE];
287	u8               attached_sas_addr[SAS_ADDR_SIZE];
288	enum sas_protocol   iproto;
289	enum sas_protocol   tproto;
290
291	enum sas_oob_mode oob_mode;
292
293	spinlock_t       phy_list_lock;
294	struct list_head phy_list;
295	int              num_phys;
296	u32              phy_mask;
297
298	struct sas_ha_struct *ha;
299
300	struct sas_port	*port;
301
302	void *lldd_port;	  /* not touched by the sas class code */
303};
304
305struct asd_sas_event {
306	struct sas_work work;
307	struct asd_sas_phy *phy;
 
308};
309
310static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
311{
312	struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
313
314	return ev;
315}
316
 
 
 
 
 
 
 
 
 
 
 
317/* The phy pretty much is controlled by the LLDD.
318 * The class only reads those fields.
319 */
320struct asd_sas_phy {
321/* private: */
322	struct asd_sas_event   port_events[PORT_NUM_EVENTS];
323	struct asd_sas_event   phy_events[PHY_NUM_EVENTS];
324
325	unsigned long port_events_pending;
326	unsigned long phy_events_pending;
327
328	int error;
329	int suspended;
330
331	struct sas_phy *phy;
332
333/* public: */
334	/* The following are class:RO, driver:R/W */
335	int            enabled;	  /* must be set */
336
337	int            id;	  /* must be set */
338	enum sas_class class;
339	enum sas_protocol iproto;
340	enum sas_protocol tproto;
341
342	enum sas_phy_type  type;
343	enum sas_phy_role  role;
344	enum sas_oob_mode  oob_mode;
345	enum sas_linkrate linkrate;
346
347	u8   *sas_addr;		  /* must be set */
348	u8   attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
349
350	spinlock_t     frame_rcvd_lock;
351	u8             *frame_rcvd; /* must be set */
352	int            frame_rcvd_size;
353
354	spinlock_t     sas_prim_lock;
355	u32            sas_prim;
356
357	struct list_head port_phy_el; /* driver:RO */
358	struct asd_sas_port      *port; /* Class:RW, driver: RO */
359
360	struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
361
362	void *lldd_phy;		  /* not touched by the sas_class_code */
363};
364
365struct scsi_core {
366	struct Scsi_Host *shost;
367
368	struct mutex	  task_queue_flush;
369	spinlock_t        task_queue_lock;
370	struct list_head  task_queue;
371	int               task_queue_size;
372
373	struct task_struct *queue_thread;
374};
375
376struct sas_ha_event {
377	struct sas_work work;
378	struct sas_ha_struct *ha;
379};
380
381static inline struct sas_ha_event *to_sas_ha_event(struct work_struct *work)
382{
383	struct sas_ha_event *ev = container_of(work, typeof(*ev), work.work);
384
385	return ev;
386}
387
388enum sas_ha_state {
389	SAS_HA_REGISTERED,
390	SAS_HA_DRAINING,
391	SAS_HA_ATA_EH_ACTIVE,
392	SAS_HA_FROZEN,
 
393};
394
395struct sas_ha_struct {
396/* private: */
397	struct sas_ha_event ha_events[HA_NUM_EVENTS];
398	unsigned long	 pending;
399
400	struct list_head  defer_q; /* work queued while draining */
401	struct mutex	  drain_mutex;
402	unsigned long	  state;
403	spinlock_t	  lock;
404	int		  eh_active;
405	wait_queue_head_t eh_wait_q;
406	struct list_head  eh_dev_q;
407
408	struct mutex disco_mutex;
409
410	struct scsi_core core;
411
412/* public: */
413	char *sas_ha_name;
414	struct device *dev;	  /* should be set */
415	struct module *lldd_module; /* should be set */
416
 
 
 
417	u8 *sas_addr;		  /* must be set */
418	u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
419
420	spinlock_t      phy_port_lock;
421	struct asd_sas_phy  **sas_phy; /* array of valid pointers, must be set */
422	struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
423	int             num_phys; /* must be set, gt 0, static */
424
425	/* The class calls this to send a task for execution. */
426	int lldd_max_execute_num;
427	int lldd_queue_size;
428	int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
429				* their siblings when forming wide ports */
430
431	/* LLDD calls these to notify the class of an event. */
432	void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
433	void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
434	void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
435
436	void *lldd_ha;		  /* not touched by sas class code */
437
438	struct list_head eh_done_q;  /* complete via scsi_eh_flush_done_q */
439	struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */
 
 
440};
441
442#define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
443
444static inline struct domain_device *
445starget_to_domain_dev(struct scsi_target *starget) {
446	return starget->hostdata;
447}
448
449static inline struct domain_device *
450sdev_to_domain_dev(struct scsi_device *sdev) {
451	return starget_to_domain_dev(sdev->sdev_target);
452}
453
454static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
455{
456	return &dev->sata_dev.ap->link.device[0];
457}
458
459static inline struct domain_device *
460cmd_to_domain_dev(struct scsi_cmnd *cmd)
461{
462	return sdev_to_domain_dev(cmd->device);
463}
464
465void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
466
467/* Before calling a notify event, LLDD should use this function
468 * when the link is severed (possibly from its tasklet).
469 * The idea is that the Class only reads those, while the LLDD,
470 * can R/W these (thus avoiding a race).
471 */
472static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
473{
474	phy->oob_mode = OOB_NOT_CONNECTED;
475	phy->linkrate = SAS_LINK_RATE_UNKNOWN;
476}
477
478static inline unsigned int to_sas_gpio_od(int device, int bit)
479{
480	return 3 * device + bit;
481}
482
483static inline void sas_put_local_phy(struct sas_phy *phy)
484{
485	put_device(&phy->dev);
486}
487
488#ifdef CONFIG_SCSI_SAS_HOST_SMP
489int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
490#else
491static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
492{
493	return -1;
494}
495#endif
496
497/* ---------- Tasks ---------- */
498/*
499      service_response |  SAS_TASK_COMPLETE  |  SAS_TASK_UNDELIVERED |
500  exec_status          |                     |                       |
501  ---------------------+---------------------+-----------------------+
502       SAM_...         |         X           |                       |
503       DEV_NO_RESPONSE |         X           |           X           |
504       INTERRUPTED     |         X           |                       |
505       QUEUE_FULL      |                     |           X           |
506       DEVICE_UNKNOWN  |                     |           X           |
507       SG_ERR          |                     |           X           |
508  ---------------------+---------------------+-----------------------+
509 */
510
511enum service_response {
512	SAS_TASK_COMPLETE,
513	SAS_TASK_UNDELIVERED = -1,
514};
515
516enum exec_status {
517	/* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
518	 * them here to silence 'case value not in enumerated type' warnings
 
 
 
519	 */
520	__SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
 
 
 
521
522	SAS_DEV_NO_RESPONSE = 0x80,
523	SAS_DATA_UNDERRUN,
524	SAS_DATA_OVERRUN,
525	SAS_INTERRUPTED,
526	SAS_QUEUE_FULL,
527	SAS_DEVICE_UNKNOWN,
528	SAS_SG_ERR,
529	SAS_OPEN_REJECT,
530	SAS_OPEN_TO,
531	SAS_PROTO_RESPONSE,
532	SAS_PHY_DOWN,
533	SAS_NAK_R_ERR,
534	SAS_PENDING,
535	SAS_ABORTED_TASK,
536};
537
538/* When a task finishes with a response, the LLDD examines the
539 * response:
540 * 	- For an ATA task task_status_struct::stat is set to
541 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
542 * contents of struct ata_task_resp.
543 * 	- For SSP tasks, if no data is present or status/TMF response
544 * is valid, task_status_struct::stat is set.  If data is present
545 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
546 * task_status_struct::buf_valid_size, and task_status_struct::stat is
547 * set to SAM_CHECK_COND.
548 *
549 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
550 * for ATA task.
551 *
552 * "frame_len" is the total frame length, which could be more or less
553 * than actually copied.
554 *
555 * Tasks ending with response, always set the residual field.
556 */
557struct ata_task_resp {
558	u16  frame_len;
559	u8   ending_fis[ATA_RESP_FIS_SIZE];	  /* dev to host or data-in */
560};
561
562#define SAS_STATUS_BUF_SIZE 96
563
564struct task_status_struct {
565	enum service_response resp;
566	enum exec_status      stat;
567	int  buf_valid_size;
568
569	u8   buf[SAS_STATUS_BUF_SIZE];
570
571	u32  residual;
572	enum sas_open_rej_reason open_rej_reason;
573};
574
575/* ATA and ATAPI task queuable to a SAS LLDD.
576 */
577struct sas_ata_task {
578	struct host_to_dev_fis fis;
579	u8     atapi_packet[16];  /* 0 if not ATAPI task */
580
581	u8     retry_count;	  /* hardware retry, should be > 0 */
582
583	u8     dma_xfer:1;	  /* PIO:0 or DMA:1 */
584	u8     use_ncq:1;
585	u8     set_affil_pol:1;
586	u8     stp_affil_pol:1;
587
588	u8     device_control_reg_update:1;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
589};
590
591struct sas_smp_task {
592	struct scatterlist smp_req;
593	struct scatterlist smp_resp;
594};
595
596enum task_attribute {
597	TASK_ATTR_SIMPLE = 0,
598	TASK_ATTR_HOQ    = 1,
599	TASK_ATTR_ORDERED= 2,
600	TASK_ATTR_ACA    = 4,
601};
602
603struct sas_ssp_task {
604	u8     retry_count;	  /* hardware retry, should be > 0 */
605
606	u8     LUN[8];
607	u8     enable_first_burst:1;
608	enum   task_attribute task_attr;
609	u8     task_prio;
610	struct scsi_cmnd *cmd;
611};
612
 
 
 
 
 
613struct sas_task {
614	struct domain_device *dev;
615	struct list_head      list;
616
617	spinlock_t   task_state_lock;
618	unsigned     task_state_flags;
619
620	enum   sas_protocol      task_proto;
621
622	union {
623		struct sas_ata_task ata_task;
624		struct sas_smp_task smp_task;
625		struct sas_ssp_task ssp_task;
 
626	};
627
628	struct scatterlist *scatter;
629	int    num_scatter;
630	u32    total_xfer_len;
631	u8     data_dir:2;	  /* Use PCI_DMA_... */
632
633	struct task_status_struct task_status;
634	void   (*task_done)(struct sas_task *);
635
636	void   *lldd_task;	  /* for use by LLDDs */
637	void   *uldd_task;
638	struct sas_task_slow *slow_task;
 
639};
640
641struct sas_task_slow {
642	/* standard/extra infrastructure for slow path commands (SMP and
643	 * internal lldd commands
644	 */
645	struct timer_list     timer;
646	struct completion     completion;
 
647};
648
649#define SAS_TASK_STATE_PENDING      1
650#define SAS_TASK_STATE_DONE         2
651#define SAS_TASK_STATE_ABORTED      4
652#define SAS_TASK_NEED_DEV_RESET     8
653#define SAS_TASK_AT_INITIATOR       16
654
655extern struct sas_task *sas_alloc_task(gfp_t flags);
656extern struct sas_task *sas_alloc_slow_task(gfp_t flags);
657extern void sas_free_task(struct sas_task *task);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
658
659struct sas_domain_function_template {
660	/* The class calls these to notify the LLDD of an event. */
661	void (*lldd_port_formed)(struct asd_sas_phy *);
662	void (*lldd_port_deformed)(struct asd_sas_phy *);
663
664	/* The class calls these when a device is found or gone. */
665	int  (*lldd_dev_found)(struct domain_device *);
666	void (*lldd_dev_gone)(struct domain_device *);
667
668	int (*lldd_execute_task)(struct sas_task *, int num,
669				 gfp_t gfp_flags);
670
671	/* Task Management Functions. Must be called from process context. */
672	int (*lldd_abort_task)(struct sas_task *);
673	int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
674	int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
675	int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
676	int (*lldd_I_T_nexus_reset)(struct domain_device *);
677	int (*lldd_ata_check_ready)(struct domain_device *);
678	void (*lldd_ata_set_dmamode)(struct domain_device *);
679	int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
680	int (*lldd_query_task)(struct sas_task *);
681
 
 
 
 
 
682	/* Port and Adapter management */
683	int (*lldd_clear_nexus_port)(struct asd_sas_port *);
684	int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
685
686	/* Phy management */
687	int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
688
689	/* GPIO support */
690	int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
691			       u8 reg_index, u8 reg_count, u8 *write_data);
692};
693
694extern int sas_register_ha(struct sas_ha_struct *);
695extern int sas_unregister_ha(struct sas_ha_struct *);
696extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
697extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
 
698extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
699
700int sas_set_phy_speed(struct sas_phy *phy,
701		      struct sas_phy_linkrates *rates);
702int sas_phy_reset(struct sas_phy *phy, int hard_reset);
703int sas_queue_up(struct sas_task *task);
704extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
705extern int sas_target_alloc(struct scsi_target *);
706extern int sas_slave_configure(struct scsi_device *);
707extern int sas_change_queue_depth(struct scsi_device *, int new_depth,
708				  int reason);
709extern int sas_change_queue_type(struct scsi_device *, int qt);
710extern int sas_bios_param(struct scsi_device *,
711			  struct block_device *,
712			  sector_t capacity, int *hsc);
 
 
 
 
 
713extern struct scsi_transport_template *
714sas_domain_attach_transport(struct sas_domain_function_template *);
715extern void sas_domain_release_transport(struct scsi_transport_template *);
716
717int  sas_discover_root_expander(struct domain_device *);
718
719void sas_init_ex_attr(void);
720
721int  sas_ex_revalidate_domain(struct domain_device *);
722
723void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
724void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
725int  sas_discover_event(struct asd_sas_port *, enum discover_event ev);
726
727int  sas_discover_sata(struct domain_device *);
728int  sas_discover_end_dev(struct domain_device *);
729
730void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
731
732void sas_init_dev(struct domain_device *);
733
734void sas_task_abort(struct sas_task *);
735int sas_eh_abort_handler(struct scsi_cmnd *cmd);
736int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
737int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd);
738
739extern void sas_target_destroy(struct scsi_target *);
740extern int sas_slave_alloc(struct scsi_device *);
741extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
 
742extern int sas_drain_work(struct sas_ha_struct *ha);
743
744extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy,
745			   struct request *req);
746
747extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
748				  struct ssp_response_iu *iu);
749struct sas_phy *sas_get_local_phy(struct domain_device *dev);
750
751int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
 
 
 
 
 
 
 
 
 
 
 
 
 
752
753#endif /* _SASLIB_H_ */