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_OBJECT_H_ 55230557Sjimharris#define _SCI_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_types.h> 70230557Sjimharris#include <dev/isci/scil/sci_status.h> 71230557Sjimharris 72230557Sjimharris/** 73230557Sjimharris * @brief This method returns the object to which a previous association was 74230557Sjimharris * created. This association represents a link between an SCI object 75230557Sjimharris * and another SCI object or potentially a user object. The 76230557Sjimharris * association essentially acts as a cookie for the user of an object. 77230557Sjimharris * The user of an SCI object is now able to retrieve a handle to their 78230557Sjimharris * own object that is managing, or related in someway, to said SCI 79230557Sjimharris * object. 80230557Sjimharris * 81230557Sjimharris * @param[in] base_object This parameter specifies the SCI object for 82230557Sjimharris * which to retrieve the association reference. 83230557Sjimharris * 84230557Sjimharris * @return This method returns a pointer to the object that was previously 85230557Sjimharris * associated to the supplied base_object parameter. 86230557Sjimharris * @retval SCI_INVALID_HANDLE This value is returned when there is no known 87230557Sjimharris * association for the supplied base_object instance. 88230557Sjimharris */ 89230557Sjimharris#if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS) 90230557Sjimharrisvoid * sci_object_get_association( 91230557Sjimharris SCI_OBJECT_HANDLE_T base_object 92230557Sjimharris); 93230557Sjimharris#else 94230557Sjimharris#define sci_object_get_association(object) (*((void **)object)) 95230557Sjimharris#endif 96230557Sjimharris 97230557Sjimharris/** 98230557Sjimharris * @brief This method will associate to SCI objects. 99230557Sjimharris * 100230557Sjimharris * @see For more information about associations please reference the 101230557Sjimharris * sci_object_get_association() method. 102230557Sjimharris * 103230557Sjimharris * @param[in] base_object This parameter specifies the SCI object for 104230557Sjimharris * which to set the association reference. 105230557Sjimharris * @param[in] associated_object This parameter specifies a pointer to the 106230557Sjimharris * object being associated. 107230557Sjimharris * 108230557Sjimharris * @return This method will return an indication as to whether the 109230557Sjimharris * association was set successfully. 110230557Sjimharris * @retval SCI_SUCCESS This value is currently always returned. 111230557Sjimharris */ 112230557Sjimharris#if defined(SCI_OBJECT_USE_ASSOCIATION_FUNCTIONS) 113230557SjimharrisSCI_STATUS sci_object_set_association( 114230557Sjimharris SCI_OBJECT_HANDLE_T base_object, 115230557Sjimharris void * associated_object 116230557Sjimharris); 117230557Sjimharris#else 118230557Sjimharris#define sci_object_set_association(base_object, associated_object) \ 119230557Sjimharris ((*((void **)base_object)) = (associated_object)) 120230557Sjimharris#endif 121230557Sjimharris 122230557Sjimharris/** 123230557Sjimharris * @brief This method will get the logger for an object. 124230557Sjimharris * 125230557Sjimharris * @param[in] object This parameter specifies SCI object for 126230557Sjimharris * which to retrieve its logger. 127230557Sjimharris * 128230557Sjimharris * @return This method returns a SCI_LOGGER_HANDLE to SCI user. 129230557Sjimharris */ 130230557SjimharrisSCI_LOGGER_HANDLE_T sci_object_get_logger( 131230557Sjimharris SCI_OBJECT_HANDLE_T object 132230557Sjimharris); 133230557Sjimharris 134230557Sjimharris#ifdef __cplusplus 135230557Sjimharris} 136230557Sjimharris#endif // __cplusplus 137230557Sjimharris 138230557Sjimharris#endif // _SCI_OBJECT_H_ 139230557Sjimharris 140