/* SPDX-License-Identifier: GPL-2.0-only */ /* * Aic94xx SAS/SATA driver SAS definitions and hardware interface header file. * * Copyright (C) 2005 Adaptec, Inc. All rights reserved. * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
*/
#ifndef _AIC94XX_SAS_H_ #define _AIC94XX_SAS_H_
#include <scsi/libsas.h>
/* ---------- DDBs ---------- */ /* DDBs are device descriptor blocks which describe a device in the * domain that this sequencer can maintain low-level connections for * us. They are be 64 bytes.
*/ #define ASD_MAX_DDBS 128
struct asd_ddb_ssp_smp_target_port {
u8 conn_type; /* byte 0 */ #define DDB_TP_CONN_TYPE 0x81 /* Initiator port and addr frame type 0x01 */
/* This struct asd_ddb_init_port, describes the device descriptor block * of an initiator port (when the sequencer is operating in target mode). * Bytes [0,11] and [20,27] are from the OPEN address frame. * The sequencer allocates an initiator port DDB entry.
*/ struct asd_ddb_init_port {
u8 conn_type; /* byte 0 */
u8 conn_rate;
__be16 init_conn_tag; /* BE */
u8 dest_sas_addr[8];
__le16 send_queue_head; /* LE, byte 12 */
u8 sq_suspended;
u8 ddb_type; /* DDB_TYPE_INITIATOR */
__le16 _r_a;
__be16 awt_def; /* BE */
u8 compat_features;
u8 pathway_blocked_count;
__be16 arb_wait_time; /* BE */
__be32 more_compat_features; /* BE */
u8 conn_mask;
u8 flags; /* == 5 */
u16 _r_b;
__le16 exec_queue_tail; /* execution queue tail */
__le16 send_queue_tail;
__le16 sister_ddb;
__le16 init_resp_timeout; /* initiator response timeout */
__le32 _r_c;
__le16 active_tasks; /* active task count */
__le16 init_list; /* initiator list link pointer */
__le32 _r_d;
u8 max_conn_to[3]; /* from Conn-Disc mode page, in us, LE */
u8 itnl_reason; /* I_T nexus loss reason */
__le16 bus_inact_to; /* from Conn-Disc mode page, in 100 us, LE */
__le16 itnl_to; /* from the Protocol Specific Port Ctrl MP */
__le32 itnl_timestamp;
} __attribute__ ((packed));
/* This struct asd_ddb_sata_tag, describes a look-up table to be used * by the sequencers. SATA II, IDENTIFY DEVICE data, word 76, bit 8: * NCQ support. This table is used by the sequencers to find the * corresponding SCB, given a SATA II tag value.
*/ struct asd_ddb_sata_tag {
__le16 scb_pointer[32];
} __attribute__ ((packed));
/* This struct asd_ddb_sata_pm_table, describes a port number to * connection handle look-up table. SATA targets attached to a port * multiplier require a 4-bit port number value. There is one DDB * entry of this type for each SATA port multiplier (sister DDB). * Given a SATA PM port number, this table gives us the SATA PM Port * DDB of the SATA port multiplier port (i.e. the SATA target * discovered on the port).
*/ struct asd_ddb_sata_pm_table {
__le16 ddb_pointer[16];
__le16 _r_a[16];
} __attribute__ ((packed));
/* This struct asd_ddb_sata_pm_port, describes the SATA port multiplier * port format DDB.
*/ struct asd_ddb_sata_pm_port {
u8 _r_a[15];
u8 ddb_type;
u8 _r_b[13];
u8 pm_port_flags; #define PM_PORT_MASK 0xF0 #define PM_PORT_SET 0x02
u8 _r_c[6];
__le16 sister_ddb;
__le16 ata_cmd_scbptr;
__le32 sata_tag_alloc_mask;
__le16 active_task_count;
__le16 parent_ddb;
__le32 sata_sactive;
u8 num_sata_tags;
u8 sata_status;
u8 sata_ending_status;
u8 _r_d[9];
} __attribute__ ((packed));
/* This struct asd_ddb_seq_shared, describes a DDB shared by the * central and link sequencers. port_map_by_links is indexed phy * number [0,7]; each byte is a bit mask of all the phys that are in * the same port as the indexed phy.
*/ struct asd_ddb_seq_shared {
__le16 q_free_ddb_head;
__le16 q_free_ddb_tail;
__le16 q_free_ddb_cnt;
__le16 q_used_ddb_head;
__le16 q_used_ddb_tail;
__le16 shared_mem_lock;
__le16 smp_conn_tag;
__le16 est_nexus_buf_cnt;
__le16 est_nexus_buf_thresh;
u32 _r_a;
u8 settable_max_contexts;
u8 _r_b[23];
u8 conn_not_active;
u8 phy_is_up;
u8 _r_c[8];
u8 port_map_by_links[8];
} __attribute__ ((packed));
/* ---------- SG Element ---------- */
/* This struct sg_el, describes the hardware scatter gather buffer * element. All entries are little endian. In an SCB, there are 2 of * this, plus one more, called a link element of this indicating a * sublist if needed. * * A link element has only the bus address set and the flags (DS) bit * valid. The bus address points to the start of the sublist. * * If a sublist is needed, then that sublist should also include the 2 * sg_el embedded in the SCB, in which case next_sg_offset is 32, * since sizeof(sg_el) = 16; EOS should be 1 and EOL 0 in this case.
*/ struct sg_el {
__le64 bus_addr;
__le32 size;
__le16 _r;
u8 next_sg_offs;
u8 flags; #define ASD_SG_EL_DS_MASK 0x30 #define ASD_SG_EL_DS_OCM 0x10 #define ASD_SG_EL_DS_HM 0x00 #define ASD_SG_EL_LIST_MASK 0xC0 #define ASD_SG_EL_LIST_EOL 0x40 #define ASD_SG_EL_LIST_EOS 0x80
} __attribute__ ((packed));
/* ---------- SCBs ---------- */
/* An SCB (sequencer control block) is comprised of a common header * and a task part, for a total of 128 bytes. All fields are in LE * order, unless otherwise noted.
*/
/* This is both ssp_task and long_ssp_task
*/ struct initiate_ssp_task {
u8 proto_conn_rate; /* proto:6,4, conn_rate:3,0 */
__le32 total_xfer_len; struct ssp_frame_hdr ssp_frame; struct ssp_command_iu ssp_cmd;
__le16 sister_scb; /* 0xFFFF */
__le16 conn_handle; /* index to DDB for the intended target */
u8 data_dir; /* :1,0 */ #define DATA_DIR_NONE 0x00 #define DATA_DIR_IN 0x01 #define DATA_DIR_OUT 0x02 #define DATA_DIR_BYRECIPIENT 0x03
u8 _r_a;
u8 retry_count;
u8 _r_b[5]; struct sg_el sg_element[3]; /* 2 real and 1 link */
} __attribute__ ((packed));
/* This defines both ata_task and atapi_task. * ata: C bit of FIS should be 1, * atapi: C bit of FIS should be 1, and command register should be 0xA0, * to indicate a packet command.
*/ struct initiate_ata_task {
u8 proto_conn_rate;
__le32 total_xfer_len; struct host_to_dev_fis fis;
__le32 data_offs;
u8 atapi_packet[16];
u8 _r_a[12];
__le16 sister_scb;
__le16 conn_handle;
u8 ata_flags; /* CSMI:6,6, DTM:4,4, QT:3,3, data dir:1,0 */ #define CSMI_TASK 0x40 #define DATA_XFER_MODE_DMA 0x10 #define ATA_Q_TYPE_MASK 0x08 #define ATA_Q_TYPE_UNTAGGED 0x00 #define ATA_Q_TYPE_NCQ 0x08
/* This describes both SSP Target Get Data and SSP Target Get Data And * Send Good Response SCBs. Used when the sequencer is operating in * target mode...
*/ struct ssp_targ_get_data {
u8 proto_conn_rate;
__le32 total_xfer_len; struct ssp_frame_hdr ssp_frame; struct xfer_rdy_iu xfer_rdy;
u8 lun[LUN_SIZE];
__le64 _r_a;
__le16 sister_scb;
__le16 conn_handle;
u8 data_dir; /* 01b */
u8 _r_b;
u8 retry_count;
u8 _r_c[5]; struct sg_el sg_element[3];
} __attribute__ ((packed));
/* ---------- Done List ---------- */ /* The done list entry opcode field is defined below. * The mnemonic encoding and meaning is as follows: * TC - Task Complete, status was received and acknowledged * TF - Task Failed, indicates an error prior to receiving acknowledgment * for the command: * - no conn, * - NACK or R_ERR received in response to this command, * - credit blocked or not available, or in the case of SMP request, * - no SMP response was received. * In these four cases it is known that the target didn't receive the * command. * TI - Task Interrupted, error after the command was acknowledged. It is * known that the command was received by the target. * TU - Task Unacked, command was transmitted but neither ACK (R_OK) nor NAK * (R_ERR) was received due to loss of signal, broken connection, loss of * dword sync or other reason. The application client should send the * appropriate task query. * TA - Task Aborted, see TF. * _RESP - The completion includes an empty buffer containing status. * TO - Timeout.
*/ #define TC_NO_ERROR 0x00 #define TC_UNDERRUN 0x01 #define TC_OVERRUN 0x02 #define TF_OPEN_TO 0x03 #define TF_OPEN_REJECT 0x04 #define TI_BREAK 0x05 #define TI_PROTO_ERR 0x06 #define TC_SSP_RESP 0x07 #define TI_PHY_DOWN 0x08 #define TF_PHY_DOWN 0x09 #define TC_LINK_ADM_RESP 0x0a #define TC_CSMI 0x0b #define TC_ATA_RESP 0x0c #define TU_PHY_DOWN 0x0d #define TU_BREAK 0x0e #define TI_SATA_TO 0x0f #define TI_NAK 0x10 #define TC_CONTROL_PHY 0x11 #define TF_BREAK 0x12 #define TC_RESUME 0x13 #define TI_ACK_NAK_TO 0x14 #define TF_SMPRSP_TO 0x15 #define TF_SMP_XMIT_RCV_ERR 0x16 #define TC_PARTIAL_SG_LIST 0x17 #define TU_ACK_NAK_TO 0x18 #define TU_SATA_TO 0x19 #define TF_NAK_RECV 0x1a #define TA_I_T_NEXUS_LOSS 0x1b #define TC_ATA_R_ERR_RECV 0x1c #define TF_TMF_NO_CTX 0x1d #define TA_ON_REQ 0x1e #define TF_TMF_NO_TAG 0x1f #define TF_TMF_TAG_FREE 0x20 #define TF_TMF_TASK_DONE 0x21 #define TF_TMF_NO_CONN_HANDLE 0x22 #define TC_TASK_CLEARED 0x23 #define TI_SYNCS_RECV 0x24 #define TU_SYNCS_RECV 0x25 #define TF_IRTT_TO 0x26 #define TF_NO_SMP_CONN 0x27 #define TF_IU_SHORT 0x28 #define TF_DATA_OFFS_ERR 0x29 #define TF_INV_CONN_HANDLE 0x2a #define TF_REQUESTED_N_PENDING 0x2b
/* 0xc1 - 0xc7: empty buffer received, 0xd1 - 0xd7: establish nexus empty buffer received
*/ /* This is the ESCB mask */ #define ESCB_RECVD 0xC0
/* This struct done_list_struct defines the done list entry. * All fields are LE.
*/ struct done_list_struct {
__le16 index; /* aka transaction context */
u8 opcode;
u8 status_block[4];
u8 toggle; /* bit 0 */ #define DL_TOGGLE_MASK 0x01
} __attribute__ ((packed));
/* Define this to 0 if you do not want NOTIFY (ENABLE SPINIP) sent. * Default: 0x10 (it's a mask)
*/ #define ASD_NOTIFY_ENABLE_SPINUP 0x10
/* If enabled, set this to the interval between transmission * of NOTIFY (ENABLE SPINUP). In units of 200 us.
*/ #define ASD_NOTIFY_TIMEOUT 2500
/* Initial delay after OOB, before we transmit NOTIFY (ENABLE SPINUP). * If 0, transmit immediately. In milliseconds.
*/ #define ASD_NOTIFY_DOWN_COUNT 0
/* How long to wait before shutting down an STP connection, unless * an STP target sent frame(s). 50 usec. * IGNORED by the sequencer (i.e. value 0 always).
*/ #define ASD_STP_SHUTDOWN_TIMEOUT 0x0
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.