1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*-
* 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 _SCI_BASE_MEMORY_DESCRIPTOR_LIST_H_
#define _SCI_BASE_MEMORY_DESCRIPTOR_LIST_H_
/**
* @file
*
* @brief This file contains the protected interface structures, constants
* and interface methods for the SCI_BASE_MEMORY_DESCRIPTOR_LIST
* object.
*/
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
#include <dev/isci/scil/sci_types.h>
#include <dev/isci/scil/sci_memory_descriptor_list.h>
/**
* @struct SCI_BASE_MEMORY_DESCRIPTOR_LIST
*
* @brief This structure contains all of the fields necessary to implement
* a simple stack for managing the list of available controller indices.
*/
typedef struct SCI_BASE_MEMORY_DESCRIPTOR_LIST
{
/**
* This field indicates the length of the memory descriptor entry array.
*/
U32 length;
/**
* This field is utilized to provide iterator pattern functionality.
* It indicates the index of the next memory descriptor in the iteration.
*/
U32 next_index;
/**
* This field will point to the list of memory descriptors.
*/
SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde_array;
/**
* This field simply allows a user to chain memory descriptor lists
* together if desired. This field will be initialized to
* SCI_INVALID_HANDLE.
*/
SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T next_mdl;
} SCI_BASE_MEMORY_DESCRIPTOR_LIST_T;
/**
* @brief This method is invoked to construct an memory descriptor list.
* It initializes the fields of the MDL.
*
* @param[in] mdl This parameter specifies the memory descriptor list
* to be constructed.
* @param[in] mde_array This parameter specifies the array of memory
* descriptor entries to be managed by this list.
* @param[in] mde_array_length This parameter specifies the size of the
* array of entries.
* @param[in] next_mdl This parameter specifies a subsequent MDL object
* to be managed by this MDL object.
*
* @return none.
*/
void sci_base_mdl_construct(
SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * mdl,
SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde_array,
U32 mde_array_length,
SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T next_mdl
);
/**
* This macro constructs an memory descriptor entry with the given
* alignment and size
*/
#define sci_base_mde_construct(mde, alignment, size, attributes) \
{ \
(mde)->constant_memory_alignment = (alignment); \
(mde)->constant_memory_size = (size); \
(mde)->constant_memory_attributes = (attributes); \
}
/**
* @brief This method validates that the memory descriptor is correctly
* filled out by the SCI User
*
* @param[in] mde This parameter is the mde entry to validate
* @param[in] alignment This parameter specifies the expected alignment of
* the memory for the mde.
* @param[in] size This parameter specifies the memory size expected for
* the mde its value should not have been changed by the SCI
* User.
* @param[in] attributes This parameter specifies the attributes for the
* memory descriptor provided.
*
* @return BOOL This method returns an indication as to whether the
* supplied MDE is valid or not.
* @retval TRUE The MDE is valid.
* @retval FALSE The MDE is not valid.
*/
BOOL sci_base_mde_is_valid(
SCI_PHYSICAL_MEMORY_DESCRIPTOR_T *mde,
U32 alignment,
U32 size,
U16 attributes
);
#ifdef __cplusplus
}
#endif // __cplusplus
#endif // _SCI_BASE_MEMORY_DESCRIPTOR_LIST_H_
|
