1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 4 * This file is provided under a dual BSD/GPLv2 license. When using or 5 * redistributing this file, you may do so under either license. 6 * 7 * GPL LICENSE SUMMARY 8 * 9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23 * The full GNU General Public License is included in this distribution 24 * in the file called LICENSE.GPL. 25 * 26 * BSD LICENSE 27 * 28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 35 * * Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * * Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in 39 * the documentation and/or other materials provided with the 40 * distribution. 41 * 42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53 * 54 * $FreeBSD$ 55 */ 56 /** 57 * @file 58 * 59 * @brief This file contains the interface to the iterator class. 60 * Methods Provided: 61 * - sci_iterator_get_object_size() 62 * - sci_iterator_get_current() 63 * - sci_iterator_first() 64 * - sci_iterator_next() 65 */ 66 67 #ifndef _SCI_ITERATOR_H_ 68 #define _SCI_ITERATOR_H_ 69 70 #ifdef __cplusplus 71 extern "C" { 72 #endif // __cplusplus 73 74 #if !defined(DISABLE_SCI_ITERATORS) 75 76 //****************************************************************************** 77 //* 78 //* I N C L U D E S 79 //* 80 //****************************************************************************** 81 82 #include <dev/isci/scil/sci_types.h> 83 84 //****************************************************************************** 85 //* 86 //* C O N S T A N T S 87 //* 88 //****************************************************************************** 89 90 //****************************************************************************** 91 //* 92 //* T Y P E S 93 //* 94 //****************************************************************************** 95 96 //****************************************************************************** 97 //* 98 //* P U B L I C M E T H O D S 99 //* 100 //****************************************************************************** 101 102 U32 sci_iterator_get_object_size( 103 void 104 ); 105 106 void * sci_iterator_get_current( 107 SCI_ITERATOR_HANDLE_T iterator_handle 108 ); 109 110 void sci_iterator_first( 111 SCI_ITERATOR_HANDLE_T iterator_handle 112 ); 113 114 void sci_iterator_next( 115 SCI_ITERATOR_HANDLE_T iterator_handle 116 ); 117 118 #else // !defined(DISABLE_SCI_ITERATORS) 119 120 #define sci_iterator_get_object_size() 0 121 #define sci_iterator_get_current(the_iterator) NULL 122 #define sci_iterator_first(the_iterator) 123 #define sci_iterator_next(the_iterator) 124 125 #endif // !defined(DISABLE_SCI_ITERATORS) 126 127 #ifdef __cplusplus 128 } 129 #endif // __cplusplus 130 131 #endif // _ITERATOR_H_ 132