#ifndef CHIPINFO_H #define CHIPINFO_H /* =========================================================================== FILE: ChipInfo.h DESCRIPTION: This is the interface specification for the chip driver/service. =========================================================================== Copyright (c) 2016-2017 QUALCOMM Technologies Incorporated. All Rights Reserved. QUALCOMM Proprietary/GTDR ============================================================================ $Header: //components/rel/core.tz/2.10.1/api/systemdrivers/ChipInfo.h#1 $ $DateTime: 2020/01/05 22:01:34 $ $Author: pwbldsvc $ */ /*========================================================================= Includes ==========================================================================*/ #include "DALStdDef.h" #include "DALStdErr.h" #include "ChipInfoDefs.h" /** @cond */ /** @addtogroup functions @{ */ /** * Returns the version of the chip as a ChipInfoVersionType * * @return Chip version if successful, * CHIPINFO_VERSION_UNKNOWN if called before ChipInfo is initialized */ ChipInfoVersionType ChipInfo_GetChipVersion(void); /** * Returns the version of the chip as read from HW. * This "raw" version is a strictly increasing integer counter, * incremented for each new HW version. e.g.: * v1.0 = 0 * v1.1 = 1 * v1.2 = 2 * v2.0 = 3 * ... * * @return Chip version as read from HW, * CHIPINFO_RAW_VERSION_UNKNOWN if called before ChipInfo is initialized */ uint32 ChipInfo_GetRawChipVersion(void); /** * Returns the chip ID as a ChipInfoIdType * * @return Chip ID associated with the part number read from HW, * CHIPINFO_ID_UNKNOWN if no associated chip id could be found, or if called before ChipInfo is initialized */ ChipInfoIdType ChipInfo_GetChipId(void); /** * Returns the chip ID as read from HW (i.e. the JTAG ID) * * @return Chip ID as read from HW, or * CHIPINFO_RAW_ID_UNKNOWN if called before ChipInfo is initialized */ uint32 ChipInfo_GetRawChipId(void); /** * Returns the name of the chip (e.g. MSM8998, MDM9665) * * @param[in,out] szChipIdStr Pointer a buffer to hold the chip's name. If called before ChipInfo is initialized, or if the Chip ID string is unknown, the string "UNKNOWN" will be copied into this buffer. * @param[in] nMaxLength Length of the string to copy. Max supported * size is CHIPINFO_MAX_ID_LENGTH * * @return DAL_SUCCESS always */ DALResult ChipInfo_GetChipIdString(char *szChipIdStr, uint32 nMaxLength); /** * Returns the chip's family as a ChipInfoFamilyType. This has no connection * to the architectural family - it's used to group all revisions of a specific chip * * @return Chip Family if successful, * CHIPINFO_FAMILY_UNKNOWN if no associated chip family can be found, or if called before ChipInfo is initialized * */ ChipInfoFamilyType ChipInfo_GetChipFamily(void); /** * Returns the marketing name of the processor. This is typically the same * as the ChipIdString. * * @param [in,out] pszProcessorNameStr Pointer to a buffer to hold the processor's name. If called before ChipInfo is initialized, or if the marketing name is unknown, the string "UNKNOWN" will be copied into this buffer. * @param [in] nMaxLen Length of the name buffer. At most CHIPINFO_MAX_NAME_LEN * bytes will be copied. * @return DAL_SUCCESS always */ DALResult ChipInfo_GetMarketingNameString(char *pszMarketingNameStr, uint32 nMaxLen); /** * Returns whether or not the chip supports a modem. * * NOTE: This isn't intended to to be an exhaustive list of modems supported by this * chip, since there are far to many configurations to keep track of. The value * returned here should be treated as indicating the presence of a modem, * i.e. 0 = Modem not supported (e.g. SDA), nonzero = Modem supported (e.g. SDM) * * @return Non-zero if modems are supported for this chip, * CHIPINFO_MODEM_UNKNOWN if modems are not supported, or * if called before ChipInfo is initialized */ ChipInfoModemType ChipInfo_GetModemSupport(void); /** * Returns the chip's serial number * * @return Serial number as read from HW, or * CHIPINFO_SERIAL_NUM_UNKNOWN if called before ChipInfo is initialized */ ChipInfoSerialNumType ChipInfo_GetSerialNumber(void); /** * Returns the foundry ID for the chip as a ChipInfoFoundryIdType * * @return Foundry ID if successful, * CHIPINFO_FOUNDRYID_UNKNOWN if called before ChipInfo is initialized */ ChipInfoFoundryIdType ChipInfo_GetFoundryId(void); /** * Returns the chip's architecture family number as read from HW * * @return Architectural family as read from HW, or * CHIPINFO_RAW_DEVICE_FAMILY_UNKNOWN if called before ChipInfo is initialized */ uint32 ChipInfo_GetRawDeviceFamily(void); /** * Returns the chip's device ID within its architectural family, as read from HW * * @return Device number as read from HW, * CHIPINFO_RAW_DEVICE_NUMBER_UNKNOWN if called before ChipInfo is initialized */ uint32 ChipInfo_GetRawDeviceNumber(void); /** * Returns the chip's QFPROM chip ID, which can be used along with the * serial number to uniquely identify the chip * * @return Chip ID as read from QFPROM fuses, if successful * CHIPINFO_QFPROM_CHIPID_UNKNOWN if called before ChipInfo is initialized */ ChipInfoQFPROMChipIdType ChipInfo_GetQFPROMChipId(void); /** * Check if the specified part is marked defective in the PTE fuses * * @param[in] ePart The ChipInfoPartType being queried * @param[out] pDefective Pointer to uint32 used to store the defectiveness of the selected part. * 1 => Defective, 0 => Not defective/Not present on chip * * @return DAL_ERROR_INVALID_TYPE if the selected part isn't a supported ChipInfoPartType * DAL_ERROR for other general errors * DAL_SUCCESS otherwise */ DALResult ChipInfo_GetDefectivePart(ChipInfoPartType ePart, uint32 *pnMask); /** * Retrieve a mask of CPUs in the current cluster which are marked as defective in the PTE fuses. * If the cluster has fewer than 32 CPUs, the additional CPUs are marked as "not defective" * * @param[in] nCPUCluster CPU cluster to check. * @param[out] nMask Pointer to uint32 to hold a mask of defective CPUs in the selected cluster * * @return DAL_ERROR_OUT_OF_RANGE_PARAMETER if nClusterIdx > number of clusters present * DAL_ERROR for othe general errors * DAL_SUCCESS otherwise */ DALResult ChipInfo_GetDefectiveCPUs(uint32 nCPUCluster, uint32 *pnMask); /** * Initialize the ChipInfo driver * * @return DAL_SUCCESS always. Any missing/unknown information will be indicated as specified in the documentation for the above APIs. */ DALResult ChipInfo_Init(void); /** * @} */ #endif /* CHIPINFO_H */