tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

synced function header 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6615 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jgong5 2008-11-18 14:30:46 +00:00
parent 83bcb6613f
commit ed729a0c3c
4 changed files with 88 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.h
View File

@ -27,16 +27,21 @@ extern EFI_COMPONENT_NAME_PROTOCOL gDhcp4ComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2; extern EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2;
/** /**
Test to see if this driver supports ControllerHandle. Test to see if this driver supports ControllerHandle. This service
is called by the EFI boot service ConnectController(). In
order to make drivers as small as possible, there are a few calling
restrictions for this service. ConnectController() must
follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param ControllerHandle Handle of device to test. @param ControllerHandle Handle of device to test
@param RemainingDevicePath Optional parameter use to pick a specific child @param RemainingDevicePath Optional parameter use to pick a specific child
device to start. device to start.
@retval EFI_SUCCES This driver supports this device @retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device. @retval EFI_ALREADY_STARTED This driver is already running on this device
@retval other This driver does not support this device. @retval other This driver does not support this device
**/ **/
EFI_STATUS EFI_STATUS
@ -48,14 +53,19 @@ Dhcp4DriverBindingSupported (
); );
/** /**
Start this driver on ControllerHandle. Start this driver on ControllerHandle. This service is called by the
EFI boot service ConnectController(). In order to make
drivers as small as possible, there are a few calling restrictions for
this service. ConnectController() must follow these
calling restrictions. If any other agent wishes to call Start() it
must also follow these calling restrictions.
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param ControllerHandle Handle of device to bind driver to @param ControllerHandle Handle of device to bind driver to
@param RemainingDevicePath Optional parameter use to pick a specific child @param RemainingDevicePath Optional parameter use to pick a specific child
device to start. device to start.
@retval EFI_SUCCES This driver is added to ControllerHandle @retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device @retval other This driver does not support this device
@ -69,15 +79,20 @@ Dhcp4DriverBindingStart (
); );
/** /**
Stop this driver on ControllerHandle. Stop this driver on ControllerHandle. This service is called by the
EFI boot service DisconnectController(). In order to
make drivers as small as possible, there are a few calling
restrictions for this service. DisconnectController()
must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param ControllerHandle Handle of device to stop driver on @param ControllerHandle Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
of children is zero stop the entire bus driver. children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop. @param ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCES This driver is removed ControllerHandle @retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device @retval other This driver was not removed from this device
**/ **/
@ -94,16 +109,15 @@ Dhcp4DriverBindingStop (
Creates a child handle with a set of I/O services. Creates a child handle with a set of I/O services.
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param ChildHandle Pointer to the handle of the child to create. If @param ChildHandle Pointer to the handle of the child to create. If it is NULL,
it is NULL, then a new handle is created. If it is then a new handle is created. If it is not NULL, then the
not NULL, then the I/O services are added to the I/O services are added to the existing child handle.
existing child handle.
@retval EFI_SUCCES The child handle was created with the I/O @retval EFI_SUCCES The child handle was created with the I/O services
services. @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child. the child
@retval other The child handle was not created. @retval other The child handle was not created
**/ **/
EFI_STATUS EFI_STATUS
@ -117,16 +131,15 @@ Dhcp4ServiceBindingCreateChild (
Destroys a child handle with a set of I/O services. Destroys a child handle with a set of I/O services.
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param ChildHandle Handle of the child to destroy. @param ChildHandle Handle of the child to destroy
@retval EFI_SUCCES The I/O services were removed from the child @retval EFI_SUCCES The I/O services were removed from the child handle
handle.
@retval EFI_UNSUPPORTED The child handle does not support the I/O services @retval EFI_UNSUPPORTED The child handle does not support the I/O services
that are being removed. that are being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle. @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
@retval EFI_ACCESS_DENIED The child handle could not be destroyed because @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its
its I/O services are being used. I/O services are being used.
@retval other The child handle was not destroyed. @retval other The child handle was not destroyed
**/ **/
EFI_STATUS EFI_STATUS

8
MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Impl.h
View File

@ -168,6 +168,14 @@ DhcpYieldControl (
IN DHCP_SERVICE *DhcpSb IN DHCP_SERVICE *DhcpSb
); );
/**
Complete a Dhcp4 transaction and signal the upper layer.
@param Instance Dhcp4 instance.
@return None.
**/
VOID VOID
PxeDhcpDone ( PxeDhcpDone (
IN DHCP_PROTOCOL *Instance IN DHCP_PROTOCOL *Instance

6
MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h
View File

@ -93,7 +93,7 @@ typedef enum {
**/ **/
EFI_STATUS EFI_STATUS
DhcpSetState ( DhcpSetState (
IN DHCP_SERVICE *DhcpSb, IN OUT DHCP_SERVICE *DhcpSb,
IN INTN State, IN INTN State,
IN BOOLEAN CallUser IN BOOLEAN CallUser
); );
@ -114,6 +114,7 @@ DhcpSetState (
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet @retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet
@retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP @retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP
@retval EFI_SUCCESS The message is sent @retval EFI_SUCCESS The message is sent
@retval other Other error occurs
**/ **/
EFI_STATUS EFI_STATUS
@ -146,7 +147,7 @@ DhcpOnTimerTick (
); );
/** /**
Handle the received DHCP packets. This function drivers the DHCP Handle the received DHCP packets. This function drives the DHCP
state machine. state machine.
@param UdpPacket The UDP packets received. @param UdpPacket The UDP packets received.
@ -172,6 +173,7 @@ DhcpInput (
@param DhcpSb The DHCP service instance @param DhcpSb The DHCP service instance
@retval EFI_SUCCESS The request has been sent @retval EFI_SUCCESS The request has been sent
@retval other Some error occurs when sending the request.
**/ **/
EFI_STATUS EFI_STATUS

7
MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
View File

@ -239,7 +239,7 @@ EFI_STATUS
@param Context The opaque parameter for Check @param Context The opaque parameter for Check
@retval EFI_SUCCESS The DHCP packet's options are well formated @retval EFI_SUCCESS The DHCP packet's options are well formated
@retval Others The DHCP packet's options are not well formated @retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated
**/ **/
EFI_STATUS EFI_STATUS
@ -277,7 +277,7 @@ DhcpValidateOptions (
as a UINT8. It then iterates the DHCP packet to get data length of as a UINT8. It then iterates the DHCP packet to get data length of
each option by calling DhcpIterOptions with DhcpGetOptionLen. Now, it each option by calling DhcpIterOptions with DhcpGetOptionLen. Now, it
knows the number of present options and their length. It allocates a knows the number of present options and their length. It allocates a
array of DHCP_OPTION and a continous buffer after the array to put array of DHCP_OPTION and a continuous buffer after the array to put
all the options' data. Each option's data is pointed to by the Data all the options' data. Each option's data is pointed to by the Data
field in DHCP_OPTION structure. At last, it call DhcpIterateOptions field in DHCP_OPTION structure. At last, it call DhcpIterateOptions
with DhcpFillOption to fill each option's data to its position in the with DhcpFillOption to fill each option's data to its position in the
@ -315,7 +315,7 @@ DhcpParseOption (
**/ **/
UINT8 * UINT8 *
DhcpAppendOption ( DhcpAppendOption (
IN UINT8 *Buf, OUT UINT8 *Buf,
IN UINT8 Tag, IN UINT8 Tag,
IN UINT16 DataLen, IN UINT16 DataLen,
IN UINT8 *Data IN UINT8 *Data
@ -334,6 +334,7 @@ DhcpAppendOption (
function. function.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory @retval EFI_OUT_OF_RESOURCES Failed to allocate memory
@retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated
@retval EFI_SUCCESS The packet is build. @retval EFI_SUCCESS The packet is build.
**/ **/