MdeModulePkg/Include/Protocol/Print.h

   1 /*++
   2
   3 Copyright (c) 2006 - 2007, Intel Corporation
   4 All rights reserved. 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   Print.h
  15
  16 Abstract:
  17
  18   This file defines the Print protocol
  19
  20 --*/
  21
  22 #ifndef __PPRINT_H__
  23 #define __PPRINT_H__
  24
  25 #define EFI_PRINT_PROTOCOL_GUID  \
  26    { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0xc, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0xc } }
  27
  28 //
  29 // Forward reference for pure ANSI compatability
  30 //
  31 typedef struct _EFI_PRINT_PROTOCOL  EFI_PRINT_PROTOCOL;
  32
  33
  34 typedef
  35 UINTN
  36 (EFIAPI *UNI_VSPRINT) (
  37   OUT CHAR16        *StartOfBuffer,
  38   IN  UINTN         BufferSize,
  39   IN  CONST CHAR16  *FormatString,
  40   IN  VA_LIST       Marker
  41   );
  42
  43 typedef
  44 UINTN
  45 (EFIAPI *UNI_VSPRINT_ASCII) (
  46   OUT CHAR16       *StartOfBuffer,
  47   IN  UINTN        BufferSize,
  48   IN  CONST CHAR8  *FormatString,
  49   IN  VA_LIST      Marker
  50   );
  51
  52 typedef
  53 UINTN
  54 (EFIAPI *VALUE_TO_UNISTRING) (
  55   IN OUT CHAR16  *Buffer,
  56   IN UINTN       Flags,
  57   IN INT64       Value,
  58   IN UINTN       Width
  59   );
  60
  61 typedef
  62 UINTN
  63 (EFIAPI *ASCII_VSPRINT) (
  64   OUT CHAR8         *StartOfBuffer,
  65   IN  UINTN         BufferSize,
  66   IN  CONST CHAR8   *FormatString,
  67   IN  VA_LIST       Marker
  68   );
  69
  70 typedef
  71 UINTN
  72 (EFIAPI *ASCII_VSPRINT_UNI) (
  73   OUT CHAR8         *StartOfBuffer,
  74   IN  UINTN         BufferSize,
  75   IN  CONST CHAR16  *FormatString,
  76   IN  VA_LIST       Marker
  77   );
  78
  79 typedef
  80 UINTN
  81 (EFIAPI *VALUE_TO_ASCIISTRING) (
  82   IN OUT CHAR8  *Buffer,
  83   IN UINTN      Flags,
  84   IN INT64      Value,
  85   IN UINTN      Width
  86   );
  87
  88 struct _EFI_PRINT_PROTOCOL {
  89   UNI_VSPRINT               VSPrint;
  90   UNI_VSPRINT_ASCII         UniVSPrintAscii;
  91   VALUE_TO_UNISTRING        UniValueToString;
  92   ASCII_VSPRINT             AsciiVSPrint;
  93   ASCII_VSPRINT_UNI         AsciiVSPrintUni;
  94   VALUE_TO_ASCIISTRING      AsciiValueToString;
  95 };
  96
  97 extern EFI_GUID gEfiPrintProtocolGuid;
  98
  99 #endif