RtGetRDTCapability

RtGetRDTCapability returns the system Resource Director Technology (RDT) allocation capability.

Note: RtGetRDTCapability is only supported in the RTSS environment. It cannot be called from a Windows application linked to wRTOS.

Syntax

Copy

BOOL RtGetRDTCapability(
    [out]   ULONG *pRDTResourceBitMap,
    [out]   ULONG *pNumberOfCLOS
);

Parameters

[out] pRDTResourceBitMap

A pointer to a ULONG variable. It stores the resource types with allocation capability in RDT. The value stored is a bit map. The offset (defined below) of each setting bit represents a resource type available for allocation:

Define	Meaning
RDT_RESOURCE_BITOFFSET_L3_CAT	If this bit is set the hardware supports L3 level Cache Allocation Technology (CAT)
RDT_RESOURCE_BITOFFSET_L2_CAT	If this bit is set the hardware supports L3 level Cache Allocation Technology (CAT)
RDT_RESOURCE_BITOFFSET_MBA	If this bit is set the hardware supports Memory Bus Allocation (MBA)

For example, if the value stored is 0xa, L3 cache and memory bandwidth are available for allocation.

[out] pNumberOfCLOS

A pointer to a ULONG variable. It stores the number of Class of Services (CLOS) available for performance prioritization of RTSS threads.

Return Value

If the function succeeds, it returns TRUE. If the argument is invalid, it returns FALSE.

Remarks

If the system does not support RDT, or RDT is disabled in the wRTOS Settings, pRDTResourceBitMap and pNumberOfCLOS point to a value of 0.

If RDT is supported and enabled in the wRTOS Settings, and both CAT and MBA are configured to Flat performance mode, pNumberOfCLOS returns 1.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtssApi.h	Startup.lib