EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Functions | Variables

EdkCompatibilityPkg/Foundation/Core/Dxe/ArchProtocol/Bds/Bds.h File Reference

Go to the source code of this file.

Data Structures

struct  _EFI_BDS_ARCH_PROTOCOL

Defines

#define EFI_BDS_ARCH_PROTOCOL_GUID   { 0x665E3FF6, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D} }

Functions

 EFI_FORWARD_DECLARATION (EFI_BDS_ARCH_PROTOCOL)
typedef VOID (EFIAPI *EFI_BDS_ENTRY)(IN EFI_BDS_ARCH_PROTOCOL *This)

Variables

EFI_GUID gEfiBdsArchProtocolGuid

Define Documentation

#define EFI_BDS_ARCH_PROTOCOL_GUID   { 0x665E3FF6, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D} }

Definition at line 30 of file Bds.h.


Function Documentation

EFI_FORWARD_DECLARATION ( EFI_BDS_ARCH_PROTOCOL  )
typedef VOID ( EFIAPI *  UGA_REGISTER_KEY_NOTIFY_CALLBACK)

Release the specified RSA Context.

Parameters:
[in]RsaContextPointer to the RSA context to be released.

C Interrupt Handler calledin the interrupt context when Source interrupt is active.

Parameters:
SourceSource of the interrupt. Hardware routing off a specific platform defines what source means.
SystemContextPointer to system register context. Mostly used by debuggers and will update the system context after the return from the interrupt if modified. Don't change these values unless you know what you are doing

Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI runtime.

This function reapplies relocation fixups to the PE/COFF image specified by ImageBase and ImageSize so the image will execute correctly when the PE/COFF image is mapped to the address specified by VirtualImageBase. RelocationData must be identical to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().

Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.

Parameters:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage().

Release the specified RSA Context.

Parameters:
[in]RsaContextPointer to the RSA context to be released.

C Interrupt Handler calledin the interrupt context when Source interrupt is active.

Parameters:
SourceSource of the interrupt. Hardware routing off a specific platform defines what source means.
SystemContextPointer to system register context. Mostly used by debuggers and will update the system context after the return from the interrupt if modified. Don't change these values unless you know what you are doing

Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI runtime.

This function reapplies relocation fixups to the PE/COFF image specified by ImageBase and ImageSize so the image will execute correctly when the PE/COFF image is mapped to the address specified by VirtualImageBase. RelocationData must be identical to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().

Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.

Parameters:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage().

The prototype is called back when an IP packet is received.

Parameters:
[in]StatusThe result of the receive request.
[in]IcmpErrValid when Status is EFI_ICMP_ERROR.
[in]NetSessionThe IP session for the received packet.
[in]PktThe packet received.
[in]ContextThe data provided by the user for the received packet when the callback is registered in IP_IO_OPEN_DATA::RcvdContext.

The prototype is called back when an IP packet is sent.

Parameters:
[in]StatusResult of the IP packet being sent.
[in]ContextThe data provided by user for the received packet when the callback is registered in IP_IO_OPEN_DATA::SndContext.
[in]SenderA Union type to specify a pointer of EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL.
[in]NotifyDataThe Context data specified when calling IpIoSend()

Prototype called when receiving or sending packets to or from a UDP point.

This prototype is used by both receive and sending when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then provided to the callback as a reference.

Parameters:
[in]PacketThe packet received or sent.
[in]EndPointThe UDP address pair corresponds to the UDP IO.
[in]IoStatusThe packet receiving or sending status.
[in]ContextThe user-defined data when calling UdpIoRecvDatagram() or UdpIoSendDatagram().

Given a pointer to a new VM context, debug one or more instructions.

Parameters:
[in]ThisA pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]VmPtrA pointer to a VM context.
Return values:
EFI_UNSUPPORTEDNo support for it.
EFI_SUCCESSDebug one or more instructions.

This function is a prototype for a periodic SMI handler function that may be enabled with PeriodicSmiEnable() and disabled with PeriodicSmiDisable().

Parameters:
[in]ContextContent registered with PeriodicSmiEnable().
[in]ElapsedTimeThe actual time in 100ns units elasped since this function was called. A value of 0 indicates an unknown amount of time.

This function is a prototype for a function that dumps information on a protocol to a given location. The location is dependant on the implementation. This is used when programatically adding shell commands.

Parameters:
[in]HandleThe handle the protocol is on.
[in]InterfaceThe interface to the protocol.

