[mirror_edk2.git] / UnixPkg / UnixBusDriverDxe / UnixBusDriver.h

/*++\r
\r
Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
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
Module Name:\r
\r
  UnixBusDriver.h\r
\r
Abstract:\r
\r
This following section documents the PCD for the Unix \r
build.  These variables are used to define the (virtual) hardware \r
configuration of the Unix environment\r
\r
A ! can be used to seperate multiple instances in a variable. Each \r
instance represents a seperate hardware device. \r
\r
EFI_UNIX_PHYSICAL_DISKS - maps to drives on your system\r
EFI_UNIX_VIRTUAL_DISKS  - maps to a device emulated by a file\r
EFI_UNIX_FILE_SYSTEM    - mouts a directory as a file system\r
EFI_UNIX_CONSOLE        - make a logical comand line window (only one!)\r
EFI_UNIX_UGA            - Builds UGA Windows of Width and Height\r
EFI_UNIX_SERIAL_PORT    - maps physical serial ports\r
EFI_UNIX_PASS_THRU      - associates a device with our PCI support\r
\r
 <F>ixed       - Fixed disk like a hard drive.\r
 <R>emovable   - Removable media like a floppy or CD-ROM.\r
 Read <O>nly   - Write protected device.\r
 Read <W>rite  - Read write device.\r
 <block count> - Decimal number of blocks a device supports.\r
 <block size>  - Decimal number of bytes per block.\r
\r
 UNIX envirnonment variable contents. '<' and '>' are not part of the variable, \r
 they are just used to make this help more readable. There should be no \r
 spaces between the ';'. Extra spaces will break the variable. A '!' is  \r
 used to seperate multiple devices in a variable.\r
\r
 EFI_UNIX_VIRTUAL_DISKS = \r
   <F | R><O | W>;<block count>;<block size>[!...]\r
\r
 EFI_UNIX_PHYSICAL_DISKS =\r
   <drive letter>:<F | R><O | W>;<block count>;<block size>[!...]\r
\r
 Virtual Disks: These devices use a file to emulate a hard disk or removable\r
                media device. \r
                \r
   Thus a 20 MB emulated hard drive would look like:\r
   EFI_UNIX_VIRTUAL_DISKS=FW;40960;512\r
\r
   A 1.44MB emulated floppy with a block size of 1024 would look like:\r
   EFI_UNIX_VIRTUAL_DISKS=RW;1440;1024\r
\r
 Physical Disks: These devices use UNIX to open a real device in your system\r
\r
   Thus a 120 MB floppy would look like:\r
   EFI_UNIX_PHYSICAL_DISKS=B:RW;245760;512\r
\r
   Thus a standard CD-ROM floppy would look like:\r
   EFI_UNIX_PHYSICAL_DISKS=Z:RO;307200;2048\r
\r
 EFI_UNIX_FILE_SYSTEM = \r
   <directory path>[!...]\r
\r
   Mounting the two directories C:\FOO and C:\BAR would look like:\r
   EFI_UNIX_FILE_SYSTEM=c:\foo!c:\bar\r
\r
 EFI_UNIX_CONSOLE = \r
   <window title>\r
\r
   Declaring a text console window with the title "My EFI Console" woild look like:\r
   EFI_UNIX_CONSOLE=My EFI Console\r
\r
 EFI_UNIX_UGA = \r
   <width> <height>[!...]\r
\r
   Declaring a two UGA windows with resolutions of 800x600 and 1024x768 would look like:\r
   Example : EFI_UNIX_UGA=800 600!1024 768\r
\r
 EFI_UNIX_SERIAL_PORT = \r
   <port name>[!...]\r
\r
   Declaring two serial ports on COM1 and COM2 would look like:\r
   Example : EFI_UNIX_SERIAL_PORT=COM1!COM2\r
\r
 EFI_UNIX_PASS_THROUGH =\r
   <BaseAddress>;<Bus#>;<Device#>;<Function#>\r
\r
   Declaring a base address of 0xE0000000 (used for PCI Express devices)\r
   and having NT32 talk to a device located at bus 0, device 1, function 0:\r
   Example : EFI_UNIX_PASS_THROUGH=E000000;0;1;0\r
\r
---*/\r
\r
#ifndef __UNIX_BUS_DRIVER_H__\r
#define __UNIX_BUS_DRIVER_H__\r
#include "PiDxe.h"\r
#include "UnixDxe.h"\r
#include <Protocol/Pcd.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
\r
extern EFI_DRIVER_BINDING_PROTOCOL gUnixBusDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL gUnixBusDriverComponentName;\r
\r
//\r
// Unix Bus Driver Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gUnixBusDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gUnixBusDriverComponentName;\r
\r
//\r
// Unix Bus Controller Structure\r
//\r
#define UNIX_BUS_DEVICE_SIGNATURE SIGNATURE_32 ('L', 'X', 'B', 'D')\r
\r
typedef struct {\r
  UINT64                    Signature;\r
  EFI_UNICODE_STRING_TABLE  *ControllerNameTable;\r
} UNIX_BUS_DEVICE;\r
\r
//\r
// Unix Child Device Controller Structure\r
//\r
#define UNIX_IO_DEVICE_SIGNATURE  SIGNATURE_32 ('L', 'X', 'V', 'D')\r
\r
typedef struct {\r
  UINT64                    Signature;\r
  EFI_HANDLE                Handle;\r
  EFI_UNIX_IO_PROTOCOL     UnixIo;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
\r
  //\r
  // Private data about the parent\r
  //\r
  EFI_HANDLE                ControllerHandle;\r
  EFI_DEVICE_PATH_PROTOCOL  *ParentDevicePath;\r
\r
  EFI_UNICODE_STRING_TABLE  *ControllerNameTable;\r
\r
} UNIX_IO_DEVICE;\r
\r
#define UNIX_IO_DEVICE_FROM_THIS(a) \\r
  CR(a, UNIX_IO_DEVICE, UnixIo, UNIX_IO_DEVICE_SIGNATURE)\r
