blob: 706a7017885c20c0fdfa9ee6520f00d1e8278c53 [file] [log] [blame]
James Bottomley2908d772006-08-29 09:22:51 -05001/*
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>
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -070033#include <linux/libata.h>
James Bottomley2908d772006-08-29 09:22:51 -050034#include <linux/list.h>
James Bottomley2908d772006-08-29 09:22:51 -050035#include <scsi/scsi_device.h>
36#include <scsi/scsi_cmnd.h>
37#include <scsi/scsi_transport_sas.h>
Adrian Bunk87ae9af2007-10-30 10:35:04 +010038#include <linux/scatterlist.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090039#include <linux/slab.h>
James Bottomley2908d772006-08-29 09:22:51 -050040
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 */
Dan Williams303694e2012-06-21 23:41:51 -070082 PHYE_RESUME_TIMEOUT = 4,
83 PHY_NUM_EVENTS = 5,
James Bottomley2908d772006-08-29 09:22:51 -050084};
85
86enum discover_event {
87 DISCE_DISCOVER_DOMAIN = 0U,
88 DISCE_REVALIDATE_DOMAIN = 1,
89 DISCE_PORT_GONE = 2,
Dan Williams87c83312011-11-17 17:59:51 -080090 DISCE_PROBE = 3,
Dan Williams303694e2012-06-21 23:41:51 -070091 DISCE_SUSPEND = 4,
92 DISCE_RESUME = 5,
93 DISCE_DESTRUCT = 6,
94 DISC_NUM_EVENTS = 7,
James Bottomley2908d772006-08-29 09:22:51 -050095};
96
97/* ---------- Expander Devices ---------- */
98
James Bottomley2908d772006-08-29 09:22:51 -050099#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
James Bottomleyaa9f8322013-05-07 14:44:06 -0700121 enum sas_device_type attached_dev_type;
James Bottomley88edf742006-09-06 17:36:13 -0500122 enum sas_linkrate linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500123
124 u8 attached_sata_host:1;
125 u8 attached_sata_dev:1;
126 u8 attached_sata_ps:1;
127
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800128 enum sas_protocol attached_tproto;
129 enum sas_protocol attached_iproto;
James Bottomley2908d772006-08-29 09:22:51 -0500130
131 u8 attached_sas_addr[SAS_ADDR_SIZE];
132 u8 attached_phy_id;
133
Dan Williams303694e2012-06-21 23:41:51 -0700134 int phy_change_count;
James Bottomley2908d772006-08-29 09:22:51 -0500135 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
Dan Williams303694e2012-06-21 23:41:51 -0700147 int ex_change_count;
James Bottomley2908d772006-08-29 09:22:51 -0500148 u16 max_route_indexes;
149 u8 num_phys;
Luben Tuikovffaac8f2011-09-22 09:41:36 -0700150
151 u8 t2t_supp:1;
James Bottomley2908d772006-08-29 09:22:51 -0500152 u8 configuring:1;
153 u8 conf_route_table:1;
Luben Tuikovffaac8f2011-09-22 09:41:36 -0700154
James Bottomley2908d772006-08-29 09:22:51 -0500155 u8 enclosure_logical_id[8];
156
157 struct ex_phy *ex_phy;
158 struct sas_port *parent_port;
Jeff Skirvin89d3cf62011-11-16 09:44:13 +0000159
160 struct mutex cmd_mutex;
James Bottomley2908d772006-08-29 09:22:51 -0500161};
162
163/* ---------- SATA device ---------- */
Dan Williams6ef1b512012-06-22 10:52:34 -0700164#define ATA_RESP_FIS_SIZE 24
165
James Bottomley2908d772006-08-29 09:22:51 -0500166struct sata_device {
Hannes Reinecke1cbd7722014-11-05 13:08:20 +0100167 unsigned int class;
Hannes Reinecke1cbd7722014-11-05 13:08:20 +0100168 u8 port_no; /* port number, if this is a PM (Port) */
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -0700169
170 struct ata_port *ap;
171 struct ata_host ata_host;
Huacai Chen35b4bfb2017-11-21 14:23:39 +0100172 struct smp_resp rps_resp ____cacheline_aligned; /* report_phy_sata_resp */
Dan Williams6ef1b512012-06-22 10:52:34 -0700173 u8 fis[ATA_RESP_FIS_SIZE];
James Bottomley2908d772006-08-29 09:22:51 -0500174};
175
Dan Williams5db45bd2012-06-21 23:30:48 -0700176struct ssp_device {
177 struct list_head eh_list_node; /* pending a user requested eh action */
178 struct scsi_lun reset_lun;
179};
180
Dan Williamse1399422012-01-07 08:52:39 +0000181enum {
182 SAS_DEV_GONE,
Dan Williams303694e2012-06-21 23:41:51 -0700183 SAS_DEV_FOUND, /* device notified to lldd */
Dan Williams87c83312011-11-17 17:59:51 -0800184 SAS_DEV_DESTROY,
Dan Williamse4a9c372012-06-21 23:25:27 -0700185 SAS_DEV_EH_PENDING,
Dan Williams5db45bd2012-06-21 23:30:48 -0700186 SAS_DEV_LU_RESET,
187 SAS_DEV_RESET,
Dan Williamse1399422012-01-07 08:52:39 +0000188};
189
James Bottomley2908d772006-08-29 09:22:51 -0500190struct domain_device {
Dan Williams9095a642011-11-28 11:29:20 -0800191 spinlock_t done_lock;
James Bottomleyaa9f8322013-05-07 14:44:06 -0700192 enum sas_device_type dev_type;
James Bottomley2908d772006-08-29 09:22:51 -0500193
James Bottomley88edf742006-09-06 17:36:13 -0500194 enum sas_linkrate linkrate;
195 enum sas_linkrate min_linkrate;
196 enum sas_linkrate max_linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500197
198 int pathways;
199
200 struct domain_device *parent;
201 struct list_head siblings; /* devices on the same level */
202 struct asd_sas_port *port; /* shortcut to root of the tree */
Dan Williamsf41a0c42011-12-21 21:33:17 -0800203 struct sas_phy *phy;
James Bottomley2908d772006-08-29 09:22:51 -0500204
205 struct list_head dev_list_node;
Dan Williams87c83312011-11-17 17:59:51 -0800206 struct list_head disco_list_node; /* awaiting probe or destruct */
James Bottomley2908d772006-08-29 09:22:51 -0500207
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800208 enum sas_protocol iproto;
209 enum sas_protocol tproto;
James Bottomley2908d772006-08-29 09:22:51 -0500210
211 struct sas_rphy *rphy;
212
213 u8 sas_addr[SAS_ADDR_SIZE];
214 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
215
216 u8 frame_rcvd[32];
217
218 union {
219 struct expander_device ex_dev;
220 struct sata_device sata_dev; /* STP & directly attached */
Dan Williams5db45bd2012-06-21 23:30:48 -0700221 struct ssp_device ssp_dev;
James Bottomley2908d772006-08-29 09:22:51 -0500222 };
223
224 void *lldd_dev;
Dan Williamse1399422012-01-07 08:52:39 +0000225 unsigned long state;
Dan Williams735f7d22011-11-17 17:59:47 -0800226 struct kref kref;
James Bottomley2908d772006-08-29 09:22:51 -0500227};
228
Dan Williams22b91532012-03-09 11:00:06 -0800229struct sas_work {
230 struct list_head drain_node;
David Howellsc4028952006-11-22 14:57:56 +0000231 struct work_struct work;
Dan Williams22b91532012-03-09 11:00:06 -0800232};
233
234static inline void INIT_SAS_WORK(struct sas_work *sw, void (*fn)(struct work_struct *))
235{
236 INIT_WORK(&sw->work, fn);
237 INIT_LIST_HEAD(&sw->drain_node);
238}
239
240struct sas_discovery_event {
241 struct sas_work work;
David Howellsc4028952006-11-22 14:57:56 +0000242 struct asd_sas_port *port;
243};
244
Dan Williams22b91532012-03-09 11:00:06 -0800245static inline struct sas_discovery_event *to_sas_discovery_event(struct work_struct *work)
246{
247 struct sas_discovery_event *ev = container_of(work, typeof(*ev), work.work);
248
249 return ev;
250}
251
James Bottomley2908d772006-08-29 09:22:51 -0500252struct sas_discovery {
David Howellsc4028952006-11-22 14:57:56 +0000253 struct sas_discovery_event disc_work[DISC_NUM_EVENTS];
James Bottomley2908d772006-08-29 09:22:51 -0500254 unsigned long pending;
255 u8 fanout_sas_addr[8];
256 u8 eeds_a[8];
257 u8 eeds_b[8];
258 int max_level;
259};
260
James Bottomley2908d772006-08-29 09:22:51 -0500261/* The port struct is Class:RW, driver:RO */
262struct asd_sas_port {
263/* private: */
264 struct completion port_gone_completion;
265
266 struct sas_discovery disc;
267 struct domain_device *port_dev;
268 spinlock_t dev_list_lock;
269 struct list_head dev_list;
Dan Williams87c83312011-11-17 17:59:51 -0800270 struct list_head disco_list;
271 struct list_head destroy_list;
James Bottomley88edf742006-09-06 17:36:13 -0500272 enum sas_linkrate linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500273
Dan Williams22b91532012-03-09 11:00:06 -0800274 struct sas_work work;
Dan Williams303694e2012-06-21 23:41:51 -0700275 int suspended;
James Bottomley2908d772006-08-29 09:22:51 -0500276
277/* public: */
278 int id;
279
280 enum sas_class class;
281 u8 sas_addr[SAS_ADDR_SIZE];
282 u8 attached_sas_addr[SAS_ADDR_SIZE];
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800283 enum sas_protocol iproto;
284 enum sas_protocol tproto;
James Bottomley2908d772006-08-29 09:22:51 -0500285
286 enum sas_oob_mode oob_mode;
287
288 spinlock_t phy_list_lock;
289 struct list_head phy_list;
290 int num_phys;
291 u32 phy_mask;
292
293 struct sas_ha_struct *ha;
294
295 struct sas_port *port;
296
297 void *lldd_port; /* not touched by the sas class code */
298};
299
David Howellsc4028952006-11-22 14:57:56 +0000300struct asd_sas_event {
Dan Williams22b91532012-03-09 11:00:06 -0800301 struct sas_work work;
David Howellsc4028952006-11-22 14:57:56 +0000302 struct asd_sas_phy *phy;
303};
304
Dan Williams22b91532012-03-09 11:00:06 -0800305static inline struct asd_sas_event *to_asd_sas_event(struct work_struct *work)
306{
307 struct asd_sas_event *ev = container_of(work, typeof(*ev), work.work);
308
309 return ev;
310}
311
James Bottomley2908d772006-08-29 09:22:51 -0500312/* The phy pretty much is controlled by the LLDD.
313 * The class only reads those fields.
314 */
315struct asd_sas_phy {
316/* private: */
David Howellsc4028952006-11-22 14:57:56 +0000317 struct asd_sas_event port_events[PORT_NUM_EVENTS];
318 struct asd_sas_event phy_events[PHY_NUM_EVENTS];
James Bottomley2908d772006-08-29 09:22:51 -0500319
320 unsigned long port_events_pending;
321 unsigned long phy_events_pending;
322
323 int error;
Dan Williams303694e2012-06-21 23:41:51 -0700324 int suspended;
James Bottomley2908d772006-08-29 09:22:51 -0500325
326 struct sas_phy *phy;
327
328/* public: */
329 /* The following are class:RO, driver:R/W */
330 int enabled; /* must be set */
331
332 int id; /* must be set */
333 enum sas_class class;
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800334 enum sas_protocol iproto;
335 enum sas_protocol tproto;
James Bottomley2908d772006-08-29 09:22:51 -0500336
337 enum sas_phy_type type;
338 enum sas_phy_role role;
339 enum sas_oob_mode oob_mode;
James Bottomley88edf742006-09-06 17:36:13 -0500340 enum sas_linkrate linkrate;
James Bottomley2908d772006-08-29 09:22:51 -0500341
342 u8 *sas_addr; /* must be set */
343 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
344
345 spinlock_t frame_rcvd_lock;
346 u8 *frame_rcvd; /* must be set */
347 int frame_rcvd_size;
348
349 spinlock_t sas_prim_lock;
350 u32 sas_prim;
351
352 struct list_head port_phy_el; /* driver:RO */
353 struct asd_sas_port *port; /* Class:RW, driver: RO */
354
355 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
356
357 void *lldd_phy; /* not touched by the sas_class_code */
358};
359
360struct scsi_core {
361 struct Scsi_Host *shost;
362
James Bottomley2908d772006-08-29 09:22:51 -0500363};
364
David Howellsc4028952006-11-22 14:57:56 +0000365struct sas_ha_event {
Dan Williams22b91532012-03-09 11:00:06 -0800366 struct sas_work work;
David Howellsc4028952006-11-22 14:57:56 +0000367 struct sas_ha_struct *ha;
368};
369
Dan Williams22b91532012-03-09 11:00:06 -0800370static inline struct sas_ha_event *to_sas_ha_event(struct work_struct *work)
371{
372 struct sas_ha_event *ev = container_of(work, typeof(*ev), work.work);
373
374 return ev;
375}
376
Darrick J. Wong6b0efb82007-01-11 14:15:43 -0800377enum sas_ha_state {
378 SAS_HA_REGISTERED,
Dan Williamsb1124cd2011-12-19 16:42:34 -0800379 SAS_HA_DRAINING,
Dan Williams87c83312011-11-17 17:59:51 -0800380 SAS_HA_ATA_EH_ACTIVE,
Dan Williams9095a642011-11-28 11:29:20 -0800381 SAS_HA_FROZEN,
Darrick J. Wong6b0efb82007-01-11 14:15:43 -0800382};
383
James Bottomley2908d772006-08-29 09:22:51 -0500384struct sas_ha_struct {
385/* private: */
David Howellsc4028952006-11-22 14:57:56 +0000386 struct sas_ha_event ha_events[HA_NUM_EVENTS];
James Bottomley2908d772006-08-29 09:22:51 -0500387 unsigned long pending;
388
Dan Williamsb1124cd2011-12-19 16:42:34 -0800389 struct list_head defer_q; /* work queued while draining */
390 struct mutex drain_mutex;
Dan Williamsf8daa6e2011-12-19 17:02:25 -0800391 unsigned long state;
Dan Williamse4a9c372012-06-21 23:25:27 -0700392 spinlock_t lock;
393 int eh_active;
Dan Williams5db45bd2012-06-21 23:30:48 -0700394 wait_queue_head_t eh_wait_q;
395 struct list_head eh_dev_q;
Darrick J. Wong6b0efb82007-01-11 14:15:43 -0800396
Dan Williams87c83312011-11-17 17:59:51 -0800397 struct mutex disco_mutex;
398
James Bottomley2908d772006-08-29 09:22:51 -0500399 struct scsi_core core;
400
401/* public: */
402 char *sas_ha_name;
Jeff Garzik1d1bbee2007-07-26 09:28:37 -0400403 struct device *dev; /* should be set */
James Bottomley2908d772006-08-29 09:22:51 -0500404 struct module *lldd_module; /* should be set */
405
406 u8 *sas_addr; /* must be set */
407 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
408
409 spinlock_t phy_port_lock;
410 struct asd_sas_phy **sas_phy; /* array of valid pointers, must be set */
411 struct asd_sas_port **sas_port; /* array of valid pointers, must be set */
412 int num_phys; /* must be set, gt 0, static */
413
Dan Williams00f02542010-10-01 13:55:52 -0700414 int strict_wide_ports; /* both sas_addr and attached_sas_addr must match
415 * their siblings when forming wide ports */
James Bottomley2908d772006-08-29 09:22:51 -0500416
417 /* LLDD calls these to notify the class of an event. */
418 void (*notify_ha_event)(struct sas_ha_struct *, enum ha_event);
419 void (*notify_port_event)(struct asd_sas_phy *, enum port_event);
420 void (*notify_phy_event)(struct asd_sas_phy *, enum phy_event);
421
422 void *lldd_ha; /* not touched by sas class code */
Darrick J. Wongf4563932006-10-30 15:18:39 -0800423
Dan Williams3944f502011-11-29 12:08:50 -0800424 struct list_head eh_done_q; /* complete via scsi_eh_flush_done_q */
425 struct list_head eh_ata_q; /* scmds to promote from sas to ata eh */
James Bottomley2908d772006-08-29 09:22:51 -0500426};
427
428#define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
429
430static inline struct domain_device *
431starget_to_domain_dev(struct scsi_target *starget) {
432 return starget->hostdata;
433}
434
435static inline struct domain_device *
436sdev_to_domain_dev(struct scsi_device *sdev) {
437 return starget_to_domain_dev(sdev->sdev_target);
438}
439
Dan Williamsb50102d2011-09-30 18:52:19 -0700440static inline struct ata_device *sas_to_ata_dev(struct domain_device *dev)
441{
442 return &dev->sata_dev.ap->link.device[0];
443}
444
James Bottomley2908d772006-08-29 09:22:51 -0500445static inline struct domain_device *
446cmd_to_domain_dev(struct scsi_cmnd *cmd)
447{
448 return sdev_to_domain_dev(cmd->device);
449}
450
451void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
452
453/* Before calling a notify event, LLDD should use this function
454 * when the link is severed (possibly from its tasklet).
455 * The idea is that the Class only reads those, while the LLDD,
456 * can R/W these (thus avoiding a race).
457 */
458static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
459{
460 phy->oob_mode = OOB_NOT_CONNECTED;
James Bottomley88edf742006-09-06 17:36:13 -0500461 phy->linkrate = SAS_LINK_RATE_UNKNOWN;
James Bottomley2908d772006-08-29 09:22:51 -0500462}
463
Dan Williams8ec65522011-09-01 21:18:20 -0700464static inline unsigned int to_sas_gpio_od(int device, int bit)
465{
466 return 3 * device + bit;
467}
468
Dan Williamsf41a0c42011-12-21 21:33:17 -0800469static inline void sas_put_local_phy(struct sas_phy *phy)
470{
471 put_device(&phy->dev);
472}
473
Dan Williamsd9624802011-09-23 16:43:45 -0700474#ifdef CONFIG_SCSI_SAS_HOST_SMP
Dan Williams8ec65522011-09-01 21:18:20 -0700475int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count);
Dan Williamsd9624802011-09-23 16:43:45 -0700476#else
477static inline int try_test_sas_gpio_gp_bit(unsigned int od, u8 *data, u8 index, u8 count)
478{
479 return -1;
480}
481#endif
Dan Williams8ec65522011-09-01 21:18:20 -0700482
James Bottomley2908d772006-08-29 09:22:51 -0500483/* ---------- Tasks ---------- */
484/*
485 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
486 exec_status | | |
487 ---------------------+---------------------+-----------------------+
488 SAM_... | X | |
489 DEV_NO_RESPONSE | X | X |
490 INTERRUPTED | X | |
491 QUEUE_FULL | | X |
492 DEVICE_UNKNOWN | | X |
493 SG_ERR | | X |
494 ---------------------+---------------------+-----------------------+
495 */
496
497enum service_response {
498 SAS_TASK_COMPLETE,
499 SAS_TASK_UNDELIVERED = -1,
500};
501
502enum exec_status {
Dan Williamsa3a14252011-12-06 23:24:42 -0800503 /* The SAM_STAT_.. codes fit in the lower 6 bits, alias some of
504 * them here to silence 'case value not in enumerated type' warnings
505 */
506 __SAM_STAT_CHECK_CONDITION = SAM_STAT_CHECK_CONDITION,
James Bottomley2908d772006-08-29 09:22:51 -0500507
508 SAS_DEV_NO_RESPONSE = 0x80,
509 SAS_DATA_UNDERRUN,
510 SAS_DATA_OVERRUN,
511 SAS_INTERRUPTED,
512 SAS_QUEUE_FULL,
513 SAS_DEVICE_UNKNOWN,
514 SAS_SG_ERR,
515 SAS_OPEN_REJECT,
516 SAS_OPEN_TO,
517 SAS_PROTO_RESPONSE,
518 SAS_PHY_DOWN,
519 SAS_NAK_R_ERR,
520 SAS_PENDING,
521 SAS_ABORTED_TASK,
522};
523
524/* When a task finishes with a response, the LLDD examines the
525 * response:
526 * - For an ATA task task_status_struct::stat is set to
527 * SAS_PROTO_RESPONSE, and the task_status_struct::buf is set to the
528 * contents of struct ata_task_resp.
529 * - For SSP tasks, if no data is present or status/TMF response
530 * is valid, task_status_struct::stat is set. If data is present
531 * (SENSE data), the LLDD copies up to SAS_STATUS_BUF_SIZE, sets
532 * task_status_struct::buf_valid_size, and task_status_struct::stat is
533 * set to SAM_CHECK_COND.
534 *
535 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
536 * for ATA task.
537 *
538 * "frame_len" is the total frame length, which could be more or less
539 * than actually copied.
540 *
541 * Tasks ending with response, always set the residual field.
542 */
543struct ata_task_resp {
544 u16 frame_len;
Dan Williams6ef1b512012-06-22 10:52:34 -0700545 u8 ending_fis[ATA_RESP_FIS_SIZE]; /* dev to host or data-in */
James Bottomley2908d772006-08-29 09:22:51 -0500546};
547
548#define SAS_STATUS_BUF_SIZE 96
549
550struct task_status_struct {
551 enum service_response resp;
552 enum exec_status stat;
553 int buf_valid_size;
554
555 u8 buf[SAS_STATUS_BUF_SIZE];
556
557 u32 residual;
558 enum sas_open_rej_reason open_rej_reason;
559};
560
561/* ATA and ATAPI task queuable to a SAS LLDD.
562 */
563struct sas_ata_task {
564 struct host_to_dev_fis fis;
565 u8 atapi_packet[16]; /* 0 if not ATAPI task */
566
567 u8 retry_count; /* hardware retry, should be > 0 */
568
569 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
570 u8 use_ncq:1;
571 u8 set_affil_pol:1;
572 u8 stp_affil_pol:1;
573
574 u8 device_control_reg_update:1;
575};
576
577struct sas_smp_task {
578 struct scatterlist smp_req;
579 struct scatterlist smp_resp;
580};
581
582enum task_attribute {
583 TASK_ATTR_SIMPLE = 0,
584 TASK_ATTR_HOQ = 1,
585 TASK_ATTR_ORDERED= 2,
586 TASK_ATTR_ACA = 4,
587};
588
589struct sas_ssp_task {
590 u8 retry_count; /* hardware retry, should be > 0 */
591
592 u8 LUN[8];
593 u8 enable_first_burst:1;
594 enum task_attribute task_attr;
595 u8 task_prio;
James Bottomleye73823f2013-05-07 15:38:18 -0700596 struct scsi_cmnd *cmd;
James Bottomley2908d772006-08-29 09:22:51 -0500597};
598
599struct sas_task {
600 struct domain_device *dev;
James Bottomley2908d772006-08-29 09:22:51 -0500601
602 spinlock_t task_state_lock;
603 unsigned task_state_flags;
604
Darrick J. Wong5929faf2007-11-05 11:51:17 -0800605 enum sas_protocol task_proto;
James Bottomley2908d772006-08-29 09:22:51 -0500606
James Bottomley2908d772006-08-29 09:22:51 -0500607 union {
608 struct sas_ata_task ata_task;
609 struct sas_smp_task smp_task;
610 struct sas_ssp_task ssp_task;
611 };
612
613 struct scatterlist *scatter;
614 int num_scatter;
615 u32 total_xfer_len;
616 u8 data_dir:2; /* Use PCI_DMA_... */
617
618 struct task_status_struct task_status;
619 void (*task_done)(struct sas_task *);
620
621 void *lldd_task; /* for use by LLDDs */
622 void *uldd_task;
Dan Williamsf0bf7502012-06-21 23:36:30 -0700623 struct sas_task_slow *slow_task;
624};
Darrick J. Wong79a5eb62006-10-30 15:18:50 -0800625
Dan Williamsf0bf7502012-06-21 23:36:30 -0700626struct sas_task_slow {
627 /* standard/extra infrastructure for slow path commands (SMP and
628 * internal lldd commands
629 */
630 struct timer_list timer;
631 struct completion completion;
James Bottomley2908d772006-08-29 09:22:51 -0500632};
633
Darrick J. Wongf4563932006-10-30 15:18:39 -0800634#define SAS_TASK_STATE_PENDING 1
635#define SAS_TASK_STATE_DONE 2
636#define SAS_TASK_STATE_ABORTED 4
Darrick J. Wong3ebf6922007-01-11 14:15:17 -0800637#define SAS_TASK_NEED_DEV_RESET 8
Darrick J. Wongb218a0d2007-01-11 14:14:55 -0800638#define SAS_TASK_AT_INITIATOR 16
James Bottomley2908d772006-08-29 09:22:51 -0500639
Dan Williams4fcf8122011-07-29 17:26:39 -0700640extern struct sas_task *sas_alloc_task(gfp_t flags);
Dan Williamsf0bf7502012-06-21 23:36:30 -0700641extern struct sas_task *sas_alloc_slow_task(gfp_t flags);
Dan Williams4fcf8122011-07-29 17:26:39 -0700642extern void sas_free_task(struct sas_task *task);
James Bottomley2908d772006-08-29 09:22:51 -0500643
644struct sas_domain_function_template {
645 /* The class calls these to notify the LLDD of an event. */
646 void (*lldd_port_formed)(struct asd_sas_phy *);
647 void (*lldd_port_deformed)(struct asd_sas_phy *);
648
649 /* The class calls these when a device is found or gone. */
650 int (*lldd_dev_found)(struct domain_device *);
651 void (*lldd_dev_gone)(struct domain_device *);
652
Christoph Hellwig79855d12014-11-05 10:36:28 +0100653 int (*lldd_execute_task)(struct sas_task *, gfp_t gfp_flags);
James Bottomley2908d772006-08-29 09:22:51 -0500654
655 /* Task Management Functions. Must be called from process context. */
656 int (*lldd_abort_task)(struct sas_task *);
657 int (*lldd_abort_task_set)(struct domain_device *, u8 *lun);
658 int (*lldd_clear_aca)(struct domain_device *, u8 *lun);
659 int (*lldd_clear_task_set)(struct domain_device *, u8 *lun);
660 int (*lldd_I_T_nexus_reset)(struct domain_device *);
Dan Williams36a39942011-11-17 17:59:54 -0800661 int (*lldd_ata_check_ready)(struct domain_device *);
Dan Williamsb91bb292011-11-17 17:59:52 -0800662 void (*lldd_ata_set_dmamode)(struct domain_device *);
James Bottomley2908d772006-08-29 09:22:51 -0500663 int (*lldd_lu_reset)(struct domain_device *, u8 *lun);
664 int (*lldd_query_task)(struct sas_task *);
665
666 /* Port and Adapter management */
667 int (*lldd_clear_nexus_port)(struct asd_sas_port *);
668 int (*lldd_clear_nexus_ha)(struct sas_ha_struct *);
669
670 /* Phy management */
James Bottomleya01e70e2006-09-06 19:28:07 -0500671 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func, void *);
Dan Williams8ec65522011-09-01 21:18:20 -0700672
673 /* GPIO support */
674 int (*lldd_write_gpio)(struct sas_ha_struct *, u8 reg_type,
675 u8 reg_index, u8 reg_count, u8 *write_data);
James Bottomley2908d772006-08-29 09:22:51 -0500676};
677
678extern int sas_register_ha(struct sas_ha_struct *);
679extern int sas_unregister_ha(struct sas_ha_struct *);
Dan Williams303694e2012-06-21 23:41:51 -0700680extern void sas_prep_resume_ha(struct sas_ha_struct *sas_ha);
681extern void sas_resume_ha(struct sas_ha_struct *sas_ha);
682extern void sas_suspend_ha(struct sas_ha_struct *sas_ha);
James Bottomley2908d772006-08-29 09:22:51 -0500683
Darrick J. Wongacbf1672007-01-11 14:14:57 -0800684int sas_set_phy_speed(struct sas_phy *phy,
685 struct sas_phy_linkrates *rates);
Darrick J. Wongdea22212006-11-07 17:28:55 -0800686int sas_phy_reset(struct sas_phy *phy, int hard_reset);
Jeff Garzikf2812332010-11-16 02:10:29 -0500687extern int sas_queuecommand(struct Scsi_Host * ,struct scsi_cmnd *);
James Bottomley2908d772006-08-29 09:22:51 -0500688extern int sas_target_alloc(struct scsi_target *);
James Bottomley2908d772006-08-29 09:22:51 -0500689extern int sas_slave_configure(struct scsi_device *);
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100690extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
James Bottomley2908d772006-08-29 09:22:51 -0500691extern int sas_bios_param(struct scsi_device *,
692 struct block_device *,
693 sector_t capacity, int *hsc);
694extern struct scsi_transport_template *
695sas_domain_attach_transport(struct sas_domain_function_template *);
696extern void sas_domain_release_transport(struct scsi_transport_template *);
697
698int sas_discover_root_expander(struct domain_device *);
699
700void sas_init_ex_attr(void);
701
702int sas_ex_revalidate_domain(struct domain_device *);
703
Dan Williams7d059192012-01-10 14:39:13 -0800704void sas_unregister_domain_devices(struct asd_sas_port *port, int gone);
James Bottomley2908d772006-08-29 09:22:51 -0500705void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
706int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
707
708int sas_discover_sata(struct domain_device *);
709int sas_discover_end_dev(struct domain_device *);
710
Dan Williams1a34c062011-09-21 22:05:34 -0700711void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *);
James Bottomley2908d772006-08-29 09:22:51 -0500712
713void sas_init_dev(struct domain_device *);
714
Darrick J. Wong396819f2007-01-11 14:15:20 -0800715void sas_task_abort(struct sas_task *);
Dan Williams9524c682012-06-21 23:30:53 -0700716int sas_eh_abort_handler(struct scsi_cmnd *cmd);
Darrick J. Wongad689232007-01-26 14:08:52 -0800717int sas_eh_device_reset_handler(struct scsi_cmnd *cmd);
Darrick J. Wonga9344e62007-01-29 23:48:19 -0800718int sas_eh_bus_reset_handler(struct scsi_cmnd *cmd);
Darrick J. Wong79a5eb62006-10-30 15:18:50 -0800719
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -0700720extern void sas_target_destroy(struct scsi_target *);
721extern int sas_slave_alloc(struct scsi_device *);
722extern int sas_ioctl(struct scsi_device *sdev, int cmd, void __user *arg);
Dan Williamsb1124cd2011-12-19 16:42:34 -0800723extern int sas_drain_work(struct sas_ha_struct *ha);
Darrick J. Wongfa1c1e82006-08-10 19:19:47 -0700724
FUJITA Tomonoriba1fc172007-07-09 12:52:08 +0900725extern int sas_smp_handler(struct Scsi_Host *shost, struct sas_rphy *rphy,
726 struct request *req);
James Bottomley366ca512008-01-18 10:47:01 -0600727
728extern void sas_ssp_task_response(struct device *dev, struct sas_task *task,
729 struct ssp_response_iu *iu);
Dan Williamsf41a0c42011-12-21 21:33:17 -0800730struct sas_phy *sas_get_local_phy(struct domain_device *dev);
James Bottomley366ca512008-01-18 10:47:01 -0600731
Darrick J. Wong45e6cdf2008-02-19 10:49:40 -0800732int sas_request_addr(struct Scsi_Host *shost, u8 *addr);
733
James Bottomley2908d772006-08-29 09:22:51 -0500734#endif /* _SASLIB_H_ */