1
2
3
4
5
6
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
43
44
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,
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
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
140#define ATA_RESP_FIS_SIZE 24
141
142struct sata_device {
143 unsigned int class;
144 u8 port_no;
145
146 struct ata_port *ap;
147 struct ata_host *ata_host;
148 struct smp_resp rps_resp ____cacheline_aligned;
149 u8 fis[ATA_RESP_FIS_SIZE];
150};
151
152struct ssp_device {
153 struct list_head eh_list_node;
154 struct scsi_lun reset_lun;
155};
156
157enum {
158 SAS_DEV_GONE,
159 SAS_DEV_FOUND,
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;
178 struct asd_sas_port *port;
179 struct sas_phy *phy;
180
181 struct list_head dev_list_node;
182 struct list_head disco_list_node;
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;
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
244struct asd_sas_port {
245
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
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;
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
306
307
308struct asd_sas_phy {
309
310 atomic_t event_nr;
311 int in_shutdown;
312 int error;
313 int suspended;
314
315 struct sas_phy *phy;
316
317
318
319 int enabled;
320
321 int id;
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;
332 u8 attached_sas_addr[SAS_ADDR_SIZE];
333
334 spinlock_t frame_rcvd_lock;
335 u8 *frame_rcvd;
336 int frame_rcvd_size;
337
338 spinlock_t sas_prim_lock;
339 u32 sas_prim;
340
341 struct list_head port_phy_el;
342 struct asd_sas_port *port;
343
344 struct sas_ha_struct *ha;
345
346 void *lldd_phy;
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};
360
361struct sas_ha_struct {
362
363 struct list_head defer_q;
364 struct mutex drain_mutex;
365 unsigned long state;
366 spinlock_t lock;
367 int eh_active;
368 wait_queue_head_t eh_wait_q;
369 struct list_head eh_dev_q;
370
371 struct mutex disco_mutex;
372
373 struct scsi_core core;
374
375
376 char *sas_ha_name;
377 struct device *dev;
378 struct module *lldd_module;
379
380 struct workqueue_struct *event_q;
381 struct workqueue_struct *disco_q;
382
383 u8 *sas_addr;
384 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
385
386 spinlock_t phy_port_lock;
387 struct asd_sas_phy **sas_phy;
388 struct asd_sas_port **sas_port;
389 int num_phys;
390
391 int strict_wide_ports;
392
393
394 void *lldd_ha;
395
396 struct list_head eh_done_q;
397 struct list_head eh_ata_q;
398
399 int event_thres;
400};
401
402#define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
403
404static inline struct domain_device *
405starget_to_domain_dev(struct scsi_target *starget) {
406 return starget->hostdata;
407}
408
409static inline struct domain_device *
410sdev_to_domain_dev(struct scsi_device *sdev) {
411 return starget_to_domain_dev(sdev->sdev_target);
412}
413
414static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
415{
416 return &dev->sata_dev.ap->link.device[0];
417}
418
419static inline struct domain_device *
420cmd_to_domain_dev(struct scsi_cmnd *cmd)
421{
422 return sdev_to_domain_dev(cmd->device);
423}
424
425void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
426
427
428
429
430
431
432static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
433{
434 phy->oob_mode = OOB_NOT_CONNECTED;
435 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
436}
437
438static inline unsigned int to_sas_gpio_od(int device, int bit)
439{
440 return 3 * device + bit;
441}
442
443static inline void sas_put_local_phy(struct sas_phy *phy)
444{
445 put_device(&phy->dev);
446}
447
448#ifdef CONFIG_SCSI_SAS_HOST_SMP
449int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
450#else
451static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
452{
453 return -1;
454}
455#endif
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471enum service_response {
472 SAS_TASK_COMPLETE,
473 SAS_TASK_UNDELIVERED = -1,
474};
475
476enum exec_status {
477
478
479
480 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
481
482 SAS_DEV_NO_RESPONSE = 0x80,
483 SAS_DATA_UNDERRUN,
484 SAS_DATA_OVERRUN,
485 SAS_INTERRUPTED,
486 SAS_QUEUE_FULL,
487 SAS_DEVICE_UNKNOWN,
488 SAS_SG_ERR,
489 SAS_OPEN_REJECT,
490 SAS_OPEN_TO,
491 SAS_PROTO_RESPONSE,
492 SAS_PHY_DOWN,
493 SAS_NAK_R_ERR,
494 SAS_PENDING,
495 SAS_ABORTED_TASK,
496};
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517struct ata_task_resp {
518 u16 frame_len;
519 u8 ending_fis[ATA_RESP_FIS_SIZE];
520};
521
522#define SAS_STATUS_BUF_SIZE 96
523
524struct task_status_struct {
525 enum service_response resp;
526 enum exec_status stat;
527 int buf_valid_size;
528
529 u8 buf[SAS_STATUS_BUF_SIZE];
530
531 u32 residual;
532 enum sas_open_rej_reason open_rej_reason;
533};
534
535
536
537struct sas_ata_task {
538 struct host_to_dev_fis fis;
539 u8 atapi_packet[16];
540
541 u8 retry_count;
542
543 u8 dma_xfer:1;
544 u8 use_ncq:1;
545 u8 set_affil_pol:1;
546 u8 stp_affil_pol:1;
547
548 u8 device_control_reg_update:1;
549};
550
551struct sas_smp_task {
552 struct scatterlist smp_req;
553 struct scatterlist smp_resp;
554};
555
556enum task_attribute {
557 TASK_ATTR_SIMPLE = 0,
558 TASK_ATTR_HOQ = 1,
559 TASK_ATTR_ORDERED= 2,
560 TASK_ATTR_ACA = 4,
561};
562
563struct sas_ssp_task {
564 u8 retry_count;
565
566 u8 LUN[8];
567 u8 enable_first_burst:1;
568 enum task_attribute task_attr;
569 u8 task_prio;
570 struct scsi_cmnd *cmd;
571};
572
573struct sas_task {
574 struct domain_device *dev;
575
576 spinlock_t task_state_lock;
577 unsigned task_state_flags;
578
579 enum sas_protocol task_proto;
580
581 union {
582 struct sas_ata_task ata_task;
583 struct sas_smp_task smp_task;
584 struct sas_ssp_task ssp_task;
585 };
586
587 struct scatterlist *scatter;
588 int num_scatter;
589 u32 total_xfer_len;
590 u8 data_dir:2;
591
592 struct task_status_struct task_status;
593 void (*task_done)(struct sas_task *);
594
595 void *lldd_task;
596 void *uldd_task;
597 struct sas_task_slow *slow_task;
598};
599
600struct sas_task_slow {
601
602
603
604 struct timer_list timer;
605 struct completion completion;
606 struct sas_task *task;
607};
608
609#define SAS_TASK_STATE_PENDING 1
610#define SAS_TASK_STATE_DONE 2
611#define SAS_TASK_STATE_ABORTED 4
612#define SAS_TASK_NEED_DEV_RESET 8
613#define SAS_TASK_AT_INITIATOR 16
614
615extern struct sas_task *sas_alloc_task(gfp_t flags);
616extern struct sas_task *sas_alloc_slow_task(gfp_t flags);
617extern void sas_free_task(struct sas_task *task);
618
619struct sas_domain_function_template {
620
621 void (*lldd_port_formed)(struct asd_sas_phy *);
622 void (*lldd_port_deformed)(struct asd_sas_phy *);
623
624
625 int (*lldd_dev_found)(struct domain_device *);
626 void (*lldd_dev_gone)(struct domain_device *);
627
628 int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags);
629
630
631 int (*lldd_abort_task)(struct sas_task *);
632 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
633 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
634 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
635 int (*lldd_I_T_nexus_reset)(struct domain_device *);
636 int (*lldd_ata_check_ready)(struct domain_device *);
637 void (*lldd_ata_set_dmamode)(struct domain_device *);
638 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
639 int (*lldd_query_task)(struct sas_task *);
640
641
642 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
643 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
644
645
646 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
647
648
649 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
650 u8 reg_index, u8 reg_count, u8 *write_data);
651};
652
653extern int sas_register_ha(struct sas_ha_struct *);
654extern int sas_unregister_ha(struct sas_ha_struct *);
655extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
656extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
657extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
658
659int sas_set_phy_speed(struct sas_phy *phy, struct sas_phy_linkrates *rates);
660int sas_phy_reset(struct sas_phy *phy, int hard_reset);
661extern int sas_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
662extern int sas_target_alloc(struct scsi_target *);
663extern int sas_slave_configure(struct scsi_device *);
664extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
665extern int sas_bios_param(struct scsi_device *, struct block_device *,
666 sector_t capacity, int *hsc);
667extern struct scsi_transport_template *
668sas_domain_attach_transport(struct sas_domain_function_template *);
669extern struct device_attribute dev_attr_phy_event_threshold;
670
671int sas_discover_root_expander(struct domain_device *);
672
673void sas_init_ex_attr(void);
674
675int sas_ex_revalidate_domain(struct domain_device *);
676
677void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
678void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
679int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
680
681int sas_discover_sata(struct domain_device *);
682int sas_discover_end_dev(struct domain_device *);
683
684void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
685
686void sas_init_dev(struct domain_device *);
687
688void sas_task_abort(struct sas_task *);
689int sas_eh_abort_handler(struct scsi_cmnd *cmd);
690int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
691int sas_eh_target_reset_handler(struct scsi_cmnd *cmd);
692
693extern void sas_target_destroy(struct scsi_target *);
694extern int sas_slave_alloc(struct scsi_device *);
695extern int sas_ioctl(struct scsi_device *sdev, unsigned int cmd,
696 void __user *arg);
697extern int sas_drain_work(struct sas_ha_struct *ha);
698
699extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
700 struct ssp_response_iu *iu);
701struct sas_phy *sas_get_local_phy(struct domain_device *dev);
702
703int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
704
705int sas_notify_port_event(struct asd_sas_phy *phy, enum port_event event,
706 gfp_t gfp_flags);
707int sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event,
708 gfp_t gfp_flags);
709
710#endif
711