SocLogicalId.c

/**
 * @file  SocLogicalId.c
 * @brief OpenSIL SoC logical ID functions
 *
 */

/* Copyright 2021-2023 Advanced Micro Devices, Inc. All rights reserved.    */
// SPDX-License-Identifier: MIT

#include <SilCommon.h>
#include <BaseSocLogicalIdXlat.h>

/**
 * SocConvertRawToLogical
 * @brief Translates the given raw ID into the appropriate logical
 *        family / logical revision
 *
 * @param[in]     RawId       Raw CPU ID to convert
 * @param[out]    LogicalId   Logical family and logical revision for the given raw ID
 *
 * @retval        true        Logical ID was successfully found
 * @retval        false       Family is unknown
 */
bool
SocConvertRawToLogical (
  uint32_t          RawId,
  SOC_LOGICAL_ID    *LogicalId
  )
{
  SOC_LOGICAL_FAMILY_XLAT    *LogicalFamilyTable;
  SOC_LOGICAL_REVISION_XLAT  *LogicalRevisionTable;
  bool                       LogicalIdValid;

  LogicalIdValid = SocFindApplicableLogicalTableEntries (
                      RawId,
                      &LogicalFamilyTable,
                      &LogicalRevisionTable
                      );
  if (LogicalIdValid) {
    LogicalId->Family = LogicalFamilyTable->LogicalFamily;
    LogicalId->Revision = LogicalRevisionTable->LogicalRevision;
  }

  return LogicalIdValid;
}

/**
 * BaseCoreConvertRawToLogical
 * @brief Translates the given raw ID into the appropriate
 * logical family / logical revision
 *
 * @param[in]     RawId       Raw CPU ID to convert
 * @param[out]    LogicalId   Logical family and logical revision for
 *                            the given raw ID
 *
 * @retval        true        Logical ID was successfully found
 * @retval        false       Family is unknown
 */
static bool
BaseCoreConvertRawToLogical (
  uint32_t          RawId,
  CORE_LOGICAL_ID   *LogicalId
  )
{
  SOC_LOGICAL_FAMILY_XLAT    *LogicalFamilyTable = {0};
  SOC_LOGICAL_REVISION_XLAT  *LogicalRevisionTable = {0};
  bool                       LogicalIdValid;

  LogicalIdValid = SocFindApplicableLogicalTableEntries (RawId,
                      &LogicalFamilyTable,
                      &LogicalRevisionTable
                      );
  if (LogicalIdValid) {
    LogicalId->CoreFamily = LogicalFamilyTable->LogicalCoreFamily;
    LogicalId->CoreRevision = LogicalRevisionTable->LogicalCoreRev;
  }

  return LogicalIdValid;
}

/**
 * GetSocLogicalIdOnCurrentCore
 * @brief This service retrieves the logical family and revision for the executing core.
 *
 * @param[out] LogicalId        Pointer to the logical ID for the executing core.
 *
 * @retval SilPass              The executing core's logical ID was successfully retrieved.
 * @retval SilInvalidParameter  All output parameter pointers are NULL.
 * @retval SilDeviceError       Unknown processor family found.
 *
 **/
SIL_STATUS GetSocLogicalIdOnCurrentCore (SOC_LOGICAL_ID *LogicalId)
{
  if (LogicalId == NULL) {
    return SilInvalidParameter;
  }

  if (SocConvertRawToLogical (xUslGetRawIdOnExecutingCore (), LogicalId)) {
    return SilPass;
  } else {
    return SilDeviceError;
  }
}

/**
 * SocFamilyIdCheck
 *
 * @brief   SocFamilyIDCheck function compare the logical family of the
 *          executing core received  from "GetSocLogicalIdOnCurrentCore"
 *          function with input logic family parameter.
 *          if both logical family info match, return true as SOC Family ID check pass.
  *         else return false as SOC Family ID check fail.
 *
 * @param[in]  SocFamilyId        FamailyId
 *
 * @return     TRUE  -  SOC Family ID check pass.
 *             FALSE -  SOC Family ID check fail.
 *
 */
bool
SocFamilyIdCheck (
  uint32_t SocFamilyId
  )
{
  SOC_LOGICAL_ID    LogicalId;
  SIL_STATUS        Status;

  // Get logical family and revision for the executing core
  Status = GetSocLogicalIdOnCurrentCore(&LogicalId);
  if (Status == SilPass) {
    if ( LogicalId.Family == SocFamilyId ) {
      return true;
    }
  }
  return false;
}

/**
 * GetCoreLogicalIdOnCurrentCore
 * @brief This service retrieves the core logical family and revision for the executing core.
 *
 * @param[out] CoreLogicalId    Pointer to the core logical ID for the executing core.
 *
 * @retval SilPass              The executing core's logical ID was successfully retrieved.
 * @retval SilInvalidParameter  All output parameter pointers are NULL.
 * @retval SilDeviceError       Unknown processor family found.
 *
 **/
SIL_STATUS
GetCoreLogicalIdOnCurrentCore (
  CORE_LOGICAL_ID *CoreLogicalId
  )
{
  if (CoreLogicalId == NULL) {
    return SilInvalidParameter;
  }

  if ((BaseCoreConvertRawToLogical (xUslGetRawIdOnExecutingCore (), CoreLogicalId))) {
    return SilPass;
  } else {
    return SilDeviceError;
  }
}