aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/scsi/libsas.h627
-rw-r--r--include/scsi/sas.h644
-rw-r--r--include/scsi/scsi.h6
3 files changed, 1277 insertions, 0 deletions
diff --git a/include/scsi/libsas.h b/include/scsi/libsas.h
new file mode 100644
index 000000000000..72acdabe7f80
--- /dev/null
+++ b/include/scsi/libsas.h
@@ -0,0 +1,627 @@
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/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>
38
39struct block_device;
40
41enum sas_class {
42 SAS,
43 EXPANDER
44};
45
46enum sas_phy_role {
47 PHY_ROLE_NONE = 0,
48 PHY_ROLE_TARGET = 0x40,
49 PHY_ROLE_INITIATOR = 0x80,
50};
51
52enum sas_phy_type {
53 PHY_TYPE_PHYSICAL,
54 PHY_TYPE_VIRTUAL
55};
56
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.
60 */
61enum ha_event {
62 HAE_RESET = 0U,
63 HA_NUM_EVENTS = 1,
64};
65
66enum port_event {
67 PORTE_BYTES_DMAED = 0U,
68 PORTE_BROADCAST_RCVD = 1,
69 PORTE_LINK_RESET_ERR = 2,
70 PORTE_TIMER_EVENT = 3,
71 PORTE_HARD_RESET = 4,
72 PORT_NUM_EVENTS = 5,
73};
74
75enum phy_event {
76 PHYE_LOSS_OF_SIGNAL = 0U,
77 PHYE_OOB_DONE = 1,
78 PHYE_OOB_ERROR = 2,
79 PHYE_SPINUP_HOLD = 3, /* hot plug SATA, no COMWAKE sent */
80 PHY_NUM_EVENTS = 4,
81};
82
83enum discover_event {
84 DISCE_DISCOVER_DOMAIN = 0U,
85 DISCE_REVALIDATE_DOMAIN = 1,
86 DISCE_PORT_GONE = 2,
87 DISC_NUM_EVENTS = 3,
88};
89
90/* ---------- Expander Devices ---------- */
91
92#define ETASK 0xFA
93
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,\
96 attr)
97
98enum routing_attribute {
99 DIRECT_ROUTING,
100 SUBTRACTIVE_ROUTING,
101 TABLE_ROUTING,
102};
103
104enum ex_phy_state {
105 PHY_EMPTY,
106 PHY_VACANT,
107 PHY_NOT_PRESENT,
108 PHY_DEVICE_DISCOVERED
109};
110
111struct ex_phy {
112 int phy_id;
113
114 enum ex_phy_state phy_state;
115
116 enum sas_dev_type attached_dev_type;
117 enum sas_phy_linkrate linkrate;
118
119 u8 attached_sata_host:1;
120 u8 attached_sata_dev:1;
121 u8 attached_sata_ps:1;
122
123 enum sas_proto attached_tproto;
124 enum sas_proto attached_iproto;
125
126 u8 attached_sas_addr[SAS_ADDR_SIZE];
127 u8 attached_phy_id;
128
129 u8 phy_change_count;
130 enum routing_attribute routing_attr;
131 u8 virtual:1;
132
133 int last_da_index;
134
135 struct sas_phy *phy;
136 struct sas_port *port;
137};
138
139struct expander_device {
140 struct list_head children;
141
142 u16 ex_change_count;
143 u16 max_route_indexes;
144 u8 num_phys;
145 u8 configuring:1;
146 u8 conf_route_table:1;
147 u8 enclosure_logical_id[8];
148
149 struct ex_phy *ex_phy;
150 struct sas_port *parent_port;
151};
152
153/* ---------- SATA device ---------- */
154enum ata_command_set {
155 ATA_COMMAND_SET = 0,
156 ATAPI_COMMAND_SET = 1,
157};
158
159struct sata_device {
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;
164
165 u8 port_no; /* port number, if this is a PM (Port) */
166 struct list_head children; /* PM Ports if this is a PM */
167};
168
169/* ---------- Domain device ---------- */
170struct domain_device {
171 enum sas_dev_type dev_type;
172
173 enum sas_phy_linkrate linkrate;
174 enum sas_phy_linkrate min_linkrate;
175 enum sas_phy_linkrate max_linkrate;
176
177 int pathways;
178
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 */
182
183 struct list_head dev_list_node;
184
185 enum sas_proto iproto;
186 enum sas_proto tproto;
187
188 struct sas_rphy *rphy;
189
190 u8 sas_addr[SAS_ADDR_SIZE];
191 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
192
193 u8 frame_rcvd[32];
194
195 union {
196 struct expander_device ex_dev;
197 struct sata_device sata_dev; /* STP & directly attached */
198 };
199
200 void *lldd_dev;
201};
202
203struct 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];
208 u8 eeds_a[8];
209 u8 eeds_b[8];
210 int max_level;
211};
212
213
214/* The port struct is Class:RW, driver:RO */
215struct asd_sas_port {
216/* private: */
217 struct completion port_gone_completion;
218
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_phy_linkrate linkrate;
224
225 struct sas_phy *phy;
226 struct work_struct work;
227
228/* public: */
229 int id;
230
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;
236
237 enum sas_oob_mode oob_mode;
238
239 spinlock_t phy_list_lock;
240 struct list_head phy_list;
241 int num_phys;
242 u32 phy_mask;
243
244 struct sas_ha_struct *ha;
245
246 struct sas_port *port;
247
248 void *lldd_port; /* not touched by the sas class code */
249};
250
251/* The phy pretty much is controlled by the LLDD.
252 * The class only reads those fields.
253 */
254struct asd_sas_phy {
255/* private: */
256 /* protected by ha->event_lock */
257 struct work_struct port_events[PORT_NUM_EVENTS];
258 struct work_struct phy_events[PHY_NUM_EVENTS];
259
260 unsigned long port_events_pending;
261 unsigned long phy_events_pending;
262
263 int error;
264
265 struct sas_phy *phy;
266
267/* public: */
268 /* The following are class:RO, driver:R/W */
269 int enabled; /* must be set */
270
271 int id; /* must be set */
272 enum sas_class class;
273 enum sas_proto iproto;
274 enum sas_proto tproto;
275
276 enum sas_phy_type type;
277 enum sas_phy_role role;
278 enum sas_oob_mode oob_mode;
279 enum sas_phy_linkrate linkrate;
280
281 u8 *sas_addr; /* must be set */
282 u8 attached_sas_addr[SAS_ADDR_SIZE]; /* class:RO, driver: R/W */
283
284 spinlock_t frame_rcvd_lock;
285 u8 *frame_rcvd; /* must be set */
286 int frame_rcvd_size;
287
288 spinlock_t sas_prim_lock;
289 u32 sas_prim;
290
291 struct list_head port_phy_el; /* driver:RO */
292 struct asd_sas_port *port; /* Class:RW, driver: RO */
293
294 struct sas_ha_struct *ha; /* may be set; the class sets it anyway */
295
296 void *lldd_phy; /* not touched by the sas_class_code */
297};
298
299struct scsi_core {
300 struct Scsi_Host *shost;
301
302 spinlock_t task_queue_lock;
303 struct list_head task_queue;
304 int task_queue_size;
305
306 struct semaphore queue_thread_sema;
307 int queue_thread_kill;
308};
309
310struct sas_ha_struct {
311/* private: */
312 spinlock_t event_lock;
313 struct work_struct ha_events[HA_NUM_EVENTS];
314 unsigned long pending;
315
316 struct scsi_core core;
317
318/* public: */
319 char *sas_ha_name;
320 struct pci_dev *pcidev; /* should be set */
321 struct module *lldd_module; /* should be set */
322
323 u8 *sas_addr; /* must be set */
324 u8 hashed_sas_addr[HASHED_SAS_ADDR_SIZE];
325
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 */
330
331 /* The class calls this to send a task for execution. */
332 int lldd_max_execute_num;
333 int lldd_queue_size;
334
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);
339
340 void *lldd_ha; /* not touched by sas class code */
341};
342
343#define SHOST_TO_SAS_HA(_shost) (*(struct sas_ha_struct **)(_shost)->hostdata)
344
345static inline struct domain_device *
346starget_to_domain_dev(struct scsi_target *starget) {
347 return starget->hostdata;
348}
349
350static inline struct domain_device *
351sdev_to_domain_dev(struct scsi_device *sdev) {
352 return starget_to_domain_dev(sdev->sdev_target);
353}
354
355static inline struct domain_device *
356cmd_to_domain_dev(struct scsi_cmnd *cmd)
357{
358 return sdev_to_domain_dev(cmd->device);
359}
360
361void sas_hash_addr(u8 *hashed, const u8 *sas_addr);
362
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).
367 */
368static inline void sas_phy_disconnected(struct asd_sas_phy *phy)
369{
370 phy->oob_mode = OOB_NOT_CONNECTED;
371 phy->linkrate = PHY_LINKRATE_NONE;
372}
373
374/* ---------- Tasks ---------- */
375/*
376 service_response | SAS_TASK_COMPLETE | SAS_TASK_UNDELIVERED |
377 exec_status | | |
378 ---------------------+---------------------+-----------------------+
379 SAM_... | X | |
380 DEV_NO_RESPONSE | X | X |
381 INTERRUPTED | X | |
382 QUEUE_FULL | | X |
383 DEVICE_UNKNOWN | | X |
384 SG_ERR | | X |
385 ---------------------+---------------------+-----------------------+
386 */
387
388enum service_response {
389 SAS_TASK_COMPLETE,
390 SAS_TASK_UNDELIVERED = -1,
391};
392
393enum exec_status {
394 SAM_GOOD = 0,
395 SAM_CHECK_COND = 2,
396 SAM_COND_MET = 4,
397 SAM_BUSY = 8,
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,
404
405 SAS_DEV_NO_RESPONSE = 0x80,
406 SAS_DATA_UNDERRUN,
407 SAS_DATA_OVERRUN,
408 SAS_INTERRUPTED,
409 SAS_QUEUE_FULL,
410 SAS_DEVICE_UNKNOWN,
411 SAS_SG_ERR,
412 SAS_OPEN_REJECT,
413 SAS_OPEN_TO,
414 SAS_PROTO_RESPONSE,
415 SAS_PHY_DOWN,
416 SAS_NAK_R_ERR,
417 SAS_PENDING,
418 SAS_ABORTED_TASK,
419};
420
421/* When a task finishes with a response, the LLDD examines the
422 * response:
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.
431 *
432 * "buf" has format SCSI Sense for SSP task, or struct ata_task_resp
433 * for ATA task.
434 *
435 * "frame_len" is the total frame length, which could be more or less
436 * than actually copied.
437 *
438 * Tasks ending with response, always set the residual field.
439 */
440struct ata_task_resp {
441 u16 frame_len;
442 u8 ending_fis[24]; /* dev to host or data-in */
443 u32 sstatus;
444 u32 serror;
445 u32 scontrol;
446 u32 sactive;
447};
448
449#define SAS_STATUS_BUF_SIZE 96
450
451struct task_status_struct {
452 enum service_response resp;
453 enum exec_status stat;
454 int buf_valid_size;
455
456 u8 buf[SAS_STATUS_BUF_SIZE];
457
458 u32 residual;
459 enum sas_open_rej_reason open_rej_reason;
460};
461
462/* ATA and ATAPI task queuable to a SAS LLDD.
463 */
464struct sas_ata_task {
465 struct host_to_dev_fis fis;
466 u8 atapi_packet[16]; /* 0 if not ATAPI task */
467
468 u8 retry_count; /* hardware retry, should be > 0 */
469
470 u8 dma_xfer:1; /* PIO:0 or DMA:1 */
471 u8 use_ncq:1;
472 u8 set_affil_pol:1;
473 u8 stp_affil_pol:1;
474
475 u8 device_control_reg_update:1;
476};
477
478struct sas_smp_task {
479 struct scatterlist smp_req;
480 struct scatterlist smp_resp;
481};
482
483enum task_attribute {
484 TASK_ATTR_SIMPLE = 0,
485 TASK_ATTR_HOQ = 1,
486 TASK_ATTR_ORDERED= 2,
487 TASK_ATTR_ACA = 4,
488};
489
490struct sas_ssp_task {
491 u8 retry_count; /* hardware retry, should be > 0 */
492
493 u8 LUN[8];
494 u8 enable_first_burst:1;
495 enum task_attribute task_attr;
496 u8 task_prio;
497 u8 cdb[16];
498};
499
500struct sas_task {
501 struct domain_device *dev;
502 struct list_head list;
503
504 spinlock_t task_state_lock;
505 unsigned task_state_flags;
506
507 enum sas_proto task_proto;
508
509 /* Used by the discovery code. */
510 struct timer_list timer;
511 struct completion completion;
512
513 union {
514 struct sas_ata_task ata_task;
515 struct sas_smp_task smp_task;
516 struct sas_ssp_task ssp_task;
517 };
518
519 struct scatterlist *scatter;
520 int num_scatter;
521 u32 total_xfer_len;
522 u8 data_dir:2; /* Use PCI_DMA_... */
523
524 struct task_status_struct task_status;
525 void (*task_done)(struct sas_task *);
526
527 void *lldd_task; /* for use by LLDDs */
528 void *uldd_task;
529};
530
531
532
533#define SAS_TASK_STATE_PENDING 1
534#define SAS_TASK_STATE_DONE 2
535#define SAS_TASK_STATE_ABORTED 4
536
537static inline struct sas_task *sas_alloc_task(unsigned long flags)
538{
539 extern kmem_cache_t *sas_task_cache;
540 struct sas_task *task = kmem_cache_alloc(sas_task_cache, flags);
541
542 if (task) {
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);
549 }
550
551 return task;
552}
553
554static inline void sas_free_task(struct sas_task *task)
555{
556 if (task) {
557 extern kmem_cache_t *sas_task_cache;
558 BUG_ON(!list_empty(&task->list));
559 kmem_cache_free(sas_task_cache, task);
560 }
561}
562
563struct 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 *);
567
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 *);
571
572 int (*lldd_execute_task)(struct sas_task *, int num,
573 unsigned long gfp_flags);
574
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 *);
583
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 *);
587
588 /* Phy management */
589 int (*lldd_control_phy)(struct asd_sas_phy *, enum phy_func);
590};
591
592extern int sas_register_ha(struct sas_ha_struct *);
593extern int sas_unregister_ha(struct sas_ha_struct *);
594
595extern int sas_queuecommand(struct scsi_cmnd *,
596 void (*scsi_done)(struct scsi_cmnd *));
597extern int sas_target_alloc(struct scsi_target *);
598extern int sas_slave_alloc(struct scsi_device *);
599extern int sas_slave_configure(struct scsi_device *);
600extern void sas_slave_destroy(struct scsi_device *);
601extern int sas_change_queue_depth(struct scsi_device *, int new_depth);
602extern int sas_change_queue_type(struct scsi_device *, int qt);
603extern int sas_bios_param(struct scsi_device *,
604 struct block_device *,
605 sector_t capacity, int *hsc);
606extern struct scsi_transport_template *
607sas_domain_attach_transport(struct sas_domain_function_template *);
608extern void sas_domain_release_transport(struct scsi_transport_template *);
609
610int sas_discover_root_expander(struct domain_device *);
611
612void sas_init_ex_attr(void);
613
614int sas_ex_revalidate_domain(struct domain_device *);
615
616void sas_unregister_domain_devices(struct asd_sas_port *port);
617void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *);
618int sas_discover_event(struct asd_sas_port *, enum discover_event ev);
619
620int sas_discover_sata(struct domain_device *);
621int sas_discover_end_dev(struct domain_device *);
622
623void sas_unregister_dev(struct domain_device *);
624
625void sas_init_dev(struct domain_device *);
626
627#endif /* _SASLIB_H_ */
diff --git a/include/scsi/sas.h b/include/scsi/sas.h
new file mode 100644
index 000000000000..752853a113dc
--- /dev/null
+++ b/include/scsi/sas.h
@@ -0,0 +1,644 @@
1/*
2 * SAS structures and definitions 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 _SAS_H_
27#define _SAS_H_
28
29#include <linux/types.h>
30#include <asm/byteorder.h>
31
32#define SAS_ADDR_SIZE 8
33#define HASHED_SAS_ADDR_SIZE 3
34#define SAS_ADDR(_sa) ((unsigned long long) be64_to_cpu(*(__be64 *)(_sa)))
35
36#define SMP_REQUEST 0x40
37#define SMP_RESPONSE 0x41
38
39#define SSP_DATA 0x01
40#define SSP_XFER_RDY 0x05
41#define SSP_COMMAND 0x06
42#define SSP_RESPONSE 0x07
43#define SSP_TASK 0x16
44
45#define SMP_REPORT_GENERAL 0x00
46#define SMP_REPORT_MANUF_INFO 0x01
47#define SMP_READ_GPIO_REG 0x02
48#define SMP_DISCOVER 0x10
49#define SMP_REPORT_PHY_ERR_LOG 0x11
50#define SMP_REPORT_PHY_SATA 0x12
51#define SMP_REPORT_ROUTE_INFO 0x13
52#define SMP_WRITE_GPIO_REG 0x82
53#define SMP_CONF_ROUTE_INFO 0x90
54#define SMP_PHY_CONTROL 0x91
55#define SMP_PHY_TEST_FUNCTION 0x92
56
57#define SMP_RESP_FUNC_ACC 0x00
58#define SMP_RESP_FUNC_UNK 0x01
59#define SMP_RESP_FUNC_FAILED 0x02
60#define SMP_RESP_INV_FRM_LEN 0x03
61#define SMP_RESP_NO_PHY 0x10
62#define SMP_RESP_NO_INDEX 0x11
63#define SMP_RESP_PHY_NO_SATA 0x12
64#define SMP_RESP_PHY_UNK_OP 0x13
65#define SMP_RESP_PHY_UNK_TESTF 0x14
66#define SMP_RESP_PHY_TEST_INPROG 0x15
67#define SMP_RESP_PHY_VACANT 0x16
68
69/* SAM TMFs */
70#define TMF_ABORT_TASK 0x01
71#define TMF_ABORT_TASK_SET 0x02
72#define TMF_CLEAR_TASK_SET 0x04
73#define TMF_LU_RESET 0x08
74#define TMF_CLEAR_ACA 0x40
75#define TMF_QUERY_TASK 0x80
76
77/* SAS TMF responses */
78#define TMF_RESP_FUNC_COMPLETE 0x00
79#define TMF_RESP_INVALID_FRAME 0x02
80#define TMF_RESP_FUNC_ESUPP 0x04
81#define TMF_RESP_FUNC_FAILED 0x05
82#define TMF_RESP_FUNC_SUCC 0x08
83#define TMF_RESP_NO_LUN 0x09
84#define TMF_RESP_OVERLAPPED_TAG 0x0A
85
86enum sas_oob_mode {
87 OOB_NOT_CONNECTED,
88 SATA_OOB_MODE,
89 SAS_OOB_MODE
90};
91
92/* See sas_discover.c if you plan on changing these.
93 */
94enum sas_dev_type {
95 NO_DEVICE = 0, /* protocol */
96 SAS_END_DEV = 1, /* protocol */
97 EDGE_DEV = 2, /* protocol */
98 FANOUT_DEV = 3, /* protocol */
99 SAS_HA = 4,
100 SATA_DEV = 5,
101 SATA_PM = 7,
102 SATA_PM_PORT= 8,
103};
104
105enum sas_phy_linkrate {
106 PHY_LINKRATE_NONE = 0,
107 PHY_LINKRATE_UNKNOWN = 0,
108 PHY_DISABLED,
109 PHY_RESET_PROBLEM,
110 PHY_SPINUP_HOLD,
111 PHY_PORT_SELECTOR,
112 PHY_LINKRATE_1_5 = 0x08,
113 PHY_LINKRATE_G1 = PHY_LINKRATE_1_5,
114 PHY_LINKRATE_3 = 0x09,
115 PHY_LINKRATE_G2 = PHY_LINKRATE_3,
116 PHY_LINKRATE_6 = 0x0A,
117};
118
119/* Partly from IDENTIFY address frame. */
120enum sas_proto {
121 SATA_PROTO = 1,
122 SAS_PROTO_SMP = 2, /* protocol */
123 SAS_PROTO_STP = 4, /* protocol */
124 SAS_PROTO_SSP = 8, /* protocol */
125 SAS_PROTO_ALL = 0xE,
126};
127
128/* From the spec; local phys only */
129enum phy_func {
130 PHY_FUNC_NOP,
131 PHY_FUNC_LINK_RESET, /* Enables the phy */
132 PHY_FUNC_HARD_RESET,
133 PHY_FUNC_DISABLE,
134 PHY_FUNC_CLEAR_ERROR_LOG = 5,
135 PHY_FUNC_CLEAR_AFFIL,
136 PHY_FUNC_TX_SATA_PS_SIGNAL,
137 PHY_FUNC_RELEASE_SPINUP_HOLD = 0x10, /* LOCAL PORT ONLY! */
138};
139
140/* SAS LLDD would need to report only _very_few_ of those, like BROADCAST.
141 * Most of those are here for completeness.
142 */
143enum sas_prim {
144 SAS_PRIM_AIP_NORMAL = 1,
145 SAS_PRIM_AIP_R0 = 2,
146 SAS_PRIM_AIP_R1 = 3,
147 SAS_PRIM_AIP_R2 = 4,
148 SAS_PRIM_AIP_WC = 5,
149 SAS_PRIM_AIP_WD = 6,
150 SAS_PRIM_AIP_WP = 7,
151 SAS_PRIM_AIP_RWP = 8,
152
153 SAS_PRIM_BC_CH = 9,
154 SAS_PRIM_BC_RCH0 = 10,
155 SAS_PRIM_BC_RCH1 = 11,
156 SAS_PRIM_BC_R0 = 12,
157 SAS_PRIM_BC_R1 = 13,
158 SAS_PRIM_BC_R2 = 14,
159 SAS_PRIM_BC_R3 = 15,
160 SAS_PRIM_BC_R4 = 16,
161
162 SAS_PRIM_NOTIFY_ENSP= 17,
163 SAS_PRIM_NOTIFY_R0 = 18,
164 SAS_PRIM_NOTIFY_R1 = 19,
165 SAS_PRIM_NOTIFY_R2 = 20,
166
167 SAS_PRIM_CLOSE_CLAF = 21,
168 SAS_PRIM_CLOSE_NORM = 22,
169 SAS_PRIM_CLOSE_R0 = 23,
170 SAS_PRIM_CLOSE_R1 = 24,
171
172 SAS_PRIM_OPEN_RTRY = 25,
173 SAS_PRIM_OPEN_RJCT = 26,
174 SAS_PRIM_OPEN_ACPT = 27,
175
176 SAS_PRIM_DONE = 28,
177 SAS_PRIM_BREAK = 29,
178
179 SATA_PRIM_DMAT = 33,
180 SATA_PRIM_PMNAK = 34,
181 SATA_PRIM_PMACK = 35,
182 SATA_PRIM_PMREQ_S = 36,
183 SATA_PRIM_PMREQ_P = 37,
184 SATA_SATA_R_ERR = 38,
185};
186
187enum sas_open_rej_reason {
188 /* Abandon open */
189 SAS_OREJ_UNKNOWN = 0,
190 SAS_OREJ_BAD_DEST = 1,
191 SAS_OREJ_CONN_RATE = 2,
192 SAS_OREJ_EPROTO = 3,
193 SAS_OREJ_RESV_AB0 = 4,
194 SAS_OREJ_RESV_AB1 = 5,
195 SAS_OREJ_RESV_AB2 = 6,
196 SAS_OREJ_RESV_AB3 = 7,
197 SAS_OREJ_WRONG_DEST= 8,
198 SAS_OREJ_STP_NORES = 9,
199
200 /* Retry open */
201 SAS_OREJ_NO_DEST = 10,
202 SAS_OREJ_PATH_BLOCKED = 11,
203 SAS_OREJ_RSVD_CONT0 = 12,
204 SAS_OREJ_RSVD_CONT1 = 13,
205 SAS_OREJ_RSVD_INIT0 = 14,
206 SAS_OREJ_RSVD_INIT1 = 15,
207 SAS_OREJ_RSVD_STOP0 = 16,
208 SAS_OREJ_RSVD_STOP1 = 17,
209 SAS_OREJ_RSVD_RETRY = 18,
210};
211
212struct dev_to_host_fis {
213 u8 fis_type; /* 0x34 */
214 u8 flags;
215 u8 status;
216 u8 error;
217
218 u8 lbal;
219 union { u8 lbam; u8 byte_count_low; };
220 union { u8 lbah; u8 byte_count_high; };
221 u8 device;
222
223 u8 lbal_exp;
224 u8 lbam_exp;
225 u8 lbah_exp;
226 u8 _r_a;
227
228 union { u8 sector_count; u8 interrupt_reason; };
229 u8 sector_count_exp;
230 u8 _r_b;
231 u8 _r_c;
232
233 u32 _r_d;
234} __attribute__ ((packed));
235
236struct host_to_dev_fis {
237 u8 fis_type; /* 0x27 */
238 u8 flags;
239 u8 command;
240 u8 features;
241
242 u8 lbal;
243 union { u8 lbam; u8 byte_count_low; };
244 union { u8 lbah; u8 byte_count_high; };
245 u8 device;
246
247 u8 lbal_exp;
248 u8 lbam_exp;
249 u8 lbah_exp;
250 u8 features_exp;
251
252 union { u8 sector_count; u8 interrupt_reason; };
253 u8 sector_count_exp;
254 u8 _r_a;
255 u8 control;
256
257 u32 _r_b;
258} __attribute__ ((packed));
259
260/* Prefer to have code clarity over header file clarity.
261 */
262#ifdef __LITTLE_ENDIAN_BITFIELD
263struct sas_identify_frame {
264 /* Byte 0 */
265 u8 frame_type:4;
266 u8 dev_type:3;
267 u8 _un0:1;
268
269 /* Byte 1 */
270 u8 _un1;
271
272 /* Byte 2 */
273 union {
274 struct {
275 u8 _un20:1;
276 u8 smp_iport:1;
277 u8 stp_iport:1;
278 u8 ssp_iport:1;
279 u8 _un247:4;
280 };
281 u8 initiator_bits;
282 };
283
284 /* Byte 3 */
285 union {
286 struct {
287 u8 _un30:1;
288 u8 smp_tport:1;
289 u8 stp_tport:1;
290 u8 ssp_tport:1;
291 u8 _un347:4;
292 };
293 u8 target_bits;
294 };
295
296 /* Byte 4 - 11 */
297 u8 _un4_11[8];
298
299 /* Byte 12 - 19 */
300 u8 sas_addr[SAS_ADDR_SIZE];
301
302 /* Byte 20 */
303 u8 phy_id;
304
305 u8 _un21_27[7];
306
307 __be32 crc;
308} __attribute__ ((packed));
309
310struct ssp_frame_hdr {
311 u8 frame_type;
312 u8 hashed_dest_addr[HASHED_SAS_ADDR_SIZE];
313 u8 _r_a;
314 u8 hashed_src_addr[HASHED_SAS_ADDR_SIZE];
315 __be16 _r_b;
316
317 u8 changing_data_ptr:1;
318 u8 retransmit:1;
319 u8 retry_data_frames:1;
320 u8 _r_c:5;
321
322 u8 num_fill_bytes:2;
323 u8 _r_d:6;
324
325 u32 _r_e;
326 __be16 tag;
327 __be16 tptt;
328 __be32 data_offs;
329} __attribute__ ((packed));
330
331struct ssp_response_iu {
332 u8 _r_a[10];
333
334 u8 datapres:2;
335 u8 _r_b:6;
336
337 u8 status;
338
339 u32 _r_c;
340
341 __be32 sense_data_len;
342 __be32 response_data_len;
343
344 u8 resp_data[0];
345 u8 sense_data[0];
346} __attribute__ ((packed));
347
348/* ---------- SMP ---------- */
349
350struct report_general_resp {
351 __be16 change_count;
352 __be16 route_indexes;
353 u8 _r_a;
354 u8 num_phys;
355
356 u8 conf_route_table:1;
357 u8 configuring:1;
358 u8 _r_b:6;
359
360 u8 _r_c;
361
362 u8 enclosure_logical_id[8];
363
364 u8 _r_d[12];
365} __attribute__ ((packed));
366
367struct discover_resp {
368 u8 _r_a[5];
369
370 u8 phy_id;
371 __be16 _r_b;
372
373 u8 _r_c:4;
374 u8 attached_dev_type:3;
375 u8 _r_d:1;
376
377 u8 linkrate:4;
378 u8 _r_e:4;
379
380 u8 attached_sata_host:1;
381 u8 iproto:3;
382 u8 _r_f:4;
383
384 u8 attached_sata_dev:1;
385 u8 tproto:3;
386 u8 _r_g:3;
387 u8 attached_sata_ps:1;
388
389 u8 sas_addr[8];
390 u8 attached_sas_addr[8];
391 u8 attached_phy_id;
392
393 u8 _r_h[7];
394
395 u8 hmin_linkrate:4;
396 u8 pmin_linkrate:4;
397 u8 hmax_linkrate:4;
398 u8 pmax_linkrate:4;
399
400 u8 change_count;
401
402 u8 pptv:4;
403 u8 _r_i:3;
404 u8 virtual:1;
405
406 u8 routing_attr:4;
407 u8 _r_j:4;
408
409 u8 conn_type;
410 u8 conn_el_index;
411 u8 conn_phy_link;
412
413 u8 _r_k[8];
414} __attribute__ ((packed));
415
416struct report_phy_sata_resp {
417 u8 _r_a[5];
418
419 u8 phy_id;
420 u8 _r_b;
421
422 u8 affil_valid:1;
423 u8 affil_supp:1;
424 u8 _r_c:6;
425
426 u32 _r_d;
427
428 u8 stp_sas_addr[8];
429
430 struct dev_to_host_fis fis;
431
432 u32 _r_e;
433
434 u8 affil_stp_ini_addr[8];
435
436 __be32 crc;
437} __attribute__ ((packed));
438
439struct smp_resp {
440 u8 frame_type;
441 u8 function;
442 u8 result;
443 u8 reserved;
444 union {
445 struct report_general_resp rg;
446 struct discover_resp disc;
447 struct report_phy_sata_resp rps;
448 };
449} __attribute__ ((packed));
450
451#elif defined(__BIG_ENDIAN_BITFIELD)
452struct sas_identify_frame {
453 /* Byte 0 */
454 u8 _un0:1;
455 u8 dev_type:3;
456 u8 frame_type:4;
457
458 /* Byte 1 */
459 u8 _un1;
460
461 /* Byte 2 */
462 union {
463 struct {
464 u8 _un247:4;
465 u8 ssp_iport:1;
466 u8 stp_iport:1;
467 u8 smp_iport:1;
468 u8 _un20:1;
469 };
470 u8 initiator_bits;
471 };
472
473 /* Byte 3 */
474 union {
475 struct {
476 u8 _un347:4;
477 u8 ssp_tport:1;
478 u8 stp_tport:1;
479 u8 smp_tport:1;
480 u8 _un30:1;
481 };
482 u8 target_bits;
483 };
484
485 /* Byte 4 - 11 */
486 u8 _un4_11[8];
487
488 /* Byte 12 - 19 */
489 u8 sas_addr[SAS_ADDR_SIZE];
490
491 /* Byte 20 */
492 u8 phy_id;
493
494 u8 _un21_27[7];
495
496 __be32 crc;
497} __attribute__ ((packed));
498
499struct ssp_frame_hdr {
500 u8 frame_type;
501 u8 hashed_dest_addr[HASHED_SAS_ADDR_SIZE];
502 u8 _r_a;
503 u8 hashed_src_addr[HASHED_SAS_ADDR_SIZE];
504 __be16 _r_b;
505
506 u8 _r_c:5;
507 u8 retry_data_frames:1;
508 u8 retransmit:1;
509 u8 changing_data_ptr:1;
510
511 u8 _r_d:6;
512 u8 num_fill_bytes:2;
513
514 u32 _r_e;
515 __be16 tag;
516 __be16 tptt;
517 __be32 data_offs;
518} __attribute__ ((packed));
519
520struct ssp_response_iu {
521 u8 _r_a[10];
522
523 u8 _r_b:6;
524 u8 datapres:2;
525
526 u8 status;
527
528 u32 _r_c;
529
530 __be32 sense_data_len;
531 __be32 response_data_len;
532
533 u8 resp_data[0];
534 u8 sense_data[0];
535} __attribute__ ((packed));
536
537/* ---------- SMP ---------- */
538
539struct report_general_resp {
540 __be16 change_count;
541 __be16 route_indexes;
542 u8 _r_a;
543 u8 num_phys;
544
545 u8 _r_b:6;
546 u8 configuring:1;
547 u8 conf_route_table:1;
548
549 u8 _r_c;
550
551 u8 enclosure_logical_id[8];
552
553 u8 _r_d[12];
554} __attribute__ ((packed));
555
556struct discover_resp {
557 u8 _r_a[5];
558
559 u8 phy_id;
560 __be16 _r_b;
561
562 u8 _r_d:1;
563 u8 attached_dev_type:3;
564 u8 _r_c:4;
565
566 u8 _r_e:4;
567 u8 linkrate:4;
568
569 u8 _r_f:4;
570 u8 iproto:3;
571 u8 attached_sata_host:1;
572
573 u8 attached_sata_ps:1;
574 u8 _r_g:3;
575 u8 tproto:3;
576 u8 attached_sata_dev:1;
577
578 u8 sas_addr[8];
579 u8 attached_sas_addr[8];
580 u8 attached_phy_id;
581
582 u8 _r_h[7];
583
584 u8 pmin_linkrate:4;
585 u8 hmin_linkrate:4;
586 u8 pmax_linkrate:4;
587 u8 hmax_linkrate:4;
588
589 u8 change_count;
590
591 u8 virtual:1;
592 u8 _r_i:3;
593 u8 pptv:4;
594
595 u8 _r_j:4;
596 u8 routing_attr:4;
597
598 u8 conn_type;
599 u8 conn_el_index;
600 u8 conn_phy_link;
601
602 u8 _r_k[8];
603} __attribute__ ((packed));
604
605struct report_phy_sata_resp {
606 u8 _r_a[5];
607
608 u8 phy_id;
609 u8 _r_b;
610
611 u8 _r_c:6;
612 u8 affil_supp:1;
613 u8 affil_valid:1;
614
615 u32 _r_d;
616
617 u8 stp_sas_addr[8];
618
619 struct dev_to_host_fis fis;
620
621 u32 _r_e;
622
623 u8 affil_stp_ini_addr[8];
624
625 __be32 crc;
626} __attribute__ ((packed));
627
628struct smp_resp {
629 u8 frame_type;
630 u8 function;
631 u8 result;
632 u8 reserved;
633 union {
634 struct report_general_resp rg;
635 struct discover_resp disc;
636 struct report_phy_sata_resp rps;
637 };
638} __attribute__ ((packed));
639
640#else
641#error "Bitfield order not defined!"
642#endif
643
644#endif /* _SAS_H_ */
diff --git a/include/scsi/scsi.h b/include/scsi/scsi.h
index 1bc675201413..84a6d5fe0920 100644
--- a/include/scsi/scsi.h
+++ b/include/scsi/scsi.h
@@ -429,4 +429,10 @@ struct scsi_lun {
429/* Used to obtain the PCI location of a device */ 429/* Used to obtain the PCI location of a device */
430#define SCSI_IOCTL_GET_PCI 0x5387 430#define SCSI_IOCTL_GET_PCI 0x5387
431 431
432/* Pull a u32 out of a SCSI message (using BE SCSI conventions) */
433static inline u32 scsi_to_u32(u8 *ptr)
434{
435 return (ptr[0]<<24) + (ptr[1]<<16) + (ptr[2]<<8) + ptr[3];
436}
437
432#endif /* _SCSI_SCSI_H */ 438#endif /* _SCSI_SCSI_H */
generated by cgit v1.2.2 (git 2.25.0) at 2024-12-16 20:52:18 -0500