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 */
93enum sas_device_type {
94 /* these are SAS protocol defined (attached device type field) */
95 SAS_PHY_UNUSED = 0,
96 SAS_END_DEVICE = 1,
97 SAS_EDGE_EXPANDER_DEVICE = 2,
98 SAS_FANOUT_EXPANDER_DEVICE = 3,
99 /* these are internal to libsas */
100 SAS_HA = 4,
101 SAS_SATA_DEV = 5,
102 SAS_SATA_PM = 7,
103 SAS_SATA_PM_PORT = 8,
104 SAS_SATA_PENDING = 9,
105};
106
107enum sas_protocol {
108 SAS_PROTOCOL_NONE = 0,
109 SAS_PROTOCOL_SATA = 0x01,
110 SAS_PROTOCOL_SMP = 0x02,
111 SAS_PROTOCOL_STP = 0x04,
112 SAS_PROTOCOL_SSP = 0x08,
113 SAS_PROTOCOL_ALL = 0x0E,
114 SAS_PROTOCOL_STP_ALL = SAS_PROTOCOL_STP|SAS_PROTOCOL_SATA,
115};
116
117/* From the spec; local phys only */
118enum phy_func {
119 PHY_FUNC_NOP,
120 PHY_FUNC_LINK_RESET, /* Enables the phy */
121 PHY_FUNC_HARD_RESET,
122 PHY_FUNC_DISABLE,
123 PHY_FUNC_CLEAR_ERROR_LOG = 5,
124 PHY_FUNC_CLEAR_AFFIL,
125 PHY_FUNC_TX_SATA_PS_SIGNAL,
126 PHY_FUNC_RELEASE_SPINUP_HOLD = 0x10, /* LOCAL PORT ONLY! */
127 PHY_FUNC_SET_LINK_RATE,
128 PHY_FUNC_GET_EVENTS,
129};
130
131/* SAS LLDD would need to report only _very_few_ of those, like BROADCAST.
132 * Most of those are here for completeness.
133 */
134enum sas_prim {
135 SAS_PRIM_AIP_NORMAL = 1,
136 SAS_PRIM_AIP_R0 = 2,
137 SAS_PRIM_AIP_R1 = 3,
138 SAS_PRIM_AIP_R2 = 4,
139 SAS_PRIM_AIP_WC = 5,
140 SAS_PRIM_AIP_WD = 6,
141 SAS_PRIM_AIP_WP = 7,
142 SAS_PRIM_AIP_RWP = 8,
143
144 SAS_PRIM_BC_CH = 9,
145 SAS_PRIM_BC_RCH0 = 10,
146 SAS_PRIM_BC_RCH1 = 11,
147 SAS_PRIM_BC_R0 = 12,
148 SAS_PRIM_BC_R1 = 13,
149 SAS_PRIM_BC_R2 = 14,
150 SAS_PRIM_BC_R3 = 15,
151 SAS_PRIM_BC_R4 = 16,
152
153 SAS_PRIM_NOTIFY_ENSP= 17,
154 SAS_PRIM_NOTIFY_R0 = 18,
155 SAS_PRIM_NOTIFY_R1 = 19,
156 SAS_PRIM_NOTIFY_R2 = 20,
157
158 SAS_PRIM_CLOSE_CLAF = 21,
159 SAS_PRIM_CLOSE_NORM = 22,
160 SAS_PRIM_CLOSE_R0 = 23,
161 SAS_PRIM_CLOSE_R1 = 24,
162
163 SAS_PRIM_OPEN_RTRY = 25,
164 SAS_PRIM_OPEN_RJCT = 26,
165 SAS_PRIM_OPEN_ACPT = 27,
166
167 SAS_PRIM_DONE = 28,
168 SAS_PRIM_BREAK = 29,
169
170 SATA_PRIM_DMAT = 33,
171 SATA_PRIM_PMNAK = 34,
172 SATA_PRIM_PMACK = 35,
173 SATA_PRIM_PMREQ_S = 36,
174 SATA_PRIM_PMREQ_P = 37,
175 SATA_SATA_R_ERR = 38,
176};
177
178enum sas_open_rej_reason {
179 /* Abandon open */
180 SAS_OREJ_UNKNOWN = 0,
181 SAS_OREJ_BAD_DEST = 1,
182 SAS_OREJ_CONN_RATE = 2,
183 SAS_OREJ_EPROTO = 3,
184 SAS_OREJ_RESV_AB0 = 4,
185 SAS_OREJ_RESV_AB1 = 5,
186 SAS_OREJ_RESV_AB2 = 6,
187 SAS_OREJ_RESV_AB3 = 7,
188 SAS_OREJ_WRONG_DEST= 8,
189 SAS_OREJ_STP_NORES = 9,
190
191 /* Retry open */
192 SAS_OREJ_NO_DEST = 10,
193 SAS_OREJ_PATH_BLOCKED = 11,
194 SAS_OREJ_RSVD_CONT0 = 12,
195 SAS_OREJ_RSVD_CONT1 = 13,
196 SAS_OREJ_RSVD_INIT0 = 14,
197 SAS_OREJ_RSVD_INIT1 = 15,
198 SAS_OREJ_RSVD_STOP0 = 16,
199 SAS_OREJ_RSVD_STOP1 = 17,
200 SAS_OREJ_RSVD_RETRY = 18,
201};
202
203enum sas_gpio_reg_type {
204 SAS_GPIO_REG_CFG = 0,
205 SAS_GPIO_REG_RX = 1,
206 SAS_GPIO_REG_RX_GP = 2,
207 SAS_GPIO_REG_TX = 3,
208 SAS_GPIO_REG_TX_GP = 4,
209};
210
211struct dev_to_host_fis {
212 u8 fis_type; /* 0x34 */
213 u8 flags;
214 u8 status;
215 u8 error;
216
217 u8 lbal;
218 union { u8 lbam; u8 byte_count_low; };
219 union { u8 lbah; u8 byte_count_high; };
220 u8 device;
221
222 u8 lbal_exp;
223 u8 lbam_exp;
224 u8 lbah_exp;
225 u8 _r_a;
226
227 union { u8 sector_count; u8 interrupt_reason; };
228 u8 sector_count_exp;
229 u8 _r_b;
230 u8 _r_c;
231
232 u32 _r_d;
233} __attribute__ ((packed));
234
235struct host_to_dev_fis {
236 u8 fis_type; /* 0x27 */
237 u8 flags;
238 u8 command;
239 u8 features;
240
241 u8 lbal;
242 union { u8 lbam; u8 byte_count_low; };
243 union { u8 lbah; u8 byte_count_high; };
244 u8 device;
245
246 u8 lbal_exp;
247 u8 lbam_exp;
248 u8 lbah_exp;
249 u8 features_exp;
250
251 union { u8 sector_count; u8 interrupt_reason; };
252 u8 sector_count_exp;
253 u8 _r_a;
254 u8 control;
255
256 u32 _r_b;
257} __attribute__ ((packed));
258
259/* Prefer to have code clarity over header file clarity.
260 */
261#ifdef __LITTLE_ENDIAN_BITFIELD
262struct sas_identify_frame {
263 /* Byte 0 */
264 u8 frame_type:4;
265 u8 dev_type:3;
266 u8 _un0:1;
267
268 /* Byte 1 */
269 u8 _un1;
270
271 /* Byte 2 */
272 union {
273 struct {
274 u8 _un20:1;
275 u8 smp_iport:1;
276 u8 stp_iport:1;
277 u8 ssp_iport:1;
278 u8 _un247:4;
279 };
280 u8 initiator_bits;
281 };
282
283 /* Byte 3 */
284 union {
285 struct {
286 u8 _un30:1;
287 u8 smp_tport:1;
288 u8 stp_tport:1;
289 u8 ssp_tport:1;
290 u8 _un347:4;
291 };
292 u8 target_bits;
293 };
294
295 /* Byte 4 - 11 */
296 u8 _un4_11[8];
297
298 /* Byte 12 - 19 */
299 u8 sas_addr[SAS_ADDR_SIZE];
300
301 /* Byte 20 */
302 u8 phy_id;
303
304 u8 _un21_27[7];
305
306 __be32 crc;
307} __attribute__ ((packed));
308
309struct ssp_frame_hdr {
310 u8 frame_type;
311 u8 hashed_dest_addr[HASHED_SAS_ADDR_SIZE];
312 u8 _r_a;
313 u8 hashed_src_addr[HASHED_SAS_ADDR_SIZE];
314 __be16 _r_b;
315
316 u8 changing_data_ptr:1;
317 u8 retransmit:1;
318 u8 retry_data_frames:1;
319 u8 _r_c:5;
320
321 u8 num_fill_bytes:2;
322 u8 _r_d:6;
323
324 u32 _r_e;
325 __be16 tag;
326 __be16 tptt;
327 __be32 data_offs;
328} __attribute__ ((packed));
329
330struct ssp_response_iu {
331 u8 _r_a[10];
332
333 u8 datapres:2;
334 u8 _r_b:6;
335
336 u8 status;
337
338 u32 _r_c;
339
340 __be32 sense_data_len;
341 __be32 response_data_len;
342
343 u8 resp_data[0];
344 u8 sense_data[0];
345} __attribute__ ((packed));
346
347struct ssp_command_iu {
348 u8 lun[8];
349 u8 _r_a;
350
351 union {
352 struct {
353 u8 attr:3;
354 u8 prio:4;
355 u8 efb:1;
356 };
357 u8 efb_prio_attr;
358 };
359
360 u8 _r_b;
361
362 u8 _r_c:2;
363 u8 add_cdb_len:6;
364
365 u8 cdb[16];
366 u8 add_cdb[0];
367} __attribute__ ((packed));
368
369struct xfer_rdy_iu {
370 __be32 requested_offset;
371 __be32 write_data_len;
372 __be32 _r_a;
373} __attribute__ ((packed));
374
375struct ssp_tmf_iu {
376 u8 lun[8];
377 u16 _r_a;
378 u8 tmf;
379 u8 _r_b;
380 __be16 tag;
381 u8 _r_c[14];
382} __attribute__ ((packed));
383
384/* ---------- SMP ---------- */
385
386struct report_general_resp {
387 __be16 change_count;
388 __be16 route_indexes;
389 u8 _r_a;
390 u8 num_phys;
391
392 u8 conf_route_table:1;
393 u8 configuring:1;
394 u8 config_others:1;
395 u8 orej_retry_supp:1;
396 u8 stp_cont_awt:1;
397 u8 self_config:1;
398 u8 zone_config:1;
399 u8 t2t_supp:1;
400
401 u8 _r_c;
402
403 u8 enclosure_logical_id[8];
404
405 u8 _r_d[12];
406} __attribute__ ((packed));
407
408struct discover_resp {
409 u8 _r_a[5];
410
411 u8 phy_id;
412 __be16 _r_b;
413
414 u8 _r_c:4;
415 u8 attached_dev_type:3;
416 u8 _r_d:1;
417
418 u8 linkrate:4;
419 u8 _r_e:4;
420
421 u8 attached_sata_host:1;
422 u8 iproto:3;
423 u8 _r_f:4;
424
425 u8 attached_sata_dev:1;
426 u8 tproto:3;
427 u8 _r_g:3;
428 u8 attached_sata_ps:1;
429
430 u8 sas_addr[8];
431 u8 attached_sas_addr[8];
432 u8 attached_phy_id;
433
434 u8 _r_h[7];
435
436 u8 hmin_linkrate:4;
437 u8 pmin_linkrate:4;
438 u8 hmax_linkrate:4;
439 u8 pmax_linkrate:4;
440
441 u8 change_count;
442
443 u8 pptv:4;
444 u8 _r_i:3;
445 u8 virtual:1;
446
447 u8 routing_attr:4;
448 u8 _r_j:4;
449
450 u8 conn_type;
451 u8 conn_el_index;
452 u8 conn_phy_link;
453
454 u8 _r_k[8];
455} __attribute__ ((packed));
456
457struct report_phy_sata_resp {
458 u8 _r_a[5];
459
460 u8 phy_id;
461 u8 _r_b;
462
463 u8 affil_valid:1;
464 u8 affil_supp:1;
465 u8 _r_c:6;
466
467 u32 _r_d;
468
469 u8 stp_sas_addr[8];
470
471 struct dev_to_host_fis fis;
472
473 u32 _r_e;
474
475 u8 affil_stp_ini_addr[8];
476
477 __be32 crc;
478} __attribute__ ((packed));
479
480struct smp_resp {
481 u8 frame_type;
482 u8 function;
483 u8 result;
484 u8 reserved;
485 union {
486 struct report_general_resp rg;
487 struct discover_resp disc;
488 struct report_phy_sata_resp rps;
489 };
490} __attribute__ ((packed));
491
492#elif defined(__BIG_ENDIAN_BITFIELD)
493struct sas_identify_frame {
494 /* Byte 0 */
495 u8 _un0:1;
496 u8 dev_type:3;
497 u8 frame_type:4;
498
499 /* Byte 1 */
500 u8 _un1;
501
502 /* Byte 2 */
503 union {
504 struct {
505 u8 _un247:4;
506 u8 ssp_iport:1;
507 u8 stp_iport:1;
508 u8 smp_iport:1;
509 u8 _un20:1;
510 };
511 u8 initiator_bits;
512 };
513
514 /* Byte 3 */
515 union {
516 struct {
517 u8 _un347:4;
518 u8 ssp_tport:1;
519 u8 stp_tport:1;
520 u8 smp_tport:1;
521 u8 _un30:1;
522 };
523 u8 target_bits;
524 };
525
526 /* Byte 4 - 11 */
527 u8 _un4_11[8];
528
529 /* Byte 12 - 19 */
530 u8 sas_addr[SAS_ADDR_SIZE];
531
532 /* Byte 20 */
533 u8 phy_id;
534
535 u8 _un21_27[7];
536
537 __be32 crc;
538} __attribute__ ((packed));
539
540struct ssp_frame_hdr {
541 u8 frame_type;
542 u8 hashed_dest_addr[HASHED_SAS_ADDR_SIZE];
543 u8 _r_a;
544 u8 hashed_src_addr[HASHED_SAS_ADDR_SIZE];
545 __be16 _r_b;
546
547 u8 _r_c:5;
548 u8 retry_data_frames:1;
549 u8 retransmit:1;
550 u8 changing_data_ptr:1;
551
552 u8 _r_d:6;
553 u8 num_fill_bytes:2;
554
555 u32 _r_e;
556 __be16 tag;
557 __be16 tptt;
558 __be32 data_offs;
559} __attribute__ ((packed));
560
561struct ssp_response_iu {
562 u8 _r_a[10];
563
564 u8 _r_b:6;
565 u8 datapres:2;
566
567 u8 status;
568
569 u32 _r_c;
570
571 __be32 sense_data_len;
572 __be32 response_data_len;
573
574 u8 resp_data[0];
575 u8 sense_data[0];
576} __attribute__ ((packed));
577
578struct ssp_command_iu {
579 u8 lun[8];
580 u8 _r_a;
581
582 union {
583 struct {
584 u8 efb:1;
585 u8 prio:4;
586 u8 attr:3;
587 };
588 u8 efb_prio_attr;
589 };
590
591 u8 _r_b;
592
593 u8 add_cdb_len:6;
594 u8 _r_c:2;
595
596 u8 cdb[16];
597 u8 add_cdb[0];
598} __attribute__ ((packed));
599
600struct xfer_rdy_iu {
601 __be32 requested_offset;
602 __be32 write_data_len;
603 __be32 _r_a;
604} __attribute__ ((packed));
605
606struct ssp_tmf_iu {
607 u8 lun[8];
608 u16 _r_a;
609 u8 tmf;
610 u8 _r_b;
611 __be16 tag;
612 u8 _r_c[14];
613} __attribute__ ((packed));
614
615/* ---------- SMP ---------- */
616
617struct report_general_resp {
618 __be16 change_count;
619 __be16 route_indexes;
620 u8 _r_a;
621 u8 num_phys;
622
623 u8 t2t_supp:1;
624 u8 zone_config:1;
625 u8 self_config:1;
626 u8 stp_cont_awt:1;
627 u8 orej_retry_supp:1;
628 u8 config_others:1;
629 u8 configuring:1;
630 u8 conf_route_table:1;
631
632 u8 _r_c;
633
634 u8 enclosure_logical_id[8];
635
636 u8 _r_d[12];
637} __attribute__ ((packed));
638
639struct discover_resp {
640 u8 _r_a[5];
641
642 u8 phy_id;
643 __be16 _r_b;
644
645 u8 _r_d:1;
646 u8 attached_dev_type:3;
647 u8 _r_c:4;
648
649 u8 _r_e:4;
650 u8 linkrate:4;
651
652 u8 _r_f:4;
653 u8 iproto:3;
654 u8 attached_sata_host:1;
655
656 u8 attached_sata_ps:1;
657 u8 _r_g:3;
658 u8 tproto:3;
659 u8 attached_sata_dev:1;
660
661 u8 sas_addr[8];
662 u8 attached_sas_addr[8];
663 u8 attached_phy_id;
664
665 u8 _r_h[7];
666
667 u8 pmin_linkrate:4;
668 u8 hmin_linkrate:4;
669 u8 pmax_linkrate:4;
670 u8 hmax_linkrate:4;
671
672 u8 change_count;
673
674 u8 virtual:1;
675 u8 _r_i:3;
676 u8 pptv:4;
677
678 u8 _r_j:4;
679 u8 routing_attr:4;
680
681 u8 conn_type;
682 u8 conn_el_index;
683 u8 conn_phy_link;
684
685 u8 _r_k[8];
686} __attribute__ ((packed));
687
688struct report_phy_sata_resp {
689 u8 _r_a[5];
690
691 u8 phy_id;
692 u8 _r_b;
693
694 u8 _r_c:6;
695 u8 affil_supp:1;
696 u8 affil_valid:1;
697
698 u32 _r_d;
699
700 u8 stp_sas_addr[8];
701
702 struct dev_to_host_fis fis;
703
704 u32 _r_e;
705
706 u8 affil_stp_ini_addr[8];
707
708 __be32 crc;
709} __attribute__ ((packed));
710
711struct smp_resp {
712 u8 frame_type;
713 u8 function;
714 u8 result;
715 u8 reserved;
716 union {
717 struct report_general_resp rg;
718 struct discover_resp disc;
719 struct report_phy_sata_resp rps;
720 };
721} __attribute__ ((packed));
722
723#else
724#error "Bitfield order not defined!"
725#endif
726
727#endif /* _SAS_H_ */
728