Tools/Source/TianoTools/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   Module Name:  ServiceBinding.h
  12
  13 **/
  14
  15 #ifndef __EFI_SERVICE_BINDING_H__
  16 #define __EFI_SERVICE_BINDING_H__
  17
  18 //
  19 // Forward reference for pure ANSI compatability
  20 //
  21 typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL;
  22
  23 /**
  24   Creates a child handle with a set of I/O services.
  25
  26   @param  This        Protocol instance pointer.
  27   @param  ChildHandle Pointer to the handle of the child to create.  If it is NULL,
  28                       then a new handle is created.  If it is not NULL, then the
  29                       I/O services are added to the existing child handle.
  30
  31   @retval EFI_SUCCES            The child handle was created with the I/O services
  32   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
  33   @retval EFI_OUT_OF_RESOURCES  There are not enough resources availabe to create
  34                                 the child
  35   @retval other                 The child handle was not created
  36
  37 **/
  38 typedef
  39 EFI_STATUS
  40 (EFIAPI *EFI_SERVICE_BINDING_CREATE_CHILD) (
  41   IN     EFI_SERVICE_BINDING_PROTOCOL  *This,
  42   IN OUT EFI_HANDLE                    *ChildHandle
  43   )
  44 ;
  45
  46 /**
  47   Destroys a child handle with a set of I/O services.
  48
  49   @param  This        Protocol instance pointer.
  50   @param  ChildHandle Handle of the child to destroy
  51
  52   @retval EFI_SUCCES            The I/O services were removed from the child handle
  53   @retval EFI_UNSUPPORTED       The child handle does not support the I/O services
  54                                 that are being removed.
  55   @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
  56   @retval EFI_ACCESS_DENIED     The child handle could not be destroyed because its
  57                                 I/O services are being used.
  58   @retval other                 The child handle was not destroyed
  59
  60 **/
  61 typedef
  62 EFI_STATUS
  63 (EFIAPI *EFI_SERVICE_BINDING_DESTROY_CHILD) (
  64   IN EFI_SERVICE_BINDING_PROTOCOL          *This,
  65   IN EFI_HANDLE                            ChildHandle
  66   )
  67 ;
  68
  69 struct _EFI_SERVICE_BINDING_PROTOCOL {
  70   EFI_SERVICE_BINDING_CREATE_CHILD         CreateChild;
  71   EFI_SERVICE_BINDING_DESTROY_CHILD        DestroyChild;
  72 };
  73
  74 #endif