Yeppp!
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Macros | Enumerations | Functions

Macros

#define YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(architecture)   (256 + (architecture))
 Returns the YepEnumeration value corresponding to ISA features of the given architecture. More...
 
#define YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(architecture)   (512 + (architecture))
 Returns the YepEnumeration value corresponding to SIMD features of the given architecture. More...
 
#define YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(architecture)   (768 + (architecture))
 Returns the YepEnumeration value corresponding to non-ISA or system features of the given architecture. More...
 

Enumerations

enum  YepEnumeration {
  YepEnumerationStatus = 0, YepEnumerationCpuArchitecture = 1, YepEnumerationCpuVendor = 2, YepEnumerationCpuMicroarchitecture = 3,
  YepEnumerationCpuBriefName = 4, YepEnumerationCpuFullName = 5, YepEnumerationGenericIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureUnknown), YepEnumerationGenericSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureUnknown),
  YepEnumerationGenericSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureUnknown), YepEnumerationX86IsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureX86), YepEnumerationX86SimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureX86), YepEnumerationX86SystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureX86),
  YepEnumerationARMIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureARM), YepEnumerationARMSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureARM), YepEnumerationARMSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureARM), YepEnumerationMIPSIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureMIPS),
  YepEnumerationMIPSSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureMIPS), YepEnumerationMIPSSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureMIPS), YepEnumerationPowerPCIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitecturePowerPC), YepEnumerationPowerPCSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitecturePowerPC),
  YepEnumerationPowerPCSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitecturePowerPC), YepEnumerationIA64IsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureIA64), YepEnumerationIA64SimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureIA64), YepEnumerationIA64SystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureIA64),
  YepEnumerationSPARCIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureSPARC), YepEnumerationSPARCSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureSPARC), YepEnumerationSPARCSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureSPARC)
}
 Indicates how to interpret integer value of Yeppp! enumeration. More...
 
enum  YepStringType { YepStringTypeDescription = 0, YepStringTypeID = 1 }
 Indicates the type of requested string representation. More...
 

Functions

enum YepStatus yepLibrary_GetString (enum YepEnumeration enumerationType, Yep32u enumerationValue, enum YepStringType stringType, void *buffer, YepSize *length)
 Returns a string representation of an integer value in a enumeration. More...
 

Detailed Description

Macro Definition Documentation

#define YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE (   architecture)    (256 + (architecture))

Returns the YepEnumeration value corresponding to ISA features of the given architecture.

See Also
YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE, YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE, YepEnumeration
Examples:
CpuInfo.c.
#define YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE (   architecture)    (512 + (architecture))

Returns the YepEnumeration value corresponding to SIMD features of the given architecture.

See Also
YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE, YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE, YepEnumeration
Examples:
CpuInfo.c.
#define YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE (   architecture)    (768 + (architecture))

Returns the YepEnumeration value corresponding to non-ISA or system features of the given architecture.

See Also
YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE, YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE, YepEnumeration
Examples:
CpuInfo.c.

Enumeration Type Documentation

Indicates how to interpret integer value of Yeppp! enumeration.

See Also
yepLibrary_GetString
Enumerator
YepEnumerationStatus 

The enumeration type is YepStatus.

YepEnumerationCpuArchitecture 

The enumeration type is YepCpuArchitecture.

YepEnumerationCpuVendor 

The enumeration type is YepCpuVendor.

YepEnumerationCpuMicroarchitecture 

The enumeration type is YepCpuMicroarchitecture.

YepEnumerationCpuBriefName 

The enumeration type is one of the processor packages for which a brief name (without vendor name) will be requested.

YepEnumerationCpuFullName 

The enumeration type is one of the processor packages for which a full name (including vendor name) will be requested.

YepEnumerationGenericIsaFeature 

The enumeration type is one of the common ISA features constants.

YepEnumerationGenericSimdFeature 

The enumeration type is one of the common SIMD features constants.

YepEnumerationGenericSystemFeature 

The enumeration type is one of the common non-ISA or system features constants.

YepEnumerationX86IsaFeature 

The enumeration type is one of the x86 ISA features constants.

YepEnumerationX86SimdFeature 

The enumeration type is one of the x86 SIMD features constants.

YepEnumerationX86SystemFeature 

