1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
/** @file
Internal definitions for the virtio-net driver, which produces Simple Network
Protocol instances for virtio-net devices.
Copyright (c) 2021, Oracle and/or its affiliates.
Copyright (c) 2017, AMD Inc, All rights reserved.
Copyright (C) 2013, Red Hat, Inc.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _E1K_NET_DXE_H_
#define _E1K_NET_DXE_H_
#include <Library/DebugLib.h>
#include <Protocol/PciIo.h>
#include <Protocol/PciRootBridgeIo.h>
#include <Protocol/ComponentName.h>
#include <Protocol/ComponentName2.h>
#include <Protocol/DevicePath.h>
#include <Protocol/DriverBinding.h>
#include <Protocol/SimpleNetwork.h>
#include <Library/OrderedCollectionLib.h>
#include "E1kNetHw.h"
#define E1K_NET_DEV_SIGNATURE SIGNATURE_32 ('E','1','K','N')
//
// maximum number of pending packets, separately for each direction
//
#define E1K_NET_MAX_PENDING 64
//
// State diagram:
//
// | ^
// | |
// BindingStart BindingStop
// +SnpPopulate |
// ++GetFeatures |
// | |
// v |
// +---------+ virtio-net device is reset, no resources are
// | stopped | allocated for traffic, but MAC address has
// +---------+ been retrieved
// | ^
// | |
// SNP.Start SNP.Stop
// | |
// v |
// +---------+
// | started | functionally identical to stopped
// +---------+
// | ^
// | |
// SNP.Initialize SNP.Shutdown
// | |
// v |
// +-------------+ Virtio-net setup complete, including DRIVER_OK
// | initialized | bit. The receive queue is populated with
// +-------------+ requests; McastIpToMac, GetStatus, Transmit,
// Receive are callable.
//
typedef struct {
//
// Parts of this structure are initialized / torn down in various functions
// at various call depths. The table to the right should make it easier to
// track them.
//
// field init function
// ------------------ ------------------------------
UINT32 Signature; // VirtioNetDriverBindingStart
EFI_PCI_IO_PROTOCOL *PciIo; // VirtioNetDriverBindingStart
UINT64 OriginalPciAttributes; // VirtioNetDriverBindingStart
EFI_SIMPLE_NETWORK_PROTOCOL Snp; // VirtioNetSnpPopulate
EFI_SIMPLE_NETWORK_MODE Snm; // VirtioNetSnpPopulate
EFI_EVENT ExitBoot; // VirtioNetSnpPopulate
EFI_DEVICE_PATH_PROTOCOL *MacDevicePath; // VirtioNetDriverBindingStart
EFI_HANDLE MacHandle; // VirtioNetDriverBindingStart
E1K_RX_DESC *RxRing; // VirtioNetInitRing
UINT8 *RxBuf; // E1kNetInitRx
UINT32 RdhLastSeen; // E1kNetInitRx
UINTN RxBufNrPages; // E1kNetInitRx
EFI_PHYSICAL_ADDRESS RxBufDeviceBase; // E1kNetInitRx
EFI_PHYSICAL_ADDRESS RxDeviceBase; // E1kNetInitRx
VOID *RxMap; // E1kNetInitRx
UINT16 TxMaxPending; // E1kNetInitTx
UINT16 TxCurPending; // E1kNetInitTx
E1K_TX_DESC *TxRing; // E1kNetInitTx
VOID *TxRingMap; // E1kNetInitTx
UINT16 TxLastUsed; // E1kNetInitTx
UINT32 TdhLastSeen; // E1kNetInitTx
ORDERED_COLLECTION *TxBufCollection; // E1kNetInitTx
} E1K_NET_DEV;
//
// In order to avoid duplication of interface documentation, please find all
// leading comments near the respective function / variable definitions (not
// the declarations here), which is where your code editor of choice takes you
// anyway when jumping to a function.
//
//
// utility macros
//
#define E1K_NET_FROM_SNP(SnpPointer) \
CR (SnpPointer, E1K_NET_DEV, Snp, E1K_NET_DEV_SIGNATURE)
//
// component naming
//
extern EFI_COMPONENT_NAME_PROTOCOL gE1kNetComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gE1kNetComponentName2;
//
// driver binding
//
extern EFI_DRIVER_BINDING_PROTOCOL gE1kNetDriverBinding;
//
// member functions implementing the Simple Network Protocol
//
EFI_STATUS
EFIAPI
E1kNetStart (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This
);
EFI_STATUS
EFIAPI
E1kNetStop (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This
);
EFI_STATUS
EFIAPI
E1kNetInitialize (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN UINTN ExtraRxBufferSize OPTIONAL,
IN UINTN ExtraTxBufferSize OPTIONAL
);
EFI_STATUS
EFIAPI
E1kNetReset (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN BOOLEAN ExtendedVerification
);
EFI_STATUS
EFIAPI
E1kNetShutdown (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This
);
EFI_STATUS
EFIAPI
E1kNetReceiveFilters (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN UINT32 Enable,
IN UINT32 Disable,
IN BOOLEAN ResetMCastFilter,
IN UINTN MCastFilterCnt OPTIONAL,
IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL
);
EFI_STATUS
EFIAPI
E1kNetStationAddress (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN BOOLEAN Reset,
IN EFI_MAC_ADDRESS *New OPTIONAL
);
EFI_STATUS
EFIAPI
E1kNetStatistics (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN BOOLEAN Reset,
IN OUT UINTN *StatisticsSize OPTIONAL,
OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL
);
EFI_STATUS
EFIAPI
E1kNetMcastIpToMac (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN BOOLEAN IPv6,
IN EFI_IP_ADDRESS *Ip,
OUT EFI_MAC_ADDRESS *Mac
);
EFI_STATUS
EFIAPI
E1kNetNvData (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN BOOLEAN ReadWrite,
IN UINTN Offset,
IN UINTN BufferSize,
IN OUT VOID *Buffer
);
EFI_STATUS
EFIAPI
E1kNetGetStatus (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
OUT UINT32 *InterruptStatus OPTIONAL,
OUT VOID **TxBuf OPTIONAL
);
EFI_STATUS
EFIAPI
E1kNetTransmit (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN UINTN HeaderSize,
IN UINTN BufferSize,
IN /* +OUT! */ VOID *Buffer,
IN EFI_MAC_ADDRESS *SrcAddr OPTIONAL,
IN EFI_MAC_ADDRESS *DestAddr OPTIONAL,
IN UINT16 *Protocol OPTIONAL
);
EFI_STATUS
EFIAPI
E1kNetReceive (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
OUT UINTN *HeaderSize OPTIONAL,
IN OUT UINTN *BufferSize,
OUT VOID *Buffer,
OUT EFI_MAC_ADDRESS *SrcAddr OPTIONAL,
OUT EFI_MAC_ADDRESS *DestAddr OPTIONAL,
OUT UINT16 *Protocol OPTIONAL
);
//
// utility functions shared by various SNP member functions
//
VOID
EFIAPI
E1kNetShutdownRx (
IN OUT E1K_NET_DEV *Dev
);
VOID
EFIAPI
E1kNetShutdownTx (
IN OUT E1K_NET_DEV *Dev
);
//
// utility functions to map caller-supplied Tx buffer system physical address
// to a device address and vice versa
//
EFI_STATUS
EFIAPI
E1kNetMapTxBuf (
IN E1K_NET_DEV *Dev,
IN VOID *Buffer,
IN UINTN NumberOfBytes,
OUT EFI_PHYSICAL_ADDRESS *DeviceAddress
);
EFI_STATUS
EFIAPI
E1kNetUnmapTxBuf (
IN E1K_NET_DEV *Dev,
OUT VOID **Buffer,
IN EFI_PHYSICAL_ADDRESS DeviceAddress
);
INTN
EFIAPI
E1kNetTxBufMapInfoCompare (
IN CONST VOID *UserStruct1,
IN CONST VOID *UserStruct2
);
INTN
EFIAPI
E1kNetTxBufDeviceAddressCompare (
IN CONST VOID *StandaloneKey,
IN CONST VOID *UserStruct
);
//
// event callbacks
//
VOID
EFIAPI
E1kNetIsPacketAvailable (
IN EFI_EVENT Event,
IN VOID *Context
);
VOID
EFIAPI
E1kNetExitBoot (
IN EFI_EVENT Event,
IN VOID *Context
);
//
// Hardware I/O functions.
//
EFI_STATUS
EFIAPI
E1kNetRegWrite32 (
IN E1K_NET_DEV *Dev,
IN UINT32 Addr,
IN UINT32 Data
);
EFI_STATUS
EFIAPI
E1kNetRegRead32 (
IN E1K_NET_DEV *Dev,
IN UINT32 Addr,
OUT UINT32 *Data
);
EFI_STATUS
EFIAPI
E1kNetRegSet32 (
IN E1K_NET_DEV *Dev,
IN UINT32 Addr,
IN UINT32 Set
);
EFI_STATUS
EFIAPI
E1kNetRegClear32 (
IN E1K_NET_DEV *Dev,
IN UINT32 Addr,
IN UINT32 Clear
);
EFI_STATUS
EFIAPI
E1kNetDevReset (
IN E1K_NET_DEV *Dev
);
#endif // _E1K_NET_DXE_H_
|
