Getmaximumprocessorindex(), Func – Intel Extensible Firmware Interface User Manual

Page 719

Advertising
background image

Protocols

— Debugger Support

Version 1.10

12/01/02

16-5

EFI_DEBUG_SUPPORT_PROTOCOL.GetMaximumProcessorIndex()

Summary

Returns the maximum value that may be used for the

ProcessorIndex

parameter in

RegisterPeriodicCallback()

and

RegisterExceptionCallback()

.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_GET_MAXIMUM_PROCESSOR_INDEX) (
IN EFI_DEBUG_SUPPORT_PROTOCOL

*This,

OUT UINTN

*MaxProcessorIndex

);

Parameters

This

A pointer to the

EFI_DEBUG_SUPPORT_PROTOCOL

instance.

Type

EFI_DEBUG_SUPPORT_PROTOCOL

is defined in

Section 16.2.

MaxProcessorIndex

Pointer to a caller-allocated

UINTN

in which the maximum

supported processor index is returned.

Description

The

GetMaximumProcessorIndex()

function returns the maximum processor index in the

output parameter

MaxProcessorIndex

. This value is the largest value that may be used in the

ProcessorIndex

parameter for both

RegisterPeriodicCallback()

and

RegisterExceptionCallback()

. All values between 0 and

MaxProcessorIndex

must

be supported by

RegisterPeriodicCallback()

and

RegisterExceptionCallback()

.

It is the responsibility of the caller to insure all parameters are correct. There is no provision for
parameter checking by

GetMaximumProcessorIndex()

. The implementation behavior

when an invalid parameter is passed is not defined by this specification.

Status Codes Returned

EFI_SUCCESS

The function completed successfully.

Advertising