The enumeration type is one of the x86 non-ISA or system features constants.

YepEnumerationARMIsaFeature 

The enumeration type is one of the ARM ISA features constants.

YepEnumerationARMSimdFeature 

The enumeration type is one of the ARM SIMD features constants.

YepEnumerationARMSystemFeature 

The enumeration type is one of the ARM non-ISA or system features constants.

YepEnumerationMIPSIsaFeature 

The enumeration type is one of the MIPS ISA features constants.

YepEnumerationMIPSSimdFeature 

The enumeration type is one of the MIPS SIMD features constants.

YepEnumerationMIPSSystemFeature 

The enumeration type is one of the MIPS non-ISA or system features constants.

YepEnumerationPowerPCIsaFeature 

The enumeration type is one of the PowerPC ISA features constants.

YepEnumerationPowerPCSimdFeature 

The enumeration type is one of the PowerPC SIMD features constants.

YepEnumerationPowerPCSystemFeature 

The enumeration type is one of the PowerPC non-ISA or system features constants.

YepEnumerationIA64IsaFeature 

The enumeration type is one of the IA64 ISA features constants.

YepEnumerationIA64SimdFeature 

The enumeration type is one of the IA64 SIMD features constants.

YepEnumerationIA64SystemFeature 

The enumeration type is one of the IA64 non-ISA or system features constants.

YepEnumerationSPARCIsaFeature 

The enumeration type is one of the SPARC ISA features constants.

YepEnumerationSPARCSimdFeature 

The enumeration type is one of the SPARC SIMD features constants.

YepEnumerationSPARCSystemFeature 

The enumeration type is one of the SPARC non-ISA or system features constants.

Indicates the type of requested string representation.

See Also
yepLibrary_GetString
Enumerator
YepStringTypeDescription 

Description string. Description can contain spaces, typography symbols, and non-ASCII characters.

YepStringTypeID 

ID string. ID must start with a Latin letter, and can contain only Latin letter (uppercase or lowercase), digits, and underscore symbol.

Function Documentation

enum YepStatus yepLibrary_GetString ( enum YepEnumeration  enumerationType,
Yep32u  enumerationValue,
enum YepStringType  stringType,
void *  buffer,
YepSize length 
)

Returns a string representation of an integer value in a enumeration.

Parameters
[in]enumerationTypeIndicates the type of integer value passed to the function in enumerationValue parameter.
[in]enumerationValueThe enumeration value of type specified in enumerationType which must be converted to string. The interpretation of enumerationValue parameter depends on enumerationType as follows:
enumerationType enumerationValue Valid stringType
YepEnumerationStatus Numerical value in YepStatus enumeration Description, ID
YepEnumerationCpuArchitecture Numerical value in YepCpuArchitecture enumeration Description, ID
YepEnumerationCpuVendor Numerical value in YepCpuVendor enumeration Description, ID
YepEnumerationCpuBriefName Processor package id (must be 0) Description
YepEnumerationCpuFullName Processor package id (must be 0) Description
YepEnumeration*IsaFeature Position of non-zero bit in ISA feature flag Description, ID
YepEnumeration*SimdFeature Position of non-zero bit in SIMD feature flag Description, ID
YepEnumeration*SystemFeature Position of non-zero bit in system feature flag Description, ID
[in]stringTypeIndicates the type of requiested string.
[out]bufferAn output buffer of size specified by the length parameter. If this pointer is null, required buffer size will be stored in length variable. On successfull return the buffer will contain the string representation of enumerationValue. The string representation does not include the terminating zero. If the function fails, the content of the buffer is not changed.
[in,out]lengthOn function call this variable must contain the length (in bytes) of the buffer. On successfull return this variable will contain the length (in bytes) of the string written to the buffer. If the function fails with YepStatusInsufficientBuffer error, on return the length variable will contain the required size of the buffer. In the function fails with any other error, this variable is unchanged.
Return values
YepStatusOkThe string is successfully stored in the buffer.
YepStatusNullPointerLength pointer is null.
YepStatusInvalidArgumentThe values of enumerationType, enumerationValue or stringType are unknown to the library, or they are provided in invalid combination.
YepStatusInsufficientBufferThe buffer pointer is null or the output buffer is too small for the string. The content of the output buffer is unchanged, and the required size of the buffer is returned in the length variable.
Examples:
CpuInfo.c.