[mirror_edk2.git] / EdkModulePkg / Bus / Pci / CirrusLogic / Dxe / CirrusLogic5430.h

/** @file\r
  Cirrus Logic 5430 Controller Driver\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
// Cirrus Logic 5430 Controller Driver\r
//\r
\r
#ifndef _CIRRUS_LOGIC_5430_H_\r
#define _CIRRUS_LOGIC_5430_H_\r
\r
\r
#include <IndustryStandard/pci22.h>\r
//\r
// Cirrus Logic 5430 PCI Configuration Header values\r
//\r
#define CIRRUS_LOGIC_VENDOR_ID                0x1013\r
#define CIRRUS_LOGIC_5430_DEVICE_ID           0x00a8\r
#define CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID 0x00a0\r
#define CIRRUS_LOGIC_5446_DEVICE_ID           0x00b8\r
\r
//\r
// Cirrus Logic Graphical Mode Data\r
//\r
#define CIRRUS_LOGIC_5430_UGA_DRAW_MODE_COUNT 3\r
\r
typedef struct {\r
  UINT32  HorizontalResolution;\r
  UINT32  VerticalResolution;\r
  UINT32  ColorDepth;\r
  UINT32  RefreshRate;\r
} CIRRUS_LOGIC_5430_UGA_DRAW_MODE_DATA;\r
\r
//\r
// Cirrus Logic 5440 Private Data Structure\r
//\r
#define CIRRUS_LOGIC_5430_PRIVATE_DATA_SIGNATURE  EFI_SIGNATURE_32 ('C', 'L', '5', '4')\r
\r
typedef struct {\r
  UINT64                                Signature;\r
  EFI_HANDLE                            Handle;\r
  EFI_PCI_IO_PROTOCOL                   *PciIo;\r
  EFI_UGA_DRAW_PROTOCOL                 UgaDraw;\r
\r
  //\r
  // UGA Draw Private Data\r
  //\r
  BOOLEAN                               HardwareNeedsStarting;\r
  UINTN                                 CurrentMode;\r
  UINTN                                 MaxMode;\r
  CIRRUS_LOGIC_5430_UGA_DRAW_MODE_DATA  ModeData[CIRRUS_LOGIC_5430_UGA_DRAW_MODE_COUNT];\r
  UINT8                                 *LineBuffer;\r
} CIRRUS_LOGIC_5430_PRIVATE_DATA;\r
\r
///\r
/// Video Mode structure\r
///\r
typedef struct {\r
  UINT32  Width;\r
  UINT32  Height;\r
  UINT32  ColorDepth;\r
  UINT32  RefreshRate;\r
  UINT8   *CrtcSettings;\r
  UINT16  *SeqSettings;\r
  UINT8   MiscSetting;\r
} CIRRUS_LOGIC_5430_VIDEO_MODES;\r
\r
#define CIRRUS_LOGIC_5430_PRIVATE_DATA_FROM_UGA_DRAW_THIS(a) \\r
  CR(a, CIRRUS_LOGIC_5430_PRIVATE_DATA, UgaDraw, CIRRUS_LOGIC_5430_PRIVATE_DATA_SIGNATURE)\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gCirrusLogic5430DriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gCirrusLogic5430ComponentName;\r
\r
//\r
// Io Registers defined by VGA\r
//\r
#define CRTC_ADDRESS_REGISTER   0x3d4\r
#define CRTC_DATA_REGISTER      0x3d5\r
#define SEQ_ADDRESS_REGISTER    0x3c4\r
#define SEQ_DATA_REGISTER       0x3c5\r
#define GRAPH_ADDRESS_REGISTER  0x3ce\r
#define GRAPH_DATA_REGISTER     0x3cf\r
#define ATT_ADDRESS_REGISTER    0x3c0\r
#define MISC_OUTPUT_REGISTER    0x3c2\r
#define INPUT_STATUS_1_REGISTER 0x3da\r
#define DAC_PIXEL_MASK_REGISTER 0x3c6\r
#define PALETTE_INDEX_REGISTER  0x3c8\r
#define PALETTE_DATA_REGISTER   0x3c9\r
\r
//\r
// UGA Draw Hardware abstraction internal worker functions\r
//\r
/**\r
  TODO: Add function description\r
\r
  @param  Private TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
CirrusLogic5430UgaDrawConstructor (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private\r
  )\r
;\r
\r
/**\r
  TODO: Add function description\r
\r
  @param  Private TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
CirrusLogic5430UgaDrawDestructor (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private\r
  )\r
;\r
\r
//\r
// EFI 1.1 driver model prototypes for Cirrus Logic 5430 UGA Draw\r
//\r
/**\r
  TODO: Add function description\r
\r
  @param  ImageHandle TODO: add argument description\r
  @param  SystemTable TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430DriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
;\r
\r
//\r
// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface\r
//\r
/**\r
  TODO: Add function description\r
\r
  @param  This TODO: add argument description\r
  @param  Controller TODO: add argument description\r
  @param  RemainingDevicePath TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
;\r
\r
/**\r
  TODO: Add function description\r
\r
  @param  This TODO: add argument description\r
  @param  Controller TODO: add argument description\r
  @param  RemainingDevicePath TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  )\r
;\r
\r
/**\r
  TODO: Add function description\r
\r
  @param  This TODO: add argument description\r
  @param  Controller TODO: add argument description\r
  @param  NumberOfChildren TODO: add argument description\r
  @param  ChildHandleBuffer TODO: add argument description\r
\r
  TODO: add return values\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ControllerDriverStop (\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
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
CirrusLogic5430ComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
//\r
// Local Function Prototypes\r
//\r
VOID\r
InitializeGraphicsMode (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,\r
  CIRRUS_LOGIC_5430_VIDEO_MODES   *ModeData\r
  );\r
\r
VOID\r
SetPaletteColor (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,\r
  UINTN                           Index,\r
  UINT8                           Red,\r
  UINT8                           Green,\r
  UINT8                           Blue\r
  );\r
\r
VOID\r
SetDefaultPalette (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private\r
  );\r
\r
VOID\r
DrawLogo (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private\r
  );\r
\r
VOID\r
outb (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,\r
  UINTN                           Address,\r
  UINT8                           Data\r
  );\r
\r
VOID\r
outw (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,\r
  UINTN                           Address,\r
  UINT16                          Data\r
  );\r
\r
UINT8\r
inb (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,\r
  UINTN                           Address\r
  );\r
\r
UINT16\r
inw (\r
  CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private,\r
  UINTN                           Address\r
  );\r
\r
#endif\r
Commit	Line	Data
ed72955c	1	/** @file\r
878ddf1f	2	Cirrus Logic 5430 Controller Driver\r
878ddf1f	3	\r
ed72955c	4	Copyright (c) 2006, Intel Corporation \r
	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
878ddf1f	9	\r
ed72955c	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	**/\r
878ddf1f	14	\r
	15	//\r
	16	// Cirrus Logic 5430 Controller Driver\r
	17	//\r
	18	\r
	19	#ifndef _CIRRUS_LOGIC_5430_H_\r
	20	#define _CIRRUS_LOGIC_5430_H_\r
	21	\r
	22	\r
