/* SPDX-License-Identifier: LGPL-2.1-only OR BSD-3-Clause */
/******************************************************************************
 *
 * This file is provided under a dual license.  When you use or
 * distribute this software, you may choose to be licensed under
 * version 2.1 of the GNU Lesser General Public License
 * ("LGPLv2.1 License") or BSD License.
 *
 * LGPLv2.1 License
 *
 * Copyright(C) 2019 MediaTek Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2.1 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html for more
 * details.
 *
 * BSD LICENSE
 *
 * Copyright(C) 2019 MediaTek Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/

/*----------------------------------------------------------------------------*/
/*! @file c_handle.h 
 *  $RCSfile: $
 *  $Revision: #1 $
 *  $Date: 2015/05/29 $
 *  $Author: brianpc.huang $
 *  
 *  @par Description:
 *         This header file contains handle specific definitions, which are
 *         exported to applications.
 */
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/*! @addtogroup groupMW_HANDLE
 *  @{ 
 */
/*----------------------------------------------------------------------------*/
#ifndef _C_HANDLE_H_
#define _C_HANDLE_H_


/*-----------------------------------------------------------------------------
                    include files
-----------------------------------------------------------------------------*/

#include "u_handle.h"
#include "c_common.h"


/*-----------------------------------------------------------------------------
                    functions declarations
 ----------------------------------------------------------------------------*/

/*------------------------------------------------------------------*/
/*! @brief              This API frees a given handle.
 *                           
 *  @param [in]       h_handle       The handle to free.
 *  @note
 *  @see
 *  @return      Return the error code
 *  @retval      HR_OK                             Routine successful.
 *  @retval      HR_FREE_NOT_ALLOWED   The handle is not allowed to free.
 *  @retval      HR_INV_HANDLE               The handle is invalid.
 */
/*------------------------------------------------------------------*/
extern INT32 c_handle_free (HANDLE_T  h_handle);

/*------------------------------------------------------------------*/
/*! @brief              This API get info of given handle.
 *                           
 *  @param [in]       h_handle       The handle to get it's info.
 *  @param [out]     pe_type        Output the type of this handle.
 *  @param [out]     ppv_tag        Output the tag info of this handle.
 *  @note
 *  @see
 *  @return      Return the error code
 *  @retval      HR_OK                             Routine successful.
 *  @retval      HR_INV_ARG                    Input argment is invalid.
 *  @retval      HR_INV_HANDLE               The handle is invalid.
 */
/*------------------------------------------------------------------*/
extern INT32 c_handle_get_info (HANDLE_T        h_handle,
                                HANDLE_TYPE_T*  pe_type,
                                VOID**          ppv_tag);

/*------------------------------------------------------------------*/
/*! @brief              This API get tag info of given handle.
 *                           
 *  @param [in]       h_handle       The handle to get it's tag.
 *  @param [out]     ppv_tag        Output the tag info of this handle.
 *  @note
 *  @see
 *  @return      Return the error code
 *  @retval      HR_OK                             Routine successful.
 *  @retval      HR_INV_ARG                    Input argment is invalid.
 *  @retval      HR_INV_HANDLE               The handle is invalid.
 */
/*------------------------------------------------------------------*/
extern INT32 c_handle_get_tag (HANDLE_T  h_handle,
                               VOID**    ppv_tag);

/*------------------------------------------------------------------*/
/*! @brief              This API get type of given handle.
 *                           
 *  @param [in]       h_handle       The handle to get it's type.
 *  @param [out]     pe_type        Output the type of this handle.
 *  @note
 *  @see
 *  @return      Return the error code
 *  @retval      HR_OK                             Routine successful.
 *  @retval      HR_INV_ARG                    Input argment is invalid.
 *  @retval      HR_INV_HANDLE               The handle is invalid.
 */
/*------------------------------------------------------------------*/
extern INT32 c_handle_get_type (HANDLE_T        h_handle,
                                HANDLE_TYPE_T*  pe_type);

/*------------------------------------------------------------------*/
/*! @brief              This API set tag info of given handle.
 *                           
 *  @param [in]       h_handle       The handle to set it's tag info.
 *  @param [in]       pv_tag          Pointer to tag info to set into the handle.
 *  @note
 *  @see
 *  @return      Return the error code
 *  @retval      HR_OK                             Routine successful.
 *  @retval      HR_INV_HANDLE               The handle is invalid.
 */
/*------------------------------------------------------------------*/
extern INT32 c_handle_set_tag (HANDLE_T  h_handle,
                               VOID*     pv_tag);

/*------------------------------------------------------------------*/
/*! @brief              This API judge a handle is valid or not.
 *                           
 *  @param [in]       h_handle       The input handle.
 *  @note
 *  @see
 *  @return      Return TRUE or FALSE. 
 *  @retval      TRUE                 The handle is valid.
 *  @retval      FALSE                The handle is invalid.
 */
/*------------------------------------------------------------------*/
extern BOOL c_handle_valid (HANDLE_T  h_handle);


#endif /* _C_HANDLE_H_ */
/*----------------------------------------------------------------------------*/
/*! @} */                                             /* end of groupMW_HANDLE */
/*----------------------------------------------------------------------------*/