Internal interface to add protocol handlers.

This function is for internal shell use only. This is how protocol handlers are added. This will get the current protocol info and add the new info or update existing info and then resave the info.

Parameters:
[in]ProtocolThe pointer to the protocol's GUID.
[in]DumpTokenThe function pointer to dump token function or NULL.
[in]DumpInfoThe function pointer to dump infomation function or NULL.
[in]IdStringThe English name of the protocol.

This is an internal shell function to free any and all allocated resources. This should be called immediately prior to closing the shell.

This function enables the page break mode.

This mode causes the output to pause after each complete screen to enable a user to more easily read it. If AutoWrap is TRUE, then rows with too many characters will be chopped and divided into 2 rows. If FALSE, then rows with too many characters may not be fully visible to the user on the screen.

Parameters:
[in]StartRowThe row number to start this on.
[in]AutoWrapWhether to auto wrap rows that are too long.

This function disables the page break mode.

Disabling this causes the output to print out exactly as coded, with no breaks for readability.

This function sets the keys to filter for for the console in. The valid values to set are:

#define EFI_OUTPUT_SCROLL 0x00000001 #define EFI_OUTPUT_PAUSE 0x00000002 #define EFI_EXECUTION_BREAK 0x00000004

Parameters:
[in]KeyFilterThe new key filter to use.

This is an internal shell function used to increment the shell nesting level.

This is an internal shell function used to decrement the shell nesting level.

Close the console proxy to restore the original console.

This is an internal shell function to handle shell cascading. It restores the original set of console protocols.

Parameters:
[in]ConInHandleThe handle of ConIn.
[in,out]ConInThe pointer to the location to return the pointer to the original console input.
[in]ConOutHandleThe handle of ConOut
[in,out]ConOutThe pointer to the location to return the pointer to the original console output.

For ease of use the shell maps handle #'s to short numbers. This is only done on request for various internal commands and the references are immediately freed when the internal command completes.

This is an internal shell function to enumerate the handle database.

This must be called after INIT_HANDLE_ENUMERATOR.

This function releases all memory and resources associated with the handle database. After this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will function properly.

This is an internal shell function to initialize the protocol enumerator.

This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO, RESET_PROTOCOL_INFO_ENUMERATOR, and CLOSE_PROTOCOL_INFO_ENUMERATOR are called.

This function is an internal shell function for enumeration of protocols.

This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be called after INIT_PROTOCOL_INFO_ENUMERATOR.

This function resets the list of protocols such that the next one in the list is the begining of the list.

This function is an internal shell function for enumeration of protocols.

This must be called after INIT_PROTOCOL_INFO_ENUMERATOR. After this call no protocol enumerator calls except INIT_PROTOCOL_INFO_ENUMERATOR may be made.

This function frees any memory or resources associated with the protocol enumerator.

a ASM function to transfer control to OS.

Parameters:
S3WakingVectorThe S3 waking up vector saved in ACPI Facs table
AcpiLowMemoryBasea buffer under 1M which could be used during the transfer

Release the specified RSA Context.

Parameters:
[in]RsaContextPointer to the RSA context to be released.

C Interrupt Handler calledin the interrupt context when Source interrupt is active.

Parameters:
SourceSource of the interrupt. Hardware routing off a specific platform defines what source means.
SystemContextPointer to system register context. Mostly used by debuggers and will update the system context after the return from the interrupt if modified. Don't change these values unless you know what you are doing

Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI runtime.

This function reapplies relocation fixups to the PE/COFF image specified by ImageBase and ImageSize so the image will execute correctly when the PE/COFF image is mapped to the address specified by VirtualImageBase. RelocationData must be identical to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().

Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.

Parameters:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage().

The prototype is called back when an IP packet is received.

Parameters:
[in]StatusThe result of the receive request.
[in]IcmpErrValid when Status is EFI_ICMP_ERROR.
[in]NetSessionThe IP session for the received packet.
[in]PktThe packet received.
[in]ContextThe data provided by the user for the received packet when the callback is registered in IP_IO_OPEN_DATA::RcvdContext.

The prototype is called back when an IP packet is sent.

Parameters:
[in]StatusResult of the IP packet being sent.
[in]ContextThe data provided by user for the received packet when the callback is registered in IP_IO_OPEN_DATA::SndContext.
[in]SenderA Union type to specify a pointer of EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL.
[in]NotifyDataThe Context data specified when calling IpIoSend()

