projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| a3bcde70 HT |
1 | /** @file\r |
| 2 | Driver Binding functions declaration for UefiPxeBc Driver.\r | |
| 3 | \r | |
| 4 | Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r | |
| 5 | \r | |
| 6 | This program and the accompanying materials\r | |
| 7 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 8 | which accompanies this distribution. The full text of the license may be found at\r | |
| 9 | http://opensource.org/licenses/bsd-license.php.\r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 13 | \r | |
| 14 | **/\r | |
| 15 | \r | |
| 16 | #ifndef __EFI_PXEBC_DRIVER_H__\r | |
| 17 | #define __EFI_PXEBC_DRIVER_H__\r | |
| 18 | \r | |
| 19 | extern EFI_COMPONENT_NAME_PROTOCOL gPxeBcComponentName;\r | |
| 20 | extern EFI_COMPONENT_NAME2_PROTOCOL gPxeBcComponentName2;\r | |
| 21 | \r | |
| 22 | /**\r | |
| 23 | Test to see if this driver supports ControllerHandle. This service\r | |
| 24 | is called by the EFI boot service ConnectController(). In\r | |
| 25 | order to make drivers as small as possible, there are a few calling\r | |
| 26 | restrictions for this service. ConnectController() must\r | |
| 27 | follow these calling restrictions. If any other agent wishes to call\r | |
| 28 | Supported() it must also follow these calling restrictions.\r | |
| 29 | \r | |
| 30 | @param[in] This The pointer to the driver binding protocol.\r | |
| 31 | @param[in] ControllerHandle The handle of device to be tested.\r | |
| 32 | @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r | |
| 33 | device to be started.\r | |
| 34 | \r | |
| 35 | @retval EFI_SUCCESS This driver supports this device.\r | |
| 36 | @retval EFI_UNSUPPORTED This driver does not support this device.\r | |
| 37 | \r | |
| 38 | **/\r | |
| 39 | EFI_STATUS\r | |
| 40 | EFIAPI\r | |
| 41 | PxeBcDriverBindingSupported (\r | |
| 42 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 43 | IN EFI_HANDLE ControllerHandle,\r | |
| 44 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
| 45 | );\r | |
| 46 | \r | |
| 47 | \r | |
| 48 | /**\r | |
| 49 | Start this driver on ControllerHandle. This service is called by the\r | |
| 50 | EFI boot service ConnectController(). In order to make\r | |
| 51 | drivers as small as possible, there are a few calling restrictions for\r | |
| 52 | this service. ConnectController() must follow these\r | |
| 53 | calling restrictions. If any other agent wishes to call Start() it\r | |
| 54 | must also follow these calling restrictions.\r | |
| 55 | \r | |
| 56 | @param[in] This The pointer to the driver binding protocol.\r | |
| 57 | @param[in] ControllerHandle The handle of device to be started.\r | |
| 58 | @param[in] RemainingDevicePath Optional parameter used to pick a specific child\r | |
| 59 | device to be started.\r | |
| 60 | \r | |
| 61 | @retval EFI_SUCCESS This driver is installed to ControllerHandle.\r | |
| 62 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.\r | |
| 63 | @retval other This driver does not support this device.\r | |
| 64 | \r | |
| 65 | **/\r | |
| 66 | EFI_STATUS\r | |
| 67 | EFIAPI\r | |
| 68 | PxeBcDriverBindingStart (\r | |
| 69 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 70 | IN EFI_HANDLE ControllerHandle,\r | |
| 71 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
| 72 | );\r | |
| 73 | \r | |
| 74 | \r | |
| 75 | /**\r | |
| 76 | Stop this driver on ControllerHandle. This service is called by the\r | |
| 77 | EFI boot service DisconnectController(). In order to\r | |
| 78 | make drivers as small as possible, there are a few calling\r | |
| 79 | restrictions for this service. DisconnectController()\r | |
| 80 | must follow these calling restrictions. If any other agent wishes\r | |
| 81 | to call Stop() it must also follow these calling restrictions.\r | |
| 82 | \r | |
| 83 | @param[in] This Protocol instance pointer.\r | |
| 84 | @param[in] ControllerHandle Handle of device to stop driver on\r | |
| 85 | @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
| 86 | children is zero stop the entire bus driver.\r | |
| 87 | @param[in] ChildHandleBuffer List of Child Handles to Stop.\r | |
| 88 | \r | |
| 89 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
| 90 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
| 91 | @retval Others This driver was not removed from this device.\r | |
| 92 | \r | |
| 93 | **/\r | |
| 94 | EFI_STATUS\r | |
| 95 | EFIAPI\r | |
| 96 | PxeBcDriverBindingStop (\r | |
| 97 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
| 98 | IN EFI_HANDLE ControllerHandle,\r | |
| 99 | IN UINTN NumberOfChildren,\r | |
| 100 | IN EFI_HANDLE *ChildHandleBuffer\r | |
| 101 | );\r | |
| 102 | \r | |
| 103 | #endif\r | |
| 104 | \r |