f0ec738d	23	#include <IndustryStandard/pci22.h>\r
878ddf1f	24	//\r
	25	// Cirrus Logic 5430 PCI Configuration Header values\r
	26	//\r
	27	#define CIRRUS_LOGIC_VENDOR_ID 0x1013\r
	28	#define CIRRUS_LOGIC_5430_DEVICE_ID 0x00a8\r
	29	#define CIRRUS_LOGIC_5430_ALTERNATE_DEVICE_ID 0x00a0\r
	30	#define CIRRUS_LOGIC_5446_DEVICE_ID 0x00b8\r
	31	\r
	32	//\r
	33	// Cirrus Logic Graphical Mode Data\r
	34	//\r
	35	#define CIRRUS_LOGIC_5430_UGA_DRAW_MODE_COUNT 3\r
	36	\r
	37	typedef struct {\r
	38	UINT32 HorizontalResolution;\r
	39	UINT32 VerticalResolution;\r
	40	UINT32 ColorDepth;\r
	41	UINT32 RefreshRate;\r
	42	} CIRRUS_LOGIC_5430_UGA_DRAW_MODE_DATA;\r
	43	\r
	44	//\r
	45	// Cirrus Logic 5440 Private Data Structure\r
	46	//\r
	47	#define CIRRUS_LOGIC_5430_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('C', 'L', '5', '4')\r
	48	\r
	49	typedef struct {\r
	50	UINT64 Signature;\r
	51	EFI_HANDLE Handle;\r
	52	EFI_PCI_IO_PROTOCOL *PciIo;\r
	53	EFI_UGA_DRAW_PROTOCOL UgaDraw;\r
	54	\r
	55	//\r
	56	// UGA Draw Private Data\r
	57	//\r
	58	BOOLEAN HardwareNeedsStarting;\r
	59	UINTN CurrentMode;\r
	60	UINTN MaxMode;\r
	61	CIRRUS_LOGIC_5430_UGA_DRAW_MODE_DATA ModeData[CIRRUS_LOGIC_5430_UGA_DRAW_MODE_COUNT];\r
	62	UINT8 *LineBuffer;\r
	63	} CIRRUS_LOGIC_5430_PRIVATE_DATA;\r
	64	\r
