/*
 * Copyright (c) 2016-2017, NVIDIA CORPORATION.  All rights reserved.
 *
 * 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.
 */

#ifndef _BOARDOBJGRP_E32_H_
#define _BOARDOBJGRP_E32_H_

#include "ctrl/ctrlboardobj.h"
#include "boardobj.h"
#include "boardobjgrp.h"
#include "boardobjgrpmask.h"
#include "boardobj/boardobjgrp.h"

/*
 * boardobjgrp_e32 is @ref BOARDOBJGRP child class allowing storage of up to 32
 * @ref BOARDOBJ object pointers with single static 32-bit mask denoting valid
 * object pointers.
 */
struct boardobjgrp_e32 {
	/*
	* BOARDOBJGRP super-class. Must be first element of the structure.
	*/
	struct boardobjgrp super;
	/*
	* Statically allocated array of PBOARDOBJ-s
	*/
	struct boardobj  *objects[CTRL_BOARDOBJGRP_E32_MAX_OBJECTS];

	/*
	* Statically allocated mask strcuture referenced by super::pMask.
	*/
	struct boardobjgrpmask_e32 mask;
};

/*
 * Wrapper to the _SUPER implementation.  Provided for the child classes which
 * implement this interface.
 */
#define boardobjgrp_pmudatainit_e32(g, pboardpbjgrp, pboardobjgrppmu) \
		boardobjgrp_pmudatainit_super(g, pboardpbjgrp, pboardobjgrppmu)

/* Constructor and destructor */
u32 boardobjgrpconstruct_e32(struct boardobjgrp_e32 *pboardobjgrp);
boardobjgrp_destruct boardobjgrpdestruct_e32;
boardobjgrp_pmuhdrdatainit  boardobjgrp_pmuhdrdatainit_e32;

#endif