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_MEMORY_DESCRIPTOR_LIST_H_ 55230557Sjimharris#define _SCI_MEMORY_DESCRIPTOR_LIST_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the basic data types utilized by an 61230557Sjimharris * SCI user or implementor. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/sci_types.h> 69230557Sjimharris 70230557Sjimharris/** 71230557Sjimharris * @name SCI_MDE_ATTRIBUTES 72230557Sjimharris * 73230557Sjimharris * These constants depict memory attributes for the Memory 74230557Sjimharris * Descriptor Entries (MDEs) contained in the MDL. 75230557Sjimharris */ 76230557Sjimharris/*@{*/ 77230557Sjimharris#define SCI_MDE_ATTRIBUTE_CACHEABLE 0x0001 78230557Sjimharris#define SCI_MDE_ATTRIBUTE_PHYSICALLY_CONTIGUOUS 0x0002 79230557Sjimharris/*@}*/ 80230557Sjimharris 81230557Sjimharris/** 82230557Sjimharris * @struct SCI_PHYSICAL_MEMORY_DESCRIPTOR 83230557Sjimharris * @brief This structure defines a description of a memory location for 84230557Sjimharris * the SCI implementation. 85230557Sjimharris */ 86230557Sjimharristypedef struct SCI_PHYSICAL_MEMORY_DESCRIPTOR 87230557Sjimharris{ 88230557Sjimharris /** 89230557Sjimharris * This field contains the virtual address associated with this descriptor 90230557Sjimharris * element. This field shall be zero when the descriptor is retrieved from 91230557Sjimharris * the SCI implementation. The user shall set this field prior 92230557Sjimharris * sci_controller_start() 93230557Sjimharris */ 94230557Sjimharris void * virtual_address; 95230557Sjimharris 96230557Sjimharris /** 97230557Sjimharris * This field contains the physical address associated with this desciptor 98230557Sjimharris * element. This field shall be zero when the descriptor is retrieved from 99230557Sjimharris * the SCI implementation. The user shall set this field prior 100230557Sjimharris * sci_controller_start() 101230557Sjimharris */ 102230557Sjimharris SCI_PHYSICAL_ADDRESS physical_address; 103230557Sjimharris 104230557Sjimharris /** 105230557Sjimharris * This field contains the size requirement for this memory descriptor. 106230557Sjimharris * A value of zero for this field indicates the end of the descriptor 107230557Sjimharris * list. The value should be treated as read only for an SCI user. 108230557Sjimharris */ 109230557Sjimharris U32 constant_memory_size; 110230557Sjimharris 111230557Sjimharris /** 112230557Sjimharris * This field contains the alignment requirement for this memory 113230557Sjimharris * descriptor. A value of zero for this field indicates the end of the 114230557Sjimharris * descriptor list. All other values indicate the number of bytes to 115230557Sjimharris * achieve the necessary alignment. The value should be treated as 116230557Sjimharris * read only for an SCI user. 117230557Sjimharris */ 118230557Sjimharris U32 constant_memory_alignment; 119230557Sjimharris 120230557Sjimharris /** 121230557Sjimharris * This field contains an indication regarding the desired memory 122230557Sjimharris * attributes for this memory descriptor entry. 123230557Sjimharris * Notes: 124230557Sjimharris * - If the cacheable attribute is set, the user can allocate 125230557Sjimharris * memory that is backed by cache for better performance. It 126230557Sjimharris * is not required that the memory be backed by cache. 127230557Sjimharris * - If the physically contiguous attribute is set, then the 128230557Sjimharris * entire memory must be physically contiguous across all 129230557Sjimharris * page boundaries. 130230557Sjimharris */ 131230557Sjimharris U16 constant_memory_attributes; 132230557Sjimharris 133230557Sjimharris} SCI_PHYSICAL_MEMORY_DESCRIPTOR_T; 134230557Sjimharris 135230557Sjimharris/** 136230557Sjimharris * @brief This method simply rewinds the MDL iterator back to the first memory 137230557Sjimharris * descriptor entry in the list. 138230557Sjimharris * 139230557Sjimharris * @param[in] mdl This parameter specifies the memory descriptor list that 140230557Sjimharris * is to be rewound. 141230557Sjimharris * 142230557Sjimharris * @return none 143230557Sjimharris */ 144230557Sjimharrisvoid sci_mdl_first_entry( 145230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 146230557Sjimharris); 147230557Sjimharris 148230557Sjimharris/** 149230557Sjimharris * @brief This method simply updates the "current" pointer to the next 150230557Sjimharris * sequential memory descriptor. 151230557Sjimharris * 152230557Sjimharris * @param[in] mdl This parameter specifies the memory descriptor list for 153230557Sjimharris * which to return the next memory descriptor entry in the list. 154230557Sjimharris * 155230557Sjimharris * @return none. 156230557Sjimharris */ 157230557Sjimharrisvoid sci_mdl_next_entry( 158230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 159230557Sjimharris); 160230557Sjimharris 161230557Sjimharris/** 162230557Sjimharris * @brief This method simply returns the current memory descriptor entry. 163230557Sjimharris * 164230557Sjimharris * @param[in] mdl This parameter specifies the memory descriptor list for 165230557Sjimharris * which to return the current memory descriptor entry. 166230557Sjimharris * 167230557Sjimharris * @return This method returns a pointer to the current physical memory 168230557Sjimharris * descriptor in the MDL. 169230557Sjimharris * @retval NULL This value is returned if there are no descriptors in the 170230557Sjimharris * list. 171230557Sjimharris */ 172230557SjimharrisSCI_PHYSICAL_MEMORY_DESCRIPTOR_T * sci_mdl_get_current_entry( 173230557Sjimharris SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 174230557Sjimharris); 175230557Sjimharris 176230557Sjimharris#ifdef __cplusplus 177230557Sjimharris} 178230557Sjimharris#endif // __cplusplus 179230557Sjimharris 180230557Sjimharris#endif // _SCI_MEMORY_DESCRIPTOR_LIST_H_ 181230557Sjimharris 182