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 * $FreeBSD$ 55 */ 56 #ifndef _SCI_MEMORY_DESCRIPTOR_LIST_H_ 57 #define _SCI_MEMORY_DESCRIPTOR_LIST_H_ 58 59 /** 60 * @file 61 * 62 * @brief This file contains all of the basic data types utilized by an 63 * SCI user or implementor. 64 */ 65 66 #ifdef __cplusplus 67 extern "C" { 68 #endif // __cplusplus 69 70 #include <dev/isci/scil/sci_types.h> 71 72 /** 73 * @name SCI_MDE_ATTRIBUTES 74 * 75 * These constants depict memory attributes for the Memory 76 * Descriptor Entries (MDEs) contained in the MDL. 77 */ 78 /*@{*/ 79 #define SCI_MDE_ATTRIBUTE_CACHEABLE 0x0001 80 #define SCI_MDE_ATTRIBUTE_PHYSICALLY_CONTIGUOUS 0x0002 81 /*@}*/ 82 83 /** 84 * @struct SCI_PHYSICAL_MEMORY_DESCRIPTOR 85 * @brief This structure defines a description of a memory location for 86 * the SCI implementation. 87 */ 88 typedef struct SCI_PHYSICAL_MEMORY_DESCRIPTOR 89 { 90 /** 91 * This field contains the virtual address associated with this descriptor 92 * element. This field shall be zero when the descriptor is retrieved from 93 * the SCI implementation. The user shall set this field prior 94 * sci_controller_start() 95 */ 96 void * virtual_address; 97 98 /** 99 * This field contains the physical address associated with this descriptor 100 * element. This field shall be zero when the descriptor is retrieved from 101 * the SCI implementation. The user shall set this field prior 102 * sci_controller_start() 103 */ 104 SCI_PHYSICAL_ADDRESS physical_address; 105 106 /** 107 * This field contains the size requirement for this memory descriptor. 108 * A value of zero for this field indicates the end of the descriptor 109 * list. The value should be treated as read only for an SCI user. 110 */ 111 U32 constant_memory_size; 112 113 /** 114 * This field contains the alignment requirement for this memory 115 * descriptor. A value of zero for this field indicates the end of the 116 * descriptor list. All other values indicate the number of bytes to 117 * achieve the necessary alignment. The value should be treated as 118 * read only for an SCI user. 119 */ 120 U32 constant_memory_alignment; 121 122 /** 123 * This field contains an indication regarding the desired memory 124 * attributes for this memory descriptor entry. 125 * Notes: 126 * - If the cacheable attribute is set, the user can allocate 127 * memory that is backed by cache for better performance. It 128 * is not required that the memory be backed by cache. 129 * - If the physically contiguous attribute is set, then the 130 * entire memory must be physically contiguous across all 131 * page boundaries. 132 */ 133 U16 constant_memory_attributes; 134 135 } SCI_PHYSICAL_MEMORY_DESCRIPTOR_T; 136 137 /** 138 * @brief This method simply rewinds the MDL iterator back to the first memory 139 * descriptor entry in the list. 140 * 141 * @param[in] mdl This parameter specifies the memory descriptor list that 142 * is to be rewound. 143 * 144 * @return none 145 */ 146 void sci_mdl_first_entry( 147 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 148 ); 149 150 /** 151 * @brief This method simply updates the "current" pointer to the next 152 * sequential memory descriptor. 153 * 154 * @param[in] mdl This parameter specifies the memory descriptor list for 155 * which to return the next memory descriptor entry in the list. 156 * 157 * @return none. 158 */ 159 void sci_mdl_next_entry( 160 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 161 ); 162 163 /** 164 * @brief This method simply returns the current memory descriptor entry. 165 * 166 * @param[in] mdl This parameter specifies the memory descriptor list for 167 * which to return the current memory descriptor entry. 168 * 169 * @return This method returns a pointer to the current physical memory 170 * descriptor in the MDL. 171 * @retval NULL This value is returned if there are no descriptors in the 172 * list. 173 */ 174 SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * sci_mdl_get_current_entry( 175 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl 176 ); 177 178 #ifdef __cplusplus 179 } 180 #endif // __cplusplus 181 182 #endif // _SCI_MEMORY_DESCRIPTOR_LIST_H_ 183 184