1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris */ 52230557Sjimharris 53230557Sjimharris#include <sys/cdefs.h> 54230557Sjimharris__FBSDID("$FreeBSD$"); 55230557Sjimharris 56230557Sjimharris/** 57230557Sjimharris * @file 58230557Sjimharris * 59230557Sjimharris * @brief This file contains the base implementation for the memory 60230557Sjimharris * descriptor list. This is currently comprised of MDL iterator 61230557Sjimharris * methods. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#include <dev/isci/scil/sci_base_memory_descriptor_list.h> 65230557Sjimharris 66230557Sjimharris//****************************************************************************** 67230557Sjimharris//* P U B L I C M E T H O D S 68230557Sjimharris//****************************************************************************** 69230557Sjimharris 70230557Sjimharrisvoid sci_mdl_first_entry( 71230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 72230557Sjimharris) 73230557Sjimharris{ 74230557Sjimharris SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * base_mdl = (SCI_BASE_MEMORY_DESCRIPTOR_LIST_T*) mdl; 75230557Sjimharris 76230557Sjimharris base_mdl->next_index = 0; 77230557Sjimharris 78230557Sjimharris // If this MDL is managing another MDL, then recursively rewind that MDL 79230557Sjimharris // object as well. 80230557Sjimharris if (base_mdl->next_mdl != SCI_INVALID_HANDLE) 81230557Sjimharris sci_mdl_first_entry(base_mdl->next_mdl); 82230557Sjimharris} 83230557Sjimharris 84230557Sjimharris// --------------------------------------------------------------------------- 85230557Sjimharris 86230557Sjimharrisvoid sci_mdl_next_entry( 87230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 88230557Sjimharris) 89230557Sjimharris{ 90230557Sjimharris SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * base_mdl = (SCI_BASE_MEMORY_DESCRIPTOR_LIST_T*) mdl; 91230557Sjimharris 92230557Sjimharris // If there is at least one more entry left in the array, then change 93230557Sjimharris // the next pointer to it. 94230557Sjimharris if (base_mdl->next_index < base_mdl->length) 95230557Sjimharris base_mdl->next_index++; 96230557Sjimharris else if (base_mdl->next_index == base_mdl->length) 97230557Sjimharris { 98230557Sjimharris // This MDL has exhausted it's set of entries. If this MDL is managing 99230557Sjimharris // another MDL, then start iterating through that MDL. 100230557Sjimharris if (base_mdl->next_mdl != SCI_INVALID_HANDLE) 101230557Sjimharris sci_mdl_next_entry(base_mdl->next_mdl); 102230557Sjimharris } 103230557Sjimharris} 104230557Sjimharris 105230557Sjimharris// --------------------------------------------------------------------------- 106230557Sjimharris 107230557SjimharrisSCI_PHYSICAL_MEMORY_DESCRIPTOR_T * sci_mdl_get_current_entry( 108230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 109230557Sjimharris) 110230557Sjimharris{ 111230557Sjimharris SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * base_mdl = (SCI_BASE_MEMORY_DESCRIPTOR_LIST_T*) mdl; 112230557Sjimharris 113230557Sjimharris if (base_mdl->next_index < base_mdl->length) 114230557Sjimharris return & base_mdl->mde_array[base_mdl->next_index]; 115230557Sjimharris else if (base_mdl->next_index == base_mdl->length) 116230557Sjimharris { 117230557Sjimharris // This MDL has exhausted it's set of entries. If this MDL is managing 118230557Sjimharris // another MDL, then return it's current entry. 119230557Sjimharris if (base_mdl->next_mdl != SCI_INVALID_HANDLE) 120230557Sjimharris return sci_mdl_get_current_entry(base_mdl->next_mdl); 121230557Sjimharris } 122230557Sjimharris 123230557Sjimharris return NULL; 124230557Sjimharris} 125230557Sjimharris 126230557Sjimharris//****************************************************************************** 127230557Sjimharris//* P R O T E C T E D M E T H O D S 128230557Sjimharris//****************************************************************************** 129230557Sjimharris 130230557Sjimharrisvoid sci_base_mdl_construct( 131230557Sjimharris SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * mdl, 132230557Sjimharris SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde_array, 133230557Sjimharris U32 mde_array_length, 134230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T next_mdl 135230557Sjimharris) 136230557Sjimharris{ 137230557Sjimharris mdl->length = mde_array_length; 138230557Sjimharris mdl->mde_array = mde_array; 139230557Sjimharris mdl->next_index = 0; 140230557Sjimharris mdl->next_mdl = next_mdl; 141230557Sjimharris} 142230557Sjimharris 143230557Sjimharris// --------------------------------------------------------------------------- 144230557Sjimharris 145230557SjimharrisBOOL sci_base_mde_is_valid( 146230557Sjimharris SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde, 147230557Sjimharris U32 alignment, 148230557Sjimharris U32 size, 149230557Sjimharris U16 attributes 150230557Sjimharris) 151230557Sjimharris{ 152230557Sjimharris // Only need the lower 32 bits to ensure alignment is met. 153230557Sjimharris U32 physical_address = sci_cb_physical_address_lower(mde->physical_address); 154230557Sjimharris 155230557Sjimharris if ( 156230557Sjimharris ((physical_address & (alignment - 1)) != 0) 157230557Sjimharris || (mde->constant_memory_alignment != alignment) 158230557Sjimharris || (mde->constant_memory_size != size) 159230557Sjimharris || (mde->virtual_address == NULL) 160230557Sjimharris || (mde->constant_memory_attributes != attributes) 161230557Sjimharris ) 162230557Sjimharris { 163230557Sjimharris return FALSE; 164230557Sjimharris } 165230557Sjimharris 166230557Sjimharris return TRUE; 167230557Sjimharris} 168230557Sjimharris 169