1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 4 * This file is provided under a dual BSD/GPLv2 license. When using or 5 * redistributing this file, you may do so under either license. 6 * 7 * GPL LICENSE SUMMARY 8 * 9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23 * The full GNU General Public License is included in this distribution 24 * in the file called LICENSE.GPL. 25 * 26 * BSD LICENSE 27 * 28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 35 * * Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * * Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in 39 * the documentation and/or other materials provided with the 40 * distribution. 41 * 42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53 */ 54 #ifndef _SCIC_SDS_REMOTE_NODE_TABLE_H_ 55 #define _SCIC_SDS_REMOTE_NODE_TABLE_H_ 56 57 /** 58 * @file 59 * 60 * @brief This file contains the structures, constants and prototypes used for 61 * the remote node table. 62 */ 63 64 #ifdef __cplusplus 65 extern "C" { 66 #endif // __cplusplus 67 68 #include <dev/isci/scil/sci_types.h> 69 #include <dev/isci/scil/sci_controller_constants.h> 70 71 /** 72 * Remote node sets are sets of remote node index in the remtoe node table 73 * The SCU hardware requires that STP remote node entries take three 74 * consecutive remote node index so the table is arranged in sets of three. 75 * The bits are used as 0111 0111 to make a byte and the bits define the set 76 * of three remote nodes to use as a sequence. 77 */ 78 #define SCIC_SDS_REMOTE_NODE_SETS_PER_BYTE 2 79 80 /** 81 * Since the remote node table is organized as DWORDS take the remote node 82 * sets in bytes and represent them in DWORDs. The lowest ordered bits are the 83 * ones used in case full DWORD is not being used. 84 * 85 * i.e. 0000 0000 0000 0000 0111 0111 0111 0111 // if only a single WORD is in 86 * use in the DWORD. 87 */ 88 #define SCIC_SDS_REMOTE_NODE_SETS_PER_DWORD \ 89 (sizeof(U32) * SCIC_SDS_REMOTE_NODE_SETS_PER_BYTE) 90 /** 91 * This is a count of the numeber of remote nodes that can be represented in 92 * a byte 93 */ 94 #define SCIC_SDS_REMOTE_NODES_PER_BYTE \ 95 (SCU_STP_REMOTE_NODE_COUNT * SCIC_SDS_REMOTE_NODE_SETS_PER_BYTE) 96 97 /** 98 * This is a count of the number of remote nodes that can be represented in a 99 * DWROD 100 */ 101 #define SCIC_SDS_REMOTE_NODES_PER_DWORD \ 102 (sizeof(U32) * SCIC_SDS_REMOTE_NODES_PER_BYTE) 103 104 /** 105 * This is the number of bits in a remote node group 106 */ 107 #define SCIC_SDS_REMOTE_NODES_BITS_PER_GROUP 4 108 109 #define SCIC_SDS_REMOTE_NODE_TABLE_INVALID_INDEX (0xFFFFFFFF) 110 #define SCIC_SDS_REMOTE_NODE_TABLE_FULL_SLOT_VALUE (0x07) 111 #define SCIC_SDS_REMOTE_NODE_TABLE_EMPTY_SLOT_VALUE (0x00) 112 113 /** 114 * Expander attached sata remote node count 115 */ 116 #define SCU_STP_REMOTE_NODE_COUNT 3 117 118 /** 119 * Expander or direct attached ssp remote node count 120 */ 121 #define SCU_SSP_REMOTE_NODE_COUNT 1 122 123 /** 124 * Direct attached STP remote node count 125 */ 126 #define SCU_SATA_REMOTE_NODE_COUNT 1 127 128 /** 129 * @struct SCIC_REMOTE_NODE_TABLE 130 */ 131 typedef struct SCIC_REMOTE_NODE_TABLE 132 { 133 /** 134 * This field contains the array size in dwords 135 */ 136 U16 available_nodes_array_size; 137 138 /** 139 * This field contains the array size of the 140 */ 141 U16 group_array_size; 142 143 /** 144 * This field is the array of available remote node entries in bits. 145 * Because of the way STP remote node data is allocated on the SCU hardware 146 * the remote nodes must occupy three consecutive remote node context 147 * entries. For ease of allocation and de-allocation we have broken the 148 * sets of three into a single nibble. When the STP RNi is allocated all 149 * of the bits in the nibble are cleared. This math results in a table size 150 * of MAX_REMOTE_NODES / CONSECUTIVE RNi ENTRIES for STP / 2 entries per byte. 151 */ 152 U32 available_remote_nodes[ 153 (SCI_MAX_REMOTE_DEVICES / SCIC_SDS_REMOTE_NODES_PER_DWORD) 154 + ((SCI_MAX_REMOTE_DEVICES % SCIC_SDS_REMOTE_NODES_PER_DWORD) != 0)]; 155 156 /** 157 * This field is the nibble selector for the above table. There are three 158 * possible selectors each for fast lookup when trying to find one, two or 159 * three remote node entries. 160 */ 161 U32 remote_node_groups[ 162 SCU_STP_REMOTE_NODE_COUNT][ 163 (SCI_MAX_REMOTE_DEVICES / (32 * SCU_STP_REMOTE_NODE_COUNT)) 164 + ((SCI_MAX_REMOTE_DEVICES % (32 * SCU_STP_REMOTE_NODE_COUNT)) != 0)]; 165 166 } SCIC_REMOTE_NODE_TABLE_T; 167 168 // --------------------------------------------------------------------------- 169 170 void scic_sds_remote_node_table_initialize( 171 SCIC_REMOTE_NODE_TABLE_T * remote_node_table, 172 U32 remote_node_entries 173 ); 174 175 U16 scic_sds_remote_node_table_allocate_remote_node( 176 SCIC_REMOTE_NODE_TABLE_T * remote_node_table, 177 U32 remote_node_count 178 ); 179 180 void scic_sds_remote_node_table_release_remote_node_index( 181 SCIC_REMOTE_NODE_TABLE_T * remote_node_table, 182 U32 remote_node_count, 183 U16 remote_node_index 184 ); 185 186 #ifdef __cplusplus 187 } 188 #endif // __cplusplus 189 190 #endif // _SCIC_SDS_REMOTE_NODE_TABLE_H_ 191