[mirror_edk2.git] / EdkUnixPkg / Dxe / UnixThunk / Bus / UnixBusDriver / UnixBusDriver.h

/*++\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
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
\r
\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 EFI_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  EFI_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
c9093a06	1	/*++\r
	2	\r
	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
	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
377fc2ae	40	UNIX envirnonment variable contents. '<' and '>' are not part of the variable, \r
c9093a06	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
377fc2ae	60	Physical Disks: These devices use UNIX to open a real device in your system\r
c9093a06	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	\r
	104	\r
	105	\r
	106	//\r
	107	// Unix Bus Driver Global Variables\r
	108	//\r
	109	extern EFI_DRIVER_BINDING_PROTOCOL gUnixBusDriverBinding;\r
	110	extern EFI_COMPONENT_NAME_PROTOCOL gUnixBusDriverComponentName;\r
	111	\r
	112	//\r
	113	// Unix Bus Controller Structure\r
	114	//\r
	115	#define UNIX_BUS_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('L', 'X', 'B', 'D')\r
	116	\r
	117	typedef struct {\r
	118	UINT64 Signature;\r
	119	EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
	120	} UNIX_BUS_DEVICE;\r
	121	\r
	122	//\r
	123	// Unix Child Device Controller Structure\r
	124	//\r
125	#define UNIX_IO_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('L', 'X', 'V', 'D')\r
126	\r
127	typedef struct {\r
128	UINT64 Signature;\r
129	EFI_HANDLE Handle;\r
130	EFI_UNIX_IO_PROTOCOL UnixIo;\r
131	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
132	\r
133	//\r
134	// Private data about the parent\r
135	//\r
136	EFI_HANDLE ControllerHandle;\r
137	EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r
138	\r
139	EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
140	\r
141	} UNIX_IO_DEVICE;\r
142	\r
143	#define UNIX_IO_DEVICE_FROM_THIS(a) \\r
144	CR(a, UNIX_IO_DEVICE, UnixIo, UNIX_IO_DEVICE_SIGNATURE)\r
145	\r
146	//\r
147	// This is the largest env variable we can parse\r
148	//\r
149	#define MAX_UNIX_ENVIRNMENT_VARIABLE_LENGTH 512\r
150	\r
151	typedef struct {\r
152	UINTN Token;\r
153	EFI_GUID *DevicePathGuid;\r
154	} UNIX_PCD_ENTRY;\r
155	\r
156	typedef struct {\r
157	VENDOR_DEVICE_PATH VendorDevicePath;\r
158	UINT32 Instance;\r
159	} UNIX_VENDOR_DEVICE_PATH_NODE;\r
160	\r
161	EFI_STATUS\r
162	EFIAPI\r
163	CpuIoInitialize (\r
164	IN EFI_HANDLE ImageHandle,\r
165	IN EFI_SYSTEM_TABLE *SystemTable\r
166	)\r
167	/*++\r
168	\r
169	Routine Description:\r
170	\r
171	TODO: Add function description\r
172	\r
173	Arguments:\r
174	\r
175	ImageHandle - TODO: add argument description\r
176	SystemTable - TODO: add argument description\r
177	\r
178	Returns:\r
179	\r
180	TODO: add return values\r
181	\r
182	--*/\r
183	;\r
184	\r
185	//\r
186	// Driver Binding Protocol function prototypes\r
187	//\r
188	EFI_STATUS\r
189	EFIAPI\r
190	UnixBusDriverBindingSupported (\r
191	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
192	IN EFI_HANDLE Handle,\r
193	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
194	)\r
195	/*++\r
196	\r
197	Routine Description:\r
198	\r
199	TODO: Add function description\r
200	\r
201	Arguments:\r
202	\r
203	This - TODO: add argument description\r
204	Handle - TODO: add argument description\r
205	RemainingDevicePath - TODO: add argument description\r
206	\r
207	Returns:\r
208	\r
209	TODO: add return values\r
210	\r
211	--*/\r
212	;\r
213	\r
214	EFI_STATUS\r
215	EFIAPI\r
216	UnixBusDriverBindingStart (\r
217	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
218	IN EFI_HANDLE ParentHandle,\r
219	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
220	)\r
221	/*++\r
222	\r
223	Routine Description:\r
224	\r
225	TODO: Add function description\r
226	\r
227	Arguments:\r
228	\r
229	This - TODO: add argument description\r
230	ParentHandle - TODO: add argument description\r
231	RemainingDevicePath - TODO: add argument description\r
232	\r
233	Returns:\r
234	\r
235	TODO: add return values\r
236	\r
237	--*/\r
238	;\r
239	\r
240	EFI_STATUS\r
241	EFIAPI\r
242	UnixBusDriverBindingStop (\r
243	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
244	IN EFI_HANDLE Handle,\r
245	IN UINTN NumberOfChildren,\r
246	IN EFI_HANDLE *ChildHandleBuffer\r
247	)\r
248	/*++\r
249	\r
250	Routine Description:\r
251	\r
252	TODO: Add function description\r
253	\r
254	Arguments:\r
255	\r
256	This - TODO: add argument description\r
257	Handle - TODO: add argument description\r
258	NumberOfChildren - TODO: add argument description\r
259	ChildHandleBuffer - TODO: add argument description\r
260	\r
261	Returns:\r
262	\r
263	TODO: add return values\r
264	\r
265	--*/\r
266	;\r
267	\r
268	//\r
269	// Unix Bus Driver private worker functions\r
270	//\r
271	EFI_DEVICE_PATH_PROTOCOL *\r
272	UnixBusCreateDevicePath (\r
273	IN EFI_DEVICE_PATH_PROTOCOL *RootDevicePath,\r
274	IN EFI_GUID *Guid,\r
275	IN UINT16 InstanceNumber\r
276	)\r
277	/*++\r
278	\r
279	Routine Description:\r
280	\r
281	TODO: Add function description\r
282	\r
283	Arguments:\r
284	\r
285	RootDevicePath - TODO: add argument description\r
286	Guid - TODO: add argument description\r
287	InstanceNumber - TODO: add argument description\r
288	\r
289	Returns:\r
290	\r
291	TODO: add return values\r
292	\r
293	--*/\r
294	;\r
295	\r
296	\r
297	#endif\r