\r
//\r
// This is the largest env variable we can parse\r
//\r
#define MAX_UNIX_ENVIRNMENT_VARIABLE_LENGTH 512\r
\r
typedef struct {\r
  UINTN               Token;\r
  EFI_GUID            *DevicePathGuid;\r
} UNIX_PCD_ENTRY;\r
\r
typedef struct {\r
  VENDOR_DEVICE_PATH  VendorDevicePath;\r
  UINT32              Instance;\r
} UNIX_VENDOR_DEVICE_PATH_NODE;\r
\r
EFI_STATUS\r
EFIAPI\r
CpuIoInitialize (\r
  IN EFI_HANDLE                            ImageHandle,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ImageHandle - TODO: add argument description\r
  SystemTable - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
//\r
// Driver Binding Protocol function prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
UnixBusDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     Handle,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This                - TODO: add argument description\r
  Handle              - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
UnixBusDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL    *This,\r
  IN EFI_HANDLE                     ParentHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This                - TODO: add argument description\r
  ParentHandle        - TODO: add argument description\r
  RemainingDevicePath - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
UnixBusDriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   Handle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  This              - TODO: add argument description\r
  Handle            - TODO: add argument description\r
  NumberOfChildren  - TODO: add argument description\r
  ChildHandleBuffer - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
//\r
// Unix Bus Driver private worker functions\r
//\r
EFI_DEVICE_PATH_PROTOCOL  *\r
UnixBusCreateDevicePath (\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *RootDevicePath,\r
  IN  EFI_GUID                  *Guid,\r
  IN  UINT16                    InstanceNumber\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  RootDevicePath  - TODO: add argument description\r
  Guid            - TODO: add argument description\r
  InstanceNumber  - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
;\r
\r
\r
#endif\r
Commit	Line	Data
804405e7	1	/*++\r
804405e7	2	\r
f9b8ab56 HT	3	Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
f9b8ab56 HT	4	This program and the accompanying materials \r
804405e7	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
	11	\r
	12	Module Name:\r
	13	\r
	14	UnixBusDriver.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	This following section documents the PCD for the Unix \r
	19	build. These variables are used to define the (virtual) hardware \r
	20	configuration of the Unix environment\r
	21	\r
	22	A ! can be used to seperate multiple instances in a variable. Each \r
	23	instance represents a seperate hardware device. \r
	24	\r
	25	EFI_UNIX_PHYSICAL_DISKS - maps to drives on your system\r
	26	EFI_UNIX_VIRTUAL_DISKS - maps to a device emulated by a file\r
	27	EFI_UNIX_FILE_SYSTEM - mouts a directory as a file system\r
	28	EFI_UNIX_CONSOLE - make a logical comand line window (only one!)\r
	29	EFI_UNIX_UGA - Builds UGA Windows of Width and Height\r
	30	EFI_UNIX_SERIAL_PORT - maps physical serial ports\r
	31	EFI_UNIX_PASS_THRU - associates a device with our PCI support\r
	32	\r
	33	<F>ixed - Fixed disk like a hard drive.\r
	34	<R>emovable - Removable media like a floppy or CD-ROM.\r
	35	Read <O>nly - Write protected device.\r
	36	Read <W>rite - Read write device.\r
	37	<block count> - Decimal number of blocks a device supports.\r
	38	<block size> - Decimal number of bytes per block.\r
	39	\r
	40	UNIX envirnonment variable contents. '<' and '>' are not part of the variable, \r
	41	they are just used to make this help more readable. There should be no \r
	42	spaces between the ';'. Extra spaces will break the variable. A '!' is \r
	43	used to seperate multiple devices in a variable.\r
	44	\r
	45	EFI_UNIX_VIRTUAL_DISKS = \r
	46	<F \| R><O \| W>;<block count>;<block size>[!...]\r
	47	\r
	48	EFI_UNIX_PHYSICAL_DISKS =\r
	49	<drive letter>:<F \| R><O \| W>;<block count>;<block size>[!...]\r
	50	\r
	51	Virtual Disks: These devices use a file to emulate a hard disk or removable\r
	52	media device. \r
	53	\r
	54	Thus a 20 MB emulated hard drive would look like:\r
	55	EFI_UNIX_VIRTUAL_DISKS=FW;40960;512\r
	56	\r
	57	A 1.44MB emulated floppy with a block size of 1024 would look like:\r
	58	EFI_UNIX_VIRTUAL_DISKS=RW;1440;1024\r
	59	\r
	60	Physical Disks: These devices use UNIX to open a real device in your system\r
	61	\r
	62	Thus a 120 MB floppy would look like:\r
	63	EFI_UNIX_PHYSICAL_DISKS=B:RW;245760;512\r
	64	\r
	65	Thus a standard CD-ROM floppy would look like:\r
	66	EFI_UNIX_PHYSICAL_DISKS=Z:RO;307200;2048\r
	67	\r
	68	EFI_UNIX_FILE_SYSTEM = \r
69	<directory path>[!...]\r
70	\r
71	Mounting the two directories C:\FOO and C:\BAR would look like:\r
72	EFI_UNIX_FILE_SYSTEM=c:\foo!c:\bar\r
73	\r
74	EFI_UNIX_CONSOLE = \r
75	<window title>\r
76	\r
77	Declaring a text console window with the title "My EFI Console" woild look like:\r
78	EFI_UNIX_CONSOLE=My EFI Console\r
79	\r
80	EFI_UNIX_UGA = \r
81	<width> <height>[!...]\r
82	\r
83	Declaring a two UGA windows with resolutions of 800x600 and 1024x768 would look like:\r
84	Example : EFI_UNIX_UGA=800 600!1024 768\r
85	\r
86	EFI_UNIX_SERIAL_PORT = \r
87	<port name>[!...]\r
88	\r
89	Declaring two serial ports on COM1 and COM2 would look like:\r
90	Example : EFI_UNIX_SERIAL_PORT=COM1!COM2\r
91	\r
92	EFI_UNIX_PASS_THROUGH =\r
93	<BaseAddress>;<Bus#>;<Device#>;<Function#>\r
94	\r
95	Declaring a base address of 0xE0000000 (used for PCI Express devices)\r
96	and having NT32 talk to a device located at bus 0, device 1, function 0:\r
97	Example : EFI_UNIX_PASS_THROUGH=E000000;0;1;0\r
98	\r
99	---*/\r
100	\r
101	#ifndef __UNIX_BUS_DRIVER_H__\r
102	#define __UNIX_BUS_DRIVER_H__\r
103	#include "PiDxe.h"\r
104	#include "UnixDxe.h"\r
105	#include <Protocol/Pcd.h>\r
106	#include <Protocol/DevicePath.h>\r
107	\r
108	#include <Library/DebugLib.h>\r
109	#include <Library/BaseLib.h>\r
110	#include <Library/UefiDriverEntryPoint.h>\r
111	#include <Library/UefiLib.h>\r
112	#include <Library/PcdLib.h>\r
113	#include <Library/BaseMemoryLib.h>\r
114	#include <Library/MemoryAllocationLib.h>\r
115	#include <Library/UefiBootServicesTableLib.h>\r
116	#include <Library/DevicePathLib.h>\r
117	\r
118	extern EFI_DRIVER_BINDING_PROTOCOL gUnixBusDriverBinding;\r
119	extern EFI_COMPONENT_NAME_PROTOCOL gUnixBusDriverComponentName;\r
120	\r
121	//\r
122	// Unix Bus Driver Global Variables\r
123	//\r
124	extern EFI_DRIVER_BINDING_PROTOCOL gUnixBusDriverBinding;\r
125	extern EFI_COMPONENT_NAME_PROTOCOL gUnixBusDriverComponentName;\r
126	\r
127	//\r
128	// Unix Bus Controller Structure\r
129	//\r
208301e9	130	#define UNIX_BUS_DEVICE_SIGNATURE SIGNATURE_32 ('L', 'X', 'B', 'D')\r
804405e7	131	\r
	132	typedef struct {\r
	133	UINT64 Signature;\r
	134	EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
	135	} UNIX_BUS_DEVICE;\r
	136	\r
	137	//\r
	138	// Unix Child Device Controller Structure\r
	139	//\r
208301e9	140	#define UNIX_IO_DEVICE_SIGNATURE SIGNATURE_32 ('L', 'X', 'V', 'D')\r
804405e7	141	\r
	142	typedef struct {\r
	143	UINT64 Signature;\r
	144	EFI_HANDLE Handle;\r
	145	EFI_UNIX_IO_PROTOCOL UnixIo;\r
	146	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	147	\r
	148	//\r
	149	// Private data about the parent\r
	150	//\r
	151	EFI_HANDLE ControllerHandle;\r
	152	EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
	153	\r
	154	EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
	155	\r
	156	} UNIX_IO_DEVICE;\r
	157	\r
	158	#define UNIX_IO_DEVICE_FROM_THIS(a) \\r
	159	CR(a, UNIX_IO_DEVICE, UnixIo, UNIX_IO_DEVICE_SIGNATURE)\r
	160	\r
	161	//\r
	162	// This is the largest env variable we can parse\r
	163	//\r
	164	#define MAX_UNIX_ENVIRNMENT_VARIABLE_LENGTH 512\r
	165	\r
	166	typedef struct {\r
	167	UINTN Token;\r
	168	EFI_GUID *DevicePathGuid;\r
	169	} UNIX_PCD_ENTRY;\r
	170	\r
	171	typedef struct {\r
	172	VENDOR_DEVICE_PATH VendorDevicePath;\r
	173	UINT32 Instance;\r
	174	} UNIX_VENDOR_DEVICE_PATH_NODE;\r
	175	\r
	176	EFI_STATUS\r
	177	EFIAPI\r
	178	CpuIoInitialize (\r
	179	IN EFI_HANDLE ImageHandle,\r
	180	IN EFI_SYSTEM_TABLE *SystemTable\r
	181	)\r
	182	/*++\r
	183	\r
	184	Routine Description:\r
	185	\r
	186	TODO: Add function description\r
	187	\r
	188	Arguments:\r
	189	\r
	190	ImageHandle - TODO: add argument description\r
	191	SystemTable - TODO: add argument description\r
	192	\r
	193	Returns:\r
	194	\r
	195	TODO: add return values\r
	196	\r
	197	--*/\r
	198	;\r
	199	\r
	200	//\r
	201	// Driver Binding Protocol function prototypes\r
	202	//\r
	203	EFI_STATUS\r
	204	EFIAPI\r
205	UnixBusDriverBindingSupported (\r
206	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
207	IN EFI_HANDLE Handle,\r
208	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
209	)\r
210	/*++\r
211	\r
212	Routine Description:\r
213	\r
214	TODO: Add function description\r
215	\r
216	Arguments:\r
217	\r
218	This - TODO: add argument description\r
219	Handle - TODO: add argument description\r
220	RemainingDevicePath - TODO: add argument description\r
221	\r
222	Returns:\r
223	\r
224	TODO: add return values\r
225	\r
226	--*/\r
227	;\r
228	\r
229	EFI_STATUS\r
230	EFIAPI\r
231	UnixBusDriverBindingStart (\r
232	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
233	IN EFI_HANDLE ParentHandle,\r
234	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
235	)\r
236	/*++\r
237	\r
238	Routine Description:\r
239	\r
240	TODO: Add function description\r
241	\r
242	Arguments:\r
243	\r
244	This - TODO: add argument description\r
245	ParentHandle - TODO: add argument description\r
246	RemainingDevicePath - TODO: add argument description\r
247	\r
248	Returns:\r
249	\r
250	TODO: add return values\r
251	\r
252	--*/\r
253	;\r
254	\r
255	EFI_STATUS\r
256	EFIAPI\r
257	UnixBusDriverBindingStop (\r
258	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
259	IN EFI_HANDLE Handle,\r
260	IN UINTN NumberOfChildren,\r
261	IN EFI_HANDLE *ChildHandleBuffer\r
262	)\r
263	/*++\r
264	\r
265	Routine Description:\r
266	\r
267	TODO: Add function description\r
268	\r
269	Arguments:\r
270	\r
271	This - TODO: add argument description\r
272	Handle - TODO: add argument description\r
273	NumberOfChildren - TODO: add argument description\r
274	ChildHandleBuffer - TODO: add argument description\r
275	\r
276	Returns:\r
277	\r
278	TODO: add return values\r
279	\r
280	--*/\r
281	;\r
282	\r
283	//\r
284	// Unix Bus Driver private worker functions\r
285	//\r
286	EFI_DEVICE_PATH_PROTOCOL *\r
287	UnixBusCreateDevicePath (\r
288	IN EFI_DEVICE_PATH_PROTOCOL *RootDevicePath,\r
289	IN EFI_GUID *Guid,\r
290	IN UINT16 InstanceNumber\r
291	)\r
292	/*++\r
293	\r
294	Routine Description:\r
295	\r
296	TODO: Add function description\r
297	\r
298	Arguments:\r
299	\r
300	RootDevicePath - TODO: add argument description\r
301	Guid - TODO: add argument description\r
302	InstanceNumber - TODO: add argument description\r
303	\r
304	Returns:\r
305	\r
306	TODO: add return values\r
307	\r
308	--*/\r
309	;\r
310	\r
311	\r
312	#endif\r