92dda53e	65	///\r
	66	/// Video Mode structure\r
	67	///\r
	68	typedef struct {\r
	69	UINT32 Width;\r
	70	UINT32 Height;\r
	71	UINT32 ColorDepth;\r
	72	UINT32 RefreshRate;\r
	73	UINT8 *CrtcSettings;\r
	74	UINT16 *SeqSettings;\r
	75	UINT8 MiscSetting;\r
	76	} CIRRUS_LOGIC_5430_VIDEO_MODES;\r
	77	\r
878ddf1f	78	#define CIRRUS_LOGIC_5430_PRIVATE_DATA_FROM_UGA_DRAW_THIS(a) \\r
	79	CR(a, CIRRUS_LOGIC_5430_PRIVATE_DATA, UgaDraw, CIRRUS_LOGIC_5430_PRIVATE_DATA_SIGNATURE)\r
	80	\r
	81	//\r
	82	// Global Variables\r
	83	//\r
	84	extern EFI_DRIVER_BINDING_PROTOCOL gCirrusLogic5430DriverBinding;\r
	85	extern EFI_COMPONENT_NAME_PROTOCOL gCirrusLogic5430ComponentName;\r
	86	\r
	87	//\r
	88	// Io Registers defined by VGA\r
	89	//\r
	90	#define CRTC_ADDRESS_REGISTER 0x3d4\r
	91	#define CRTC_DATA_REGISTER 0x3d5\r
	92	#define SEQ_ADDRESS_REGISTER 0x3c4\r
	93	#define SEQ_DATA_REGISTER 0x3c5\r
	94	#define GRAPH_ADDRESS_REGISTER 0x3ce\r
	95	#define GRAPH_DATA_REGISTER 0x3cf\r
	96	#define ATT_ADDRESS_REGISTER 0x3c0\r
	97	#define MISC_OUTPUT_REGISTER 0x3c2\r
	98	#define INPUT_STATUS_1_REGISTER 0x3da\r
	99	#define DAC_PIXEL_MASK_REGISTER 0x3c6\r
	100	#define PALETTE_INDEX_REGISTER 0x3c8\r
	101	#define PALETTE_DATA_REGISTER 0x3c9\r
	102	\r
	103	//\r
	104	// UGA Draw Hardware abstraction internal worker functions\r
	105	//\r
ed72955c	106	/**\r
	107	TODO: Add function description\r
	108	\r
	109	@param Private TODO: add argument description\r
	110	\r
	111	TODO: add return values\r
	112	\r
	113	**/\r
878ddf1f	114	EFI_STATUS\r
	115	CirrusLogic5430UgaDrawConstructor (\r
	116	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private\r
	117	)\r
ed72955c	118	;\r
878ddf1f	119	\r
ed72955c	120	/**\r
878ddf1f	121	TODO: Add function description\r
878ddf1f	122	\r
ed72955c	123	@param Private TODO: add argument description\r
878ddf1f	124	\r
	125	TODO: add return values\r
	126	\r
ed72955c	127	**/\r
878ddf1f	128	EFI_STATUS\r
	129	CirrusLogic5430UgaDrawDestructor (\r
	130	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private\r
	131	)\r
ed72955c	132	;\r
878ddf1f	133	\r
ed72955c	134	//\r
	135	// EFI 1.1 driver model prototypes for Cirrus Logic 5430 UGA Draw\r
	136	//\r
	137	/**\r
878ddf1f	138	TODO: Add function description\r
878ddf1f	139	\r
ed72955c	140	@param ImageHandle TODO: add argument description\r
ed72955c	141	@param SystemTable TODO: add argument description\r
878ddf1f	142	\r
	143	TODO: add return values\r
	144	\r
ed72955c	145	**/\r
878ddf1f	146	EFI_STATUS\r
	147	EFIAPI\r
	148	CirrusLogic5430DriverEntryPoint (\r
	149	IN EFI_HANDLE ImageHandle,\r
	150	IN EFI_SYSTEM_TABLE *SystemTable\r
	151	)\r
