sys/dev/isci/scil/sci_memory_descriptor_list_decorator.h

   1 /*-
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  41  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  42  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  43  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  44  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  46  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  48  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  49  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  50  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  51  *
  52  * $FreeBSD$
  53  */
  54 #ifndef _SCI_MEMORY_DESCRIPTOR_LIST_DECORATOR_H_
  55 #define _SCI_MEMORY_DESCRIPTOR_LIST_DECORATOR_H_
  56
  57 /**
  58  * @file
  59  *
  60  * @brief This file contains methods utilized to provide additional
  61  *        functionality above normal MDL processing.
  62  */
  63
  64 #ifdef __cplusplus
  65 extern "C" {
  66 #endif // __cplusplus
  67
  68 #include <dev/isci/scil/sci_memory_descriptor_list.h>
  69
  70 /**
  71  * @brief This method will determine the amount of memory needed for
  72  *        memory descriptors with exact matching memory attributes.
  73  *        If the supplied attributes value is 0, then all MDEs are
  74  *        included in the calculation.
  75  *
  76  * @param[in] mdl This parameter specifies the MDL to search through
  77  *            for MDEs with matching memory attributes.
  78  * @param[in] attributes This parameter specifies the attributes to
  79  *            match.  If this parameter is set to 0, then each MDE
  80  *            is included in the calculation.
  81  *
  82  * @return This method returns the number of bytes, including offsets
  83  *         to achieve proper alignment, for memory descriptors that
  84  *         exactly match the supplied memory attributes.
  85  */
  86 U32 sci_mdl_decorator_get_memory_size(
  87    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
  88    U32                                 attributes
  89 );
  90
  91 /**
  92  * @brief This method will assign the supplied memory address values
  93  *        to all of the MDEs in the memory descriptor list with
  94  *        exact matching attributes as those supplied by parameter.
  95  *        If the supplied attributes value is 0, then all MDEs will
  96  *        have their values assigned.
  97  *
  98  * @warning It is suggested the user invoke the
  99  *          sci_mdl_decorator_get_memory_size() method prior to invoking
 100  *          this method.  This ensures that the user supplies pointers
 101  *          that refer to memory locations with sufficient space.
 102  *
 103  * @param[in,out] mdl This parameter specifies the MDL to iterate through
 104  *                for MDEs with matching memory attributes.
 105  * @param[in]     attributes This parameter specifies the attributes to
 106  *                match.  If this parameter is set to 0, then each
 107  *                memory descriptor will be filled out.
 108  * @param[in]     virtual_address This parameter specifies the starting
 109  *                virtual address to be used when filling out the MDE
 110  *                virtual address field.
 111  * @param[in]     sci_physical_address This parameter specifies the starting
 112  *                physical address to be used when filling out the MDE
 113  *                physical address field.
 114  *
 115  * @return none
 116  */
 117 void sci_mdl_decorator_assign_memory(
 118    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
 119    U32                                 attributes,
 120    POINTER_UINT                        virtual_address,
 121    SCI_PHYSICAL_ADDRESS                sci_physical_address
 122 );
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif // __cplusplus
 127
 128 #endif // _SCI_MEMORY_DESCRIPTOR_LIST_DECORATOR_H_
 129