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 decorator.  The decorator adds additional
63  *        functionality that may be used by SCI users to help
64  *        offload MDE processing.
65  */
66 
67 #include <dev/isci/scil/sci_memory_descriptor_list_decorator.h>
68 
69 U32 sci_mdl_decorator_get_memory_size(
70    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
71    U32                                 attributes
72 )
73 {
74    U32                                size = 0;
75    SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde;
76 
77    sci_mdl_first_entry(mdl);
78    mde = sci_mdl_get_current_entry(mdl);
79    while (mde != NULL)
80    {
81       if (  (mde->constant_memory_attributes == attributes)
82          || (attributes == 0) )
83          size += (mde->constant_memory_size + mde->constant_memory_alignment);
84 
85       sci_mdl_next_entry(mdl);
86       mde = sci_mdl_get_current_entry(mdl);
87    }
88 
89    return size;
90 }
91 
92 // ---------------------------------------------------------------------------
93 
94 void sci_mdl_decorator_assign_memory(
95    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
96    U32                                 attributes,
97    POINTER_UINT                        virtual_address,
98    SCI_PHYSICAL_ADDRESS                sci_physical_address
99 )
100 {
101    SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde;
102    U64  physical_address;
103 
104    physical_address
105       =   ((U64) sci_cb_physical_address_lower(sci_physical_address))
106         | (((U64) sci_cb_physical_address_upper(sci_physical_address)) << 32);
107 
108    sci_mdl_first_entry(mdl);
109    mde = sci_mdl_get_current_entry(mdl);
110    while (mde != NULL)
111    {
112       // As long as the memory attribute for this MDE is equivalent to
113       // those supplied by the caller, then fill out the appropriate
114       // MDE fields.
115       if (  (mde->constant_memory_attributes == attributes)
116          || (attributes == 0) )
117       {
118          // Ensure the virtual address alignment rules are met.
119          if ((virtual_address % mde->constant_memory_alignment) != 0)
120          {
121             virtual_address
122                += (mde->constant_memory_alignment -
123                    (virtual_address % mde->constant_memory_alignment));
124          }
125 
126          // Ensure the physical address alignment rules are met.
127          if ((physical_address % mde->constant_memory_alignment) != 0)
128          {
129             physical_address
130                += (mde->constant_memory_alignment -
131                    (physical_address % mde->constant_memory_alignment));
132          }
133 
134          // Update the MDE with properly aligned address values.
135          mde->virtual_address  = (void *)virtual_address;
136          sci_cb_make_physical_address(
137             mde->physical_address,
138             (U32) (physical_address >> 32),
139             (U32) (physical_address & 0xFFFFFFFF)
140          );
141 
142          virtual_address  += mde->constant_memory_size;
143          physical_address += mde->constant_memory_size;
144       }
145 
146       // Move on to the next MDE
147       sci_mdl_next_entry(mdl);
148       mde = sci_mdl_get_current_entry (mdl);
149    }
150 }
151 
152