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#ifndef _SCI_BASE_LIBRARY_H_ 55230557Sjimharris#define _SCI_BASE_LIBRARY_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains the protected interface structures, constants 61230557Sjimharris * and interface methods for the SCI_BASE_LIBRARY object. 62230557Sjimharris * 63230557Sjimharris */ 64230557Sjimharris 65230557Sjimharris#ifdef __cplusplus 66230557Sjimharrisextern "C" { 67230557Sjimharris#endif // __cplusplus 68230557Sjimharris 69230557Sjimharris#include <dev/isci/scil/sci_library.h> 70230557Sjimharris#include <dev/isci/scil/sci_pool.h> 71230557Sjimharris#include <dev/isci/scil/sci_base_object.h> 72230557Sjimharris#include <dev/isci/scil/sci_base_logger.h> 73230557Sjimharris#include <dev/isci/scil/sci_controller_constants.h> 74230557Sjimharris 75230557Sjimharris/** 76230557Sjimharris * @struct SCI_BASE_LIBRARY 77230557Sjimharris * 78230557Sjimharris * @brief This structure contains all of the objects common to all library 79230557Sjimharris * sub-objects. 80230557Sjimharris */ 81230557Sjimharristypedef struct SCI_BASE_LIBRARY 82230557Sjimharris{ 83230557Sjimharris /** 84230557Sjimharris * This class derives directly from the base object class. As a result, 85230557Sjimharris * the field is named "parent" and is the first field contained in the 86230557Sjimharris * structure. 87230557Sjimharris */ 88230557Sjimharris SCI_BASE_OBJECT_T parent; 89230557Sjimharris 90230557Sjimharris /** 91230557Sjimharris * This field provides the logger object to be utilized by all objects 92230557Sjimharris * contained inside of a library. 93230557Sjimharris */ 94230557Sjimharris SCI_BASE_LOGGER_T logger; 95230557Sjimharris 96230557Sjimharris // Create a pool structure to manage free controller indices. 97230557Sjimharris SCI_POOL_CREATE(controller_id_pool, U16, SCI_MAX_CONTROLLERS); 98230557Sjimharris 99230557Sjimharris} SCI_BASE_LIBRARY_T; 100230557Sjimharris 101230557Sjimharris 102230557Sjimharris/** 103230557Sjimharris * @brief This method will construct the base library object. 104230557Sjimharris * 105230557Sjimharris * @param[in] this_library This parameter specifies the library object 106230557Sjimharris * to be constructed. 107230557Sjimharris * @param[in] max_controllers This parameter specifies the maximum number 108230557Sjimharris * of controllers to be supported by this library. 109230557Sjimharris * 110230557Sjimharris * @return none 111230557Sjimharris */ 112230557Sjimharrisvoid sci_base_library_construct( 113230557Sjimharris SCI_BASE_LIBRARY_T * this_library, 114230557Sjimharris U32 max_controllers 115230557Sjimharris); 116230557Sjimharris 117230557Sjimharris/** 118230557Sjimharris * This macro provides common code for allocating a controller from a library. 119230557Sjimharris * It will ensure that we successfully allocate an available controller index 120230557Sjimharris * and return SCI_FAILURE_INSUFFICIENT_RESOURCES if unsuccessful. 121230557Sjimharris */ 122230557Sjimharris#define SCI_BASE_LIBRARY_ALLOCATE_CONTROLLER( \ 123230557Sjimharris library, \ 124230557Sjimharris controller_ptr, \ 125230557Sjimharris rc \ 126230557Sjimharris) \ 127230557Sjimharris{ \ 128230557Sjimharris U16 index; \ 129230557Sjimharris *rc = SCI_SUCCESS; \ 130230557Sjimharris if (! sci_pool_empty((library)->parent.controller_id_pool)) \ 131230557Sjimharris { \ 132230557Sjimharris sci_pool_get((library)->parent.controller_id_pool, index); \ 133230557Sjimharris *controller_ptr = (SCI_CONTROLLER_HANDLE_T) \ 134230557Sjimharris & (library)->controllers[index]; \ 135230557Sjimharris } \ 136230557Sjimharris else \ 137230557Sjimharris *rc = SCI_FAILURE_INSUFFICIENT_RESOURCES; \ 138230557Sjimharris} 139230557Sjimharris 140230557Sjimharris/** 141230557Sjimharris * This macro provides common code for freeing a controller to a library. 142230557Sjimharris * It calculates the index to the controller instance in the array by 143230557Sjimharris * determining the offset. 144230557Sjimharris */ 145230557Sjimharris#define SCI_BASE_LIBRARY_FREE_CONTROLLER( \ 146230557Sjimharris library, \ 147230557Sjimharris controller, \ 148230557Sjimharris CONTROLLER_TYPE, \ 149230557Sjimharris rc \ 150230557Sjimharris) \ 151230557Sjimharris{ \ 152230557Sjimharris U16 index = (U16) \ 153230557Sjimharris ((((char *)(controller)) - ((char *)(library)->controllers))\ 154230557Sjimharris / sizeof(CONTROLLER_TYPE)); \ 155230557Sjimharris *rc = SCI_SUCCESS; \ 156230557Sjimharris if ( (index < SCI_MAX_CONTROLLERS) \ 157230557Sjimharris && (! sci_pool_full((library)->parent.controller_id_pool)) ) \ 158230557Sjimharris { \ 159230557Sjimharris sci_pool_put((library)->parent.controller_id_pool, index); \ 160230557Sjimharris } \ 161230557Sjimharris else \ 162230557Sjimharris *rc = SCI_FAILURE_CONTROLLER_NOT_FOUND; \ 163230557Sjimharris} 164230557Sjimharris 165230557Sjimharris 166230557Sjimharris 167230557Sjimharris/** 168230557Sjimharris * This macro provides common code for constructing library. It 169230557Sjimharris * It initialize and fill the library's controller_id_pool. 170230557Sjimharris */ 171230557Sjimharris#define SCI_BASE_LIBRARY_CONSTRUCT( \ 172230557Sjimharris library, \ 173230557Sjimharris base_library, \ 174230557Sjimharris max_controllers, \ 175230557Sjimharris CONTROLLER_TYPE, \ 176230557Sjimharris status \ 177230557Sjimharris) \ 178230557Sjimharris{ \ 179230557Sjimharris U32 controller_index; \ 180230557Sjimharris sci_base_object_construct(&(base_library)->parent, &(base_library)->logger); \ 181230557Sjimharris sci_pool_initialize((base_library)->controller_id_pool); \ 182230557Sjimharris for (controller_index = 0; controller_index < max_controller_count; controller_index++) \ 183230557Sjimharris { \ 184230557Sjimharris SCI_BASE_LIBRARY_FREE_CONTROLLER( \ 185230557Sjimharris library, \ 186230557Sjimharris &library->controllers[controller_index], \ 187230557Sjimharris CONTROLLER_TYPE, \ 188230557Sjimharris &status \ 189230557Sjimharris ); \ 190230557Sjimharris } \ 191230557Sjimharris} 192230557Sjimharris 193230557Sjimharris#ifdef __cplusplus 194230557Sjimharris} 195230557Sjimharris#endif // __cplusplus 196230557Sjimharris 197230557Sjimharris#endif // _SCI_BASE_LIBRARY_H_ 198