1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris/** 55230557Sjimharris * @file 56230557Sjimharris * 57230557Sjimharris * @brief This file contains the interface to the iterator class. 58230557Sjimharris * Methods Provided: 59230557Sjimharris * - sci_iterator_get_object_size() 60230557Sjimharris * - sci_iterator_get_current() 61230557Sjimharris * - sci_iterator_first() 62230557Sjimharris * - sci_iterator_next() 63230557Sjimharris */ 64230557Sjimharris 65230557Sjimharris#ifndef _SCI_ITERATOR_H_ 66230557Sjimharris#define _SCI_ITERATOR_H_ 67230557Sjimharris 68230557Sjimharris#ifdef __cplusplus 69230557Sjimharrisextern "C" { 70230557Sjimharris#endif // __cplusplus 71230557Sjimharris 72230557Sjimharris#if !defined(DISABLE_SCI_ITERATORS) 73230557Sjimharris 74230557Sjimharris//****************************************************************************** 75230557Sjimharris//* 76230557Sjimharris//* I N C L U D E S 77230557Sjimharris//* 78230557Sjimharris//****************************************************************************** 79230557Sjimharris 80230557Sjimharris#include <dev/isci/scil/sci_types.h> 81230557Sjimharris 82230557Sjimharris//****************************************************************************** 83230557Sjimharris//* 84230557Sjimharris//* C O N S T A N T S 85230557Sjimharris//* 86230557Sjimharris//****************************************************************************** 87230557Sjimharris 88230557Sjimharris//****************************************************************************** 89230557Sjimharris//* 90230557Sjimharris//* T Y P E S 91230557Sjimharris//* 92230557Sjimharris//****************************************************************************** 93230557Sjimharris 94230557Sjimharris//****************************************************************************** 95230557Sjimharris//* 96230557Sjimharris//* P U B L I C M E T H O D S 97230557Sjimharris//* 98230557Sjimharris//****************************************************************************** 99230557Sjimharris 100230557SjimharrisU32 sci_iterator_get_object_size( 101230557Sjimharris void 102230557Sjimharris); 103230557Sjimharris 104230557Sjimharrisvoid * sci_iterator_get_current( 105230557Sjimharris SCI_ITERATOR_HANDLE_T iterator_handle 106230557Sjimharris); 107230557Sjimharris 108230557Sjimharrisvoid sci_iterator_first( 109230557Sjimharris SCI_ITERATOR_HANDLE_T iterator_handle 110230557Sjimharris); 111230557Sjimharris 112230557Sjimharrisvoid sci_iterator_next( 113230557Sjimharris SCI_ITERATOR_HANDLE_T iterator_handle 114230557Sjimharris); 115230557Sjimharris 116230557Sjimharris#else // !defined(DISABLE_SCI_ITERATORS) 117230557Sjimharris 118230557Sjimharris#define sci_iterator_get_object_size() 0 119230557Sjimharris#define sci_iterator_get_current(the_iterator) NULL 120230557Sjimharris#define sci_iterator_first(the_iterator) 121230557Sjimharris#define sci_iterator_next(the_iterator) 122230557Sjimharris 123230557Sjimharris#endif // !defined(DISABLE_SCI_ITERATORS) 124230557Sjimharris 125230557Sjimharris#ifdef __cplusplus 126230557Sjimharris} 127230557Sjimharris#endif // __cplusplus 128230557Sjimharris 129230557Sjimharris#endif // _ITERATOR_H_ 130