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