sys/dev/isci/scil/sci_controller.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_CONTROLLER_H_
  55 #define _SCI_CONTROLLER_H_
  56
  57 /**
  58  * @file
  59  *
  60  * @brief This file contains all of the interface methods that can be called
  61  *        by an SCI user on all SCI controller objects.
  62  */
  63
  64 #ifdef __cplusplus
  65 extern "C" {
  66 #endif // __cplusplus
  67
  68 #include <dev/isci/scil/sci_types.h>
  69
  70
  71 #define SCI_CONTROLLER_INVALID_IO_TAG 0xFFFF
  72
  73 typedef enum _SCI_CONTROLLER_ERROR {
  74     SCI_CONTROLLER_FATAL_ERROR = 1,
  75     SCI_CONTROLLER_REMOTE_DEVICE_ERROR,
  76     SCI_CONTROLLER_FATAL_MEMORY_ERROR
  77 } SCI_CONTROLLER_ERROR;
  78
  79 /**
  80  * @brief This method simply returns a handle for the memory descriptor
  81  *        list associated with the supplied controller.  The descriptor list
  82  *        provides DMA safe/capable memory requirements for this controller.
  83  *
  84  * @warning The user must adhere to the alignment requirements specified in
  85  *          memory descriptor.  In situations where the operating environment
  86  *          does not offer memory allocation utilities supporting alignment,
  87  *          then it is the responsibility of the user to manually align the
  88  *          memory buffer for SCI.  Thus, the user may have to allocate a
  89  *          larger buffer to meet the alignment.  Additionally, the user will
  90  *          need to remember the actual memory allocation addresses in order
  91  *          to ensure the memory can be properly freed when necessary to do
  92  *          so.
  93  *
  94  * @pre This method will return a valid handle, but the MDL may not be
  95  *      accurate until after the user has invoked the associated
  96  *      sci_controller_initialize() routine.
  97  *
  98  * @param[in]  controller This parameter specifies the controller for which
  99  *             to retrieve the DMA safe memory descriptor list.
 100  *
 101  * @return A pointer to a physical memory descriptor array.
 102  */
 103 SCI_MEMORY_DESCRIPTOR_LIST_HANDLE_T
 104 sci_controller_get_memory_descriptor_list_handle(
 105    SCI_CONTROLLER_HANDLE_T  controller
 106 );
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif // __cplusplus
 111
 112 #endif // _SCI_CONTROLLER_H_
 113