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

/**@file\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\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/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
Commit	Line	Data
3db51098	1	/**@file\r
e081218d	2	\r
3db51098	3	Copyright (c) 2006, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
e081218d	11	\r
3db51098	12	**/\r
e081218d	13	\r
e081218d	14	\r
	15	#ifndef _VGA_CLASS_H\r
	16	#define _VGA_CLASS_H\r
	17	\r
	18	#include <PiDxe.h>\r
	19	#include <FrameworkDxe.h>\r
ed7748fe	20	\r
e081218d	21	#include <Protocol/SimpleTextIn.h>\r
	22	#include <Protocol/SimpleTextOut.h>\r
	23	#include <Protocol/PciIo.h>\r
	24	#include <Protocol/VgaMiniPort.h>\r
	25	#include <Protocol/DevicePath.h>\r
ed7748fe	26	\r
e081218d	27	#include <Library/DebugLib.h>\r
	28	#include <Library/UefiDriverEntryPoint.h>\r
	29	#include <Library/BaseLib.h>\r
	30	#include <Library/UefiLib.h>\r
e081218d	31	#include <Library/BaseMemoryLib.h>\r
	32	#include <Library/MemoryAllocationLib.h>\r
	33	#include <Library/UefiBootServicesTableLib.h>\r
	34	#include <Library/ReportStatusCodeLib.h>\r
	35	\r
	36	\r
	37	#include <IndustryStandard/Pci22.h>\r
	38	#include "ComponentName.h"\r
	39	#include <Protocol/VgaMiniPort.h>\r
	40	\r
	41	//\r
	42	// VGA specific registers\r
	43	//\r
	44	#define CRTC_CURSOR_START 0xA\r
	45	#define CRTC_CURSOR_END 0xB\r
	46	\r
	47	#define CRTC_CURSOR_LOCATION_HIGH 0xE\r
	48	#define CRTC_CURSOR_LOCATION_LOW 0xF\r
	49	\r
	50	#define EFI_MAX_ATTRIBUTE 0x7f\r
	51	\r
	52	//\r
	53	// VGA Class Device Structure\r
	54	//\r
	55	#define VGA_CLASS_DEV_SIGNATURE EFI_SIGNATURE_32 ('V', 'G', 'A', 'C')\r
	56	\r
	57	typedef struct {\r
	58	UINTN Signature;\r
	59	EFI_HANDLE Handle;\r
	60	EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SimpleTextOut;\r
	61	EFI_SIMPLE_TEXT_OUTPUT_MODE SimpleTextOutputMode;\r
	62	EFI_VGA_MINI_PORT_PROTOCOL *VgaMiniPort;\r
	63	EFI_PCI_IO_PROTOCOL *PciIo;\r
	64	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	65	} VGA_CLASS_DEV;\r
	66	\r
	67	#define VGA_CLASS_DEV_FROM_THIS(a) CR (a, VGA_CLASS_DEV, SimpleTextOut, VGA_CLASS_DEV_SIGNATURE)\r
	68	\r
	69	//\r
	70	// Global Variables\r
	71	//\r
	72	extern EFI_DRIVER_BINDING_PROTOCOL gVgaClassDriverBinding;\r
	73	\r
	74	//\r
	75	// Driver Binding Protocol functions\r
	76	//\r
	77	EFI_STATUS\r
	78	EFIAPI\r
	79	VgaClassDriverBindingSupported (\r
	80	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	81	IN EFI_HANDLE Controller,\r
	82	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	83	)\r
bcd70414	84	/**\r
e081218d	85	\r
	86	Routine Description:\r
	87	\r
	88	GC_TODO: Add function description\r
	89	\r
	90	Arguments:\r
	91	\r
	92	This - GC_TODO: add argument description\r
	93	Controller - GC_TODO: add argument description\r
	94	RemainingDevicePath - GC_TODO: add argument description\r
	95	\r
	96	Returns:\r
	97	\r
	98	GC_TODO: add return values\r
	99	\r
bcd70414	100	**/\r
e081218d	101	;\r
	102	\r
	103	EFI_STATUS\r
	104	EFIAPI\r
	105	VgaClassDriverBindingStart (\r
	106	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	107	IN EFI_HANDLE Controller,\r
	108	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	109	)\r
bcd70414	110	/**\r
e081218d	111	\r
	112	Routine Description:\r
	113	\r
	114	GC_TODO: Add function description\r
	115	\r
	116	Arguments:\r
	117	\r
	118	This - GC_TODO: add argument description\r
	119	Controller - GC_TODO: add argument description\r
	120	RemainingDevicePath - GC_TODO: add argument description\r
	121	\r
	122	Returns:\r
	123	\r
	124	GC_TODO: add return values\r
	125	\r
bcd70414	126	**/\r
e081218d	127	;\r
	128	\r
	129	EFI_STATUS\r
	130	EFIAPI\r
	131	VgaClassDriverBindingStop (\r
	132	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	133	IN EFI_HANDLE Controller,\r
	134	IN UINTN NumberOfChildren,\r
	135	IN EFI_HANDLE *ChildHandleBuffer\r
	136	)\r
bcd70414	137	/**\r
e081218d	138	\r
	139	Routine Description:\r
	140	\r
	141	GC_TODO: Add function description\r
	142	\r
	143	Arguments:\r
	144	\r
	145	This - GC_TODO: add argument description\r
	146	Controller - GC_TODO: add argument description\r
	147	NumberOfChildren - GC_TODO: add argument description\r
	148	ChildHandleBuffer - GC_TODO: add argument description\r
	149	\r
	150	Returns:\r
	151	\r
	152	GC_TODO: add return values\r
	153	\r
bcd70414	154	**/\r
e081218d	155	;\r
	156	\r
	157	//\r
	158	// Simple Text Output Protocol functions\r
	159	//\r
	160	EFI_STATUS\r
	161	EFIAPI\r
	162	VgaClassReset (\r
	163	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	164	IN BOOLEAN ExtendedVerification\r
	165	)\r
bcd70414	166	/**\r
e081218d	167	\r
	168	Routine Description:\r
	169	\r
	170	GC_TODO: Add function description\r
	171	\r
	172	Arguments:\r
	173	\r
	174	This - GC_TODO: add argument description\r
	175	ExtendedVerification - GC_TODO: add argument description\r
	176	\r
	177	Returns:\r
	178	\r
	179	GC_TODO: add return values\r
	180	\r
bcd70414	181	**/\r
e081218d	182	;\r
	183	\r
	184	EFI_STATUS\r
	185	EFIAPI\r
	186	VgaClassOutputString (\r
	187	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	188	IN CHAR16 *WString\r
	189	)\r
bcd70414	190	/**\r
e081218d	191	\r
	192	Routine Description:\r
	193	\r
	194	GC_TODO: Add function description\r
	195	\r
	196	Arguments:\r
	197	\r
	198	This - GC_TODO: add argument description\r
	199	WString - GC_TODO: add argument description\r
	200	\r
	201	Returns:\r
	202	\r
	203	GC_TODO: add return values\r
	204	\r
bcd70414	205	**/\r
e081218d	206	;\r
	207	\r
	208	EFI_STATUS\r
	209	EFIAPI\r
	210	VgaClassTestString (\r
	211	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	212	IN CHAR16 *WString\r
	213	)\r
bcd70414	214	/**\r
e081218d	215	\r
	216	Routine Description:\r
	217	\r
	218	GC_TODO: Add function description\r
	219	\r
	220	Arguments:\r
	221	\r
	222	This - GC_TODO: add argument description\r
	223	WString - GC_TODO: add argument description\r
	224	\r
	225	Returns:\r
	226	\r
	227	GC_TODO: add return values\r
	228	\r
bcd70414	229	**/\r
e081218d	230	;\r
	231	\r
	232	EFI_STATUS\r
	233	EFIAPI\r
	234	VgaClassClearScreen (\r
	235	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
	236	)\r
bcd70414	237	/**\r
e081218d	238	\r
	239	Routine Description:\r
	240	\r
	241	GC_TODO: Add function description\r
	242	\r
	243	Arguments:\r
	244	\r
	245	This - GC_TODO: add argument description\r
	246	\r
	247	Returns:\r
	248	\r
	249	GC_TODO: add return values\r
	250	\r
bcd70414	251	**/\r
e081218d	252	;\r
	253	\r
	254	EFI_STATUS\r
	255	EFIAPI\r
	256	VgaClassSetAttribute (\r
	257	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	258	IN UINTN Attribute\r
	259	)\r
bcd70414	260	/**\r
e081218d	261	\r
	262	Routine Description:\r
	263	\r
	264	GC_TODO: Add function description\r
	265	\r
	266	Arguments:\r
	267	\r
	268	This - GC_TODO: add argument description\r
	269	Attribute - GC_TODO: add argument description\r
	270	\r
	271	Returns:\r
	272	\r
	273	GC_TODO: add return values\r
	274	\r
bcd70414	275	**/\r
e081218d	276	;\r
	277	\r
	278	EFI_STATUS\r
	279	EFIAPI\r
	280	VgaClassSetCursorPosition (\r
	281	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	282	IN UINTN Column,\r
	283	IN UINTN Row\r
	284	)\r
bcd70414	285	/**\r
e081218d	286	\r
	287	Routine Description:\r
	288	\r
	289	GC_TODO: Add function description\r
	290	\r
	291	Arguments:\r
	292	\r
	293	This - GC_TODO: add argument description\r
	294	Column - GC_TODO: add argument description\r
	295	Row - GC_TODO: add argument description\r
	296	\r
	297	Returns:\r
	298	\r
	299	GC_TODO: add return values\r
	300	\r
bcd70414	301	**/\r
e081218d	302	;\r
	303	\r
	304	EFI_STATUS\r
	305	EFIAPI\r
	306	VgaClassEnableCursor (\r
	307	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	308	IN BOOLEAN Visible\r
	309	)\r
bcd70414	310	/**\r
e081218d	311	\r
	312	Routine Description:\r
	313	\r
	314	GC_TODO: Add function description\r
	315	\r
	316	Arguments:\r
	317	\r
	318	This - GC_TODO: add argument description\r
	319	Visible - GC_TODO: add argument description\r
	320	\r
	321	Returns:\r
	322	\r
	323	GC_TODO: add return values\r
	324	\r
bcd70414	325	**/\r
e081218d	326	;\r
	327	\r
	328	EFI_STATUS\r
	329	EFIAPI\r
	330	VgaClassQueryMode (\r
	331	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	332	IN UINTN ModeNumber,\r
	333	OUT UINTN *Columns,\r
	334	OUT UINTN *Rows\r
	335	)\r
bcd70414	336	/**\r
e081218d	337	\r
	338	Routine Description:\r
	339	\r
	340	GC_TODO: Add function description\r
	341	\r
	342	Arguments:\r
	343	\r
	344	This - GC_TODO: add argument description\r
	345	ModeNumber - GC_TODO: add argument description\r
	346	Columns - GC_TODO: add argument description\r
	347	Rows - GC_TODO: add argument description\r
	348	\r
	349	Returns:\r
	350	\r
	351	GC_TODO: add return values\r
	352	\r
bcd70414	353	**/\r
e081218d	354	;\r
	355	\r
	356	EFI_STATUS\r
	357	EFIAPI\r
	358	VgaClassSetMode (\r
	359	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
	360	IN UINTN ModeNumber\r
	361	)\r
bcd70414	362	/**\r
e081218d	363	\r
	364	Routine Description:\r
	365	\r
	366	GC_TODO: Add function description\r
	367	\r
	368	Arguments:\r
	369	\r
	370	This - GC_TODO: add argument description\r
	371	ModeNumber - GC_TODO: add argument description\r
	372	\r
	373	Returns:\r
	374	\r
	375	GC_TODO: add return values\r
	376	\r
bcd70414	377	**/\r
e081218d	378	;\r
	379	\r
	380	#endif\r