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
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 #ifndef _SCIC_SDS_REMOTE_NODE_TABLE_H_
55 #define _SCIC_SDS_REMOTE_NODE_TABLE_H_
60 * @brief This file contains the structures, constants and prototypes used for
61 * the remote node table.
68 #include <dev/isci/scil/sci_types.h>
69 #include <dev/isci/scil/sci_controller_constants.h>
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.
78 #define SCIC_SDS_REMOTE_NODE_SETS_PER_BYTE 2
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.
85 * i.e. 0000 0000 0000 0000 0111 0111 0111 0111 // if only a single WORD is in
88 #define SCIC_SDS_REMOTE_NODE_SETS_PER_DWORD \
89 (sizeof(U32) * SCIC_SDS_REMOTE_NODE_SETS_PER_BYTE)
91 * This is a count of the numeber of remote nodes that can be represented in
94 #define SCIC_SDS_REMOTE_NODES_PER_BYTE \
95 (SCU_STP_REMOTE_NODE_COUNT * SCIC_SDS_REMOTE_NODE_SETS_PER_BYTE)
98 * This is a count of the number of remote nodes that can be represented in a
101 #define SCIC_SDS_REMOTE_NODES_PER_DWORD \
102 (sizeof(U32) * SCIC_SDS_REMOTE_NODES_PER_BYTE)
105 * This is the number of bits in a remote node group
107 #define SCIC_SDS_REMOTE_NODES_BITS_PER_GROUP 4
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)
114 * Expander attached sata remote node count
116 #define SCU_STP_REMOTE_NODE_COUNT 3
119 * Expander or direct attached ssp remote node count
121 #define SCU_SSP_REMOTE_NODE_COUNT 1
124 * Direct attached STP remote node count
126 #define SCU_SATA_REMOTE_NODE_COUNT 1
129 * @struct SCIC_REMOTE_NODE_TABLE
131 typedef struct SCIC_REMOTE_NODE_TABLE
134 * This field contains the array size in dwords
136 U16 available_nodes_array_size;
139 * This field contains the array size of the
141 U16 group_array_size;
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.
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)];
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.
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)];
166 } SCIC_REMOTE_NODE_TABLE_T;
168 // ---------------------------------------------------------------------------
170 void scic_sds_remote_node_table_initialize(
171 SCIC_REMOTE_NODE_TABLE_T * remote_node_table,
172 U32 remote_node_entries
175 U16 scic_sds_remote_node_table_allocate_remote_node(
176 SCIC_REMOTE_NODE_TABLE_T * remote_node_table,
177 U32 remote_node_count
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
188 #endif // __cplusplus
190 #endif // _SCIC_SDS_REMOTE_NODE_TABLE_H_