Prototype called when receiving or sending packets to or from a UDP point.

This prototype is used by both receive and sending when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then provided to the callback as a reference.

Parameters:
[in]PacketThe packet received or sent.
[in]EndPointThe UDP address pair corresponds to the UDP IO.
[in]IoStatusThe packet receiving or sending status.
[in]ContextThe user-defined data when calling UdpIoRecvDatagram() or UdpIoSendDatagram().

Given a pointer to a new VM context, debug one or more instructions.

Parameters:
[in]ThisA pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]VmPtrA pointer to a VM context.
Return values:
EFI_UNSUPPORTEDNo support for it.
EFI_SUCCESSDebug one or more instructions.

This function is a prototype for a periodic SMI handler function that may be enabled with PeriodicSmiEnable() and disabled with PeriodicSmiDisable().

Parameters:
[in]ContextContent registered with PeriodicSmiEnable().
[in]ElapsedTimeThe actual time in 100ns units elasped since this function was called. A value of 0 indicates an unknown amount of time.

This function is a prototype for a function that dumps information on a protocol to a given location. The location is dependant on the implementation. This is used when programatically adding shell commands.

Parameters:
[in]HandleThe handle the protocol is on.
[in]InterfaceThe interface to the protocol.

Internal interface to add protocol handlers.

This function is for internal shell use only. This is how protocol handlers are added. This will get the current protocol info and add the new info or update existing info and then resave the info.

Parameters:
[in]ProtocolThe pointer to the protocol's GUID.
[in]DumpTokenThe function pointer to dump token function or NULL.
[in]DumpInfoThe function pointer to dump infomation function or NULL.
[in]IdStringThe English name of the protocol.

This is an internal shell function to free any and all allocated resources. This should be called immediately prior to closing the shell.

This function enables the page break mode.

This mode causes the output to pause after each complete screen to enable a user to more easily read it. If AutoWrap is TRUE, then rows with too many characters will be chopped and divided into 2 rows. If FALSE, then rows with too many characters may not be fully visible to the user on the screen.

Parameters:
[in]StartRowThe row number to start this on.
[in]AutoWrapWhether to auto wrap rows that are too long.

This function disables the page break mode.

Disabling this causes the output to print out exactly as coded, with no breaks for readability.

This function sets the keys to filter for for the console in. The valid values to set are:

#define EFI_OUTPUT_SCROLL 0x00000001 #define EFI_OUTPUT_PAUSE 0x00000002 #define EFI_EXECUTION_BREAK 0x00000004

Parameters:
[in]KeyFilterThe new key filter to use.

This is an internal shell function used to increment the shell nesting level.

This is an internal shell function used to decrement the shell nesting level.

Close the console proxy to restore the original console.

This is an internal shell function to handle shell cascading. It restores the original set of console protocols.

Parameters:
[in]ConInHandleThe handle of ConIn.
[in,out]ConInThe pointer to the location to return the pointer to the original console input.
[in]ConOutHandleThe handle of ConOut
[in,out]ConOutThe pointer to the location to return the pointer to the original console output.

For ease of use the shell maps handle #'s to short numbers. This is only done on request for various internal commands and the references are immediately freed when the internal command completes.

This is an internal shell function to enumerate the handle database.

This must be called after INIT_HANDLE_ENUMERATOR.

This function releases all memory and resources associated with the handle database. After this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will function properly.

This is an internal shell function to initialize the protocol enumerator.

This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO, RESET_PROTOCOL_INFO_ENUMERATOR, and CLOSE_PROTOCOL_INFO_ENUMERATOR are called.

This function is an internal shell function for enumeration of protocols.

This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be called after INIT_PROTOCOL_INFO_ENUMERATOR.

This function resets the list of protocols such that the next one in the list is the begining of the list.

This function is an internal shell function for enumeration of protocols.

This must be called after INIT_PROTOCOL_INFO_ENUMERATOR. After this call no protocol enumerator calls except INIT_PROTOCOL_INFO_ENUMERATOR may be made.

This function frees any memory or resources associated with the protocol enumerator.

a ASM function to transfer control to OS.

Parameters:
S3WakingVectorThe S3 waking up vector saved in ACPI Facs table
AcpiLowMemoryBasea buffer under 1M which could be used during the transfer

Variable Documentation

Definition at line 32 of file AutoGen.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines