1) Remove Protocol/AcpiS3Save.h from IntelFrameworkPkg, which should be defined in...

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / Console / VgaClassDxe / VgaClass.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation. All rights reserved. \r
This software and associated documentation (if any) is furnished\r
under a license and may only be used or copied in accordance\r
with the terms of the license. Except as permitted by such\r
license, no part of this software or documentation may be\r
reproduced, stored in a retrieval system, or transmitted in any\r
form or by any means without the express written consent of\r
Intel Corporation.\r
\r
\r
Module Name:\r
\r
    VgaClass.h\r
    \r
Abstract: \r
    \r
\r
Revision History\r
--*/\r
\r
#ifndef _VGA_CLASS_H\r
#define _VGA_CLASS_H\r
\r
#include <PiDxe.h>\r
#include <FrameworkDxe.h>\r
\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/SimpleTextOut.h>\r
#include <Protocol/PciIo.h>\r
#include <Protocol/VgaMiniPort.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
\r
\r
#include <IndustryStandard/Pci22.h>\r
#include "ComponentName.h"\r
#include <Protocol/VgaMiniPort.h>\r
\r
//\r
// VGA specific registers\r
//\r
#define CRTC_CURSOR_START         0xA\r
#define CRTC_CURSOR_END           0xB\r
\r
#define CRTC_CURSOR_LOCATION_HIGH 0xE\r
#define CRTC_CURSOR_LOCATION_LOW  0xF\r
\r
#define EFI_MAX_ATTRIBUTE         0x7f\r
\r
//\r
// VGA Class Device Structure\r
//\r
#define VGA_CLASS_DEV_SIGNATURE EFI_SIGNATURE_32 ('V', 'G', 'A', 'C')\r
\r
typedef struct {\r
  UINTN                         Signature;\r
  EFI_HANDLE                    Handle;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL  SimpleTextOut;\r
  EFI_SIMPLE_TEXT_OUTPUT_MODE   SimpleTextOutputMode;\r
  EFI_VGA_MINI_PORT_PROTOCOL    *VgaMiniPort;\r
  EFI_PCI_IO_PROTOCOL           *PciIo;\r
  EFI_DEVICE_PATH_PROTOCOL      *DevicePath;\r
} VGA_CLASS_DEV;\r
\r
#define VGA_CLASS_DEV_FROM_THIS(a)  CR (a, VGA_CLASS_DEV, SimpleTextOut, VGA_CLASS_DEV_SIGNATURE)\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gVgaClassDriverBinding;\r
\r
//\r
// Driver Binding Protocol functions\r
//\r
EFI_STATUS\r
EFIAPI\r
VgaClassDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  IN EFI_HANDLE                    Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This                - GC_TODO: add argument description\r
  Controller          - GC_TODO: add argument description\r
  RemainingDevicePath - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL   *This,\r
  IN EFI_HANDLE                    Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This                - GC_TODO: add argument description\r
  Controller          - GC_TODO: add argument description\r
  RemainingDevicePath - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Controller,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This              - GC_TODO: add argument description\r
  Controller        - GC_TODO: add argument description\r
  NumberOfChildren  - GC_TODO: add argument description\r
  ChildHandleBuffer - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
//\r
// Simple Text Output Protocol functions\r
//\r
EFI_STATUS\r
EFIAPI\r
VgaClassReset (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  BOOLEAN                      ExtendedVerification\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This                  - GC_TODO: add argument description\r
  ExtendedVerification  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassOutputString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  CHAR16                       *WString\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This    - GC_TODO: add argument description\r
  WString - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassTestString (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  CHAR16                       *WString\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This    - GC_TODO: add argument description\r
  WString - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassClearScreen (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassSetAttribute (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  UINTN                        Attribute\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This      - GC_TODO: add argument description\r
  Attribute - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassSetCursorPosition (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  UINTN                        Column,\r
  IN  UINTN                        Row\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This    - GC_TODO: add argument description\r
  Column  - GC_TODO: add argument description\r
  Row     - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassEnableCursor (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  BOOLEAN                      Visible\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This    - GC_TODO: add argument description\r
  Visible - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassQueryMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  UINTN                        ModeNumber,\r
  OUT UINTN                        *Columns,\r
  OUT UINTN                        *Rows\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This        - GC_TODO: add argument description\r
  ModeNumber  - GC_TODO: add argument description\r
  Columns     - GC_TODO: add argument description\r
  Rows        - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
VgaClassSetMode (\r
  IN  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
  IN  UINTN                        ModeNumber\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  GC_TODO: Add function description\r
\r
Arguments:\r
\r
  This        - GC_TODO: add argument description\r
  ModeNumber  - GC_TODO: add argument description\r
\r
Returns:\r
\r
  GC_TODO: add return values\r
\r
--*/\r
;\r
\r
#endif\r