4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * CDDL HEADER START
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * The contents of this file are subject to the terms of the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Common Development and Distribution License (the "License").
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * You may not use this file except in compliance with the License.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * or http://www.opensolaris.org/os/licensing.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * See the License for the specific language governing permissions
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * and limitations under the License.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * When distributing Covered Code, include this CDDL HEADER in each
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * If applicable, add the following below this CDDL HEADER, with the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * fields enclosed by brackets "[]" replaced with your own identifying
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * information: Portions Copyright [yyyy] [name of copyright owner]
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * CDDL HEADER END
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Use is subject to license terms.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * SAS Common Structures and Definitions
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * sas2r14, simplified/reduced
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#ifndef _SAS_H
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define _SAS_H
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#ifdef __cplusplus
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhextern "C" {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#endif
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#include <sys/sysmacros.h>
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * SAS Address Frames
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Trailing 4 byte CRC not included.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD3(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh address_frame_type :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh device_type :3,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved0 :1);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD2(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reason :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved1 :4);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD5(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh restricted0 :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh smp_ini_port :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh stp_ini_port :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ssp_ini_port :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved2 :4);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD5(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh restricted1 :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh smp_tgt_port :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh stp_tgt_port :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ssp_tgt_port :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved3 :4);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t device_name[8];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t sas_address[8];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t phy_identifier;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD4(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh break_reply_capable :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh requested_inside_zpsds :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh inside_zpsds_persistent :1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved4 :5);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t reserved5[6];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} sas_identify_af_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD3(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh address_frame_type :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh protocol :3,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ini_port :1);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD2(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh connection_rate :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh features :4);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint16_t itag; /* initiator connection tag */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t sas_dst[8]; /* destination sas address */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t sas_src[8]; /* source sas address */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t src_zone_group; /* source zone group */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t path_block_count; /* pathway blocked count */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint16_t arb_wait_time; /* arbitration wait time */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t compat[4]; /* 'more' compatible features */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} sas_open_af_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_AF_IDENTIFY 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_AF_OPEN 1
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_IF_DTYPE_ENDPOINT 1
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_IF_DTYPE_EDGE 2
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_IF_DTYPE_FANOUT 3 /* obsolete */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_OF_PROTO_SMP 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_OF_PROTO_SSP 1
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_OF_PROTO_STP 2
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_SSP_SUPPORT 0x8
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_STP_SUPPORT 0x4
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_SMP_SUPPORT 0x2
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CONNRATE_1_5_GBPS 0x8
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CONNRATE_3_0_GBPS 0x9
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CONNRATE_6_0_GBPS 0xA
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_SATA_SUPPORT 0x1
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_ATTACHED_NAME_OFFSET 52 /* SAS-2 only */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * SSP Definitions
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t lun[8];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t reserved0;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD3(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh task_attribute :2,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh command_priority :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh enable_first_burst :1);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t reserved1;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD2(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved2 :2,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh addi_cdb_len :6);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t cdb[16];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh /* additional cdb bytes go here, followed by 4 byte CRC */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} sas_ssp_cmd_iu_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CMD_TASK_ATTR_SIMPLE 0x00
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CMD_TASK_ATTR_HEAD 0x01
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CMD_TASK_ATTR_ORDERED 0x02
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CMD_TASK_ATTR_ACA 0x04
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t reserved0[8];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint16_t status_qualifier;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh DECL_BITFIELD2(
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh datapres :2,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved1 :6);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t status;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t reserved2[4];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t sense_data_length;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t response_data_length;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t rspd[];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh /* response data followed by sense data goes here */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} sas_ssp_rsp_iu_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/* length of bytes up to response data */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_HDR_SIZE 24
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_DATAPRES_NO_DATA 0x00
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_DATAPRES_RESPONSE_DATA 0x01
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_DATAPRES_SENSE_DATA 0x02
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * When the RSP IU is type RESPONSE_DATA,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * the first 4 bytes of response data should
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * be a Big Endian representation of one of
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * these codes.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_TMF_COMPLETE 0x00
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_INVALID_FRAME 0x02
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_TMF_NOT_SUPPORTED 0x04
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_TMF_FAILED 0x05
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_TMF_SUCCEEDED 0x08
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_TMF_INCORRECT_LUN 0x09
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_RSP_OVERLAPPED_OIPTTA 0x0A
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Task Management Functions- should be in a SAM definition file
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_ABORT_TASK 0x01
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_ABORT_TASK_SET 0x02
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CLEAR_TASK_SET 0x04
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_LOGICAL_UNIT_RESET 0x08
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_I_T_NEXUS_RESET 0x10
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_CLEAR_ACA 0x40
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_QUERY_TASK 0x80
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_QUERY_TASK_SET 0x81
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_QUERY_UNIT_ATTENTION 0x82
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * PHY size changed from SAS1.1 to SAS2.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_PHYNUM_MAX 127
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_PHYNUM_MASK 0x7f
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS2_PHYNUM_MAX 254
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS2_PHYNUM_MASK 0xff
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Maximum SMP payload size, including CRC
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_SMP_MAX_PAYLOAD 1032
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#ifdef __cplusplus
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh}
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#endif
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#endif /* _SAS_H */