2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
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
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.
56 #ifndef _SCI_MEMORY_DESCRIPTOR_LIST_DECORATOR_H_
57 #define _SCI_MEMORY_DESCRIPTOR_LIST_DECORATOR_H_
62 * @brief This file contains methods utilized to provide additional
63 * functionality above normal MDL processing.
70 #include <dev/isci/scil/sci_memory_descriptor_list.h>
73 * @brief This method will determine the amount of memory needed for
74 * memory descriptors with exact matching memory attributes.
75 * If the supplied attributes value is 0, then all MDEs are
76 * included in the calculation.
78 * @param[in] mdl This parameter specifies the MDL to search through
79 * for MDEs with matching memory attributes.
80 * @param[in] attributes This parameter specifies the attributes to
81 * match. If this parameter is set to 0, then each MDE
82 * is included in the calculation.
84 * @return This method returns the number of bytes, including offsets
85 * to achieve proper alignment, for memory descriptors that
86 * exactly match the supplied memory attributes.
88 U32 sci_mdl_decorator_get_memory_size(
89 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
94 * @brief This method will assign the supplied memory address values
95 * to all of the MDEs in the memory descriptor list with
96 * exact matching attributes as those supplied by parameter.
97 * If the supplied attributes value is 0, then all MDEs will
98 * have their values assigned.
100 * @warning It is suggested the user invoke the
101 * sci_mdl_decorator_get_memory_size() method prior to invoking
102 * this method. This ensures that the user supplies pointers
103 * that refer to memory locations with sufficient space.
105 * @param[in,out] mdl This parameter specifies the MDL to iterate through
106 * for MDEs with matching memory attributes.
107 * @param[in] attributes This parameter specifies the attributes to
108 * match. If this parameter is set to 0, then each
109 * memory descriptor will be filled out.
110 * @param[in] virtual_address This parameter specifies the starting
111 * virtual address to be used when filling out the MDE
112 * virtual address field.
113 * @param[in] sci_physical_address This parameter specifies the starting
114 * physical address to be used when filling out the MDE
115 * physical address field.
119 void sci_mdl_decorator_assign_memory(
120 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
122 POINTER_UINT virtual_address,
123 SCI_PHYSICAL_ADDRESS sci_physical_address
128 #endif // __cplusplus
130 #endif // _SCI_MEMORY_DESCRIPTOR_LIST_DECORATOR_H_