MdePkg/Include/Protocol/ServiceBinding.h

   1 /** @file
   2   Copyright (c) 2006, Intel Corporation
   3   All rights reserved. This program and the accompanying materials
   4   are licensed and made available under the terms and conditions of the BSD License
   5   which accompanies this distribution.  The full text of the license may be found at
   6   http://opensource.org/licenses/bsd-license.php
   7
   8   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   9   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  10
  11 **/
  12
  13 #ifndef __EFI_SERVICE_BINDING_H__
  14 #define __EFI_SERVICE_BINDING_H__
  15
  16 //
  17 // Forward reference for pure ANSI compatability
  18 //
  19 typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL;
  20
  21 /**
  22   Creates a child handle with a set of I/O services.
  23
  24   @param  This        Protocol instance pointer.
  25   @param  ChildHandle Pointer to the handle of the child to create.  If it is NULL,
  26                       then a new handle is created.  If it is not NULL, then the
  27                       I/O services are added to the existing child handle.
  28
  29   @retval EFI_SUCCES            The child handle was created with the I/O services
  30   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
  31   @retval EFI_OUT_OF_RESOURCES  There are not enough resources availabe to create
  32                                 the child
  33   @retval other                 The child handle was not created
  34
  35 **/
  36 typedef
  37 EFI_STATUS
  38 (EFIAPI *EFI_SERVICE_BINDING_CREATE_CHILD) (
  39   IN     EFI_SERVICE_BINDING_PROTOCOL  *This,
  40   IN OUT EFI_HANDLE                    *ChildHandle
  41   )
  42 ;
  43
  44 /**
  45   Destroys a child handle with a set of I/O services.
  46
  47   @param  This        Protocol instance pointer.
  48   @param  ChildHandle Handle of the child to destroy
  49
  50   @retval EFI_SUCCES            The I/O services were removed from the child handle
  51   @retval EFI_UNSUPPORTED       The child handle does not support the I/O services
  52                                 that are being removed.
  53   @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
  54   @retval EFI_ACCESS_DENIED     The child handle could not be destroyed because its
  55                                 I/O services are being used.
  56   @retval other                 The child handle was not destroyed
  57
  58 **/
  59 typedef
  60 EFI_STATUS
  61 (EFIAPI *EFI_SERVICE_BINDING_DESTROY_CHILD) (
  62   IN EFI_SERVICE_BINDING_PROTOCOL          *This,
  63   IN EFI_HANDLE                            ChildHandle
  64   )
  65 ;
  66
  67 struct _EFI_SERVICE_BINDING_PROTOCOL {
  68   EFI_SERVICE_BINDING_CREATE_CHILD         CreateChild;
  69   EFI_SERVICE_BINDING_DESTROY_CHILD        DestroyChild;
  70 };
  71
  72 #endif