EdkCompatibilityPkg/Foundation/Protocol/Performance/Performance.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   Performance.h
  15
  16 Abstract:
  17
  18
  19 --*/
  20
  21 #ifndef _EFI_PERFORMANCE_H_
  22 #define _EFI_PERFORMANCE_H_
  23
  24 #define EFI_PERFORMANCE_PROTOCOL_GUID \
  25   { 0xFFECFFFF, 0x923C, 0x14d2, {0x9E, 0x3F, 0x22, 0xA0, 0xC9, 0x69, 0x56, 0x3B} }
  26
  27 #define EFI_NULL_GUID \
  28   { 0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} }
  29
  30
  31 EFI_FORWARD_DECLARATION (EFI_PERFORMANCE_PROTOCOL);
  32
  33 #define DXE_TOK L"DXE"
  34 #define SHELL_TOK L"SHELL"
  35 #define PEI_TOK L"PEI"
  36 #define BDS_TOK L"BDS"
  37 #define DRIVERBINDING_START_TOK L"DriverBinding:Start"
  38 #define DRIVERBINDING_SUPPORT_TOK L"DriverBinding:Support"
  39 #define START_IMAGE_TOK L"StartImage"
  40 #define LOAD_IMAGE_TOK L"LoadImage"
  41
  42 #define DXE_PHASE 0
  43 #define SHELL_PHASE 1
  44 #define PEI_PHASE 2
  45
  46 #define EFI_PERF_TOKEN_LENGTH        32
  47 #define EFI_PERF_HOST_LENGTH         32
  48 #define EFI_PERF_PDBFILENAME_LENGTH  28
  49
  50 typedef struct {
  51   EFI_HANDLE        Handle;
  52   UINT16            Token[EFI_PERF_TOKEN_LENGTH];
  53   UINT16            Host[EFI_PERF_HOST_LENGTH];
  54   UINT64            StartTick;
  55   UINT64            EndTick;
  56   EFI_GUID          GuidName;
  57   CHAR8             PdbFileName[EFI_PERF_PDBFILENAME_LENGTH];
  58   UINT8             Phase;
  59 } EFI_GAUGE_DATA ;
  60
  61
  62 typedef
  63 EFI_STATUS
  64 (EFIAPI * EFI_PERF_START_GAUGE) (
  65   IN EFI_PERFORMANCE_PROTOCOL *This,
  66   IN EFI_HANDLE        Handle,
  67   IN UINT16           *Token,
  68   IN UINT16           *Host,
  69   IN UINT64           Ticker
  70   );
  71
  72 typedef
  73 EFI_STATUS
  74 (EFIAPI * EFI_PERF_END_GAUGE) (
  75   IN EFI_PERFORMANCE_PROTOCOL *This,
  76   IN EFI_HANDLE        Handle,
  77   IN UINT16           *Token,
  78   IN UINT16           *Host,
  79   IN UINT64           Ticker
  80   );
  81
  82
  83 typedef
  84 EFI_GAUGE_DATA *
  85 (EFIAPI * EFI_PERF_GET_GAUGE) (
  86   IN EFI_PERFORMANCE_PROTOCOL *This,
  87   IN EFI_HANDLE                       Handle,
  88   IN UINT16                           *Token,
  89   IN UINT16                           *Host,
  90   IN EFI_GAUGE_DATA                   *PrevGauge
  91   );
  92
  93
  94 struct _EFI_PERFORMANCE_PROTOCOL {
  95   EFI_PERF_START_GAUGE  StartGauge;
  96   EFI_PERF_END_GAUGE    EndGauge;
  97   EFI_PERF_GET_GAUGE    GetGauge;
  98 };
  99
 100 extern EFI_GUID gEfiPerformanceProtocolGuid;
 101
 102 #endif
 103