Home | History | Annotate | Download | only in HttpBootDxe
      1 /** @file
      2   The declaration of UEFI HTTP boot function.
      3 
      4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
      5 This program and the accompanying materials are licensed and made available under
      6 the terms and conditions of the BSD License that accompanies this distribution.
      7 The full text of the license may be found at
      8 http://opensource.org/licenses/bsd-license.php.
      9 
     10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
     11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
     12 
     13 **/
     14 #ifndef __EFI_HTTP_BOOT_IMPL_H__
     15 #define __EFI_HTTP_BOOT_IMPL_H__
     16 
     17 /**
     18   Attempt to complete a DHCPv4 D.O.R.A or DHCPv6 S.R.A.A sequence to retrieve the boot resource information.
     19 
     20   @param[in]    Private            The pointer to the driver's private data.
     21 
     22   @retval EFI_SUCCESS              Boot info was successfully retrieved.
     23   @retval EFI_INVALID_PARAMETER    Private is NULL.
     24   @retval EFI_NOT_STARTED          The driver is in stopped state.
     25   @retval EFI_DEVICE_ERROR         An unexpected network error occurred.
     26   @retval Others                   Other errors as indicated.
     27 
     28 **/
     29 EFI_STATUS
     30 HttpBootDhcp (
     31   IN HTTP_BOOT_PRIVATE_DATA           *Private
     32   );
     33 
     34 /**
     35   Disable the use of UEFI HTTP boot function.
     36 
     37   @param[in]    Private            The pointer to the driver's private data.
     38 
     39   @retval EFI_SUCCESS              HTTP boot was successfully disabled.
     40   @retval EFI_NOT_STARTED          The driver is already in stopped state.
     41   @retval EFI_INVALID_PARAMETER    Private is NULL.
     42   @retval Others                   Unexpected error when stop the function.
     43 
     44 **/
     45 EFI_STATUS
     46 HttpBootStop (
     47   IN HTTP_BOOT_PRIVATE_DATA           *Private
     48   );
     49 
     50 #endif
     51