EdkCompatibilityPkg/Foundation/Protocol/DebugMask/DebugMask.h

   1 /*++
   2
   3 Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>
   4 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   DebugMask.h
  15
  16 Abstract:
  17
  18   This protocol is used to abstract the Debug Mask serivces for
  19   the specific driver or application image.
  20
  21 --*/
  22
  23 #ifndef _DEBUG_MASK_H_
  24 #define _DEBUG_MASK_H_
  25
  26 //
  27 //4C8A2451-C207-405b-9694-99EA13251341
  28 //
  29 #define EFI_DEBUG_MASK_PROTOCOL_GUID \
  30   { 0x4c8a2451, 0xc207, 0x405b, {0x96, 0x94, 0x99, 0xea, 0x13, 0x25, 0x13, 0x41} }
  31
  32
  33 #define EFI_DEBUG_MASK_REVISION        0x00010000
  34
  35 //
  36 // Forward reference for pure ANSI compatability
  37 //
  38 EFI_FORWARD_DECLARATION (EFI_DEBUG_MASK_PROTOCOL);
  39
  40 //
  41 // DebugMask member functions definition
  42 //
  43 typedef
  44 EFI_STATUS
  45 (EFIAPI * EFI_GET_DEBUG_MASK) (
  46   IN EFI_DEBUG_MASK_PROTOCOL      *This,             // Calling context
  47   IN OUT UINTN                    *CurrentDebugMask  // Ptr to store current debug mask
  48   );
  49
  50 typedef
  51 EFI_STATUS
  52 (EFIAPI *EFI_SET_DEBUG_MASK) (
  53   IN  EFI_DEBUG_MASK_PROTOCOL     *This,             // Calling context
  54   IN  UINTN                       NewDebugMask       // New Debug Mask value to set
  55   );
  56
  57 //
  58 // DebugMask protocol definition
  59 //
  60 struct _EFI_DEBUG_MASK_PROTOCOL {
  61   INT64                               Revision;
  62   EFI_GET_DEBUG_MASK                  GetDebugMask;
  63   EFI_SET_DEBUG_MASK                  SetDebugMask;
  64 };
  65
  66 extern EFI_GUID gEfiDebugMaskProtocolGuid;
  67
  68 #endif