MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h

   1 /** @file
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   Udp4Driver.h
  15
  16 Abstract:
  17
  18
  19 **/
  20
  21 #ifndef _UDP4_DRIVER_H_
  22 #define _UDP4_DRIVER_H_
  23
  24 #include <PiDxe.h>
  25 #include <Library/BaseLib.h>
  26 #include <Library/NetLib.h>
  27 #include <Protocol/DriverBinding.h>
  28 #include <Protocol/ServiceBinding.h>
  29
  30 /**
  31   Test to see if this driver supports ControllerHandle. This service
  32   is called by the EFI boot service ConnectController(). In
  33   order to make drivers as small as possible, there are a few calling
  34   restrictions for this service. ConnectController() must
  35   follow these calling restrictions. If any other agent wishes to call
  36   Supported() it must also follow these calling restrictions.
  37
  38   @param  This                Protocol instance pointer.
  39   @param  ControllerHandle    Handle of device to test
  40   @param  RemainingDevicePath Optional parameter use to pick a specific child
  41                               device to start.
  42
  43   @retval EFI_SUCCESS         This driver supports this device
  44   @retval EFI_ALREADY_STARTED This driver is already running on this device
  45   @retval other               This driver does not support this device
  46
  47 **/
  48 EFI_STATUS
  49 EFIAPI
  50 Udp4DriverBindingSupported (
  51   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  52   IN EFI_HANDLE                   ControllerHandle,
  53   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath  OPTIONAL
  54   );
  55
  56 /**
  57   Start this driver on ControllerHandle. This service is called by the
  58   EFI boot service ConnectController(). In order to make
  59   drivers as small as possible, there are a few calling restrictions for
  60   this service. ConnectController() must follow these
  61   calling restrictions. If any other agent wishes to call Start() it
  62   must also follow these calling restrictions.
  63
  64   @param  This                 Protocol instance pointer.
  65   @param  ControllerHandle     Handle of device to bind driver to
  66   @param  RemainingDevicePath  Optional parameter use to pick a specific child
  67                                device to start.
  68
  69   @retval EFI_SUCCESS          This driver is added to ControllerHandle
  70   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle
  71   @retval other                This driver does not support this device
  72
  73 **/
  74 EFI_STATUS
  75 EFIAPI
  76 Udp4DriverBindingStart (
  77   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  78   IN EFI_HANDLE                   ControllerHandle,
  79   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath  OPTIONAL
  80   );
  81
  82 /**
  83   Stop this driver on ControllerHandle. This service is called by the
  84   EFI boot service DisconnectController(). In order to
  85   make drivers as small as possible, there are a few calling
  86   restrictions for this service. DisconnectController()
  87   must follow these calling restrictions. If any other agent wishes
  88   to call Stop() it must also follow these calling restrictions.
  89
  90   @param  This              Protocol instance pointer.
  91   @param  ControllerHandle  Handle of device to stop driver on
  92   @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
  93                             children is zero stop the entire bus driver.
  94   @param  ChildHandleBuffer List of Child Handles to Stop.
  95
  96   @retval EFI_SUCCESS       This driver is removed ControllerHandle
  97   @retval other             This driver was not removed from this device
  98
  99 **/
 100 EFI_STATUS
 101 EFIAPI
 102 Udp4DriverBindingStop (
 103   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
 104   IN  EFI_HANDLE                   ControllerHandle,
 105   IN  UINTN                        NumberOfChildren,
 106   IN  EFI_HANDLE                   *ChildHandleBuffer
 107   );
 108
 109 /**
 110   Creates a child handle with a set of I/O services.
 111
 112   @param  This        Protocol instance pointer.
 113   @param  ChildHandle Pointer to the handle of the child to create.  If it is NULL,
 114                       then a new handle is created.  If it is not NULL, then the
 115                       I/O services are added to the existing child handle.
 116
 117   @retval EFI_SUCCES            The child handle was created with the I/O services
 118   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
 119   @retval EFI_OUT_OF_RESOURCES  There are not enough resources availabe to create
 120                                 the child
 121   @retval other                 The child handle was not created
 122
 123 **/
 124 EFI_STATUS
 125 EFIAPI
 126 Udp4ServiceBindingCreateChild (
 127   IN EFI_SERVICE_BINDING_PROTOCOL  *This,
 128   IN EFI_HANDLE                    *ChildHandle
 129   );
 130
 131 /**
 132   Destroys a child handle with a set of I/O services.
 133
 134   @param  This        Protocol instance pointer.
 135   @param  ChildHandle Handle of the child to destroy
 136
 137   @retval EFI_SUCCES            The I/O services were removed from the child handle
 138   @retval EFI_UNSUPPORTED       The child handle does not support the I/O services
 139                                 that are being removed.
 140   @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
 141   @retval EFI_ACCESS_DENIED     The child handle could not be destroyed because its
 142                                 I/O services are being used.
 143   @retval other                 The child handle was not destroyed
 144
 145 **/
 146 EFI_STATUS
 147 EFIAPI
 148 Udp4ServiceBindingDestroyChild (
 149   IN EFI_SERVICE_BINDING_PROTOCOL  *This,
 150   IN EFI_HANDLE                    ChildHandle
 151   );
 152
 153 #endif
 154