1537078d8f
Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts.
245 lines
7.1 KiB
C
245 lines
7.1 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
|
|
*
|
|
* This file is provided under a dual BSD/GPLv2 license. When using or
|
|
* redistributing this file, you may do so under either license.
|
|
*
|
|
* GPL LICENSE SUMMARY
|
|
*
|
|
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of version 2 of the GNU General Public License as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
|
|
* The full GNU General Public License is included in this distribution
|
|
* in the file called LICENSE.GPL.
|
|
*
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
#ifndef __SCU_REMOTE_NODE_CONTEXT_HEADER__
|
|
#define __SCU_REMOTE_NODE_CONTEXT_HEADER__
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* @brief This file contains the structures and constatns used by the SCU
|
|
* hardware to describe a remote node context.
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif // __cplusplus
|
|
|
|
#include <dev/isci/scil/sci_types.h>
|
|
|
|
/**
|
|
* @struct SSP_REMOTE_NODE_CONTEXT
|
|
*
|
|
* @brief This structure contains the SCU hardware definition for an SSP
|
|
* remote node.
|
|
*/
|
|
typedef struct SSP_REMOTE_NODE_CONTEXT
|
|
{
|
|
// WORD 0
|
|
|
|
/**
|
|
* This field is the remote node index assigned for this remote node. All
|
|
* remote nodes must have a unique remote node index. The value of the remote
|
|
* node index can not exceed the maximum number of remote nodes reported in
|
|
* the SCU device context capacity register.
|
|
*/
|
|
U32 remote_node_index :12;
|
|
U32 reserved0_1 : 4;
|
|
|
|
/**
|
|
* This field tells the SCU hardware how many simultaneous connections that
|
|
* this remote node will support.
|
|
*/
|
|
U32 remote_node_port_width : 4;
|
|
|
|
/**
|
|
* This field tells the SCU hardware which logical port to associate with this
|
|
* remote node.
|
|
*/
|
|
U32 logical_port_index : 3;
|
|
U32 reserved0_2 : 5;
|
|
|
|
/**
|
|
* This field will enable the I_T nexus loss timer for this remote node.
|
|
*/
|
|
U32 nexus_loss_timer_enable : 1;
|
|
|
|
/**
|
|
* This field is the for driver debug only and is not used.
|
|
*/
|
|
U32 check_bit : 1;
|
|
|
|
/**
|
|
* This field must be set to TRUE when the hardware DMAs the remote node
|
|
* context to the hardware SRAM. When the remote node is being invalidated
|
|
* this field must be set to FALSE.
|
|
*/
|
|
U32 is_valid : 1;
|
|
|
|
/**
|
|
* This field must be set to TRUE.
|
|
*/
|
|
U32 is_remote_node_context : 1;
|
|
|
|
// WORD 1 - 2
|
|
|
|
/**
|
|
* This is the low word of the remote device SAS Address
|
|
*/
|
|
U32 remote_sas_address_lo;
|
|
|
|
/**
|
|
* This field is the high word of the remote device SAS Address
|
|
*/
|
|
U32 remote_sas_address_hi;
|
|
|
|
// WORD 3
|
|
/**
|
|
* This field reprensets the function number assigned to this remote device.
|
|
* This value must match the virtual function number that is being used to
|
|
* communicate to the device.
|
|
*/
|
|
U32 function_number : 8;
|
|
U32 reserved3_1 : 8;
|
|
|
|
/**
|
|
* This field provides the driver a way to cheat on the arbitration wait time
|
|
* for this remote node.
|
|
*/
|
|
U32 arbitration_wait_time :16;
|
|
|
|
// WORD 4
|
|
/**
|
|
* This field tells the SCU hardware how long this device may occupy the
|
|
* connection before it must be closed.
|
|
*/
|
|
U32 connection_occupancy_timeout :16;
|
|
|
|
/**
|
|
* This field tells the SCU hardware how long to maintain a connection when
|
|
* there are no frames being transmitted on the link.
|
|
*/
|
|
U32 connection_inactivity_timeout :16;
|
|
|
|
// WORD 5
|
|
/**
|
|
* This field allows the driver to cheat on the arbitration wait time for this
|
|
* remote node.
|
|
*/
|
|
U32 initial_arbitration_wait_time :16;
|
|
|
|
/**
|
|
* This field is tells the hardware what to program for the connection rate in
|
|
* the open address frame. See the SAS spec for valid values.
|
|
*/
|
|
U32 oaf_connection_rate : 4;
|
|
|
|
/**
|
|
* This field tells the SCU hardware what to program for the features in the
|
|
* open address frame. See the SAS spec for valid values.
|
|
*/
|
|
U32 oaf_features : 4;
|
|
|
|
/**
|
|
* This field tells the SCU hardware what to use for the source zone group in
|
|
* the open address frame. See the SAS spec for more details on zoning.
|
|
*/
|
|
U32 oaf_source_zone_group : 8;
|
|
|
|
// WORD 6
|
|
/**
|
|
* This field tells the SCU hardware what to use as the more capibilities in
|
|
* the open address frame. See the SAS Spec for details.
|
|
*/
|
|
U32 oaf_more_compatibility_features;
|
|
|
|
// WORD 7
|
|
U32 reserved7;
|
|
|
|
} SSP_REMOTE_NODE_CONTEXT_T;
|
|
|
|
/**
|
|
* @struct STP_REMOTE_NODE_CONTEXT
|
|
*
|
|
* @brief This structure contains the SCU hardware definition for a STP remote
|
|
* node.
|
|
*
|
|
* @todo STP Targets are not yet supported so this definition is a placeholder
|
|
* until we do support them.
|
|
*/
|
|
typedef struct STP_REMOTE_NODE_CONTEXT
|
|
{
|
|
/**
|
|
* Placeholder data for the STP remote node.
|
|
*/
|
|
U32 data[8];
|
|
|
|
} STP_REMOTE_NODE_CONTEXT_T;
|
|
|
|
/**
|
|
* @union SCU_REMOTE_NODE_CONTEXT
|
|
*
|
|
* @brief This union combines the SAS and SATA remote node definitions.
|
|
*/
|
|
typedef union SCU_REMOTE_NODE_CONTEXT
|
|
{
|
|
/**
|
|
* SSP Remote Node
|
|
*/
|
|
SSP_REMOTE_NODE_CONTEXT_T ssp;
|
|
|
|
/**
|
|
* STP Remote Node
|
|
*/
|
|
STP_REMOTE_NODE_CONTEXT_T stp;
|
|
|
|
} SCU_REMOTE_NODE_CONTEXT_T;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif // __cplusplus
|
|
|
|
#endif // __SCU_REMOTE_NODE_CONTEXT_HEADER__
|