2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
33 * * Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * * Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in
37 * the documentation and/or other materials provided with the
39 * * Neither the name of Intel Corporation nor the names of its
40 * contributors may be used to endorse or promote products derived
41 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60 * This file contains all of the definitions relating to structures, constants,
61 * etc. defined by the SAS specification.
65 #include <linux/kernel.h>
66 #include "intel_scsi.h"
69 * struct sci_sas_address - This structure depicts how a SAS address is
74 struct sci_sas_address
{
76 * This member contains the higher 32-bits of the SAS address.
81 * This member contains the lower 32-bits of the SAS address.
88 * struct sci_sas_identify_address_frame_protocols - This structure depicts the
89 * contents of bytes 2 and 3 in the SAS IDENTIFY ADDRESS FRAME (IAF).
91 * For specific information on each of these individual fields please reference
92 * the SAS specification Link layer section on address frames.
94 struct sci_sas_identify_address_frame_protocols
{
115 * enum _SCI_SAS_TASK_ATTRIBUTE - This enumeration depicts the SAM/SAS
116 * specification defined task attribute values for a command information
121 enum sci_sas_task_attribute
{
122 SCI_SAS_SIMPLE_ATTRIBUTE
= 0,
123 SCI_SAS_HEAD_OF_QUEUE_ATTRIBUTE
= 1,
124 SCI_SAS_ORDERED_ATTRIBUTE
= 2,
125 SCI_SAS_ACA_ATTRIBUTE
= 4,
129 * enum _SCI_SAS_TASK_MGMT_FUNCTION - This enumeration depicts the SAM/SAS
130 * specification defined task management functions.
132 * This HARD_RESET function listed here is not actually defined as a task
133 * management function in the industry standard.
135 enum sci_sas_task_mgmt_function
{
136 SCI_SAS_ABORT_TASK
= SCSI_TASK_REQUEST_ABORT_TASK
,
137 SCI_SAS_ABORT_TASK_SET
= SCSI_TASK_REQUEST_ABORT_TASK_SET
,
138 SCI_SAS_CLEAR_TASK_SET
= SCSI_TASK_REQUEST_CLEAR_TASK_SET
,
139 SCI_SAS_LOGICAL_UNIT_RESET
= SCSI_TASK_REQUEST_LOGICAL_UNIT_RESET
,
140 SCI_SAS_I_T_NEXUS_RESET
= SCSI_TASK_REQUEST_I_T_NEXUS_RESET
,
141 SCI_SAS_CLEAR_ACA
= SCSI_TASK_REQUEST_CLEAR_ACA
,
142 SCI_SAS_QUERY_TASK
= SCSI_TASK_REQUEST_QUERY_TASK
,
143 SCI_SAS_QUERY_TASK_SET
= SCSI_TASK_REQUEST_QUERY_TASK_SET
,
144 SCI_SAS_QUERY_ASYNCHRONOUS_EVENT
= SCSI_TASK_REQUEST_QUERY_UNIT_ATTENTION
,
145 SCI_SAS_HARD_RESET
= 0xFF
150 * enum _SCI_SAS_FRAME_TYPE - This enumeration depicts the SAS specification
151 * defined SSP frame types.
155 enum sci_sas_frame_type
{
156 SCI_SAS_DATA_FRAME
= 0x01,
157 SCI_SAS_XFER_RDY_FRAME
= 0x05,
158 SCI_SAS_COMMAND_FRAME
= 0x06,
159 SCI_SAS_RESPONSE_FRAME
= 0x07,
160 SCI_SAS_TASK_FRAME
= 0x16
163 #define SSP_RESPONSE_IU_MAX_DATA 64
165 #define SCI_SSP_RESPONSE_IU_DATA_PRESENT_MASK (0x03)
168 #define sci_ssp_get_sense_data_length(sense_data_length_buffer) \
169 SCIC_BUILD_DWORD(sense_data_length_buffer)
171 #define sci_ssp_get_response_data_length(response_data_length_buffer) \
172 SCIC_BUILD_DWORD(response_data_length_buffer)
175 * struct sci_ssp_response_iu - This structure depicts the contents of the SSP
176 * RESPONSE INFORMATION UNIT. For specific information on each of these
177 * individual fields please reference the SAS specification SSP transport
182 struct sci_ssp_response_iu
{
185 u8 retry_delay_timer
[2];
190 u8 sense_data_length
[4];
191 u8 response_data_length
[4];
193 u32 data
[SSP_RESPONSE_IU_MAX_DATA
];
198 * enum _SCI_SAS_DATA_PRESENT_TYPE - This enumeration depicts the SAS
199 * specification defined SSP data present types in struct sci_ssp_response_iu.
203 enum sci_ssp_response_iu_data_present_type
{
204 SCI_SSP_RESPONSE_IU_NO_DATA
= 0x00,
205 SCI_SSP_RESPONSE_IU_RESPONSE_DATA
= 0x01,
206 SCI_SSP_RESPONSE_IU_SENSE_DATA
= 0x02
210 * struct sci_ssp_frame_header - This structure depicts the contents of an SSP
211 * frame header. For specific information on the individual fields please
212 * reference the SAS specification transport layer SSP frame format.
216 struct sci_ssp_frame_header
{
218 u32 hashed_destination_address
:24;
222 u32 hashed_source_address
:24;
230 u32 retry_data_frames
:1;
232 u32 changing_data_pointer
:1;
239 u16 target_port_transfer_tag
;
248 * struct smp_request_header - This structure defines the contents of an SMP
251 * For specific information on each of these individual fields please reference
252 * the SAS specification.
254 struct smp_request_header
{
255 u8 smp_frame_type
; /* byte 0 */
256 u8 function
; /* byte 1 */
257 u8 allocated_response_length
; /* byte 2 */
258 u8 request_length
; /* byte 3 */
262 * struct smp_response_header - This structure depicts the contents of the SAS
263 * SMP DISCOVER RESPONSE frame. For specific information on each of these
264 * individual fields please reference the SAS specification Link layer
265 * section on address frames.
269 struct smp_response_header
{
270 u8 smp_frame_type
; /* byte 0 */
271 u8 function
; /* byte 1 */
272 u8 function_result
; /* byte 2 */
273 u8 response_length
; /* byte 3 */
277 * struct smp_request_general - This structure defines the contents of an SMP
278 * Request that is comprised of the struct smp_request_header and a CRC.
280 * For specific information on each of these individual fields please reference
281 * the SAS specification.
283 struct smp_request_general
{
284 u32 crc
; /* bytes 4-7 */
289 * struct smp_request_phy_identifier - This structure defines the contents of
290 * an SMP Request that is comprised of the struct smp_request_header and a phy
291 * identifier. Examples: SMP_REQUEST_DISCOVER, SMP_REQUEST_REPORT_PHY_SATA.
293 * For specific information on each of these individual fields please reference
294 * the SAS specification.
296 struct smp_request_phy_identifier
{
297 u32 reserved_byte4_7
; /* bytes 4-7 */
299 u32 ignore_zone_group
:1; /* byte 8 */
300 u32 reserved_byte8
:7;
302 u32 phy_identifier
:8; /* byte 9 */
303 u32 reserved_byte10
:8; /* byte 10 */
304 u32 reserved_byte11
:8; /* byte 11 */
309 * struct smp_request_configure_route_information - This structure defines the
310 * contents of an SMP Configure Route Information request.
312 * For specific information on each of these individual fields please reference
313 * the SAS specification.
315 struct smp_request_configure_route_information
{
316 u32 expected_expander_change_count
:16; /* bytes 4-5 */
317 u32 expander_route_index_high
:8;
318 u32 expander_route_index
:8; /* bytes 6-7 */
320 u32 reserved_byte8
:8; /* bytes 8 */
321 u32 phy_identifier
:8; /* bytes 9 */
322 u32 reserved_byte_10_11
:16; /* bytes 10-11 */
324 u32 reserved_byte_12_bit_0_6
:7;
325 u32 disable_route_entry
:1; /* byte 12 */
326 u32 reserved_byte_13_15
:24; /* bytes 13-15 */
328 u32 routed_sas_address
[2]; /* bytes 16-23 */
329 u8 reserved_byte_24_39
[16]; /* bytes 24-39 */
334 * struct smp_request_phy_control - This structure defines the contents of an
335 * SMP Phy Controler request.
337 * For specific information on each of these individual fields please reference
338 * the SAS specification.
340 struct smp_request_phy_control
{
341 u16 expected_expander_change_count
; /* byte 4-5 */
343 u16 reserved_byte_6_7
; /* byte 6-7 */
344 u8 reserved_byte_8
; /* byte 8 */
346 u8 phy_identifier
; /* byte 9 */
347 u8 phy_operation
; /* byte 10 */
349 u8 update_partial_pathway_timeout_value
:1;
350 u8 reserved_byte_11_bit_1_7
:7; /* byte 11 */
352 u8 reserved_byte_12_23
[12]; /* byte 12-23 */
354 u8 attached_device_name
[8]; /* byte 24-31 */
356 u8 reserved_byte_32_bit_3_0
:4; /* byte 32 */
357 u8 programmed_minimum_physical_link_rate
:4;
359 u8 reserved_byte_33_bit_3_0
:4; /* byte 33 */
360 u8 programmed_maximum_physical_link_rate
:4;
362 u16 reserved_byte_34_35
; /* byte 34-35 */
364 u8 partial_pathway_timeout_value
:4;
365 u8 reserved_byte_36_bit_4_7
:4; /* byte 36 */
367 u16 reserved_byte_37_38
; /* byte 37-38 */
368 u8 reserved_byte_39
; /* byte 39 */
373 * struct smp_request_vendor_specific - This structure depicts the vendor
374 * specific space for SMP request.
378 #define SMP_REQUEST_VENDOR_SPECIFIC_MAX_LENGTH 1016
379 struct smp_request_vendor_specific
{
380 u8 request_bytes
[SMP_REQUEST_VENDOR_SPECIFIC_MAX_LENGTH
];
384 * struct smp_request - This structure simply unionizes the existing request
385 * structures into a common request type.
390 struct smp_request_header header
;
392 union { /* bytes 4-N */
393 struct smp_request_general report_general
;
394 struct smp_request_phy_identifier discover
;
395 struct smp_request_general report_manufacturer_information
;
396 struct smp_request_phy_identifier report_phy_sata
;
397 struct smp_request_phy_control phy_control
;
398 struct smp_request_phy_identifier report_phy_error_log
;
399 struct smp_request_phy_identifier report_route_information
;
400 struct smp_request_configure_route_information configure_route_information
;
401 struct smp_request_vendor_specific vendor_specific_request
;
408 * struct smp_response_report_general - This structure depicts the SMP Report
409 * General for expander devices. It adheres to the SAS-2.1 specification.
411 * For specific information on each of these individual fields please reference
412 * the SAS specification Application layer section on SMP.
414 struct smp_response_report_general
{
415 u16 expander_change_count
; /* byte 4-5 */
416 u16 expander_route_indexes
; /* byte 6-7 */
418 u32 reserved_byte8
:7; /* byte 8 bit 0-6 */
419 u32 long_response
:1; /* byte 8 bit 7 */
421 u32 number_of_phys
:8; /* byte 9 */
423 u32 configurable_route_table
:1; /* byte 10 */
425 u32 configures_others
:1;
426 u32 open_reject_retry_supported
:1;
427 u32 stp_continue_awt
:1;
428 u32 self_configuring
:1;
429 u32 zone_configuring
:1;
430 u32 table_to_table_supported
:1;
432 u32 reserved_byte11
:8; /* byte 11 */
434 u32 enclosure_logical_identifier_high
; /* byte 12-15 */
435 u32 enclosure_logical_identifier_low
; /* byte 16-19 */
437 u32 reserved_byte20_23
;
438 u32 reserved_byte24_27
;
442 struct smp_response_report_general_long
{
443 struct smp_response_report_general sas1_1
;
447 u16 stp_bus_inactivity_time_limit
;
448 u16 stp_max_connect_time_limit
;
449 u16 stp_smp_i_t_nexus_loss_time
;
451 u32 zoning_enabled
:1;
452 u32 zoning_supported
:1;
453 u32 physicaL_presence_asserted
:1;
456 u32 num_zone_groups
:3;
457 u32 saving_zoning_enabled_supported
:3;
458 u32 saving_zone_perms_table_supported
:1;
459 u32 saving_zone_phy_info_supported
:1;
460 u32 saving_zone_manager_password_supported
:1;
463 u32 max_number_routed_sas_addresses
:16;
465 struct sci_sas_address active_zone_manager_sas_address
;
467 u16 zone_lock_inactivity_time_limit
;
471 u8 first_enclosure_connector_element_index
;
472 u8 number_of_enclosure_connector_element_indices
;
476 u32 reduced_functionality
:1;
477 u32 time_to_reduce_functionality
:8;
478 u32 initial_time_to_reduce_functionality
:8;
479 u8 max_reduced_functionality_time
;
481 u16 last_self_config_status_descriptor_index
;
482 u16 max_number_of_stored_self_config_status_descriptors
;
484 u16 last_phy_event_list_descriptor_index
;
485 u16 max_number_of_stored_phy_event_list_descriptors
;
491 * struct smp_response_report_manufacturer_information - This structure depicts
492 * the SMP report manufacturer information for expander devices. It adheres
493 * to the SAS-2.1 specification.
495 * For specific information on each of these individual fields please reference
496 * the SAS specification Application layer section on SMP.
498 struct smp_response_report_manufacturer_information
{
499 u32 expander_change_count
:16; /* bytes 4-5 */
507 u8 product_revision_level
[4];
508 u8 component_vendor_id
[8];
510 u8 component_revision_level
;
512 u8 vendor_specific
[8];
517 * struct smp_response_report_phy_sata - This structure depicts the contents of
518 * the SAS SMP REPORT PHY SATA frame. For specific information on each of
519 * these individual fields please reference the SAS specification Link layer
520 * section on address frames.
524 struct smp_response_report_phy_sata
{
525 u32 ignored_byte_4_7
; /* bytes 4-7 */
527 u32 affiliations_valid
:1;
528 u32 affiliations_supported
:1;
529 u32 reserved_byte11
:6; /* byte 11 */
530 u32 ignored_byte10
:8; /* byte 10 */
531 u32 phy_identifier
:8; /* byte 9 */
532 u32 reserved_byte_8
:8; /* byte 8 */
535 u32 stp_sas_address
[2];
536 u8 device_to_host_fis
[20];
538 u32 affiliated_stp_initiator_sas_address
[2];
542 struct smp_response_vendor_specific
{
543 u8 response_bytes
[SMP_REQUEST_VENDOR_SPECIFIC_MAX_LENGTH
];
546 union smp_response_body
{
547 struct smp_response_report_general report_general
;
548 struct smp_response_report_manufacturer_information report_manufacturer_information
;
549 struct smp_response_report_phy_sata report_phy_sata
;
550 struct smp_response_vendor_specific vendor_specific_response
;
554 * struct smp_response - This structure simply unionizes the existing response
555 * structures into a common response type.
559 struct smp_response
{
560 struct smp_response_header header
;
562 union smp_response_body response
;
566 /* SMP Request Functions */
567 #define SMP_FUNCTION_REPORT_GENERAL 0x00
568 #define SMP_FUNCTION_REPORT_MANUFACTURER_INFORMATION 0x01
569 #define SMP_FUNCTION_DISCOVER 0x10
570 #define SMP_FUNCTION_REPORT_PHY_ERROR_LOG 0x11
571 #define SMP_FUNCTION_REPORT_PHY_SATA 0x12
572 #define SMP_FUNCTION_REPORT_ROUTE_INFORMATION 0X13
573 #define SMP_FUNCTION_CONFIGURE_ROUTE_INFORMATION 0X90
574 #define SMP_FUNCTION_PHY_CONTROL 0x91
575 #define SMP_FUNCTION_PHY_TEST 0x92
577 #define SMP_FRAME_TYPE_REQUEST 0x40
578 #define SMP_FRAME_TYPE_RESPONSE 0x41
580 #define PHY_OPERATION_NOP 0x00
581 #define PHY_OPERATION_LINK_RESET 0x01
582 #define PHY_OPERATION_HARD_RESET 0x02
583 #define PHY_OPERATION_DISABLE 0x03
584 #define PHY_OPERATION_CLEAR_ERROR_LOG 0x05
585 #define PHY_OPERATION_CLEAR_AFFILIATION 0x06
587 #define NPLR_PHY_ENABLED_UNK_LINK_RATE 0x00
588 #define NPLR_PHY_DISABLED 0x01
589 #define NPLR_PHY_ENABLED_SPD_NEG_FAILED 0x02
590 #define NPLR_PHY_ENABLED_SATA_HOLD 0x03
591 #define NPLR_PHY_ENABLED_1_5G 0x08
592 #define NPLR_PHY_ENABLED_3_0G 0x09
594 /* SMP Function Result values. */
595 #define SMP_RESULT_FUNCTION_ACCEPTED 0x00
596 #define SMP_RESULT_UNKNOWN_FUNCTION 0x01
597 #define SMP_RESULT_FUNCTION_FAILED 0x02
598 #define SMP_RESULT_INVALID_REQUEST_FRAME_LEN 0x03
599 #define SMP_RESULT_INAVALID_EXPANDER_CHANGE_COUNT 0x04
600 #define SMP_RESULT_BUSY 0x05
601 #define SMP_RESULT_INCOMPLETE_DESCRIPTOR_LIST 0x06
602 #define SMP_RESULT_PHY_DOES_NOT_EXIST 0x10
603 #define SMP_RESULT_INDEX_DOES_NOT_EXIST 0x11
604 #define SMP_RESULT_PHY_DOES_NOT_SUPPORT_SATA 0x12
605 #define SMP_RESULT_UNKNOWN_PHY_OPERATION 0x13
606 #define SMP_RESULT_UNKNOWN_PHY_TEST_FUNCTION 0x14
607 #define SMP_RESULT_PHY_TEST_IN_PROGRESS 0x15
608 #define SMP_RESULT_PHY_VACANT 0x16
610 /* Attached Device Types */
611 #define SMP_NO_DEVICE_ATTACHED 0
612 #define SMP_END_DEVICE_ONLY 1
613 #define SMP_EDGE_EXPANDER_DEVICE 2
614 #define SMP_FANOUT_EXPANDER_DEVICE 3
616 /* Expander phy routine attribute */
617 #define DIRECT_ROUTING_ATTRIBUTE 0
618 #define SUBTRACTIVE_ROUTING_ATTRIBUTE 1
619 #define TABLE_ROUTING_ATTRIBUTE 2
621 #endif /* _INTEL_SAS_H_ */