]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /*++\r |
2 | Copyright (c) 2006, Intel Corporation \r | |
3 | All rights reserved. This program and the accompanying materials \r | |
4 | are licensed and made available under the terms and conditions of the BSD License \r | |
5 | which accompanies this distribution. The full text of the license may be found at \r | |
6 | http://opensource.org/licenses/bsd-license.php \r | |
7 | \r | |
8 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
9 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
10 | \r | |
11 | Module name:\r | |
12 | snp.h\r | |
13 | \r | |
14 | Abstract:\r | |
15 | \r | |
16 | Revision history:\r | |
17 | 2000-Feb-03 M(f)J Genesis.\r | |
18 | --*/\r | |
19 | #ifndef _SNP_H\r | |
20 | #define _SNP_H\r | |
21 | \r | |
22 | \r | |
23 | #include "IndustryStandard/pci22.h"\r | |
24 | \r | |
25 | #define SNP_DEBUG 0\r | |
26 | #define FOUR_GIGABYTES (UINT64) 0x100000000ULL\r | |
27 | \r | |
28 | #if SNP_DEBUG\r | |
29 | #undef D_NET\r | |
30 | #define D_NET D_WARN\r | |
31 | #define SNP_PRINT(DebugInfo) Print (DebugInfo)\r | |
32 | #else\r | |
33 | #define SNP_PRINT(DebugInfo)\r | |
34 | #endif\r | |
35 | \r | |
36 | #define SNP_DRIVER_SIGNATURE EFI_SIGNATURE_32 ('s', 'n', 'd', 's')\r | |
37 | #define MAX_MAP_LENGTH 100\r | |
38 | \r | |
39 | #define PCI_BAR_IO_MASK 0x00000003\r | |
40 | #define PCI_BAR_IO_MODE 0x00000001\r | |
41 | \r | |
42 | #define PCI_BAR_MEM_MASK 0x0000000F\r | |
43 | #define PCI_BAR_MEM_MODE 0x00000000\r | |
44 | #define PCI_BAR_MEM_64BIT 0x00000004\r | |
45 | \r | |
46 | typedef struct {\r | |
47 | UINT32 Signature;\r | |
48 | EFI_LOCK lock;\r | |
49 | \r | |
50 | EFI_SIMPLE_NETWORK_PROTOCOL snp;\r | |
51 | EFI_SIMPLE_NETWORK_MODE mode;\r | |
52 | \r | |
53 | EFI_HANDLE device_handle;\r | |
54 | EFI_DEVICE_PATH_PROTOCOL *device_path;\r | |
55 | \r | |
56 | //\r | |
57 | // Local instance data needed by SNP driver\r | |
58 | //\r | |
59 | // Pointer to S/W UNDI API entry point\r | |
60 | // This will be NULL for H/W UNDI\r | |
61 | //\r | |
62 | EFI_STATUS (*issue_undi32_command) (UINT64 cdb);\r | |
63 | \r | |
64 | BOOLEAN is_swundi;\r | |
65 | \r | |
66 | //\r | |
67 | // undi interface number, if one undi manages more nics\r | |
68 | //\r | |
69 | PXE_IFNUM if_num;\r | |
70 | \r | |
71 | //\r | |
72 | // Allocated tx/rx buffer that was passed to UNDI Initialize.\r | |
73 | //\r | |
74 | UINT32 tx_rx_bufsize;\r | |
75 | VOID *tx_rx_buffer;\r | |
76 | //\r | |
77 | // mappable buffers for receive and fill header for undi3.0\r | |
78 | // these will be used if the user buffers are above 4GB limit (instead of\r | |
79 | // mapping the user buffers)\r | |
80 | //\r | |
81 | UINT8 *receive_buf;\r | |
82 | VOID *ReceiveBufUnmap;\r | |
83 | UINT8 *fill_hdr_buf;\r | |
84 | VOID *FillHdrBufUnmap;\r | |
85 | \r | |
86 | EFI_PCI_IO_PROTOCOL *IoFncs;\r | |
87 | UINT8 IoBarIndex;\r | |
88 | UINT8 MemoryBarIndex;\r | |
89 | BOOLEAN IsOldUndi; // true for EFI1.0 UNDI (3.0) drivers\r | |
90 | //\r | |
91 | // Buffers for command descriptor block, command parameter block\r | |
92 | // and data block.\r | |
93 | //\r | |
94 | PXE_CDB cdb;\r | |
95 | VOID *cpb;\r | |
96 | VOID *CpbUnmap;\r | |
97 | VOID *db;\r | |
98 | \r | |
99 | //\r | |
100 | // UNDI structure, we need to remember the init info for a long time!\r | |
101 | //\r | |
102 | PXE_DB_GET_INIT_INFO init_info;\r | |
103 | \r | |
104 | VOID *SnpDriverUnmap;\r | |
105 | //\r | |
106 | // when ever we map an address, we must remember it's address and the un-map\r | |
107 | // cookie so that we can unmap later\r | |
108 | //\r | |
109 | struct s_map_list {\r | |
110 | EFI_PHYSICAL_ADDRESS virt;\r | |
111 | VOID *map_cookie;\r | |
112 | } map_list[MAX_MAP_LENGTH];\r | |
113 | }\r | |
114 | SNP_DRIVER;\r | |
115 | \r | |
116 | #define EFI_SIMPLE_NETWORK_DEV_FROM_THIS(a) CR (a, SNP_DRIVER, snp, SNP_DRIVER_SIGNATURE)\r | |
117 | \r | |
118 | //\r | |
119 | // Global Variables\r | |
120 | //\r | |
121 | extern EFI_COMPONENT_NAME_PROTOCOL gSimpleNetworkComponentName;\r | |
122 | extern EFI_DRIVER_BINDING_PROTOCOL gSimpleNetworkDriverBinding;\r | |
123 | \r | |
124 | //\r | |
125 | // Virtual to physical mapping for all UNDI 3.0s.\r | |
126 | //\r | |
127 | extern struct s_v2p {\r | |
128 | struct s_v2p *next;\r | |
129 | VOID *vaddr;\r | |
130 | UINTN bsize;\r | |
131 | EFI_PHYSICAL_ADDRESS paddr;\r | |
132 | VOID *unmap;\r | |
133 | }\r | |
134 | *_v2p;\r | |
135 | \r | |
136 | EFI_STATUS\r | |
137 | add_v2p (\r | |
138 | struct s_v2p **v2p,\r | |
139 | EFI_PCI_IO_PROTOCOL_OPERATION type,\r | |
140 | VOID *vaddr,\r | |
141 | UINTN bsize\r | |
142 | )\r | |
143 | ;\r | |
144 | \r | |
145 | EFI_STATUS\r | |
146 | find_v2p (\r | |
147 | struct s_v2p **v2p,\r | |
148 | VOID *vaddr\r | |
149 | )\r | |
150 | ;\r | |
151 | \r | |
152 | EFI_STATUS\r | |
153 | del_v2p (\r | |
154 | VOID *vaddr\r | |
155 | )\r | |
156 | ;\r | |
157 | \r | |
158 | extern\r | |
159 | VOID\r | |
160 | snp_undi32_callback_block_30 (\r | |
161 | IN UINT32 Enable\r | |
162 | )\r | |
163 | ;\r | |
164 | \r | |
165 | extern\r | |
166 | VOID\r | |
167 | snp_undi32_callback_delay_30 (\r | |
168 | IN UINT64 MicroSeconds\r | |
169 | )\r | |
170 | ;\r | |
171 | \r | |
172 | extern\r | |
173 | VOID\r | |
174 | snp_undi32_callback_memio_30 (\r | |
175 | IN UINT8 ReadOrWrite,\r | |
176 | IN UINT8 NumBytes,\r | |
177 | IN UINT64 MemOrPortAddress,\r | |
178 | IN OUT UINT64 BufferPtr\r | |
179 | )\r | |
180 | ;\r | |
181 | \r | |
182 | extern\r | |
183 | VOID\r | |
184 | snp_undi32_callback_v2p_30 (\r | |
185 | IN UINT64 CpuAddr,\r | |
186 | IN OUT UINT64 DeviceAddrPtr\r | |
187 | )\r | |
188 | ;\r | |
189 | \r | |
190 | extern\r | |
191 | VOID\r | |
192 | snp_undi32_callback_block (\r | |
193 | IN UINT64 UniqueId,\r | |
194 | IN UINT32 Enable\r | |
195 | )\r | |
196 | ;\r | |
197 | \r | |
198 | extern\r | |
199 | VOID\r | |
200 | snp_undi32_callback_delay (\r | |
201 | IN UINT64 UniqueId,\r | |
202 | IN UINT64 MicroSeconds\r | |
203 | )\r | |
204 | ;\r | |
205 | \r | |
206 | extern\r | |
207 | VOID\r | |
208 | snp_undi32_callback_memio (\r | |
209 | IN UINT64 UniqueId,\r | |
210 | IN UINT8 ReadOrWrite,\r | |
211 | IN UINT8 NumBytes,\r | |
212 | IN UINT64 MemOrPortAddr,\r | |
213 | IN OUT UINT64 BufferPtr\r | |
214 | )\r | |
215 | ;\r | |
216 | \r | |
217 | extern\r | |
218 | VOID\r | |
219 | snp_undi32_callback_map (\r | |
220 | IN UINT64 UniqueId,\r | |
221 | IN UINT64 CpuAddr,\r | |
222 | IN UINT32 NumBytes,\r | |
223 | IN UINT32 Direction,\r | |
224 | IN OUT UINT64 DeviceAddrPtr\r | |
225 | )\r | |
226 | ;\r | |
227 | \r | |
228 | extern\r | |
229 | VOID\r | |
230 | snp_undi32_callback_unmap (\r | |
231 | IN UINT64 UniqueId,\r | |
232 | IN UINT64 CpuAddr,\r | |
233 | IN UINT32 NumBytes,\r | |
234 | IN UINT32 Direction,\r | |
235 | IN UINT64 DeviceAddr // not a pointer to device address\r | |
236 | )\r | |
237 | ;\r | |
238 | \r | |
239 | extern\r | |
240 | VOID\r | |
241 | snp_undi32_callback_sync (\r | |
242 | IN UINT64 UniqueId,\r | |
243 | IN UINT64 CpuAddr,\r | |
244 | IN UINT32 NumBytes,\r | |
245 | IN UINT32 Direction,\r | |
246 | IN UINT64 DeviceAddr // not a pointer to device address\r | |
247 | )\r | |
248 | ;\r | |
249 | \r | |
250 | extern\r | |
251 | EFI_STATUS\r | |
252 | EFIAPI\r | |
253 | snp_undi32_start (\r | |
254 | IN EFI_SIMPLE_NETWORK_PROTOCOL *this\r | |
255 | )\r | |
256 | ;\r | |
257 | \r | |
258 | extern\r | |
259 | EFI_STATUS\r | |
260 | EFIAPI\r | |
261 | snp_undi32_stop (\r | |
262 | IN EFI_SIMPLE_NETWORK_PROTOCOL *this\r | |
263 | )\r | |
264 | ;\r | |
265 | \r | |
266 | extern\r | |
267 | EFI_STATUS\r | |
268 | EFIAPI\r | |
269 | snp_undi32_initialize (\r | |
270 | IN EFI_SIMPLE_NETWORK_PROTOCOL *this,\r | |
271 | IN UINTN extra_rx_buffer_size OPTIONAL,\r | |
272 | IN UINTN extra_tx_buffer_size OPTIONAL\r | |
273 | )\r | |
274 | ;\r | |
275 | \r | |
276 | extern\r | |
277 | EFI_STATUS\r | |
278 | EFIAPI\r | |
279 | snp_undi32_reset (\r | |
280 | IN EFI_SIMPLE_NETWORK_PROTOCOL *this,\r | |
281 | IN BOOLEAN ExtendedVerification\r | |
282 | )\r | |
283 | ;\r | |
284 | \r | |
285 | extern\r | |
286 | EFI_STATUS\r | |
287 | EFIAPI\r | |
288 | snp_undi32_shutdown (\r | |
289 | IN EFI_SIMPLE_NETWORK_PROTOCOL *this\r | |
290 | )\r | |
291 | ;\r | |
292 | \r | |
293 | extern\r | |
294 | EFI_STATUS\r | |
295 | EFIAPI\r | |
296 | snp_undi32_receive_filters (\r | |
297 | IN EFI_SIMPLE_NETWORK_PROTOCOL * this,\r | |
298 | IN UINT32 enable,\r | |
299 | IN UINT32 disable,\r | |
300 | IN BOOLEAN reset_mcast_filter,\r | |
301 | IN UINTN mcast_filter_count OPTIONAL,\r | |
302 | IN EFI_MAC_ADDRESS * mcast_filter OPTIONAL\r | |
303 | )\r | |
304 | ;\r | |
305 | \r | |
306 | extern\r | |
307 | EFI_STATUS\r | |
308 | EFIAPI\r | |
309 | snp_undi32_station_address (\r | |
310 | IN EFI_SIMPLE_NETWORK_PROTOCOL * this,\r | |
311 | IN BOOLEAN reset,\r | |
312 | IN EFI_MAC_ADDRESS *new OPTIONAL\r | |
313 | )\r | |
314 | ;\r | |
315 | \r | |
316 | extern\r | |
317 | EFI_STATUS\r | |
318 | EFIAPI\r | |
319 | snp_undi32_statistics (\r | |
320 | IN EFI_SIMPLE_NETWORK_PROTOCOL * this,\r | |
321 | IN BOOLEAN reset,\r | |
322 | IN OUT UINTN *statistics_size OPTIONAL,\r | |
323 | IN OUT EFI_NETWORK_STATISTICS * statistics_table OPTIONAL\r | |
324 | )\r | |
325 | ;\r | |
326 | \r | |
327 | extern\r | |
328 | EFI_STATUS\r | |
329 | EFIAPI\r | |
330 | snp_undi32_mcast_ip_to_mac (\r | |
331 | IN EFI_SIMPLE_NETWORK_PROTOCOL *this,\r | |
332 | IN BOOLEAN IPv6,\r | |
333 | IN EFI_IP_ADDRESS *IP,\r | |
334 | OUT EFI_MAC_ADDRESS *MAC\r | |
335 | )\r | |
336 | ;\r | |
337 | \r | |
338 | extern\r | |
339 | EFI_STATUS\r | |
340 | EFIAPI\r | |
341 | snp_undi32_nvdata (\r | |
342 | IN EFI_SIMPLE_NETWORK_PROTOCOL *this,\r | |
343 | IN BOOLEAN read_write,\r | |
344 | IN UINTN offset,\r | |
345 | IN UINTN buffer_size,\r | |
346 | IN OUT VOID *buffer\r | |
347 | )\r | |
348 | ;\r | |
349 | \r | |
350 | extern\r | |
351 | EFI_STATUS\r | |
352 | EFIAPI\r | |
353 | snp_undi32_get_status (\r | |
354 | IN EFI_SIMPLE_NETWORK_PROTOCOL * this,\r | |
355 | OUT UINT32 *interrupt_status OPTIONAL,\r | |
356 | OUT VOID **tx_buffer OPTIONAL\r | |
357 | )\r | |
358 | ;\r | |
359 | \r | |
360 | extern\r | |
361 | EFI_STATUS\r | |
362 | EFIAPI\r | |
363 | snp_undi32_transmit (\r | |
364 | IN EFI_SIMPLE_NETWORK_PROTOCOL * this,\r | |
365 | IN UINTN header_size,\r | |
366 | IN UINTN buffer_size,\r | |
367 | IN VOID *buffer,\r | |
368 | IN EFI_MAC_ADDRESS * src_addr OPTIONAL,\r | |
369 | IN EFI_MAC_ADDRESS * dest_addr OPTIONAL,\r | |
370 | IN UINT16 *protocol OPTIONAL\r | |
371 | )\r | |
372 | ;\r | |
373 | \r | |
374 | extern\r | |
375 | EFI_STATUS\r | |
376 | EFIAPI\r | |
377 | snp_undi32_receive (\r | |
378 | IN EFI_SIMPLE_NETWORK_PROTOCOL * this,\r | |
379 | OUT UINTN *header_size OPTIONAL,\r | |
380 | IN OUT UINTN *buffer_size,\r | |
381 | OUT VOID *buffer,\r | |
382 | OUT EFI_MAC_ADDRESS * src_addr OPTIONAL,\r | |
383 | OUT EFI_MAC_ADDRESS * dest_addr OPTIONAL,\r | |
384 | OUT UINT16 *protocol OPTIONAL\r | |
385 | )\r | |
386 | ;\r | |
387 | \r | |
388 | typedef\r | |
389 | EFI_STATUS\r | |
390 | (*issue_undi32_command) (\r | |
391 | UINT64 cdb\r | |
392 | );\r | |
393 | typedef\r | |
394 | VOID\r | |
395 | (*ptr) (\r | |
396 | VOID\r | |
397 | );\r | |
398 | \r | |
399 | #define SNP_MEM_PAGES(x) (((x) - 1) / 4096 + 1)\r | |
400 | \r | |
401 | #if SNP_DEBUG\r | |
402 | extern\r | |
403 | VOID\r | |
404 | snp_wait_for_key (\r | |
405 | VOID\r | |
406 | )\r | |
407 | ;\r | |
408 | #endif\r | |
409 | \r | |
410 | #endif /* _SNP_H */\r |