sys/dev/isci/scil/sci_base_memory_descriptor_list_decorator.c

   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
  53 #include <sys/cdefs.h>
  54 __FBSDID("$FreeBSD$");
  55
  56 /**
  57  * @file
  58  *
  59  * @brief This file contains the base implementation for the memory
  60  *        descriptor list decorator.  The decorator adds additional
  61  *        functionality that may be used by SCI users to help
  62  *        offload MDE processing.
  63  */
  64
  65 #include <dev/isci/scil/sci_memory_descriptor_list_decorator.h>
  66
  67 U32 sci_mdl_decorator_get_memory_size(
  68    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
  69    U32                                 attributes
  70 )
  71 {
  72    U32                                size = 0;
  73    SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde;
  74
  75    sci_mdl_first_entry(mdl);
  76    mde = sci_mdl_get_current_entry(mdl);
  77    while (mde != NULL)
  78    {
  79       if (  (mde->constant_memory_attributes == attributes)
  80          || (attributes == 0) )
  81          size += (mde->constant_memory_size + mde->constant_memory_alignment);
  82
  83       sci_mdl_next_entry(mdl);
  84       mde = sci_mdl_get_current_entry(mdl);
  85    }
  86
  87    return size;
  88 }
  89
  90 // ---------------------------------------------------------------------------
  91
  92 void sci_mdl_decorator_assign_memory(
  93    SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T mdl,
  94    U32                                 attributes,
  95    POINTER_UINT                        virtual_address,
  96    SCI_PHYSICAL_ADDRESS                sci_physical_address
  97 )
  98 {
  99    SCI_PHYSICAL_MEMORY_DESCRIPTOR_T * mde;
 100    U64  physical_address;
 101
 102    physical_address
 103       =   ((U64) sci_cb_physical_address_lower(sci_physical_address))
 104         | (((U64) sci_cb_physical_address_upper(sci_physical_address)) << 32);
 105
 106    sci_mdl_first_entry(mdl);
 107    mde = sci_mdl_get_current_entry(mdl);
 108    while (mde != NULL)
 109    {
 110       // As long as the memory attribute for this MDE is equivalent to
 111       // those supplied by the caller, then fill out the appropriate
 112       // MDE fields.
 113       if (  (mde->constant_memory_attributes == attributes)
 114          || (attributes == 0) )
 115       {
 116          // Ensure the virtual address alignment rules are met.
 117          if ((virtual_address % mde->constant_memory_alignment) != 0)
 118          {
 119             virtual_address
 120                += (mde->constant_memory_alignment -
 121                    (virtual_address % mde->constant_memory_alignment));
 122          }
 123
 124          // Ensure the physical address alignment rules are met.
 125          if ((physical_address % mde->constant_memory_alignment) != 0)
 126          {
 127             physical_address
 128                += (mde->constant_memory_alignment -
 129                    (physical_address % mde->constant_memory_alignment));
 130          }
 131
 132          // Update the MDE with properly aligned address values.
 133          mde->virtual_address  = (void *)virtual_address;
 134          sci_cb_make_physical_address(
 135             mde->physical_address,
 136             (U32) (physical_address >> 32),
 137             (U32) (physical_address & 0xFFFFFFFF)
 138          );
 139
 140          virtual_address  += mde->constant_memory_size;
 141          physical_address += mde->constant_memory_size;
 142       }
 143
 144       // Move on to the next MDE
 145       sci_mdl_next_entry(mdl);
 146       mde = sci_mdl_get_current_entry (mdl);
 147    }
 148 }
 149