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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
39 * * Neither the name of Intel Corporation nor the names of its
40 * contributors may be used to endorse or promote products derived
41 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56 #ifndef _SCI_CONTROLLER_H_
57 #define _SCI_CONTROLLER_H_
60 * This file contains all of the interface methods that can be called by an SCI
61 * user on all SCI controller objects.
67 #include "sci_types.h"
69 struct sci_base_memory_descriptor_list;
70 struct scic_sds_controller;
72 #define SCI_CONTROLLER_INVALID_IO_TAG 0xFFFF
75 * sci_controller_get_memory_descriptor_list_handle() - This method simply
76 * returns a handle for the memory descriptor list associated with the
77 * supplied controller. The descriptor list provides DMA safe/capable
78 * memory requirements for this controller.
79 * @controller: This parameter specifies the controller for which to retrieve
80 * the DMA safe memory descriptor list.
82 * The user must adhere to the alignment requirements specified in memory
83 * descriptor. In situations where the operating environment does not offer
84 * memory allocation utilities supporting alignment, then it is the
85 * responsibility of the user to manually align the memory buffer for SCI.
86 * Thus, the user may have to allocate a larger buffer to meet the alignment.
87 * Additionally, the user will need to remember the actual memory allocation
88 * addresses in order to ensure the memory can be properly freed when necessary
89 * to do so. This method will return a valid handle, but the MDL may not be
90 * accurate until after the user has invoked the associated
91 * sci_controller_initialize() routine. A pointer to a physical memory
94 struct sci_base_memory_descriptor_list *
95 sci_controller_get_memory_descriptor_list_handle(
96 struct scic_sds_controller *controller);
99 #endif /* _SCI_CONTROLLER_H_ */