ed72955c	152	;\r
878ddf1f	153	\r
ed72955c	154	//\r
	155	// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface\r
	156	//\r
	157	/**\r
878ddf1f	158	TODO: Add function description\r
878ddf1f	159	\r
ed72955c	160	@param This TODO: add argument description\r
	161	@param Controller TODO: add argument description\r
	162	@param RemainingDevicePath TODO: add argument description\r
878ddf1f	163	\r
	164	TODO: add return values\r
	165	\r
ed72955c	166	**/\r
878ddf1f	167	EFI_STATUS\r
	168	EFIAPI\r
	169	CirrusLogic5430ControllerDriverSupported (\r
	170	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	171	IN EFI_HANDLE Controller,\r
	172	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	173	)\r
ed72955c	174	;\r
878ddf1f	175	\r
ed72955c	176	/**\r
878ddf1f	177	TODO: Add function description\r
878ddf1f	178	\r
ed72955c	179	@param This TODO: add argument description\r
	180	@param Controller TODO: add argument description\r
	181	@param RemainingDevicePath TODO: add argument description\r
878ddf1f	182	\r
	183	TODO: add return values\r
	184	\r
ed72955c	185	**/\r
878ddf1f	186	EFI_STATUS\r
	187	EFIAPI\r
	188	CirrusLogic5430ControllerDriverStart (\r
	189	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	190	IN EFI_HANDLE Controller,\r
	191	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
	192	)\r
ed72955c	193	;\r
878ddf1f	194	\r
ed72955c	195	/**\r
878ddf1f	196	TODO: Add function description\r
878ddf1f	197	\r
ed72955c	198	@param This TODO: add argument description\r
	199	@param Controller TODO: add argument description\r
	200	@param NumberOfChildren TODO: add argument description\r
	201	@param ChildHandleBuffer TODO: add argument description\r
878ddf1f	202	\r
	203	TODO: add return values\r
	204	\r
ed72955c	205	**/\r
878ddf1f	206	EFI_STATUS\r
	207	EFIAPI\r
	208	CirrusLogic5430ControllerDriverStop (\r
	209	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	210	IN EFI_HANDLE Controller,\r
	211	IN UINTN NumberOfChildren,\r
	212	IN EFI_HANDLE *ChildHandleBuffer\r
	213	)\r
878ddf1f	214	;\r
878ddf1f	215	\r
92dda53e	216	//\r
	217	// EFI Component Name Functions\r
	218	//\r
	219	EFI_STATUS\r
	220	EFIAPI\r
	221	CirrusLogic5430ComponentNameGetDriverName (\r
	222	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	223	IN CHAR8 *Language,\r
	224	OUT CHAR16 **DriverName\r
	225	);\r
	226	\r
	227	EFI_STATUS\r
	228	EFIAPI\r
	229	CirrusLogic5430ComponentNameGetControllerName (\r
	230	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	231	IN EFI_HANDLE ControllerHandle,\r
	232	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	233	IN CHAR8 *Language,\r
	234	OUT CHAR16 **ControllerName\r
	235	);\r
	236	\r
	237	//\r
	238	// Local Function Prototypes\r
	239	//\r
	240	VOID\r
	241	InitializeGraphicsMode (\r
	242	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,\r
	243	CIRRUS_LOGIC_5430_VIDEO_MODES *ModeData\r
	244	);\r
	245	\r
	246	VOID\r
	247	SetPaletteColor (\r
	248	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,\r
	249	UINTN Index,\r
	250	UINT8 Red,\r
	251	UINT8 Green,\r
	252	UINT8 Blue\r
	253	);\r
	254	\r
	255	VOID\r
	256	SetDefaultPalette (\r
	257	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private\r
	258	);\r
	259	\r
	260	VOID\r
	261	DrawLogo (\r
	262	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private\r
	263	);\r
	264	\r
	265	VOID\r
	266	outb (\r
	267	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,\r
	268	UINTN Address,\r
	269	UINT8 Data\r
	270	);\r
	271	\r
	272	VOID\r
	273	outw (\r
	274	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,\r
	275	UINTN Address,\r
	276	UINT16 Data\r
	277	);\r
	278	\r
	279	UINT8\r
280	inb (\r
281	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,\r
282	UINTN Address\r
283	);\r
284	\r
285	UINT16\r
286	inw (\r
287	CIRRUS_LOGIC_5430_PRIVATE_DATA *Private,\r
288	UINTN Address\r
289	);\r
290	\r
878ddf1f	291	#endif\r