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
55#include <sys/cdefs.h>
56__FBSDID("$FreeBSD$");
57
58/**
59 * @file
60 *
61 * @brief This file contains the base implementation for the memory
62 *        descriptor list.  This is currently comprised of MDL iterator
63 *        methods.
64 */
65
66#include <dev/isci/scil/sci_base_memory_descriptor_list.h>
67
68//******************************************************************************
69//* P U B L I C   M E T H O D S
70//******************************************************************************
71
72void sci_mdl_first_entry(
73   SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl
74)
75{
76   SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * base_mdl = (SCI_BASE_MEMORY_DESCRIPTOR_LIST_T*) mdl;
77
78   base_mdl->next_index = 0;
79
80   // If this MDL is managing another MDL, then recursively rewind that MDL
81   // object as well.
82   if (base_mdl->next_mdl != SCI_INVALID_HANDLE)
83      sci_mdl_first_entry(base_mdl->next_mdl);
84}
85
86// ---------------------------------------------------------------------------
87
88void sci_mdl_next_entry(
89   SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl
90)
91{
92   SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * base_mdl = (SCI_BASE_MEMORY_DESCRIPTOR_LIST_T*) mdl;
93
94   // If there is at least one more entry left in the array, then change
95   // the next pointer to it.
96   if (base_mdl->next_index < base_mdl->length)
97      base_mdl->next_index++;
98   else if (base_mdl->next_index == base_mdl->length)
99   {
100      // This MDL has exhausted it's set of entries.  If this MDL is managing
101      // another MDL, then start iterating through that MDL.
102      if (base_mdl->next_mdl != SCI_INVALID_HANDLE)
103         sci_mdl_next_entry(base_mdl->next_mdl);
104   }
105}
106
107// ---------------------------------------------------------------------------
108
109SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * sci_mdl_get_current_entry(
110   SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl
111)
112{
113   SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * base_mdl = (SCI_BASE_MEMORY_DESCRIPTOR_LIST_T*) mdl;
114
115   if (base_mdl->next_index < base_mdl->length)
116      return & base_mdl->mde_array[base_mdl->next_index];
117   else if (base_mdl->next_index == base_mdl->length)
118   {
119      // This MDL has exhausted it's set of entries.  If this MDL is managing
120      // another MDL, then return it's current entry.
121      if (base_mdl->next_mdl != SCI_INVALID_HANDLE)
122         return sci_mdl_get_current_entry(base_mdl->next_mdl);
123   }
124
125   return NULL;
126}
127
128//******************************************************************************
129//* P R O T E C T E D   M E T H O D S
130//******************************************************************************
131
132void sci_base_mdl_construct(
133   SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * mdl,
134   SCI_PHYSICAL_MEMORY_DESCRIPTOR_T  * mde_array,
135   U32                                 mde_array_length,
136   SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T next_mdl
137)
138{
139   mdl->length     = mde_array_length;
140   mdl->mde_array  = mde_array;
141   mdl->next_index = 0;
142   mdl->next_mdl   = next_mdl;
143}
144
145// ---------------------------------------------------------------------------
146
147BOOL sci_base_mde_is_valid(
148   SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde,
149   U32                                alignment,
150   U32                                size,
151   U16                                attributes
152)
153{
154   // Only need the lower 32 bits to ensure alignment is met.
155   U32 physical_address = sci_cb_physical_address_lower(mde->physical_address);
156
157   if (
158         ((physical_address & (alignment - 1)) != 0)
159      || (mde->constant_memory_alignment != alignment)
160      || (mde->constant_memory_size != size)
161      || (mde->virtual_address == NULL)
162      || (mde->constant_memory_attributes != attributes)
163      )
164   {
165      return FALSE;
166   }
167
168   return TRUE;
169}
170
171