
#ifndef _G_CRASHCAT_QUEUE_NVOC_H_
#define _G_CRASHCAT_QUEUE_NVOC_H_

// Version of generated metadata structures
#ifdef NVOC_METADATA_VERSION
#undef NVOC_METADATA_VERSION
#endif
#define NVOC_METADATA_VERSION 2

#include "nvoc/runtime.h"
#include "nvoc/rtti.h"

#ifdef __cplusplus
extern "C" {
#endif

/*
 * SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#pragma once
#include "g_crashcat_queue_nvoc.h"

#ifndef CRASHCAT_QUEUE_H
#define CRASHCAT_QUEUE_H

#include "nvoc/object.h"
#include "nv-crashcat.h"
#include "crashcat/crashcat_wayfinder.h" // for CrashCatWayfinderHal spec

struct CrashCatEngine;

#ifndef __nvoc_class_id_CrashCatEngine
#define __nvoc_class_id_CrashCatEngine 0x654166u
typedef struct CrashCatEngine CrashCatEngine;
#endif /* __nvoc_class_id_CrashCatEngine */


struct CrashCatReport;

#ifndef __nvoc_class_id_CrashCatReport
#define __nvoc_class_id_CrashCatReport 0xde4777u
typedef struct CrashCatReport CrashCatReport;
#endif /* __nvoc_class_id_CrashCatReport */



typedef struct
{
    NV_CRASHCAT_MEM_APERTURE aperture;
    NvU32 size;
    NvU64 offset;

    NvU32 putRegOffset;
    NvU32 getRegOffset;
} CrashCatQueueConfig;


// Private field names are wrapped in PRIVATE_FIELD, which does nothing for
// the matching C source file, but causes diagnostics to be issued if another
// source file references the field.
#ifdef NVOC_CRASHCAT_QUEUE_H_PRIVATE_ACCESS_ALLOWED
#define PRIVATE_FIELD(x) x
#else
#define PRIVATE_FIELD(x) NVOC_PRIVATE_FIELD(x)
#endif


// Metadata with per-class RTTI with ancestor(s)
struct NVOC_METADATA__CrashCatQueue;
struct NVOC_METADATA__Object;


struct CrashCatQueue {

    // Metadata starts with RTTI structure.
    union {
         const struct NVOC_METADATA__CrashCatQueue *__nvoc_metadata_ptr;
         const struct NVOC_RTTI *__nvoc_rtti;
    };

    // Parent (i.e. superclass or base class) objects
    struct Object __nvoc_base_Object;

    // Ancestor object pointers for `staticCast` feature
    struct Object *__nvoc_pbase_Object;    // obj super
    struct CrashCatQueue *__nvoc_pbase_CrashCatQueue;    // crashcatQueue

    // Data members
    CrashCatQueueConfig PRIVATE_FIELD(config);
    struct CrashCatEngine *PRIVATE_FIELD(pEngine);
    void *PRIVATE_FIELD(pMapping);
};


// Metadata with per-class RTTI with ancestor(s)
struct NVOC_METADATA__CrashCatQueue {
    const struct NVOC_RTTI rtti;
    const struct NVOC_METADATA__Object metadata__Object;
};

#ifndef __nvoc_class_id_CrashCatQueue
#define __nvoc_class_id_CrashCatQueue 0xbaa900u
typedef struct CrashCatQueue CrashCatQueue;
#endif /* __nvoc_class_id_CrashCatQueue */

// Casting support
extern const struct NVOC_CLASS_DEF __nvoc_class_def_CrashCatQueue;

#define __staticCast_CrashCatQueue(pThis) \
    ((pThis)->__nvoc_pbase_CrashCatQueue)

#ifdef __nvoc_crashcat_queue_h_disabled
#define __dynamicCast_CrashCatQueue(pThis) ((CrashCatQueue*) NULL)
#else //__nvoc_crashcat_queue_h_disabled
#define __dynamicCast_CrashCatQueue(pThis) \
    ((CrashCatQueue*) __nvoc_dynamicCast(staticCast((pThis), Dynamic), classInfo(CrashCatQueue)))
#endif //__nvoc_crashcat_queue_h_disabled

NV_STATUS __nvoc_objCreateDynamic_CrashCatQueue(CrashCatQueue**, Dynamic*, NvU32, va_list);

NV_STATUS __nvoc_objCreate_CrashCatQueue(CrashCatQueue**, Dynamic*, NvU32, CrashCatQueueConfig *pQueueConfig);
#define __objCreate_CrashCatQueue(__nvoc_ppNewObj, __nvoc_pParent, __nvoc_createFlags, pQueueConfig) \
    __nvoc_objCreate_CrashCatQueue((__nvoc_ppNewObj), staticCast((__nvoc_pParent), Dynamic), (__nvoc_createFlags), pQueueConfig)


// Wrapper macros for implementation functions
NV_STATUS crashcatQueueConstruct_IMPL(struct CrashCatQueue *arg_this, CrashCatQueueConfig *pQueueConfig);
#define __nvoc_crashcatQueueConstruct(arg_this, pQueueConfig) crashcatQueueConstruct_IMPL(arg_this, pQueueConfig)

void crashcatQueueDestruct_IMPL(struct CrashCatQueue *arg_this);
#define __nvoc_crashcatQueueDestruct(arg_this) crashcatQueueDestruct_IMPL(arg_this)

#ifdef __nvoc_crashcat_queue_h_disabled
static inline struct CrashCatReport * crashcatQueueConsumeNextReport(struct CrashCatQueue *arg_this) {
    NV_ASSERT_FAILED_PRECOMP("CrashCatQueue was disabled!");
    return NULL;
}
#else // __nvoc_crashcat_queue_h_disabled
#define crashcatQueueConsumeNextReport(arg_this) crashcatQueueConsumeNextReport_V1(arg_this)
#endif // __nvoc_crashcat_queue_h_disabled


// Wrapper macros for halified functions
#define crashcatQueueConsumeNextReport_HAL(arg_this) crashcatQueueConsumeNextReport(arg_this)

// Dispatch functions
// Virtual method declarations and/or inline definitions
// Exported method declarations and/or inline definitions
// HAL method declarations without bodies
struct CrashCatReport * crashcatQueueConsumeNextReport_V1(struct CrashCatQueue *arg_this);

// Inline HAL method definitions
// Static dispatch method declarations
// Static inline method definitions
#undef PRIVATE_FIELD


#endif // CRASHCAT_QUEUE_H

#ifdef __cplusplus
} // extern "C"
#endif

#endif // _G_CRASHCAT_QUEUE_NVOC_H_
