/* 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.
 *
 *****************************************************************************/
/*-----------------------------------------------------------------------------
 *
 * $Author: dtvbm11 $
 * $Date: 2015/11/10 $
 * $RCSfile: gfx_cmdque.h,v $
 * $Revision: #1 $
 *
 *---------------------------------------------------------------------------*/

/** @file gfx_cmdque.h
 *  gfx command queue function prototypes.
 */

#ifndef GFX_CMDQUE_H
#define GFX_CMDQUE_H

//---------------------------------------------------------------------------
// Include files
//---------------------------------------------------------------------------

#include "x_typedef.h"
#include "gfx_common_if.h"

//---------------------------------------------------------------------------
// Type definitions
//---------------------------------------------------------------------------


//---------------------------------------------------------------------------
// Macro definitions
//---------------------------------------------------------------------------

#if defined(GFX_DEBUG_MODE)

#define GFX_CMDQUE_INC_FLUSH_COUNT()    GFX_CmdQueFlushCount()
#define GFX_CMDQUE_INC_INT_COUNT()      GFX_CmdQueIntCount()

#else       // normal mode
#define GFX_CMDQUE_INC_FLUSH_COUNT()
#define GFX_CMDQUE_INC_INT_COUNT()

#endif // #if defined(GFX_DEBUG_MODE)

//---------------------------------------------------------------------------
// Inter-file functions
//---------------------------------------------------------------------------


//---------------------------------------------------------------------------
// Public functions
//---------------------------------------------------------------------------

extern void GFX_CmdQueInit(volatile GFX_CMDQUE_T *rGfxCmdQue,
        volatile UINT64 **cmdQueBuf);

extern void GFX_CmdQueReset(void);

extern void GFX_CmdQueAction(void);

extern void GFX_RiscPushBack(UINT32 u4Reg, UINT32 u4Val);

extern void GFX_CmdQuePushBack(UINT32 u4Reg, UINT32 u4Val);

extern void GFX_CmdQueCalculateCapacity(INT32 i4CmdqConfig);

extern void GFX_CmdQueSetup(void);

extern void GFX_VirtualCmdQueAction(void);

extern void VGFX_CmdQuePushBack(UINT32 u4Reg, UINT32 u4Val);

extern bool GFX_CmdQueIsTH(void);

// for debug use
#if defined(GFX_DEBUG_MODE)
extern void GFX_CmdQueDbgInfo(void);

extern void GFX_CmdQueSetNewConfig(INT32 i4NewConfig);

extern void GFX_CmdQueFlushCount(void);

extern void GFX_CmdQueIntCount(void);
#endif // #if defined(GFX_DEBUG_MODE)

#endif // GFX_CMDQUE_H
