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