Files
openSIL/xSIM/xSIM.h
Paul Grimes 39e0cdde44 Initial commit.
Signed-off-by: Paul Grimes <paul.grimes@amd.com>
2023-06-14 08:35:34 -07:00

64 lines
1.8 KiB
C

/**
* @file xSIM.h
* @brief xSIM Internal definitions
* This file is used to declare the functions, variables and macros used
* by inside the xSIM core. These are not intended for Host access.
*/
/* Copyright 2021-2023 Advanced Micro Devices, Inc. All rights reserved. */
// SPDX-License-Identifier: MIT
/**
* @ingroup xSIM_group
* @defgroup xSIMcore_group xSIMcoregroup: Early Init operations center
* The xSIM library is comprised of IP blocks that each work with their
* corresponding silicon IP block within the Soc. The core xSIM routines
* provide the host entry points for initialization of all the various
* IP components.
* The primary entry points are:
* - @ref xSimQueryMemoryRequirements
* - @ref xSimAssignMemoryTp1
* - @ref xSimAssignMemoryTp2
* - @ref xSimAssignMemoryTp3
* - @ref SilFindStructure
* - @ref xSimDebugSetup
* - @ref InitializeSiTp1
* - @ref InitializeSiTp2
* - @ref InitializeSiTp3
*
* Please refer to the API document for information on how these fit
* in the design.
*Additional related service functions for use by the xSIM components are:
* - @ref SilCreateInfoBlock
*/
#pragma once
#include <SilCommon.h>
#include <xSIM-api.h>
/* *************************************************************************
* Declare openSIL common structures here
*
*/
#define KILOBYTE 1024
/* *************************************************************************
* Declare common variables here
*
*/
/*********************************************************************
* private Function prototypes
*********************************************************************/
void*
SilCreateInfoBlock (
uint32_t BlockTag,
size_t BlockSize,
uint16_t Block_Instance,
uint8_t Block_MajorRev,
uint8_t Block_MinorRev
);
// The Host API functions are declared in xSIM-api.h