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_OBJECT_H_ 55230557Sjimharris#define _SCI_BASE_OBJECT_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the method and constants associated with 61230557Sjimharris * the SCI base object. The SCI base object is the class from which 62230557Sjimharris * all other objects derive in the Storage Controller Interface. 63230557Sjimharris */ 64230557Sjimharris 65230557Sjimharris#ifdef __cplusplus 66230557Sjimharrisextern "C" { 67230557Sjimharris#endif // __cplusplus 68230557Sjimharris 69230557Sjimharris#include <dev/isci/scil/sci_object.h> 70230557Sjimharris 71230557Sjimharris// Forward declare the logger object 72230557Sjimharrisstruct SCI_BASE_LOGGER; 73230557Sjimharris 74230557Sjimharris/** 75230557Sjimharris * @struct SCI_BASE_OBJECT 76230557Sjimharris * 77230557Sjimharris * @brief The SCI_BASE_OBJECT object represents the data and functionality 78230557Sjimharris * that is common to all SCI objects. It is the base class. 79230557Sjimharris */ 80230557Sjimharristypedef struct SCI_BASE_OBJECT 81230557Sjimharris{ 82230557Sjimharris /** 83230557Sjimharris * This field represents an association created by the user for this 84230557Sjimharris * object. The association can be whatever the user wishes. Think of 85230557Sjimharris * it as a cookie. 86230557Sjimharris */ 87230557Sjimharris void * associated_object; 88230557Sjimharris 89230557Sjimharris /** 90230557Sjimharris * This field simply contains a handle to the logger object to be 91230557Sjimharris * utilized when utilizing the logger interface. 92230557Sjimharris */ 93230557Sjimharris struct SCI_BASE_LOGGER * logger; 94230557Sjimharris 95230557Sjimharris} SCI_BASE_OBJECT_T; 96230557Sjimharris 97230557Sjimharris 98230557Sjimharris/** 99230557Sjimharris * @brief This method constructs the sci base object. 100230557Sjimharris * 101230557Sjimharris * @param[in] base_object This parameter specifies the SCI base 102230557Sjimharris * object which we whish to construct. 103230557Sjimharris * @param[in] logger This parameter specifies the logger object to be 104230557Sjimharris * saved and utilized for this base object. 105230557Sjimharris * 106230557Sjimharris * @return none 107230557Sjimharris */ 108230557Sjimharrisvoid sci_base_object_construct( 109230557Sjimharris SCI_BASE_OBJECT_T * base_object, 110230557Sjimharris struct SCI_BASE_LOGGER * logger 111230557Sjimharris); 112230557Sjimharris 113230557Sjimharris#if defined(SCI_LOGGING) 114230557Sjimharris/** 115230557Sjimharris * @brief This method returns the logger to which a previous 116230557Sjimharris * association was created. 117230557Sjimharris * 118230557Sjimharris * @param[in] base_object This parameter specifies the SCI base object for 119230557Sjimharris * which to retrieve the logger. 120230557Sjimharris * 121230557Sjimharris * @return This method returns a pointer to the logger that was 122230557Sjimharris * previously associated to the supplied base_object 123230557Sjimharris * parameter. 124230557Sjimharris * @retval NULL This value is returned when there is no logger 125230557Sjimharris * association for the supplied base_object instance. 126230557Sjimharris */ 127230557Sjimharris#define sci_base_object_get_logger(this_object) \ 128230557Sjimharris (((SCI_BASE_OBJECT_T *)(this_object))->logger) 129230557Sjimharris 130230557Sjimharris#else // defined(SCI_LOGGING) 131230557Sjimharris 132230557Sjimharris#define sci_base_object_get_logger(this_object) NULL 133230557Sjimharris 134230557Sjimharris#endif // defined(SCI_LOGGING) 135230557Sjimharris 136230557Sjimharris#ifdef __cplusplus 137230557Sjimharris} 138230557Sjimharris#endif // __cplusplus 139230557Sjimharris 140230557Sjimharris 141230557Sjimharris#endif // _SCI_BASE_OBJECT_H_ 142230557Sjimharris 143