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 * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCI_BASE_MEMORY_DESCRIPTOR_LIST_H_ 55230557Sjimharris#define _SCI_BASE_MEMORY_DESCRIPTOR_LIST_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains the protected interface structures, constants 61230557Sjimharris * and interface methods for the SCI_BASE_MEMORY_DESCRIPTOR_LIST 62230557Sjimharris * object. 63230557Sjimharris */ 64230557Sjimharris 65230557Sjimharris#ifdef __cplusplus 66230557Sjimharrisextern "C" { 67230557Sjimharris#endif // __cplusplus 68230557Sjimharris 69230557Sjimharris#include <dev/isci/scil/sci_types.h> 70230557Sjimharris#include <dev/isci/scil/sci_memory_descriptor_list.h> 71230557Sjimharris 72230557Sjimharris 73230557Sjimharris/** 74230557Sjimharris * @struct SCI_BASE_MEMORY_DESCRIPTOR_LIST 75230557Sjimharris * 76230557Sjimharris * @brief This structure contains all of the fields necessary to implement 77230557Sjimharris * a simple stack for managing the list of available controller indices. 78230557Sjimharris */ 79230557Sjimharristypedef struct SCI_BASE_MEMORY_DESCRIPTOR_LIST 80230557Sjimharris{ 81230557Sjimharris /** 82230557Sjimharris * This field indicates the length of the memory descriptor entry array. 83230557Sjimharris */ 84230557Sjimharris U32 length; 85230557Sjimharris 86230557Sjimharris /** 87230557Sjimharris * This field is utilized to provide iterator pattern functionality. 88230557Sjimharris * It indicates the index of the next memory descriptor in the iteration. 89230557Sjimharris */ 90230557Sjimharris U32 next_index; 91230557Sjimharris 92230557Sjimharris /** 93230557Sjimharris * This field will point to the list of memory descriptors. 94230557Sjimharris */ 95230557Sjimharris SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde_array; 96230557Sjimharris 97230557Sjimharris /** 98230557Sjimharris * This field simply allows a user to chain memory descriptor lists 99230557Sjimharris * together if desired. This field will be initialized to 100230557Sjimharris * SCI_INVALID_HANDLE. 101230557Sjimharris */ 102230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T next_mdl; 103230557Sjimharris 104230557Sjimharris} SCI_BASE_MEMORY_DESCRIPTOR_LIST_T; 105230557Sjimharris 106230557Sjimharris/** 107230557Sjimharris * @brief This method is invoked to construct an memory descriptor list. 108230557Sjimharris * It initializes the fields of the MDL. 109230557Sjimharris * 110230557Sjimharris * @param[in] mdl This parameter specifies the memory descriptor list 111230557Sjimharris * to be constructed. 112230557Sjimharris * @param[in] mde_array This parameter specifies the array of memory 113230557Sjimharris * descriptor entries to be managed by this list. 114230557Sjimharris * @param[in] mde_array_length This parameter specifies the size of the 115230557Sjimharris * array of entries. 116230557Sjimharris * @param[in] next_mdl This parameter specifies a subsequent MDL object 117230557Sjimharris * to be managed by this MDL object. 118230557Sjimharris * 119230557Sjimharris * @return none. 120230557Sjimharris */ 121230557Sjimharrisvoid sci_base_mdl_construct( 122230557Sjimharris SCI_BASE_MEMORY_DESCRIPTOR_LIST_T * mdl, 123230557Sjimharris SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde_array, 124230557Sjimharris U32 mde_array_length, 125230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T next_mdl 126230557Sjimharris); 127230557Sjimharris 128230557Sjimharris/** 129230557Sjimharris * This macro constructs an memory descriptor entry with the given 130230557Sjimharris * alignment and size 131230557Sjimharris */ 132230557Sjimharris#define sci_base_mde_construct(mde, alignment, size, attributes) \ 133230557Sjimharris{ \ 134230557Sjimharris (mde)->constant_memory_alignment = (alignment); \ 135230557Sjimharris (mde)->constant_memory_size = (size); \ 136230557Sjimharris (mde)->constant_memory_attributes = (attributes); \ 137230557Sjimharris} 138230557Sjimharris 139230557Sjimharris/** 140230557Sjimharris * @brief This method validates that the memory descriptor is correctly 141230557Sjimharris * filled out by the SCI User 142230557Sjimharris * 143230557Sjimharris * @param[in] mde This parameter is the mde entry to validate 144230557Sjimharris * @param[in] alignment This parameter specifies the expected alignment of 145230557Sjimharris * the memory for the mde. 146230557Sjimharris * @param[in] size This parameter specifies the memory size expected for 147230557Sjimharris * the mde its value should not have been changed by the SCI 148230557Sjimharris * User. 149230557Sjimharris * @param[in] attributes This parameter specifies the attributes for the 150230557Sjimharris * memory descriptor provided. 151230557Sjimharris * 152230557Sjimharris * @return BOOL This method returns an indication as to whether the 153230557Sjimharris * supplied MDE is valid or not. 154230557Sjimharris * @retval TRUE The MDE is valid. 155230557Sjimharris * @retval FALSE The MDE is not valid. 156230557Sjimharris */ 157230557SjimharrisBOOL sci_base_mde_is_valid( 158230557Sjimharris SCI_PHYSICAL_MEMORY_DESCRIPTOR_T *mde, 159230557Sjimharris U32 alignment, 160230557Sjimharris U32 size, 161230557Sjimharris U16 attributes 162230557Sjimharris); 163230557Sjimharris 164230557Sjimharris#ifdef __cplusplus 165230557Sjimharris} 166230557Sjimharris#endif // __cplusplus 167230557Sjimharris 168230557Sjimharris#endif // _SCI_BASE_MEMORY_DESCRIPTOR_LIST_H_ 169