VirtualBox

source: vbox/trunk/src/VBox/Devices/Network/DevE1000.cpp@ 69304

Last change on this file since 69304 was 69298, checked in by vboxsync, 7 years ago

Devices/Network: scm updates
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 324.3 KB
Line 
1/* $Id: DevE1000.cpp 69298 2017-10-25 12:56:50Z vboxsync $ */
2/** @file
3 * DevE1000 - Intel 82540EM Ethernet Controller Emulation.
4 *
5 * Implemented in accordance with the specification:
6 *
7 * PCI/PCI-X Family of Gigabit Ethernet Controllers Software Developer's Manual
8 * 82540EP/EM, 82541xx, 82544GC/EI, 82545GM/EM, 82546GB/EB, and 82547xx
9 *
10 * 317453-002 Revision 3.5
11 *
12 * @todo IPv6 checksum offloading support
13 * @todo Flexible Filter / Wakeup (optional?)
14 */
15
16/*
17 * Copyright (C) 2007-2016 Oracle Corporation
18 *
19 * This file is part of VirtualBox Open Source Edition (OSE), as
20 * available from http://www.virtualbox.org. This file is free software;
21 * you can redistribute it and/or modify it under the terms of the GNU
22 * General Public License (GPL) as published by the Free Software
23 * Foundation, in version 2 as it comes in the "COPYING" file of the
24 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
25 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
26 */
27
28
29/*********************************************************************************************************************************
30* Header Files *
31*********************************************************************************************************************************/
32#define LOG_GROUP LOG_GROUP_DEV_E1000
33#include <iprt/crc.h>
34#include <iprt/ctype.h>
35#include <iprt/net.h>
36#include <iprt/semaphore.h>
37#include <iprt/string.h>
38#include <iprt/time.h>
39#include <iprt/uuid.h>
40#include <VBox/vmm/pdmdev.h>
41#include <VBox/vmm/pdmnetifs.h>
42#include <VBox/vmm/pdmnetinline.h>
43#include <VBox/param.h>
44#include "VBoxDD.h"
45
46#include "DevEEPROM.h"
47#include "DevE1000Phy.h"
48
49
50/*********************************************************************************************************************************
51* Defined Constants And Macros *
52*********************************************************************************************************************************/
53/** @name E1000 Build Options
54 * @{ */
55/** @def E1K_INIT_RA0
56 * E1K_INIT_RA0 forces E1000 to set the first entry in Receive Address filter
57 * table to MAC address obtained from CFGM. Most guests read MAC address from
58 * EEPROM and write it to RA[0] explicitly, but Mac OS X seems to depend on it
59 * being already set (see @bugref{4657}).
60 */
61#define E1K_INIT_RA0
62/** @def E1K_LSC_ON_RESET
63 * E1K_LSC_ON_RESET causes e1000 to generate Link Status Change
64 * interrupt after hard reset. This makes the E1K_LSC_ON_SLU option unnecessary.
65 * With unplugged cable, LSC is triggerred for 82543GC only.
66 */
67#define E1K_LSC_ON_RESET
68/** @def E1K_LSC_ON_SLU
69 * E1K_LSC_ON_SLU causes E1000 to generate Link Status Change interrupt when
70 * the guest driver brings up the link via STATUS.LU bit. Again the only guest
71 * that requires it is Mac OS X (see @bugref{4657}).
72 */
73//#define E1K_LSC_ON_SLU
74/** @def E1K_INIT_LINKUP_DELAY
75 * E1K_INIT_LINKUP_DELAY prevents the link going up while the driver is still
76 * in init (see @bugref{8624}).
77 */
78#define E1K_INIT_LINKUP_DELAY_US (2000 * 1000)
79/** @def E1K_IMS_INT_DELAY_NS
80 * E1K_IMS_INT_DELAY_NS prevents interrupt storms in Windows guests on enabling
81 * interrupts (see @bugref{8624}).
82 */
83#define E1K_IMS_INT_DELAY_NS 100
84/** @def E1K_TX_DELAY
85 * E1K_TX_DELAY aims to improve guest-host transfer rate for TCP streams by
86 * preventing packets to be sent immediately. It allows to send several
87 * packets in a batch reducing the number of acknowledgments. Note that it
88 * effectively disables R0 TX path, forcing sending in R3.
89 */
90//#define E1K_TX_DELAY 150
91/** @def E1K_USE_TX_TIMERS
92 * E1K_USE_TX_TIMERS aims to reduce the number of generated TX interrupts if a
93 * guest driver set the delays via the Transmit Interrupt Delay Value (TIDV)
94 * register. Enabling it showed no positive effects on existing guests so it
95 * stays disabled. See sections 3.2.7.1 and 3.4.3.1 in "8254x Family of Gigabit
96 * Ethernet Controllers Software Developer’s Manual" for more detailed
97 * explanation.
98 */
99//#define E1K_USE_TX_TIMERS
100/** @def E1K_NO_TAD
101 * E1K_NO_TAD disables one of two timers enabled by E1K_USE_TX_TIMERS, the
102 * Transmit Absolute Delay time. This timer sets the maximum time interval
103 * during which TX interrupts can be postponed (delayed). It has no effect
104 * if E1K_USE_TX_TIMERS is not defined.
105 */
106//#define E1K_NO_TAD
107/** @def E1K_REL_DEBUG
108 * E1K_REL_DEBUG enables debug logging of l1, l2, l3 in release build.
109 */
110//#define E1K_REL_DEBUG
111/** @def E1K_INT_STATS
112 * E1K_INT_STATS enables collection of internal statistics used for
113 * debugging of delayed interrupts, etc.
114 */
115#define E1K_INT_STATS
116/** @def E1K_WITH_MSI
117 * E1K_WITH_MSI enables rudimentary MSI support. Not implemented.
118 */
119//#define E1K_WITH_MSI
120/** @def E1K_WITH_TX_CS
121 * E1K_WITH_TX_CS protects e1kXmitPending with a critical section.
122 */
123#define E1K_WITH_TX_CS
124/** @def E1K_WITH_TXD_CACHE
125 * E1K_WITH_TXD_CACHE causes E1000 to fetch multiple TX descriptors in a
126 * single physical memory read (or two if it wraps around the end of TX
127 * descriptor ring). It is required for proper functioning of bandwidth
128 * resource control as it allows to compute exact sizes of packets prior
129 * to allocating their buffers (see @bugref{5582}).
130 */
131#define E1K_WITH_TXD_CACHE
132/** @def E1K_WITH_RXD_CACHE
133 * E1K_WITH_RXD_CACHE causes E1000 to fetch multiple RX descriptors in a
134 * single physical memory read (or two if it wraps around the end of RX
135 * descriptor ring). Intel's packet driver for DOS needs this option in
136 * order to work properly (see @bugref{6217}).
137 */
138#define E1K_WITH_RXD_CACHE
139/** @def E1K_WITH_PREREG_MMIO
140 * E1K_WITH_PREREG_MMIO enables a new style MMIO registration and is
141 * currently only done for testing the relateted PDM, IOM and PGM code. */
142//#define E1K_WITH_PREREG_MMIO
143/* @} */
144/* End of Options ************************************************************/
145
146#ifdef E1K_WITH_TXD_CACHE
147/**
148 * E1K_TXD_CACHE_SIZE specifies the maximum number of TX descriptors stored
149 * in the state structure. It limits the amount of descriptors loaded in one
150 * batch read. For example, Linux guest may use up to 20 descriptors per
151 * TSE packet. The largest TSE packet seen (Windows guest) was 45 descriptors.
152 */
153# define E1K_TXD_CACHE_SIZE 64u
154#endif /* E1K_WITH_TXD_CACHE */
155
156#ifdef E1K_WITH_RXD_CACHE
157/**
158 * E1K_RXD_CACHE_SIZE specifies the maximum number of RX descriptors stored
159 * in the state structure. It limits the amount of descriptors loaded in one
160 * batch read. For example, XP guest adds 15 RX descriptors at a time.
161 */
162# define E1K_RXD_CACHE_SIZE 16u
163#endif /* E1K_WITH_RXD_CACHE */
164
165
166/* Little helpers ************************************************************/
167#undef htons
168#undef ntohs
169#undef htonl
170#undef ntohl
171#define htons(x) ((((x) & 0xff00) >> 8) | (((x) & 0x00ff) << 8))
172#define ntohs(x) htons(x)
173#define htonl(x) ASMByteSwapU32(x)
174#define ntohl(x) htonl(x)
175
176#ifndef DEBUG
177# ifdef E1K_REL_DEBUG
178# define DEBUG
179# define E1kLog(a) LogRel(a)
180# define E1kLog2(a) LogRel(a)
181# define E1kLog3(a) LogRel(a)
182# define E1kLogX(x, a) LogRel(a)
183//# define E1kLog3(a) do {} while (0)
184# else
185# define E1kLog(a) do {} while (0)
186# define E1kLog2(a) do {} while (0)
187# define E1kLog3(a) do {} while (0)
188# define E1kLogX(x, a) do {} while (0)
189# endif
190#else
191# define E1kLog(a) Log(a)
192# define E1kLog2(a) Log2(a)
193# define E1kLog3(a) Log3(a)
194# define E1kLogX(x, a) LogIt(x, LOG_GROUP, a)
195//# define E1kLog(a) do {} while (0)
196//# define E1kLog2(a) do {} while (0)
197//# define E1kLog3(a) do {} while (0)
198#endif
199
200#if 0
201# define LOG_ENABLED
202# define E1kLogRel(a) LogRel(a)
203# undef Log6
204# define Log6(a) LogRel(a)
205#else
206# define E1kLogRel(a) do { } while (0)
207#endif
208
209//#undef DEBUG
210
211#define STATE_TO_DEVINS(pThis) (((PE1KSTATE )pThis)->CTX_SUFF(pDevIns))
212#define E1K_RELOCATE(p, o) *(RTHCUINTPTR *)&p += o
213
214#define E1K_INC_CNT32(cnt) \
215do { \
216 if (cnt < UINT32_MAX) \
217 cnt++; \
218} while (0)
219
220#define E1K_ADD_CNT64(cntLo, cntHi, val) \
221do { \
222 uint64_t u64Cnt = RT_MAKE_U64(cntLo, cntHi); \
223 uint64_t tmp = u64Cnt; \
224 u64Cnt += val; \
225 if (tmp > u64Cnt ) \
226 u64Cnt = UINT64_MAX; \
227 cntLo = (uint32_t)u64Cnt; \
228 cntHi = (uint32_t)(u64Cnt >> 32); \
229} while (0)
230
231#ifdef E1K_INT_STATS
232# define E1K_INC_ISTAT_CNT(cnt) do { ++cnt; } while (0)
233#else /* E1K_INT_STATS */
234# define E1K_INC_ISTAT_CNT(cnt) do { } while (0)
235#endif /* E1K_INT_STATS */
236
237
238/*****************************************************************************/
239
240typedef uint32_t E1KCHIP;
241#define E1K_CHIP_82540EM 0
242#define E1K_CHIP_82543GC 1
243#define E1K_CHIP_82545EM 2
244
245#ifdef IN_RING3
246/** Different E1000 chips. */
247static const struct E1kChips
248{
249 uint16_t uPCIVendorId;
250 uint16_t uPCIDeviceId;
251 uint16_t uPCISubsystemVendorId;
252 uint16_t uPCISubsystemId;
253 const char *pcszName;
254} g_aChips[] =
255{
256 /* Vendor Device SSVendor SubSys Name */
257 { 0x8086,
258 /* Temporary code, as MSI-aware driver dislike 0x100E. How to do that right? */
259# ifdef E1K_WITH_MSI
260 0x105E,
261# else
262 0x100E,
263# endif
264 0x8086, 0x001E, "82540EM" }, /* Intel 82540EM-A in Intel PRO/1000 MT Desktop */
265 { 0x8086, 0x1004, 0x8086, 0x1004, "82543GC" }, /* Intel 82543GC in Intel PRO/1000 T Server */
266 { 0x8086, 0x100F, 0x15AD, 0x0750, "82545EM" } /* Intel 82545EM-A in VMWare Network Adapter */
267};
268#endif /* IN_RING3 */
269
270
271/* The size of register area mapped to I/O space */
272#define E1K_IOPORT_SIZE 0x8
273/* The size of memory-mapped register area */
274#define E1K_MM_SIZE 0x20000
275
276#define E1K_MAX_TX_PKT_SIZE 16288
277#define E1K_MAX_RX_PKT_SIZE 16384
278
279/*****************************************************************************/
280
281/** Gets the specfieid bits from the register. */
282#define GET_BITS(reg, bits) ((reg & reg##_##bits##_MASK) >> reg##_##bits##_SHIFT)
283#define GET_BITS_V(val, reg, bits) ((val & reg##_##bits##_MASK) >> reg##_##bits##_SHIFT)
284#define BITS(reg, bits, bitval) (bitval << reg##_##bits##_SHIFT)
285#define SET_BITS(reg, bits, bitval) do { reg = (reg & ~reg##_##bits##_MASK) | (bitval << reg##_##bits##_SHIFT); } while (0)
286#define SET_BITS_V(val, reg, bits, bitval) do { val = (val & ~reg##_##bits##_MASK) | (bitval << reg##_##bits##_SHIFT); } while (0)
287
288#define CTRL_SLU UINT32_C(0x00000040)
289#define CTRL_MDIO UINT32_C(0x00100000)
290#define CTRL_MDC UINT32_C(0x00200000)
291#define CTRL_MDIO_DIR UINT32_C(0x01000000)
292#define CTRL_MDC_DIR UINT32_C(0x02000000)
293#define CTRL_RESET UINT32_C(0x04000000)
294#define CTRL_VME UINT32_C(0x40000000)
295
296#define STATUS_LU UINT32_C(0x00000002)
297#define STATUS_TXOFF UINT32_C(0x00000010)
298
299#define EECD_EE_WIRES UINT32_C(0x0F)
300#define EECD_EE_REQ UINT32_C(0x40)
301#define EECD_EE_GNT UINT32_C(0x80)
302
303#define EERD_START UINT32_C(0x00000001)
304#define EERD_DONE UINT32_C(0x00000010)
305#define EERD_DATA_MASK UINT32_C(0xFFFF0000)
306#define EERD_DATA_SHIFT 16
307#define EERD_ADDR_MASK UINT32_C(0x0000FF00)
308#define EERD_ADDR_SHIFT 8
309
310#define MDIC_DATA_MASK UINT32_C(0x0000FFFF)
311#define MDIC_DATA_SHIFT 0
312#define MDIC_REG_MASK UINT32_C(0x001F0000)
313#define MDIC_REG_SHIFT 16
314#define MDIC_PHY_MASK UINT32_C(0x03E00000)
315#define MDIC_PHY_SHIFT 21
316#define MDIC_OP_WRITE UINT32_C(0x04000000)
317#define MDIC_OP_READ UINT32_C(0x08000000)
318#define MDIC_READY UINT32_C(0x10000000)
319#define MDIC_INT_EN UINT32_C(0x20000000)
320#define MDIC_ERROR UINT32_C(0x40000000)
321
322#define TCTL_EN UINT32_C(0x00000002)
323#define TCTL_PSP UINT32_C(0x00000008)
324
325#define RCTL_EN UINT32_C(0x00000002)
326#define RCTL_UPE UINT32_C(0x00000008)
327#define RCTL_MPE UINT32_C(0x00000010)
328#define RCTL_LPE UINT32_C(0x00000020)
329#define RCTL_LBM_MASK UINT32_C(0x000000C0)
330#define RCTL_LBM_SHIFT 6
331#define RCTL_RDMTS_MASK UINT32_C(0x00000300)
332#define RCTL_RDMTS_SHIFT 8
333#define RCTL_LBM_TCVR UINT32_C(3) /**< PHY or external SerDes loopback. */
334#define RCTL_MO_MASK UINT32_C(0x00003000)
335#define RCTL_MO_SHIFT 12
336#define RCTL_BAM UINT32_C(0x00008000)
337#define RCTL_BSIZE_MASK UINT32_C(0x00030000)
338#define RCTL_BSIZE_SHIFT 16
339#define RCTL_VFE UINT32_C(0x00040000)
340#define RCTL_CFIEN UINT32_C(0x00080000)
341#define RCTL_CFI UINT32_C(0x00100000)
342#define RCTL_BSEX UINT32_C(0x02000000)
343#define RCTL_SECRC UINT32_C(0x04000000)
344
345#define ICR_TXDW UINT32_C(0x00000001)
346#define ICR_TXQE UINT32_C(0x00000002)
347#define ICR_LSC UINT32_C(0x00000004)
348#define ICR_RXDMT0 UINT32_C(0x00000010)
349#define ICR_RXT0 UINT32_C(0x00000080)
350#define ICR_TXD_LOW UINT32_C(0x00008000)
351#define RDTR_FPD UINT32_C(0x80000000)
352
353#define PBA_st ((PBAST*)(pThis->auRegs + PBA_IDX))
354typedef struct
355{
356 unsigned rxa : 7;
357 unsigned rxa_r : 9;
358 unsigned txa : 16;
359} PBAST;
360AssertCompileSize(PBAST, 4);
361
362#define TXDCTL_WTHRESH_MASK 0x003F0000
363#define TXDCTL_WTHRESH_SHIFT 16
364#define TXDCTL_LWTHRESH_MASK 0xFE000000
365#define TXDCTL_LWTHRESH_SHIFT 25
366
367#define RXCSUM_PCSS_MASK UINT32_C(0x000000FF)
368#define RXCSUM_PCSS_SHIFT 0
369
370/** @name Register access macros
371 * @remarks These ASSUME alocal variable @a pThis of type PE1KSTATE.
372 * @{ */
373#define CTRL pThis->auRegs[CTRL_IDX]
374#define STATUS pThis->auRegs[STATUS_IDX]
375#define EECD pThis->auRegs[EECD_IDX]
376#define EERD pThis->auRegs[EERD_IDX]
377#define CTRL_EXT pThis->auRegs[CTRL_EXT_IDX]
378#define FLA pThis->auRegs[FLA_IDX]
379#define MDIC pThis->auRegs[MDIC_IDX]
380#define FCAL pThis->auRegs[FCAL_IDX]
381#define FCAH pThis->auRegs[FCAH_IDX]
382#define FCT pThis->auRegs[FCT_IDX]
383#define VET pThis->auRegs[VET_IDX]
384#define ICR pThis->auRegs[ICR_IDX]
385#define ITR pThis->auRegs[ITR_IDX]
386#define ICS pThis->auRegs[ICS_IDX]
387#define IMS pThis->auRegs[IMS_IDX]
388#define IMC pThis->auRegs[IMC_IDX]
389#define RCTL pThis->auRegs[RCTL_IDX]
390#define FCTTV pThis->auRegs[FCTTV_IDX]
391#define TXCW pThis->auRegs[TXCW_IDX]
392#define RXCW pThis->auRegs[RXCW_IDX]
393#define TCTL pThis->auRegs[TCTL_IDX]
394#define TIPG pThis->auRegs[TIPG_IDX]
395#define AIFS pThis->auRegs[AIFS_IDX]
396#define LEDCTL pThis->auRegs[LEDCTL_IDX]
397#define PBA pThis->auRegs[PBA_IDX]
398#define FCRTL pThis->auRegs[FCRTL_IDX]
399#define FCRTH pThis->auRegs[FCRTH_IDX]
400#define RDFH pThis->auRegs[RDFH_IDX]
401#define RDFT pThis->auRegs[RDFT_IDX]
402#define RDFHS pThis->auRegs[RDFHS_IDX]
403#define RDFTS pThis->auRegs[RDFTS_IDX]
404#define RDFPC pThis->auRegs[RDFPC_IDX]
405#define RDBAL pThis->auRegs[RDBAL_IDX]
406#define RDBAH pThis->auRegs[RDBAH_IDX]
407#define RDLEN pThis->auRegs[RDLEN_IDX]
408#define RDH pThis->auRegs[RDH_IDX]
409#define RDT pThis->auRegs[RDT_IDX]
410#define RDTR pThis->auRegs[RDTR_IDX]
411#define RXDCTL pThis->auRegs[RXDCTL_IDX]
412#define RADV pThis->auRegs[RADV_IDX]
413#define RSRPD pThis->auRegs[RSRPD_IDX]
414#define TXDMAC pThis->auRegs[TXDMAC_IDX]
415#define TDFH pThis->auRegs[TDFH_IDX]
416#define TDFT pThis->auRegs[TDFT_IDX]
417#define TDFHS pThis->auRegs[TDFHS_IDX]
418#define TDFTS pThis->auRegs[TDFTS_IDX]
419#define TDFPC pThis->auRegs[TDFPC_IDX]
420#define TDBAL pThis->auRegs[TDBAL_IDX]
421#define TDBAH pThis->auRegs[TDBAH_IDX]
422#define TDLEN pThis->auRegs[TDLEN_IDX]
423#define TDH pThis->auRegs[TDH_IDX]
424#define TDT pThis->auRegs[TDT_IDX]
425#define TIDV pThis->auRegs[TIDV_IDX]
426#define TXDCTL pThis->auRegs[TXDCTL_IDX]
427#define TADV pThis->auRegs[TADV_IDX]
428#define TSPMT pThis->auRegs[TSPMT_IDX]
429#define CRCERRS pThis->auRegs[CRCERRS_IDX]
430#define ALGNERRC pThis->auRegs[ALGNERRC_IDX]
431#define SYMERRS pThis->auRegs[SYMERRS_IDX]
432#define RXERRC pThis->auRegs[RXERRC_IDX]
433#define MPC pThis->auRegs[MPC_IDX]
434#define SCC pThis->auRegs[SCC_IDX]
435#define ECOL pThis->auRegs[ECOL_IDX]
436#define MCC pThis->auRegs[MCC_IDX]
437#define LATECOL pThis->auRegs[LATECOL_IDX]
438#define COLC pThis->auRegs[COLC_IDX]
439#define DC pThis->auRegs[DC_IDX]
440#define TNCRS pThis->auRegs[TNCRS_IDX]
441/* #define SEC pThis->auRegs[SEC_IDX] Conflict with sys/time.h */
442#define CEXTERR pThis->auRegs[CEXTERR_IDX]
443#define RLEC pThis->auRegs[RLEC_IDX]
444#define XONRXC pThis->auRegs[XONRXC_IDX]
445#define XONTXC pThis->auRegs[XONTXC_IDX]
446#define XOFFRXC pThis->auRegs[XOFFRXC_IDX]
447#define XOFFTXC pThis->auRegs[XOFFTXC_IDX]
448#define FCRUC pThis->auRegs[FCRUC_IDX]
449#define PRC64 pThis->auRegs[PRC64_IDX]
450#define PRC127 pThis->auRegs[PRC127_IDX]
451#define PRC255 pThis->auRegs[PRC255_IDX]
452#define PRC511 pThis->auRegs[PRC511_IDX]
453#define PRC1023 pThis->auRegs[PRC1023_IDX]
454#define PRC1522 pThis->auRegs[PRC1522_IDX]
455#define GPRC pThis->auRegs[GPRC_IDX]
456#define BPRC pThis->auRegs[BPRC_IDX]
457#define MPRC pThis->auRegs[MPRC_IDX]
458#define GPTC pThis->auRegs[GPTC_IDX]
459#define GORCL pThis->auRegs[GORCL_IDX]
460#define GORCH pThis->auRegs[GORCH_IDX]
461#define GOTCL pThis->auRegs[GOTCL_IDX]
462#define GOTCH pThis->auRegs[GOTCH_IDX]
463#define RNBC pThis->auRegs[RNBC_IDX]
464#define RUC pThis->auRegs[RUC_IDX]
465#define RFC pThis->auRegs[RFC_IDX]
466#define ROC pThis->auRegs[ROC_IDX]
467#define RJC pThis->auRegs[RJC_IDX]
468#define MGTPRC pThis->auRegs[MGTPRC_IDX]
469#define MGTPDC pThis->auRegs[MGTPDC_IDX]
470#define MGTPTC pThis->auRegs[MGTPTC_IDX]
471#define TORL pThis->auRegs[TORL_IDX]
472#define TORH pThis->auRegs[TORH_IDX]
473#define TOTL pThis->auRegs[TOTL_IDX]
474#define TOTH pThis->auRegs[TOTH_IDX]
475#define TPR pThis->auRegs[TPR_IDX]
476#define TPT pThis->auRegs[TPT_IDX]
477#define PTC64 pThis->auRegs[PTC64_IDX]
478#define PTC127 pThis->auRegs[PTC127_IDX]
479#define PTC255 pThis->auRegs[PTC255_IDX]
480#define PTC511 pThis->auRegs[PTC511_IDX]
481#define PTC1023 pThis->auRegs[PTC1023_IDX]
482#define PTC1522 pThis->auRegs[PTC1522_IDX]
483#define MPTC pThis->auRegs[MPTC_IDX]
484#define BPTC pThis->auRegs[BPTC_IDX]
485#define TSCTC pThis->auRegs[TSCTC_IDX]
486#define TSCTFC pThis->auRegs[TSCTFC_IDX]
487#define RXCSUM pThis->auRegs[RXCSUM_IDX]
488#define WUC pThis->auRegs[WUC_IDX]
489#define WUFC pThis->auRegs[WUFC_IDX]
490#define WUS pThis->auRegs[WUS_IDX]
491#define MANC pThis->auRegs[MANC_IDX]
492#define IPAV pThis->auRegs[IPAV_IDX]
493#define WUPL pThis->auRegs[WUPL_IDX]
494/** @} */
495
496/**
497 * Indices of memory-mapped registers in register table.
498 */
499typedef enum
500{
501 CTRL_IDX,
502 STATUS_IDX,
503 EECD_IDX,
504 EERD_IDX,
505 CTRL_EXT_IDX,
506 FLA_IDX,
507 MDIC_IDX,
508 FCAL_IDX,
509 FCAH_IDX,
510 FCT_IDX,
511 VET_IDX,
512 ICR_IDX,
513 ITR_IDX,
514 ICS_IDX,
515 IMS_IDX,
516 IMC_IDX,
517 RCTL_IDX,
518 FCTTV_IDX,
519 TXCW_IDX,
520 RXCW_IDX,
521 TCTL_IDX,
522 TIPG_IDX,
523 AIFS_IDX,
524 LEDCTL_IDX,
525 PBA_IDX,
526 FCRTL_IDX,
527 FCRTH_IDX,
528 RDFH_IDX,
529 RDFT_IDX,
530 RDFHS_IDX,
531 RDFTS_IDX,
532 RDFPC_IDX,
533 RDBAL_IDX,
534 RDBAH_IDX,
535 RDLEN_IDX,
536 RDH_IDX,
537 RDT_IDX,
538 RDTR_IDX,
539 RXDCTL_IDX,
540 RADV_IDX,
541 RSRPD_IDX,
542 TXDMAC_IDX,
543 TDFH_IDX,
544 TDFT_IDX,
545 TDFHS_IDX,
546 TDFTS_IDX,
547 TDFPC_IDX,
548 TDBAL_IDX,
549 TDBAH_IDX,
550 TDLEN_IDX,
551 TDH_IDX,
552 TDT_IDX,
553 TIDV_IDX,
554 TXDCTL_IDX,
555 TADV_IDX,
556 TSPMT_IDX,
557 CRCERRS_IDX,
558 ALGNERRC_IDX,
559 SYMERRS_IDX,
560 RXERRC_IDX,
561 MPC_IDX,
562 SCC_IDX,
563 ECOL_IDX,
564 MCC_IDX,
565 LATECOL_IDX,
566 COLC_IDX,
567 DC_IDX,
568 TNCRS_IDX,
569 SEC_IDX,
570 CEXTERR_IDX,
571 RLEC_IDX,
572 XONRXC_IDX,
573 XONTXC_IDX,
574 XOFFRXC_IDX,
575 XOFFTXC_IDX,
576 FCRUC_IDX,
577 PRC64_IDX,
578 PRC127_IDX,
579 PRC255_IDX,
580 PRC511_IDX,
581 PRC1023_IDX,
582 PRC1522_IDX,
583 GPRC_IDX,
584 BPRC_IDX,
585 MPRC_IDX,
586 GPTC_IDX,
587 GORCL_IDX,
588 GORCH_IDX,
589 GOTCL_IDX,
590 GOTCH_IDX,
591 RNBC_IDX,
592 RUC_IDX,
593 RFC_IDX,
594 ROC_IDX,
595 RJC_IDX,
596 MGTPRC_IDX,
597 MGTPDC_IDX,
598 MGTPTC_IDX,
599 TORL_IDX,
600 TORH_IDX,
601 TOTL_IDX,
602 TOTH_IDX,
603 TPR_IDX,
604 TPT_IDX,
605 PTC64_IDX,
606 PTC127_IDX,
607 PTC255_IDX,
608 PTC511_IDX,
609 PTC1023_IDX,
610 PTC1522_IDX,
611 MPTC_IDX,
612 BPTC_IDX,
613 TSCTC_IDX,
614 TSCTFC_IDX,
615 RXCSUM_IDX,
616 WUC_IDX,
617 WUFC_IDX,
618 WUS_IDX,
619 MANC_IDX,
620 IPAV_IDX,
621 WUPL_IDX,
622 MTA_IDX,
623 RA_IDX,
624 VFTA_IDX,
625 IP4AT_IDX,
626 IP6AT_IDX,
627 WUPM_IDX,
628 FFLT_IDX,
629 FFMT_IDX,
630 FFVT_IDX,
631 PBM_IDX,
632 RA_82542_IDX,
633 MTA_82542_IDX,
634 VFTA_82542_IDX,
635 E1K_NUM_OF_REGS
636} E1kRegIndex;
637
638#define E1K_NUM_OF_32BIT_REGS MTA_IDX
639/** The number of registers with strictly increasing offset. */
640#define E1K_NUM_OF_BINARY_SEARCHABLE (WUPL_IDX + 1)
641
642
643/**
644 * Define E1000-specific EEPROM layout.
645 */
646struct E1kEEPROM
647{
648 public:
649 EEPROM93C46 eeprom;
650
651#ifdef IN_RING3
652 /**
653 * Initialize EEPROM content.
654 *
655 * @param macAddr MAC address of E1000.
656 */
657 void init(RTMAC &macAddr)
658 {
659 eeprom.init();
660 memcpy(eeprom.m_au16Data, macAddr.au16, sizeof(macAddr.au16));
661 eeprom.m_au16Data[0x04] = 0xFFFF;
662 /*
663 * bit 3 - full support for power management
664 * bit 10 - full duplex
665 */
666 eeprom.m_au16Data[0x0A] = 0x4408;
667 eeprom.m_au16Data[0x0B] = 0x001E;
668 eeprom.m_au16Data[0x0C] = 0x8086;
669 eeprom.m_au16Data[0x0D] = 0x100E;
670 eeprom.m_au16Data[0x0E] = 0x8086;
671 eeprom.m_au16Data[0x0F] = 0x3040;
672 eeprom.m_au16Data[0x21] = 0x7061;
673 eeprom.m_au16Data[0x22] = 0x280C;
674 eeprom.m_au16Data[0x23] = 0x00C8;
675 eeprom.m_au16Data[0x24] = 0x00C8;
676 eeprom.m_au16Data[0x2F] = 0x0602;
677 updateChecksum();
678 };
679
680 /**
681 * Compute the checksum as required by E1000 and store it
682 * in the last word.
683 */
684 void updateChecksum()
685 {
686 uint16_t u16Checksum = 0;
687
688 for (int i = 0; i < eeprom.SIZE-1; i++)
689 u16Checksum += eeprom.m_au16Data[i];
690 eeprom.m_au16Data[eeprom.SIZE-1] = 0xBABA - u16Checksum;
691 };
692
693 /**
694 * First 6 bytes of EEPROM contain MAC address.
695 *
696 * @returns MAC address of E1000.
697 */
698 void getMac(PRTMAC pMac)
699 {
700 memcpy(pMac->au16, eeprom.m_au16Data, sizeof(pMac->au16));
701 };
702
703 uint32_t read()
704 {
705 return eeprom.read();
706 }
707
708 void write(uint32_t u32Wires)
709 {
710 eeprom.write(u32Wires);
711 }
712
713 bool readWord(uint32_t u32Addr, uint16_t *pu16Value)
714 {
715 return eeprom.readWord(u32Addr, pu16Value);
716 }
717
718 int load(PSSMHANDLE pSSM)
719 {
720 return eeprom.load(pSSM);
721 }
722
723 void save(PSSMHANDLE pSSM)
724 {
725 eeprom.save(pSSM);
726 }
727#endif /* IN_RING3 */
728};
729
730
731#define E1K_SPEC_VLAN(s) (s & 0xFFF)
732#define E1K_SPEC_CFI(s) (!!((s>>12) & 0x1))
733#define E1K_SPEC_PRI(s) ((s>>13) & 0x7)
734
735struct E1kRxDStatus
736{
737 /** @name Descriptor Status field (3.2.3.1)
738 * @{ */
739 unsigned fDD : 1; /**< Descriptor Done. */
740 unsigned fEOP : 1; /**< End of packet. */
741 unsigned fIXSM : 1; /**< Ignore checksum indication. */
742 unsigned fVP : 1; /**< VLAN, matches VET. */
743 unsigned : 1;
744 unsigned fTCPCS : 1; /**< RCP Checksum calculated on the packet. */
745 unsigned fIPCS : 1; /**< IP Checksum calculated on the packet. */
746 unsigned fPIF : 1; /**< Passed in-exact filter */
747 /** @} */
748 /** @name Descriptor Errors field (3.2.3.2)
749 * (Only valid when fEOP and fDD are set.)
750 * @{ */
751 unsigned fCE : 1; /**< CRC or alignment error. */
752 unsigned : 4; /**< Reserved, varies with different models... */
753 unsigned fTCPE : 1; /**< TCP/UDP checksum error. */
754 unsigned fIPE : 1; /**< IP Checksum error. */
755 unsigned fRXE : 1; /**< RX Data error. */
756 /** @} */
757 /** @name Descriptor Special field (3.2.3.3)
758 * @{ */
759 unsigned u16Special : 16; /**< VLAN: Id, Canonical form, Priority. */
760 /** @} */
761};
762typedef struct E1kRxDStatus E1KRXDST;
763
764struct E1kRxDesc_st
765{
766 uint64_t u64BufAddr; /**< Address of data buffer */
767 uint16_t u16Length; /**< Length of data in buffer */
768 uint16_t u16Checksum; /**< Packet checksum */
769 E1KRXDST status;
770};
771typedef struct E1kRxDesc_st E1KRXDESC;
772AssertCompileSize(E1KRXDESC, 16);
773
774#define E1K_DTYP_LEGACY -1
775#define E1K_DTYP_CONTEXT 0
776#define E1K_DTYP_DATA 1
777
778struct E1kTDLegacy
779{
780 uint64_t u64BufAddr; /**< Address of data buffer */
781 struct TDLCmd_st
782 {
783 unsigned u16Length : 16;
784 unsigned u8CSO : 8;
785 /* CMD field : 8 */
786 unsigned fEOP : 1;
787 unsigned fIFCS : 1;
788 unsigned fIC : 1;
789 unsigned fRS : 1;
790 unsigned fRPS : 1;
791 unsigned fDEXT : 1;
792 unsigned fVLE : 1;
793 unsigned fIDE : 1;
794 } cmd;
795 struct TDLDw3_st
796 {
797 /* STA field */
798 unsigned fDD : 1;
799 unsigned fEC : 1;
800 unsigned fLC : 1;
801 unsigned fTURSV : 1;
802 /* RSV field */
803 unsigned u4RSV : 4;
804 /* CSS field */
805 unsigned u8CSS : 8;
806 /* Special field*/
807 unsigned u16Special: 16;
808 } dw3;
809};
810
811/**
812 * TCP/IP Context Transmit Descriptor, section 3.3.6.
813 */
814struct E1kTDContext
815{
816 struct CheckSum_st
817 {
818 /** TSE: Header start. !TSE: Checksum start. */
819 unsigned u8CSS : 8;
820 /** Checksum offset - where to store it. */
821 unsigned u8CSO : 8;
822 /** Checksum ending (inclusive) offset, 0 = end of packet. */
823 unsigned u16CSE : 16;
824 } ip;
825 struct CheckSum_st tu;
826 struct TDCDw2_st
827 {
828 /** TSE: The total number of payload bytes for this context. Sans header. */
829 unsigned u20PAYLEN : 20;
830 /** The descriptor type - E1K_DTYP_CONTEXT (0). */
831 unsigned u4DTYP : 4;
832 /** TUCMD field, 8 bits
833 * @{ */
834 /** TSE: TCP (set) or UDP (clear). */
835 unsigned fTCP : 1;
836 /** TSE: IPv4 (set) or IPv6 (clear) - for finding the payload length field in
837 * the IP header. Does not affect the checksumming.
838 * @remarks 82544GC/EI interprets a cleared field differently. */
839 unsigned fIP : 1;
840 /** TSE: TCP segmentation enable. When clear the context describes */
841 unsigned fTSE : 1;
842 /** Report status (only applies to dw3.fDD for here). */
843 unsigned fRS : 1;
844 /** Reserved, MBZ. */
845 unsigned fRSV1 : 1;
846 /** Descriptor extension, must be set for this descriptor type. */
847 unsigned fDEXT : 1;
848 /** Reserved, MBZ. */
849 unsigned fRSV2 : 1;
850 /** Interrupt delay enable. */
851 unsigned fIDE : 1;
852 /** @} */
853 } dw2;
854 struct TDCDw3_st
855 {
856 /** Descriptor Done. */
857 unsigned fDD : 1;
858 /** Reserved, MBZ. */
859 unsigned u7RSV : 7;
860 /** TSO: The header (prototype) length (Ethernet[, VLAN tag], IP, TCP/UDP. */
861 unsigned u8HDRLEN : 8;
862 /** TSO: Maximum segment size. */
863 unsigned u16MSS : 16;
864 } dw3;
865};
866typedef struct E1kTDContext E1KTXCTX;
867
868/**
869 * TCP/IP Data Transmit Descriptor, section 3.3.7.
870 */
871struct E1kTDData
872{
873 uint64_t u64BufAddr; /**< Address of data buffer */
874 struct TDDCmd_st
875 {
876 /** The total length of data pointed to by this descriptor. */
877 unsigned u20DTALEN : 20;
878 /** The descriptor type - E1K_DTYP_DATA (1). */
879 unsigned u4DTYP : 4;
880 /** @name DCMD field, 8 bits (3.3.7.1).
881 * @{ */
882 /** End of packet. Note TSCTFC update. */
883 unsigned fEOP : 1;
884 /** Insert Ethernet FCS/CRC (requires fEOP to be set). */
885 unsigned fIFCS : 1;
886 /** Use the TSE context when set and the normal when clear. */
887 unsigned fTSE : 1;
888 /** Report status (dw3.STA). */
889 unsigned fRS : 1;
890 /** Reserved. 82544GC/EI defines this report packet set (RPS). */
891 unsigned fRPS : 1;
892 /** Descriptor extension, must be set for this descriptor type. */
893 unsigned fDEXT : 1;
894 /** VLAN enable, requires CTRL.VME, auto enables FCS/CRC.
895 * Insert dw3.SPECIAL after ethernet header. */
896 unsigned fVLE : 1;
897 /** Interrupt delay enable. */
898 unsigned fIDE : 1;
899 /** @} */
900 } cmd;
901 struct TDDDw3_st
902 {
903 /** @name STA field (3.3.7.2)
904 * @{ */
905 unsigned fDD : 1; /**< Descriptor done. */
906 unsigned fEC : 1; /**< Excess collision. */
907 unsigned fLC : 1; /**< Late collision. */
908 /** Reserved, except for the usual oddball (82544GC/EI) where it's called TU. */
909 unsigned fTURSV : 1;
910 /** @} */
911 unsigned u4RSV : 4; /**< Reserved field, MBZ. */
912 /** @name POPTS (Packet Option) field (3.3.7.3)
913 * @{ */
914 unsigned fIXSM : 1; /**< Insert IP checksum. */
915 unsigned fTXSM : 1; /**< Insert TCP/UDP checksum. */
916 unsigned u6RSV : 6; /**< Reserved, MBZ. */
917 /** @} */
918 /** @name SPECIAL field - VLAN tag to be inserted after ethernet header.
919 * Requires fEOP, fVLE and CTRL.VME to be set.
920 * @{ */
921 unsigned u16Special: 16; /**< VLAN: Id, Canonical form, Priority. */
922 /** @} */
923 } dw3;
924};
925typedef struct E1kTDData E1KTXDAT;
926
927union E1kTxDesc
928{
929 struct E1kTDLegacy legacy;
930 struct E1kTDContext context;
931 struct E1kTDData data;
932};
933typedef union E1kTxDesc E1KTXDESC;
934AssertCompileSize(E1KTXDESC, 16);
935
936#define RA_CTL_AS 0x0003
937#define RA_CTL_AV 0x8000
938
939union E1kRecAddr
940{
941 uint32_t au32[32];
942 struct RAArray
943 {
944 uint8_t addr[6];
945 uint16_t ctl;
946 } array[16];
947};
948typedef struct E1kRecAddr::RAArray E1KRAELEM;
949typedef union E1kRecAddr E1KRA;
950AssertCompileSize(E1KRA, 8*16);
951
952#define E1K_IP_RF UINT16_C(0x8000) /**< reserved fragment flag */
953#define E1K_IP_DF UINT16_C(0x4000) /**< dont fragment flag */
954#define E1K_IP_MF UINT16_C(0x2000) /**< more fragments flag */
955#define E1K_IP_OFFMASK UINT16_C(0x1fff) /**< mask for fragmenting bits */
956
957/** @todo use+extend RTNETIPV4 */
958struct E1kIpHeader
959{
960 /* type of service / version / header length */
961 uint16_t tos_ver_hl;
962 /* total length */
963 uint16_t total_len;
964 /* identification */
965 uint16_t ident;
966 /* fragment offset field */
967 uint16_t offset;
968 /* time to live / protocol*/
969 uint16_t ttl_proto;
970 /* checksum */
971 uint16_t chksum;
972 /* source IP address */
973 uint32_t src;
974 /* destination IP address */
975 uint32_t dest;
976};
977AssertCompileSize(struct E1kIpHeader, 20);
978
979#define E1K_TCP_FIN UINT16_C(0x01)
980#define E1K_TCP_SYN UINT16_C(0x02)
981#define E1K_TCP_RST UINT16_C(0x04)
982#define E1K_TCP_PSH UINT16_C(0x08)
983#define E1K_TCP_ACK UINT16_C(0x10)
984#define E1K_TCP_URG UINT16_C(0x20)
985#define E1K_TCP_ECE UINT16_C(0x40)
986#define E1K_TCP_CWR UINT16_C(0x80)
987#define E1K_TCP_FLAGS UINT16_C(0x3f)
988
989/** @todo use+extend RTNETTCP */
990struct E1kTcpHeader
991{
992 uint16_t src;
993 uint16_t dest;
994 uint32_t seqno;
995 uint32_t ackno;
996 uint16_t hdrlen_flags;
997 uint16_t wnd;
998 uint16_t chksum;
999 uint16_t urgp;
1000};
1001AssertCompileSize(struct E1kTcpHeader, 20);
1002
1003
1004#ifdef E1K_WITH_TXD_CACHE
1005/** The current Saved state version. */
1006# define E1K_SAVEDSTATE_VERSION 4
1007/** Saved state version for VirtualBox 4.2 with VLAN tag fields. */
1008# define E1K_SAVEDSTATE_VERSION_VBOX_42_VTAG 3
1009#else /* !E1K_WITH_TXD_CACHE */
1010/** The current Saved state version. */
1011# define E1K_SAVEDSTATE_VERSION 3
1012#endif /* !E1K_WITH_TXD_CACHE */
1013/** Saved state version for VirtualBox 4.1 and earlier.
1014 * These did not include VLAN tag fields. */
1015#define E1K_SAVEDSTATE_VERSION_VBOX_41 2
1016/** Saved state version for VirtualBox 3.0 and earlier.
1017 * This did not include the configuration part nor the E1kEEPROM. */
1018#define E1K_SAVEDSTATE_VERSION_VBOX_30 1
1019
1020/**
1021 * Device state structure.
1022 *
1023 * Holds the current state of device.
1024 *
1025 * @implements PDMINETWORKDOWN
1026 * @implements PDMINETWORKCONFIG
1027 * @implements PDMILEDPORTS
1028 */
1029struct E1kState_st
1030{
1031 char szPrf[8]; /**< Log prefix, e.g. E1000#1. */
1032 PDMIBASE IBase;
1033 PDMINETWORKDOWN INetworkDown;
1034 PDMINETWORKCONFIG INetworkConfig;
1035 PDMILEDPORTS ILeds; /**< LED interface */
1036 R3PTRTYPE(PPDMIBASE) pDrvBase; /**< Attached network driver. */
1037 R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector;
1038
1039 PPDMDEVINSR3 pDevInsR3; /**< Device instance - R3. */
1040 R3PTRTYPE(PPDMQUEUE) pTxQueueR3; /**< Transmit queue - R3. */
1041 R3PTRTYPE(PPDMQUEUE) pCanRxQueueR3; /**< Rx wakeup signaller - R3. */
1042 PPDMINETWORKUPR3 pDrvR3; /**< Attached network driver - R3. */
1043 PTMTIMERR3 pRIDTimerR3; /**< Receive Interrupt Delay Timer - R3. */
1044 PTMTIMERR3 pRADTimerR3; /**< Receive Absolute Delay Timer - R3. */
1045 PTMTIMERR3 pTIDTimerR3; /**< Transmit Interrupt Delay Timer - R3. */
1046 PTMTIMERR3 pTADTimerR3; /**< Transmit Absolute Delay Timer - R3. */
1047 PTMTIMERR3 pTXDTimerR3; /**< Transmit Delay Timer - R3. */
1048 PTMTIMERR3 pIntTimerR3; /**< Late Interrupt Timer - R3. */
1049 PTMTIMERR3 pLUTimerR3; /**< Link Up(/Restore) Timer. */
1050 /** The scatter / gather buffer used for the current outgoing packet - R3. */
1051 R3PTRTYPE(PPDMSCATTERGATHER) pTxSgR3;
1052
1053 PPDMDEVINSR0 pDevInsR0; /**< Device instance - R0. */
1054 R0PTRTYPE(PPDMQUEUE) pTxQueueR0; /**< Transmit queue - R0. */
1055 R0PTRTYPE(PPDMQUEUE) pCanRxQueueR0; /**< Rx wakeup signaller - R0. */
1056 PPDMINETWORKUPR0 pDrvR0; /**< Attached network driver - R0. */
1057 PTMTIMERR0 pRIDTimerR0; /**< Receive Interrupt Delay Timer - R0. */
1058 PTMTIMERR0 pRADTimerR0; /**< Receive Absolute Delay Timer - R0. */
1059 PTMTIMERR0 pTIDTimerR0; /**< Transmit Interrupt Delay Timer - R0. */
1060 PTMTIMERR0 pTADTimerR0; /**< Transmit Absolute Delay Timer - R0. */
1061 PTMTIMERR0 pTXDTimerR0; /**< Transmit Delay Timer - R0. */
1062 PTMTIMERR0 pIntTimerR0; /**< Late Interrupt Timer - R0. */
1063 PTMTIMERR0 pLUTimerR0; /**< Link Up(/Restore) Timer - R0. */
1064 /** The scatter / gather buffer used for the current outgoing packet - R0. */
1065 R0PTRTYPE(PPDMSCATTERGATHER) pTxSgR0;
1066
1067 PPDMDEVINSRC pDevInsRC; /**< Device instance - RC. */
1068 RCPTRTYPE(PPDMQUEUE) pTxQueueRC; /**< Transmit queue - RC. */
1069 RCPTRTYPE(PPDMQUEUE) pCanRxQueueRC; /**< Rx wakeup signaller - RC. */
1070 PPDMINETWORKUPRC pDrvRC; /**< Attached network driver - RC. */
1071 PTMTIMERRC pRIDTimerRC; /**< Receive Interrupt Delay Timer - RC. */
1072 PTMTIMERRC pRADTimerRC; /**< Receive Absolute Delay Timer - RC. */
1073 PTMTIMERRC pTIDTimerRC; /**< Transmit Interrupt Delay Timer - RC. */
1074 PTMTIMERRC pTADTimerRC; /**< Transmit Absolute Delay Timer - RC. */
1075 PTMTIMERRC pTXDTimerRC; /**< Transmit Delay Timer - RC. */
1076 PTMTIMERRC pIntTimerRC; /**< Late Interrupt Timer - RC. */
1077 PTMTIMERRC pLUTimerRC; /**< Link Up(/Restore) Timer - RC. */
1078 /** The scatter / gather buffer used for the current outgoing packet - RC. */
1079 RCPTRTYPE(PPDMSCATTERGATHER) pTxSgRC;
1080 RTRCPTR RCPtrAlignment;
1081
1082#if HC_ARCH_BITS != 32
1083 uint32_t Alignment1;
1084#endif
1085 PDMCRITSECT cs; /**< Critical section - what is it protecting? */
1086 PDMCRITSECT csRx; /**< RX Critical section. */
1087#ifdef E1K_WITH_TX_CS
1088 PDMCRITSECT csTx; /**< TX Critical section. */
1089#endif /* E1K_WITH_TX_CS */
1090 /** Base address of memory-mapped registers. */
1091 RTGCPHYS addrMMReg;
1092 /** MAC address obtained from the configuration. */
1093 RTMAC macConfigured;
1094 /** Base port of I/O space region. */
1095 RTIOPORT IOPortBase;
1096 /** EMT: */
1097 PDMPCIDEV pciDevice;
1098 /** EMT: Last time the interrupt was acknowledged. */
1099 uint64_t u64AckedAt;
1100 /** All: Used for eliminating spurious interrupts. */
1101 bool fIntRaised;
1102 /** EMT: false if the cable is disconnected by the GUI. */
1103 bool fCableConnected;
1104 /** EMT: */
1105 bool fR0Enabled;
1106 /** EMT: */
1107 bool fRCEnabled;
1108 /** EMT: Compute Ethernet CRC for RX packets. */
1109 bool fEthernetCRC;
1110 /** All: throttle interrupts. */
1111 bool fItrEnabled;
1112 /** All: throttle RX interrupts. */
1113 bool fItrRxEnabled;
1114 /** All: Delay TX interrupts using TIDV/TADV. */
1115 bool fTidEnabled;
1116 /** Link up delay (in milliseconds). */
1117 uint32_t cMsLinkUpDelay;
1118
1119 /** All: Device register storage. */
1120 uint32_t auRegs[E1K_NUM_OF_32BIT_REGS];
1121 /** TX/RX: Status LED. */
1122 PDMLED led;
1123 /** TX/RX: Number of packet being sent/received to show in debug log. */
1124 uint32_t u32PktNo;
1125
1126 /** EMT: Offset of the register to be read via IO. */
1127 uint32_t uSelectedReg;
1128 /** EMT: Multicast Table Array. */
1129 uint32_t auMTA[128];
1130 /** EMT: Receive Address registers. */
1131 E1KRA aRecAddr;
1132 /** EMT: VLAN filter table array. */
1133 uint32_t auVFTA[128];
1134 /** EMT: Receive buffer size. */
1135 uint16_t u16RxBSize;
1136 /** EMT: Locked state -- no state alteration possible. */
1137 bool fLocked;
1138 /** EMT: */
1139 bool fDelayInts;
1140 /** All: */
1141 bool fIntMaskUsed;
1142
1143 /** N/A: */
1144 bool volatile fMaybeOutOfSpace;
1145 /** EMT: Gets signalled when more RX descriptors become available. */
1146 RTSEMEVENT hEventMoreRxDescAvail;
1147#ifdef E1K_WITH_RXD_CACHE
1148 /** RX: Fetched RX descriptors. */
1149 E1KRXDESC aRxDescriptors[E1K_RXD_CACHE_SIZE];
1150 //uint64_t aRxDescAddr[E1K_RXD_CACHE_SIZE];
1151 /** RX: Actual number of fetched RX descriptors. */
1152 uint32_t nRxDFetched;
1153 /** RX: Index in cache of RX descriptor being processed. */
1154 uint32_t iRxDCurrent;
1155#endif /* E1K_WITH_RXD_CACHE */
1156
1157 /** TX: Context used for TCP segmentation packets. */
1158 E1KTXCTX contextTSE;
1159 /** TX: Context used for ordinary packets. */
1160 E1KTXCTX contextNormal;
1161#ifdef E1K_WITH_TXD_CACHE
1162 /** TX: Fetched TX descriptors. */
1163 E1KTXDESC aTxDescriptors[E1K_TXD_CACHE_SIZE];
1164 /** TX: Actual number of fetched TX descriptors. */
1165 uint8_t nTxDFetched;
1166 /** TX: Index in cache of TX descriptor being processed. */
1167 uint8_t iTxDCurrent;
1168 /** TX: Will this frame be sent as GSO. */
1169 bool fGSO;
1170 /** Alignment padding. */
1171 bool fReserved;
1172 /** TX: Number of bytes in next packet. */
1173 uint32_t cbTxAlloc;
1174
1175#endif /* E1K_WITH_TXD_CACHE */
1176 /** GSO context. u8Type is set to PDMNETWORKGSOTYPE_INVALID when not
1177 * applicable to the current TSE mode. */
1178 PDMNETWORKGSO GsoCtx;
1179 /** Scratch space for holding the loopback / fallback scatter / gather
1180 * descriptor. */
1181 union
1182 {
1183 PDMSCATTERGATHER Sg;
1184 uint8_t padding[8 * sizeof(RTUINTPTR)];
1185 } uTxFallback;
1186 /** TX: Transmit packet buffer use for TSE fallback and loopback. */
1187 uint8_t aTxPacketFallback[E1K_MAX_TX_PKT_SIZE];
1188 /** TX: Number of bytes assembled in TX packet buffer. */
1189 uint16_t u16TxPktLen;
1190 /** TX: False will force segmentation in e1000 instead of sending frames as GSO. */
1191 bool fGSOEnabled;
1192 /** TX: IP checksum has to be inserted if true. */
1193 bool fIPcsum;
1194 /** TX: TCP/UDP checksum has to be inserted if true. */
1195 bool fTCPcsum;
1196 /** TX: VLAN tag has to be inserted if true. */
1197 bool fVTag;
1198 /** TX: TCI part of VLAN tag to be inserted. */
1199 uint16_t u16VTagTCI;
1200 /** TX TSE fallback: Number of payload bytes remaining in TSE context. */
1201 uint32_t u32PayRemain;
1202 /** TX TSE fallback: Number of header bytes remaining in TSE context. */
1203 uint16_t u16HdrRemain;
1204 /** TX TSE fallback: Flags from template header. */
1205 uint16_t u16SavedFlags;
1206 /** TX TSE fallback: Partial checksum from template header. */
1207 uint32_t u32SavedCsum;
1208 /** ?: Emulated controller type. */
1209 E1KCHIP eChip;
1210
1211 /** EMT: EEPROM emulation */
1212 E1kEEPROM eeprom;
1213 /** EMT: Physical interface emulation. */
1214 PHY phy;
1215
1216#if 0
1217 /** Alignment padding. */
1218 uint8_t Alignment[HC_ARCH_BITS == 64 ? 8 : 4];
1219#endif
1220
1221 STAMCOUNTER StatReceiveBytes;
1222 STAMCOUNTER StatTransmitBytes;
1223#if defined(VBOX_WITH_STATISTICS)
1224 STAMPROFILEADV StatMMIOReadRZ;
1225 STAMPROFILEADV StatMMIOReadR3;
1226 STAMPROFILEADV StatMMIOWriteRZ;
1227 STAMPROFILEADV StatMMIOWriteR3;
1228 STAMPROFILEADV StatEEPROMRead;
1229 STAMPROFILEADV StatEEPROMWrite;
1230 STAMPROFILEADV StatIOReadRZ;
1231 STAMPROFILEADV StatIOReadR3;
1232 STAMPROFILEADV StatIOWriteRZ;
1233 STAMPROFILEADV StatIOWriteR3;
1234 STAMPROFILEADV StatLateIntTimer;
1235 STAMCOUNTER StatLateInts;
1236 STAMCOUNTER StatIntsRaised;
1237 STAMCOUNTER StatIntsPrevented;
1238 STAMPROFILEADV StatReceive;
1239 STAMPROFILEADV StatReceiveCRC;
1240 STAMPROFILEADV StatReceiveFilter;
1241 STAMPROFILEADV StatReceiveStore;
1242 STAMPROFILEADV StatTransmitRZ;
1243 STAMPROFILEADV StatTransmitR3;
1244 STAMPROFILE StatTransmitSendRZ;
1245 STAMPROFILE StatTransmitSendR3;
1246 STAMPROFILE StatRxOverflow;
1247 STAMCOUNTER StatRxOverflowWakeup;
1248 STAMCOUNTER StatTxDescCtxNormal;
1249 STAMCOUNTER StatTxDescCtxTSE;
1250 STAMCOUNTER StatTxDescLegacy;
1251 STAMCOUNTER StatTxDescData;
1252 STAMCOUNTER StatTxDescTSEData;
1253 STAMCOUNTER StatTxPathFallback;
1254 STAMCOUNTER StatTxPathGSO;
1255 STAMCOUNTER StatTxPathRegular;
1256 STAMCOUNTER StatPHYAccesses;
1257 STAMCOUNTER aStatRegWrites[E1K_NUM_OF_REGS];
1258 STAMCOUNTER aStatRegReads[E1K_NUM_OF_REGS];
1259#endif /* VBOX_WITH_STATISTICS */
1260
1261#ifdef E1K_INT_STATS
1262 /* Internal stats */
1263 uint64_t u64ArmedAt;
1264 uint64_t uStatMaxTxDelay;
1265 uint32_t uStatInt;
1266 uint32_t uStatIntTry;
1267 uint32_t uStatIntLower;
1268 uint32_t uStatNoIntICR;
1269 int32_t iStatIntLost;
1270 int32_t iStatIntLostOne;
1271 uint32_t uStatIntIMS;
1272 uint32_t uStatIntSkip;
1273 uint32_t uStatIntLate;
1274 uint32_t uStatIntMasked;
1275 uint32_t uStatIntEarly;
1276 uint32_t uStatIntRx;
1277 uint32_t uStatIntTx;
1278 uint32_t uStatIntICS;
1279 uint32_t uStatIntRDTR;
1280 uint32_t uStatIntRXDMT0;
1281 uint32_t uStatIntTXQE;
1282 uint32_t uStatTxNoRS;
1283 uint32_t uStatTxIDE;
1284 uint32_t uStatTxDelayed;
1285 uint32_t uStatTxDelayExp;
1286 uint32_t uStatTAD;
1287 uint32_t uStatTID;
1288 uint32_t uStatRAD;
1289 uint32_t uStatRID;
1290 uint32_t uStatRxFrm;
1291 uint32_t uStatTxFrm;
1292 uint32_t uStatDescCtx;
1293 uint32_t uStatDescDat;
1294 uint32_t uStatDescLeg;
1295 uint32_t uStatTx1514;
1296 uint32_t uStatTx2962;
1297 uint32_t uStatTx4410;
1298 uint32_t uStatTx5858;
1299 uint32_t uStatTx7306;
1300 uint32_t uStatTx8754;
1301 uint32_t uStatTx16384;
1302 uint32_t uStatTx32768;
1303 uint32_t uStatTxLarge;
1304 uint32_t uStatAlign;
1305#endif /* E1K_INT_STATS */
1306};
1307typedef struct E1kState_st E1KSTATE;
1308/** Pointer to the E1000 device state. */
1309typedef E1KSTATE *PE1KSTATE;
1310
1311#ifndef VBOX_DEVICE_STRUCT_TESTCASE
1312
1313/* Forward declarations ******************************************************/
1314static int e1kXmitPending(PE1KSTATE pThis, bool fOnWorkerThread);
1315
1316static int e1kRegReadUnimplemented (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1317static int e1kRegWriteUnimplemented(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1318static int e1kRegReadAutoClear (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1319static int e1kRegReadDefault (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1320static int e1kRegWriteDefault (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1321#if 0 /* unused */
1322static int e1kRegReadCTRL (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1323#endif
1324static int e1kRegWriteCTRL (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1325static int e1kRegReadEECD (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1326static int e1kRegWriteEECD (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1327static int e1kRegWriteEERD (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1328static int e1kRegWriteMDIC (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1329static int e1kRegReadICR (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1330static int e1kRegWriteICR (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1331static int e1kRegWriteICS (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1332static int e1kRegWriteIMS (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1333static int e1kRegWriteIMC (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1334static int e1kRegWriteRCTL (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1335static int e1kRegWritePBA (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1336static int e1kRegWriteRDT (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1337static int e1kRegWriteRDTR (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1338static int e1kRegWriteTDT (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1339static int e1kRegReadMTA (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1340static int e1kRegWriteMTA (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1341static int e1kRegReadRA (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1342static int e1kRegWriteRA (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1343static int e1kRegReadVFTA (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1344static int e1kRegWriteVFTA (PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1345
1346/**
1347 * Register map table.
1348 *
1349 * Override pfnRead and pfnWrite to get register-specific behavior.
1350 */
1351static const struct E1kRegMap_st
1352{
1353 /** Register offset in the register space. */
1354 uint32_t offset;
1355 /** Size in bytes. Registers of size > 4 are in fact tables. */
1356 uint32_t size;
1357 /** Readable bits. */
1358 uint32_t readable;
1359 /** Writable bits. */
1360 uint32_t writable;
1361 /** Read callback. */
1362 int (*pfnRead)(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value);
1363 /** Write callback. */
1364 int (*pfnWrite)(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t u32Value);
1365 /** Abbreviated name. */
1366 const char *abbrev;
1367 /** Full name. */
1368 const char *name;
1369} g_aE1kRegMap[E1K_NUM_OF_REGS] =
1370{
1371 /* offset size read mask write mask read callback write callback abbrev full name */
1372 /*------- ------- ---------- ---------- ----------------------- ------------------------ ---------- ------------------------------*/
1373 { 0x00000, 0x00004, 0xDBF31BE9, 0xDBF31BE9, e1kRegReadDefault , e1kRegWriteCTRL , "CTRL" , "Device Control" },
1374 { 0x00008, 0x00004, 0x0000FDFF, 0x00000000, e1kRegReadDefault , e1kRegWriteUnimplemented, "STATUS" , "Device Status" },
1375 { 0x00010, 0x00004, 0x000027F0, 0x00000070, e1kRegReadEECD , e1kRegWriteEECD , "EECD" , "EEPROM/Flash Control/Data" },
1376 { 0x00014, 0x00004, 0xFFFFFF10, 0xFFFFFF00, e1kRegReadDefault , e1kRegWriteEERD , "EERD" , "EEPROM Read" },
1377 { 0x00018, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "CTRL_EXT", "Extended Device Control" },
1378 { 0x0001c, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FLA" , "Flash Access (N/A)" },
1379 { 0x00020, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteMDIC , "MDIC" , "MDI Control" },
1380 { 0x00028, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FCAL" , "Flow Control Address Low" },
1381 { 0x0002c, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FCAH" , "Flow Control Address High" },
1382 { 0x00030, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FCT" , "Flow Control Type" },
1383 { 0x00038, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteDefault , "VET" , "VLAN EtherType" },
1384 { 0x000c0, 0x00004, 0x0001F6DF, 0x0001F6DF, e1kRegReadICR , e1kRegWriteICR , "ICR" , "Interrupt Cause Read" },
1385 { 0x000c4, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteDefault , "ITR" , "Interrupt Throttling" },
1386 { 0x000c8, 0x00004, 0x00000000, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteICS , "ICS" , "Interrupt Cause Set" },
1387 { 0x000d0, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteIMS , "IMS" , "Interrupt Mask Set/Read" },
1388 { 0x000d8, 0x00004, 0x00000000, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteIMC , "IMC" , "Interrupt Mask Clear" },
1389 { 0x00100, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteRCTL , "RCTL" , "Receive Control" },
1390 { 0x00170, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FCTTV" , "Flow Control Transmit Timer Value" },
1391 { 0x00178, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TXCW" , "Transmit Configuration Word (N/A)" },
1392 { 0x00180, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RXCW" , "Receive Configuration Word (N/A)" },
1393 { 0x00400, 0x00004, 0x017FFFFA, 0x017FFFFA, e1kRegReadDefault , e1kRegWriteDefault , "TCTL" , "Transmit Control" },
1394 { 0x00410, 0x00004, 0x3FFFFFFF, 0x3FFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "TIPG" , "Transmit IPG" },
1395 { 0x00458, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteDefault , "AIFS" , "Adaptive IFS Throttle - AIT" },
1396 { 0x00e00, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "LEDCTL" , "LED Control" },
1397 { 0x01000, 0x00004, 0xFFFF007F, 0x0000007F, e1kRegReadDefault , e1kRegWritePBA , "PBA" , "Packet Buffer Allocation" },
1398 { 0x02160, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FCRTL" , "Flow Control Receive Threshold Low" },
1399 { 0x02168, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FCRTH" , "Flow Control Receive Threshold High" },
1400 { 0x02410, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RDFH" , "Receive Data FIFO Head" },
1401 { 0x02418, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RDFT" , "Receive Data FIFO Tail" },
1402 { 0x02420, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RDFHS" , "Receive Data FIFO Head Saved Register" },
1403 { 0x02428, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RDFTS" , "Receive Data FIFO Tail Saved Register" },
1404 { 0x02430, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RDFPC" , "Receive Data FIFO Packet Count" },
1405 { 0x02800, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "RDBAL" , "Receive Descriptor Base Low" },
1406 { 0x02804, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "RDBAH" , "Receive Descriptor Base High" },
1407 { 0x02808, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "RDLEN" , "Receive Descriptor Length" },
1408 { 0x02810, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "RDH" , "Receive Descriptor Head" },
1409 { 0x02818, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteRDT , "RDT" , "Receive Descriptor Tail" },
1410 { 0x02820, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteRDTR , "RDTR" , "Receive Delay Timer" },
1411 { 0x02828, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RXDCTL" , "Receive Descriptor Control" },
1412 { 0x0282c, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteDefault , "RADV" , "Receive Interrupt Absolute Delay Timer" },
1413 { 0x02c00, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RSRPD" , "Receive Small Packet Detect Interrupt" },
1414 { 0x03000, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TXDMAC" , "TX DMA Control (N/A)" },
1415 { 0x03410, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TDFH" , "Transmit Data FIFO Head" },
1416 { 0x03418, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TDFT" , "Transmit Data FIFO Tail" },
1417 { 0x03420, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TDFHS" , "Transmit Data FIFO Head Saved Register" },
1418 { 0x03428, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TDFTS" , "Transmit Data FIFO Tail Saved Register" },
1419 { 0x03430, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TDFPC" , "Transmit Data FIFO Packet Count" },
1420 { 0x03800, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "TDBAL" , "Transmit Descriptor Base Low" },
1421 { 0x03804, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "TDBAH" , "Transmit Descriptor Base High" },
1422 { 0x03808, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "TDLEN" , "Transmit Descriptor Length" },
1423 { 0x03810, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteDefault , "TDH" , "Transmit Descriptor Head" },
1424 { 0x03818, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteTDT , "TDT" , "Transmit Descriptor Tail" },
1425 { 0x03820, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteDefault , "TIDV" , "Transmit Interrupt Delay Value" },
1426 { 0x03828, 0x00004, 0xFF3F3F3F, 0xFF3F3F3F, e1kRegReadDefault , e1kRegWriteDefault , "TXDCTL" , "Transmit Descriptor Control" },
1427 { 0x0382c, 0x00004, 0x0000FFFF, 0x0000FFFF, e1kRegReadDefault , e1kRegWriteDefault , "TADV" , "Transmit Absolute Interrupt Delay Timer" },
1428 { 0x03830, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "TSPMT" , "TCP Segmentation Pad and Threshold" },
1429 { 0x04000, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "CRCERRS" , "CRC Error Count" },
1430 { 0x04004, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "ALGNERRC", "Alignment Error Count" },
1431 { 0x04008, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "SYMERRS" , "Symbol Error Count" },
1432 { 0x0400c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RXERRC" , "RX Error Count" },
1433 { 0x04010, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "MPC" , "Missed Packets Count" },
1434 { 0x04014, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "SCC" , "Single Collision Count" },
1435 { 0x04018, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "ECOL" , "Excessive Collisions Count" },
1436 { 0x0401c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "MCC" , "Multiple Collision Count" },
1437 { 0x04020, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "LATECOL" , "Late Collisions Count" },
1438 { 0x04028, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "COLC" , "Collision Count" },
1439 { 0x04030, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "DC" , "Defer Count" },
1440 { 0x04034, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "TNCRS" , "Transmit - No CRS" },
1441 { 0x04038, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "SEC" , "Sequence Error Count" },
1442 { 0x0403c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "CEXTERR" , "Carrier Extension Error Count" },
1443 { 0x04040, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RLEC" , "Receive Length Error Count" },
1444 { 0x04048, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "XONRXC" , "XON Received Count" },
1445 { 0x0404c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "XONTXC" , "XON Transmitted Count" },
1446 { 0x04050, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "XOFFRXC" , "XOFF Received Count" },
1447 { 0x04054, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "XOFFTXC" , "XOFF Transmitted Count" },
1448 { 0x04058, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FCRUC" , "FC Received Unsupported Count" },
1449 { 0x0405c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PRC64" , "Packets Received (64 Bytes) Count" },
1450 { 0x04060, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PRC127" , "Packets Received (65-127 Bytes) Count" },
1451 { 0x04064, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PRC255" , "Packets Received (128-255 Bytes) Count" },
1452 { 0x04068, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PRC511" , "Packets Received (256-511 Bytes) Count" },
1453 { 0x0406c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PRC1023" , "Packets Received (512-1023 Bytes) Count" },
1454 { 0x04070, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PRC1522" , "Packets Received (1024-Max Bytes)" },
1455 { 0x04074, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "GPRC" , "Good Packets Received Count" },
1456 { 0x04078, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "BPRC" , "Broadcast Packets Received Count" },
1457 { 0x0407c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "MPRC" , "Multicast Packets Received Count" },
1458 { 0x04080, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "GPTC" , "Good Packets Transmitted Count" },
1459 { 0x04088, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "GORCL" , "Good Octets Received Count (Low)" },
1460 { 0x0408c, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "GORCH" , "Good Octets Received Count (Hi)" },
1461 { 0x04090, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "GOTCL" , "Good Octets Transmitted Count (Low)" },
1462 { 0x04094, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "GOTCH" , "Good Octets Transmitted Count (Hi)" },
1463 { 0x040a0, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RNBC" , "Receive No Buffers Count" },
1464 { 0x040a4, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RUC" , "Receive Undersize Count" },
1465 { 0x040a8, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RFC" , "Receive Fragment Count" },
1466 { 0x040ac, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "ROC" , "Receive Oversize Count" },
1467 { 0x040b0, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "RJC" , "Receive Jabber Count" },
1468 { 0x040b4, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "MGTPRC" , "Management Packets Received Count" },
1469 { 0x040b8, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "MGTPDC" , "Management Packets Dropped Count" },
1470 { 0x040bc, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "MGTPTC" , "Management Pkts Transmitted Count" },
1471 { 0x040c0, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TORL" , "Total Octets Received (Lo)" },
1472 { 0x040c4, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TORH" , "Total Octets Received (Hi)" },
1473 { 0x040c8, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TOTL" , "Total Octets Transmitted (Lo)" },
1474 { 0x040cc, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TOTH" , "Total Octets Transmitted (Hi)" },
1475 { 0x040d0, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TPR" , "Total Packets Received" },
1476 { 0x040d4, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TPT" , "Total Packets Transmitted" },
1477 { 0x040d8, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PTC64" , "Packets Transmitted (64 Bytes) Count" },
1478 { 0x040dc, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PTC127" , "Packets Transmitted (65-127 Bytes) Count" },
1479 { 0x040e0, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PTC255" , "Packets Transmitted (128-255 Bytes) Count" },
1480 { 0x040e4, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PTC511" , "Packets Transmitted (256-511 Bytes) Count" },
1481 { 0x040e8, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PTC1023" , "Packets Transmitted (512-1023 Bytes) Count" },
1482 { 0x040ec, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "PTC1522" , "Packets Transmitted (1024 Bytes or Greater) Count" },
1483 { 0x040f0, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "MPTC" , "Multicast Packets Transmitted Count" },
1484 { 0x040f4, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "BPTC" , "Broadcast Packets Transmitted Count" },
1485 { 0x040f8, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TSCTC" , "TCP Segmentation Context Transmitted Count" },
1486 { 0x040fc, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadAutoClear , e1kRegWriteUnimplemented, "TSCTFC" , "TCP Segmentation Context Tx Fail Count" },
1487 { 0x05000, 0x00004, 0x000007FF, 0x000007FF, e1kRegReadDefault , e1kRegWriteDefault , "RXCSUM" , "Receive Checksum Control" },
1488 { 0x05800, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "WUC" , "Wakeup Control" },
1489 { 0x05808, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "WUFC" , "Wakeup Filter Control" },
1490 { 0x05810, 0x00004, 0xFFFFFFFF, 0x00000000, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "WUS" , "Wakeup Status" },
1491 { 0x05820, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadDefault , e1kRegWriteDefault , "MANC" , "Management Control" },
1492 { 0x05838, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "IPAV" , "IP Address Valid" },
1493 { 0x05900, 0x00004, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "WUPL" , "Wakeup Packet Length" },
1494 { 0x05200, 0x00200, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadMTA , e1kRegWriteMTA , "MTA" , "Multicast Table Array (n)" },
1495 { 0x05400, 0x00080, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadRA , e1kRegWriteRA , "RA" , "Receive Address (64-bit) (n)" },
1496 { 0x05600, 0x00200, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadVFTA , e1kRegWriteVFTA , "VFTA" , "VLAN Filter Table Array (n)" },
1497 { 0x05840, 0x0001c, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "IP4AT" , "IPv4 Address Table" },
1498 { 0x05880, 0x00010, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "IP6AT" , "IPv6 Address Table" },
1499 { 0x05a00, 0x00080, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "WUPM" , "Wakeup Packet Memory" },
1500 { 0x05f00, 0x0001c, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FFLT" , "Flexible Filter Length Table" },
1501 { 0x09000, 0x003fc, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FFMT" , "Flexible Filter Mask Table" },
1502 { 0x09800, 0x003fc, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "FFVT" , "Flexible Filter Value Table" },
1503 { 0x10000, 0x10000, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadUnimplemented, e1kRegWriteUnimplemented, "PBM" , "Packet Buffer Memory (n)" },
1504 { 0x00040, 0x00080, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadRA , e1kRegWriteRA , "RA82542" , "Receive Address (64-bit) (n) (82542)" },
1505 { 0x00200, 0x00200, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadMTA , e1kRegWriteMTA , "MTA82542", "Multicast Table Array (n) (82542)" },
1506 { 0x00600, 0x00200, 0xFFFFFFFF, 0xFFFFFFFF, e1kRegReadVFTA , e1kRegWriteVFTA , "VFTA82542", "VLAN Filter Table Array (n) (82542)" }
1507};
1508
1509#ifdef LOG_ENABLED
1510
1511/**
1512 * Convert U32 value to hex string. Masked bytes are replaced with dots.
1513 *
1514 * @remarks The mask has byte (not bit) granularity (e.g. 000000FF).
1515 *
1516 * @returns The buffer.
1517 *
1518 * @param u32 The word to convert into string.
1519 * @param mask Selects which bytes to convert.
1520 * @param buf Where to put the result.
1521 */
1522static char *e1kU32toHex(uint32_t u32, uint32_t mask, char *buf)
1523{
1524 for (char *ptr = buf + 7; ptr >= buf; --ptr, u32 >>=4, mask >>=4)
1525 {
1526 if (mask & 0xF)
1527 *ptr = (u32 & 0xF) + ((u32 & 0xF) > 9 ? '7' : '0');
1528 else
1529 *ptr = '.';
1530 }
1531 buf[8] = 0;
1532 return buf;
1533}
1534
1535/**
1536 * Returns timer name for debug purposes.
1537 *
1538 * @returns The timer name.
1539 *
1540 * @param pThis The device state structure.
1541 * @param pTimer The timer to get the name for.
1542 */
1543DECLINLINE(const char *) e1kGetTimerName(PE1KSTATE pThis, PTMTIMER pTimer)
1544{
1545 if (pTimer == pThis->CTX_SUFF(pTIDTimer))
1546 return "TID";
1547 if (pTimer == pThis->CTX_SUFF(pTADTimer))
1548 return "TAD";
1549 if (pTimer == pThis->CTX_SUFF(pRIDTimer))
1550 return "RID";
1551 if (pTimer == pThis->CTX_SUFF(pRADTimer))
1552 return "RAD";
1553 if (pTimer == pThis->CTX_SUFF(pIntTimer))
1554 return "Int";
1555 if (pTimer == pThis->CTX_SUFF(pTXDTimer))
1556 return "TXD";
1557 if (pTimer == pThis->CTX_SUFF(pLUTimer))
1558 return "LinkUp";
1559 return "unknown";
1560}
1561
1562#endif /* DEBUG */
1563
1564/**
1565 * Arm a timer.
1566 *
1567 * @param pThis Pointer to the device state structure.
1568 * @param pTimer Pointer to the timer.
1569 * @param uExpireIn Expiration interval in microseconds.
1570 */
1571DECLINLINE(void) e1kArmTimer(PE1KSTATE pThis, PTMTIMER pTimer, uint32_t uExpireIn)
1572{
1573 if (pThis->fLocked)
1574 return;
1575
1576 E1kLog2(("%s Arming %s timer to fire in %d usec...\n",
1577 pThis->szPrf, e1kGetTimerName(pThis, pTimer), uExpireIn));
1578 TMTimerSetMicro(pTimer, uExpireIn);
1579}
1580
1581#ifdef IN_RING3
1582/**
1583 * Cancel a timer.
1584 *
1585 * @param pThis Pointer to the device state structure.
1586 * @param pTimer Pointer to the timer.
1587 */
1588DECLINLINE(void) e1kCancelTimer(PE1KSTATE pThis, PTMTIMER pTimer)
1589{
1590 E1kLog2(("%s Stopping %s timer...\n",
1591 pThis->szPrf, e1kGetTimerName(pThis, pTimer)));
1592 int rc = TMTimerStop(pTimer);
1593 if (RT_FAILURE(rc))
1594 E1kLog2(("%s e1kCancelTimer: TMTimerStop() failed with %Rrc\n",
1595 pThis->szPrf, rc));
1596 RT_NOREF1(pThis);
1597}
1598#endif /* IN_RING3 */
1599
1600#define e1kCsEnter(ps, rc) PDMCritSectEnter(&ps->cs, rc)
1601#define e1kCsLeave(ps) PDMCritSectLeave(&ps->cs)
1602
1603#define e1kCsRxEnter(ps, rc) PDMCritSectEnter(&ps->csRx, rc)
1604#define e1kCsRxLeave(ps) PDMCritSectLeave(&ps->csRx)
1605#define e1kCsRxIsOwner(ps) PDMCritSectIsOwner(&ps->csRx)
1606
1607#ifndef E1K_WITH_TX_CS
1608# define e1kCsTxEnter(ps, rc) VINF_SUCCESS
1609# define e1kCsTxLeave(ps) do { } while (0)
1610#else /* E1K_WITH_TX_CS */
1611# define e1kCsTxEnter(ps, rc) PDMCritSectEnter(&ps->csTx, rc)
1612# define e1kCsTxLeave(ps) PDMCritSectLeave(&ps->csTx)
1613#endif /* E1K_WITH_TX_CS */
1614
1615#ifdef IN_RING3
1616
1617/**
1618 * Wakeup the RX thread.
1619 */
1620static void e1kWakeupReceive(PPDMDEVINS pDevIns)
1621{
1622 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, PE1KSTATE);
1623 if ( pThis->fMaybeOutOfSpace
1624 && pThis->hEventMoreRxDescAvail != NIL_RTSEMEVENT)
1625 {
1626 STAM_COUNTER_INC(&pThis->StatRxOverflowWakeup);
1627 E1kLog(("%s Waking up Out-of-RX-space semaphore\n", pThis->szPrf));
1628 RTSemEventSignal(pThis->hEventMoreRxDescAvail);
1629 }
1630}
1631
1632/**
1633 * Hardware reset. Revert all registers to initial values.
1634 *
1635 * @param pThis The device state structure.
1636 */
1637static void e1kHardReset(PE1KSTATE pThis)
1638{
1639 E1kLog(("%s Hard reset triggered\n", pThis->szPrf));
1640 memset(pThis->auRegs, 0, sizeof(pThis->auRegs));
1641 memset(pThis->aRecAddr.au32, 0, sizeof(pThis->aRecAddr.au32));
1642#ifdef E1K_INIT_RA0
1643 memcpy(pThis->aRecAddr.au32, pThis->macConfigured.au8,
1644 sizeof(pThis->macConfigured.au8));
1645 pThis->aRecAddr.array[0].ctl |= RA_CTL_AV;
1646#endif /* E1K_INIT_RA0 */
1647 STATUS = 0x0081; /* SPEED=10b (1000 Mb/s), FD=1b (Full Duplex) */
1648 EECD = 0x0100; /* EE_PRES=1b (EEPROM present) */
1649 CTRL = 0x0a09; /* FRCSPD=1b SPEED=10b LRST=1b FD=1b */
1650 TSPMT = 0x01000400;/* TSMT=0400h TSPBP=0100h */
1651 Assert(GET_BITS(RCTL, BSIZE) == 0);
1652 pThis->u16RxBSize = 2048;
1653
1654 /* Reset promiscuous mode */
1655 if (pThis->pDrvR3)
1656 pThis->pDrvR3->pfnSetPromiscuousMode(pThis->pDrvR3, false);
1657
1658#ifdef E1K_WITH_TXD_CACHE
1659 int rc = e1kCsTxEnter(pThis, VERR_SEM_BUSY);
1660 if (RT_LIKELY(rc == VINF_SUCCESS))
1661 {
1662 pThis->nTxDFetched = 0;
1663 pThis->iTxDCurrent = 0;
1664 pThis->fGSO = false;
1665 pThis->cbTxAlloc = 0;
1666 e1kCsTxLeave(pThis);
1667 }
1668#endif /* E1K_WITH_TXD_CACHE */
1669#ifdef E1K_WITH_RXD_CACHE
1670 if (RT_LIKELY(e1kCsRxEnter(pThis, VERR_SEM_BUSY) == VINF_SUCCESS))
1671 {
1672 pThis->iRxDCurrent = pThis->nRxDFetched = 0;
1673 e1kCsRxLeave(pThis);
1674 }
1675#endif /* E1K_WITH_RXD_CACHE */
1676#ifdef E1K_LSC_ON_RESET
1677 E1kLog(("%s Will trigger LSC in %d seconds...\n",
1678 pThis->szPrf, pThis->cMsLinkUpDelay / 1000));
1679 e1kArmTimer(pThis, pThis->CTX_SUFF(pLUTimer), pThis->cMsLinkUpDelay * 1000);
1680#endif /* E1K_LSC_ON_RESET */
1681}
1682
1683#endif /* IN_RING3 */
1684
1685/**
1686 * Compute Internet checksum.
1687 *
1688 * @remarks Refer to http://www.netfor2.com/checksum.html for short intro.
1689 *
1690 * @param pThis The device state structure.
1691 * @param cpPacket The packet.
1692 * @param cb The size of the packet.
1693 * @param pszText A string denoting direction of packet transfer.
1694 *
1695 * @return The 1's complement of the 1's complement sum.
1696 *
1697 * @thread E1000_TX
1698 */
1699static uint16_t e1kCSum16(const void *pvBuf, size_t cb)
1700{
1701 uint32_t csum = 0;
1702 uint16_t *pu16 = (uint16_t *)pvBuf;
1703
1704 while (cb > 1)
1705 {
1706 csum += *pu16++;
1707 cb -= 2;
1708 }
1709 if (cb)
1710 csum += *(uint8_t*)pu16;
1711 while (csum >> 16)
1712 csum = (csum >> 16) + (csum & 0xFFFF);
1713 return ~csum;
1714}
1715
1716/**
1717 * Dump a packet to debug log.
1718 *
1719 * @param pThis The device state structure.
1720 * @param cpPacket The packet.
1721 * @param cb The size of the packet.
1722 * @param pszText A string denoting direction of packet transfer.
1723 * @thread E1000_TX
1724 */
1725DECLINLINE(void) e1kPacketDump(PE1KSTATE pThis, const uint8_t *cpPacket, size_t cb, const char *pszText)
1726{
1727#ifdef DEBUG
1728 if (RT_LIKELY(e1kCsEnter(pThis, VERR_SEM_BUSY) == VINF_SUCCESS))
1729 {
1730 Log4(("%s --- %s packet #%d: %RTmac => %RTmac (%d bytes) ---\n",
1731 pThis->szPrf, pszText, ++pThis->u32PktNo, cpPacket+6, cpPacket, cb));
1732 if (ntohs(*(uint16_t*)(cpPacket+12)) == 0x86DD)
1733 {
1734 Log4(("%s --- IPv6: %RTnaipv6 => %RTnaipv6\n",
1735 pThis->szPrf, cpPacket+14+8, cpPacket+14+24));
1736 if (*(cpPacket+14+6) == 0x6)
1737 Log4(("%s --- TCP: seq=%x ack=%x\n", pThis->szPrf,
1738 ntohl(*(uint32_t*)(cpPacket+14+40+4)), ntohl(*(uint32_t*)(cpPacket+14+40+8))));
1739 }
1740 else if (ntohs(*(uint16_t*)(cpPacket+12)) == 0x800)
1741 {
1742 Log4(("%s --- IPv4: %RTnaipv4 => %RTnaipv4\n",
1743 pThis->szPrf, *(uint32_t*)(cpPacket+14+12), *(uint32_t*)(cpPacket+14+16)));
1744 if (*(cpPacket+14+6) == 0x6)
1745 Log4(("%s --- TCP: seq=%x ack=%x\n", pThis->szPrf,
1746 ntohl(*(uint32_t*)(cpPacket+14+20+4)), ntohl(*(uint32_t*)(cpPacket+14+20+8))));
1747 }
1748 E1kLog3(("%.*Rhxd\n", cb, cpPacket));
1749 e1kCsLeave(pThis);
1750 }
1751#else
1752 if (RT_LIKELY(e1kCsEnter(pThis, VERR_SEM_BUSY) == VINF_SUCCESS))
1753 {
1754 if (ntohs(*(uint16_t*)(cpPacket+12)) == 0x86DD)
1755 E1kLogRel(("E1000: %s packet #%d, %RTmac => %RTmac, %RTnaipv6 => %RTnaipv6, seq=%x ack=%x\n",
1756 pszText, ++pThis->u32PktNo, cpPacket+6, cpPacket, cpPacket+14+8, cpPacket+14+24,
1757 ntohl(*(uint32_t*)(cpPacket+14+40+4)), ntohl(*(uint32_t*)(cpPacket+14+40+8))));
1758 else
1759 E1kLogRel(("E1000: %s packet #%d, %RTmac => %RTmac, %RTnaipv4 => %RTnaipv4, seq=%x ack=%x\n",
1760 pszText, ++pThis->u32PktNo, cpPacket+6, cpPacket,
1761 *(uint32_t*)(cpPacket+14+12), *(uint32_t*)(cpPacket+14+16),
1762 ntohl(*(uint32_t*)(cpPacket+14+20+4)), ntohl(*(uint32_t*)(cpPacket+14+20+8))));
1763 e1kCsLeave(pThis);
1764 }
1765 RT_NOREF2(cb, pszText);
1766#endif
1767}
1768
1769/**
1770 * Determine the type of transmit descriptor.
1771 *
1772 * @returns Descriptor type. See E1K_DTYP_XXX defines.
1773 *
1774 * @param pDesc Pointer to descriptor union.
1775 * @thread E1000_TX
1776 */
1777DECLINLINE(int) e1kGetDescType(E1KTXDESC *pDesc)
1778{
1779 if (pDesc->legacy.cmd.fDEXT)
1780 return pDesc->context.dw2.u4DTYP;
1781 return E1K_DTYP_LEGACY;
1782}
1783
1784
1785#if defined(E1K_WITH_RXD_CACHE) && defined(IN_RING3) /* currently only used in ring-3 due to stack space requirements of the caller */
1786/**
1787 * Dump receive descriptor to debug log.
1788 *
1789 * @param pThis The device state structure.
1790 * @param pDesc Pointer to the descriptor.
1791 * @thread E1000_RX
1792 */
1793static void e1kPrintRDesc(PE1KSTATE pThis, E1KRXDESC *pDesc)
1794{
1795 RT_NOREF2(pThis, pDesc);
1796 E1kLog2(("%s <-- Receive Descriptor (%d bytes):\n", pThis->szPrf, pDesc->u16Length));
1797 E1kLog2((" Address=%16LX Length=%04X Csum=%04X\n",
1798 pDesc->u64BufAddr, pDesc->u16Length, pDesc->u16Checksum));
1799 E1kLog2((" STA: %s %s %s %s %s %s %s ERR: %s %s %s %s SPECIAL: %s VLAN=%03x PRI=%x\n",
1800 pDesc->status.fPIF ? "PIF" : "pif",
1801 pDesc->status.fIPCS ? "IPCS" : "ipcs",
1802 pDesc->status.fTCPCS ? "TCPCS" : "tcpcs",
1803 pDesc->status.fVP ? "VP" : "vp",
1804 pDesc->status.fIXSM ? "IXSM" : "ixsm",
1805 pDesc->status.fEOP ? "EOP" : "eop",
1806 pDesc->status.fDD ? "DD" : "dd",
1807 pDesc->status.fRXE ? "RXE" : "rxe",
1808 pDesc->status.fIPE ? "IPE" : "ipe",
1809 pDesc->status.fTCPE ? "TCPE" : "tcpe",
1810 pDesc->status.fCE ? "CE" : "ce",
1811 E1K_SPEC_CFI(pDesc->status.u16Special) ? "CFI" :"cfi",
1812 E1K_SPEC_VLAN(pDesc->status.u16Special),
1813 E1K_SPEC_PRI(pDesc->status.u16Special)));
1814}
1815#endif /* E1K_WITH_RXD_CACHE && IN_RING3 */
1816
1817/**
1818 * Dump transmit descriptor to debug log.
1819 *
1820 * @param pThis The device state structure.
1821 * @param pDesc Pointer to descriptor union.
1822 * @param pszDir A string denoting direction of descriptor transfer
1823 * @thread E1000_TX
1824 */
1825static void e1kPrintTDesc(PE1KSTATE pThis, E1KTXDESC *pDesc, const char *pszDir,
1826 unsigned uLevel = RTLOGGRPFLAGS_LEVEL_2)
1827{
1828 RT_NOREF4(pThis, pDesc, pszDir, uLevel);
1829
1830 /*
1831 * Unfortunately we cannot use our format handler here, we want R0 logging
1832 * as well.
1833 */
1834 switch (e1kGetDescType(pDesc))
1835 {
1836 case E1K_DTYP_CONTEXT:
1837 E1kLogX(uLevel, ("%s %s Context Transmit Descriptor %s\n",
1838 pThis->szPrf, pszDir, pszDir));
1839 E1kLogX(uLevel, (" IPCSS=%02X IPCSO=%02X IPCSE=%04X TUCSS=%02X TUCSO=%02X TUCSE=%04X\n",
1840 pDesc->context.ip.u8CSS, pDesc->context.ip.u8CSO, pDesc->context.ip.u16CSE,
1841 pDesc->context.tu.u8CSS, pDesc->context.tu.u8CSO, pDesc->context.tu.u16CSE));
1842 E1kLogX(uLevel, (" TUCMD:%s%s%s %s %s PAYLEN=%04x HDRLEN=%04x MSS=%04x STA: %s\n",
1843 pDesc->context.dw2.fIDE ? " IDE":"",
1844 pDesc->context.dw2.fRS ? " RS" :"",
1845 pDesc->context.dw2.fTSE ? " TSE":"",
1846 pDesc->context.dw2.fIP ? "IPv4":"IPv6",
1847 pDesc->context.dw2.fTCP ? "TCP":"UDP",
1848 pDesc->context.dw2.u20PAYLEN,
1849 pDesc->context.dw3.u8HDRLEN,
1850 pDesc->context.dw3.u16MSS,
1851 pDesc->context.dw3.fDD?"DD":""));
1852 break;
1853 case E1K_DTYP_DATA:
1854 E1kLogX(uLevel, ("%s %s Data Transmit Descriptor (%d bytes) %s\n",
1855 pThis->szPrf, pszDir, pDesc->data.cmd.u20DTALEN, pszDir));
1856 E1kLogX(uLevel, (" Address=%16LX DTALEN=%05X\n",
1857 pDesc->data.u64BufAddr,
1858 pDesc->data.cmd.u20DTALEN));
1859 E1kLogX(uLevel, (" DCMD:%s%s%s%s%s%s%s STA:%s%s%s POPTS:%s%s SPECIAL:%s VLAN=%03x PRI=%x\n",
1860 pDesc->data.cmd.fIDE ? " IDE" :"",
1861 pDesc->data.cmd.fVLE ? " VLE" :"",
1862 pDesc->data.cmd.fRPS ? " RPS" :"",
1863 pDesc->data.cmd.fRS ? " RS" :"",
1864 pDesc->data.cmd.fTSE ? " TSE" :"",
1865 pDesc->data.cmd.fIFCS? " IFCS":"",
1866 pDesc->data.cmd.fEOP ? " EOP" :"",
1867 pDesc->data.dw3.fDD ? " DD" :"",
1868 pDesc->data.dw3.fEC ? " EC" :"",
1869 pDesc->data.dw3.fLC ? " LC" :"",
1870 pDesc->data.dw3.fTXSM? " TXSM":"",
1871 pDesc->data.dw3.fIXSM? " IXSM":"",
1872 E1K_SPEC_CFI(pDesc->data.dw3.u16Special) ? "CFI" :"cfi",
1873 E1K_SPEC_VLAN(pDesc->data.dw3.u16Special),
1874 E1K_SPEC_PRI(pDesc->data.dw3.u16Special)));
1875 break;
1876 case E1K_DTYP_LEGACY:
1877 E1kLogX(uLevel, ("%s %s Legacy Transmit Descriptor (%d bytes) %s\n",
1878 pThis->szPrf, pszDir, pDesc->legacy.cmd.u16Length, pszDir));
1879 E1kLogX(uLevel, (" Address=%16LX DTALEN=%05X\n",
1880 pDesc->data.u64BufAddr,
1881 pDesc->legacy.cmd.u16Length));
1882 E1kLogX(uLevel, (" CMD:%s%s%s%s%s%s%s STA:%s%s%s CSO=%02x CSS=%02x SPECIAL:%s VLAN=%03x PRI=%x\n",
1883 pDesc->legacy.cmd.fIDE ? " IDE" :"",
1884 pDesc->legacy.cmd.fVLE ? " VLE" :"",
1885 pDesc->legacy.cmd.fRPS ? " RPS" :"",
1886 pDesc->legacy.cmd.fRS ? " RS" :"",
1887 pDesc->legacy.cmd.fIC ? " IC" :"",
1888 pDesc->legacy.cmd.fIFCS? " IFCS":"",
1889 pDesc->legacy.cmd.fEOP ? " EOP" :"",
1890 pDesc->legacy.dw3.fDD ? " DD" :"",
1891 pDesc->legacy.dw3.fEC ? " EC" :"",
1892 pDesc->legacy.dw3.fLC ? " LC" :"",
1893 pDesc->legacy.cmd.u8CSO,
1894 pDesc->legacy.dw3.u8CSS,
1895 E1K_SPEC_CFI(pDesc->legacy.dw3.u16Special) ? "CFI" :"cfi",
1896 E1K_SPEC_VLAN(pDesc->legacy.dw3.u16Special),
1897 E1K_SPEC_PRI(pDesc->legacy.dw3.u16Special)));
1898 break;
1899 default:
1900 E1kLog(("%s %s Invalid Transmit Descriptor %s\n",
1901 pThis->szPrf, pszDir, pszDir));
1902 break;
1903 }
1904}
1905
1906/**
1907 * Raise an interrupt later.
1908 *
1909 * @param pThis The device state structure.
1910 */
1911inline void e1kPostponeInterrupt(PE1KSTATE pThis, uint64_t uNanoseconds)
1912{
1913 if (!TMTimerIsActive(pThis->CTX_SUFF(pIntTimer)))
1914 TMTimerSetNano(pThis->CTX_SUFF(pIntTimer), uNanoseconds);
1915}
1916
1917/**
1918 * Raise interrupt if not masked.
1919 *
1920 * @param pThis The device state structure.
1921 */
1922static int e1kRaiseInterrupt(PE1KSTATE pThis, int rcBusy, uint32_t u32IntCause = 0)
1923{
1924 int rc = e1kCsEnter(pThis, rcBusy);
1925 if (RT_UNLIKELY(rc != VINF_SUCCESS))
1926 return rc;
1927
1928 E1K_INC_ISTAT_CNT(pThis->uStatIntTry);
1929 ICR |= u32IntCause;
1930 if (ICR & IMS)
1931 {
1932 if (pThis->fIntRaised)
1933 {
1934 E1K_INC_ISTAT_CNT(pThis->uStatIntSkip);
1935 E1kLog2(("%s e1kRaiseInterrupt: Already raised, skipped. ICR&IMS=%08x\n",
1936 pThis->szPrf, ICR & IMS));
1937 }
1938 else
1939 {
1940 uint64_t tsNow = TMTimerGet(pThis->CTX_SUFF(pIntTimer));
1941 if (!!ITR && tsNow - pThis->u64AckedAt < ITR * 256
1942 && pThis->fItrEnabled && (pThis->fItrRxEnabled || !(ICR & ICR_RXT0)))
1943 {
1944 E1K_INC_ISTAT_CNT(pThis->uStatIntEarly);
1945 E1kLog2(("%s e1kRaiseInterrupt: Too early to raise again: %d ns < %d ns.\n",
1946 pThis->szPrf, (uint32_t)(tsNow - pThis->u64AckedAt), ITR * 256));
1947 e1kPostponeInterrupt(pThis, ITR * 256);
1948 }
1949 else
1950 {
1951
1952 /* Since we are delivering the interrupt now
1953 * there is no need to do it later -- stop the timer.
1954 */
1955 TMTimerStop(pThis->CTX_SUFF(pIntTimer));
1956 E1K_INC_ISTAT_CNT(pThis->uStatInt);
1957 STAM_COUNTER_INC(&pThis->StatIntsRaised);
1958 /* Got at least one unmasked interrupt cause */
1959 pThis->fIntRaised = true;
1960 /* Raise(1) INTA(0) */
1961 E1kLogRel(("E1000: irq RAISED icr&mask=0x%x, icr=0x%x\n", ICR & IMS, ICR));
1962 PDMDevHlpPCISetIrq(pThis->CTX_SUFF(pDevIns), 0, 1);
1963 E1kLog(("%s e1kRaiseInterrupt: Raised. ICR&IMS=%08x\n",
1964 pThis->szPrf, ICR & IMS));
1965 }
1966 }
1967 }
1968 else
1969 {
1970 E1K_INC_ISTAT_CNT(pThis->uStatIntMasked);
1971 E1kLog2(("%s e1kRaiseInterrupt: Not raising, ICR=%08x, IMS=%08x\n",
1972 pThis->szPrf, ICR, IMS));
1973 }
1974 e1kCsLeave(pThis);
1975 return VINF_SUCCESS;
1976}
1977
1978/**
1979 * Compute the physical address of the descriptor.
1980 *
1981 * @returns the physical address of the descriptor.
1982 *
1983 * @param baseHigh High-order 32 bits of descriptor table address.
1984 * @param baseLow Low-order 32 bits of descriptor table address.
1985 * @param idxDesc The descriptor index in the table.
1986 */
1987DECLINLINE(RTGCPHYS) e1kDescAddr(uint32_t baseHigh, uint32_t baseLow, uint32_t idxDesc)
1988{
1989 AssertCompile(sizeof(E1KRXDESC) == sizeof(E1KTXDESC));
1990 return ((uint64_t)baseHigh << 32) + baseLow + idxDesc * sizeof(E1KRXDESC);
1991}
1992
1993#ifdef IN_RING3 /* currently only used in ring-3 due to stack space requirements of the caller */
1994/**
1995 * Advance the head pointer of the receive descriptor queue.
1996 *
1997 * @remarks RDH always points to the next available RX descriptor.
1998 *
1999 * @param pThis The device state structure.
2000 */
2001DECLINLINE(void) e1kAdvanceRDH(PE1KSTATE pThis)
2002{
2003 Assert(e1kCsRxIsOwner(pThis));
2004 //e1kCsEnter(pThis, RT_SRC_POS);
2005 if (++RDH * sizeof(E1KRXDESC) >= RDLEN)
2006 RDH = 0;
2007 /*
2008 * Compute current receive queue length and fire RXDMT0 interrupt
2009 * if we are low on receive buffers
2010 */
2011 uint32_t uRQueueLen = RDH>RDT ? RDLEN/sizeof(E1KRXDESC)-RDH+RDT : RDT-RDH;
2012 /*
2013 * The minimum threshold is controlled by RDMTS bits of RCTL:
2014 * 00 = 1/2 of RDLEN
2015 * 01 = 1/4 of RDLEN
2016 * 10 = 1/8 of RDLEN
2017 * 11 = reserved
2018 */
2019 uint32_t uMinRQThreshold = RDLEN / sizeof(E1KRXDESC) / (2 << GET_BITS(RCTL, RDMTS));
2020 if (uRQueueLen <= uMinRQThreshold)
2021 {
2022 E1kLogRel(("E1000: low on RX descriptors, RDH=%x RDT=%x len=%x threshold=%x\n", RDH, RDT, uRQueueLen, uMinRQThreshold));
2023 E1kLog2(("%s Low on RX descriptors, RDH=%x RDT=%x len=%x threshold=%x, raise an interrupt\n",
2024 pThis->szPrf, RDH, RDT, uRQueueLen, uMinRQThreshold));
2025 E1K_INC_ISTAT_CNT(pThis->uStatIntRXDMT0);
2026 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_RXDMT0);
2027 }
2028 E1kLog2(("%s e1kAdvanceRDH: at exit RDH=%x RDT=%x len=%x\n",
2029 pThis->szPrf, RDH, RDT, uRQueueLen));
2030 //e1kCsLeave(pThis);
2031}
2032#endif /* IN_RING3 */
2033
2034#ifdef E1K_WITH_RXD_CACHE
2035
2036/**
2037 * Return the number of RX descriptor that belong to the hardware.
2038 *
2039 * @returns the number of available descriptors in RX ring.
2040 * @param pThis The device state structure.
2041 * @thread ???
2042 */
2043DECLINLINE(uint32_t) e1kGetRxLen(PE1KSTATE pThis)
2044{
2045 /**
2046 * Make sure RDT won't change during computation. EMT may modify RDT at
2047 * any moment.
2048 */
2049 uint32_t rdt = RDT;
2050 return (RDH > rdt ? RDLEN/sizeof(E1KRXDESC) : 0) + rdt - RDH;
2051}
2052
2053DECLINLINE(unsigned) e1kRxDInCache(PE1KSTATE pThis)
2054{
2055 return pThis->nRxDFetched > pThis->iRxDCurrent ?
2056 pThis->nRxDFetched - pThis->iRxDCurrent : 0;
2057}
2058
2059DECLINLINE(unsigned) e1kRxDIsCacheEmpty(PE1KSTATE pThis)
2060{
2061 return pThis->iRxDCurrent >= pThis->nRxDFetched;
2062}
2063
2064/**
2065 * Load receive descriptors from guest memory. The caller needs to be in Rx
2066 * critical section.
2067 *
2068 * We need two physical reads in case the tail wrapped around the end of RX
2069 * descriptor ring.
2070 *
2071 * @returns the actual number of descriptors fetched.
2072 * @param pThis The device state structure.
2073 * @param pDesc Pointer to descriptor union.
2074 * @param addr Physical address in guest context.
2075 * @thread EMT, RX
2076 */
2077DECLINLINE(unsigned) e1kRxDPrefetch(PE1KSTATE pThis)
2078{
2079 /* We've already loaded pThis->nRxDFetched descriptors past RDH. */
2080 unsigned nDescsAvailable = e1kGetRxLen(pThis) - e1kRxDInCache(pThis);
2081 unsigned nDescsToFetch = RT_MIN(nDescsAvailable, E1K_RXD_CACHE_SIZE - pThis->nRxDFetched);
2082 unsigned nDescsTotal = RDLEN / sizeof(E1KRXDESC);
2083 Assert(nDescsTotal != 0);
2084 if (nDescsTotal == 0)
2085 return 0;
2086 unsigned nFirstNotLoaded = (RDH + e1kRxDInCache(pThis)) % nDescsTotal;
2087 unsigned nDescsInSingleRead = RT_MIN(nDescsToFetch, nDescsTotal - nFirstNotLoaded);
2088 E1kLog3(("%s e1kRxDPrefetch: nDescsAvailable=%u nDescsToFetch=%u "
2089 "nDescsTotal=%u nFirstNotLoaded=0x%x nDescsInSingleRead=%u\n",
2090 pThis->szPrf, nDescsAvailable, nDescsToFetch, nDescsTotal,
2091 nFirstNotLoaded, nDescsInSingleRead));
2092 if (nDescsToFetch == 0)
2093 return 0;
2094 E1KRXDESC* pFirstEmptyDesc = &pThis->aRxDescriptors[pThis->nRxDFetched];
2095 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns),
2096 ((uint64_t)RDBAH << 32) + RDBAL + nFirstNotLoaded * sizeof(E1KRXDESC),
2097 pFirstEmptyDesc, nDescsInSingleRead * sizeof(E1KRXDESC));
2098 // uint64_t addrBase = ((uint64_t)RDBAH << 32) + RDBAL;
2099 // unsigned i, j;
2100 // for (i = pThis->nRxDFetched; i < pThis->nRxDFetched + nDescsInSingleRead; ++i)
2101 // {
2102 // pThis->aRxDescAddr[i] = addrBase + (nFirstNotLoaded + i - pThis->nRxDFetched) * sizeof(E1KRXDESC);
2103 // E1kLog3(("%s aRxDescAddr[%d] = %p\n", pThis->szPrf, i, pThis->aRxDescAddr[i]));
2104 // }
2105 E1kLog3(("%s Fetched %u RX descriptors at %08x%08x(0x%x), RDLEN=%08x, RDH=%08x, RDT=%08x\n",
2106 pThis->szPrf, nDescsInSingleRead,
2107 RDBAH, RDBAL + RDH * sizeof(E1KRXDESC),
2108 nFirstNotLoaded, RDLEN, RDH, RDT));
2109 if (nDescsToFetch > nDescsInSingleRead)
2110 {
2111 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns),
2112 ((uint64_t)RDBAH << 32) + RDBAL,
2113 pFirstEmptyDesc + nDescsInSingleRead,
2114 (nDescsToFetch - nDescsInSingleRead) * sizeof(E1KRXDESC));
2115 // Assert(i == pThis->nRxDFetched + nDescsInSingleRead);
2116 // for (j = 0; i < pThis->nRxDFetched + nDescsToFetch; ++i, ++j)
2117 // {
2118 // pThis->aRxDescAddr[i] = addrBase + j * sizeof(E1KRXDESC);
2119 // E1kLog3(("%s aRxDescAddr[%d] = %p\n", pThis->szPrf, i, pThis->aRxDescAddr[i]));
2120 // }
2121 E1kLog3(("%s Fetched %u RX descriptors at %08x%08x\n",
2122 pThis->szPrf, nDescsToFetch - nDescsInSingleRead,
2123 RDBAH, RDBAL));
2124 }
2125 pThis->nRxDFetched += nDescsToFetch;
2126 return nDescsToFetch;
2127}
2128
2129# ifdef IN_RING3 /* currently only used in ring-3 due to stack space requirements of the caller */
2130
2131/**
2132 * Obtain the next RX descriptor from RXD cache, fetching descriptors from the
2133 * RX ring if the cache is empty.
2134 *
2135 * Note that we cannot advance the cache pointer (iRxDCurrent) yet as it will
2136 * go out of sync with RDH which will cause trouble when EMT checks if the
2137 * cache is empty to do pre-fetch @bugref(6217).
2138 *
2139 * @param pThis The device state structure.
2140 * @thread RX
2141 */
2142DECLINLINE(E1KRXDESC*) e1kRxDGet(PE1KSTATE pThis)
2143{
2144 Assert(e1kCsRxIsOwner(pThis));
2145 /* Check the cache first. */
2146 if (pThis->iRxDCurrent < pThis->nRxDFetched)
2147 return &pThis->aRxDescriptors[pThis->iRxDCurrent];
2148 /* Cache is empty, reset it and check if we can fetch more. */
2149 pThis->iRxDCurrent = pThis->nRxDFetched = 0;
2150 if (e1kRxDPrefetch(pThis))
2151 return &pThis->aRxDescriptors[pThis->iRxDCurrent];
2152 /* Out of Rx descriptors. */
2153 return NULL;
2154}
2155
2156
2157/**
2158 * Return the RX descriptor obtained with e1kRxDGet() and advance the cache
2159 * pointer. The descriptor gets written back to the RXD ring.
2160 *
2161 * @param pThis The device state structure.
2162 * @param pDesc The descriptor being "returned" to the RX ring.
2163 * @thread RX
2164 */
2165DECLINLINE(void) e1kRxDPut(PE1KSTATE pThis, E1KRXDESC* pDesc)
2166{
2167 Assert(e1kCsRxIsOwner(pThis));
2168 pThis->iRxDCurrent++;
2169 // Assert(pDesc >= pThis->aRxDescriptors);
2170 // Assert(pDesc < pThis->aRxDescriptors + E1K_RXD_CACHE_SIZE);
2171 // uint64_t addr = e1kDescAddr(RDBAH, RDBAL, RDH);
2172 // uint32_t rdh = RDH;
2173 // Assert(pThis->aRxDescAddr[pDesc - pThis->aRxDescriptors] == addr);
2174 PDMDevHlpPCIPhysWrite(pThis->CTX_SUFF(pDevIns),
2175 e1kDescAddr(RDBAH, RDBAL, RDH),
2176 pDesc, sizeof(E1KRXDESC));
2177 e1kAdvanceRDH(pThis);
2178 e1kPrintRDesc(pThis, pDesc);
2179}
2180
2181/**
2182 * Store a fragment of received packet at the specifed address.
2183 *
2184 * @param pThis The device state structure.
2185 * @param pDesc The next available RX descriptor.
2186 * @param pvBuf The fragment.
2187 * @param cb The size of the fragment.
2188 */
2189static DECLCALLBACK(void) e1kStoreRxFragment(PE1KSTATE pThis, E1KRXDESC *pDesc, const void *pvBuf, size_t cb)
2190{
2191 STAM_PROFILE_ADV_START(&pThis->StatReceiveStore, a);
2192 E1kLog2(("%s e1kStoreRxFragment: store fragment of %04X at %016LX, EOP=%d\n",
2193 pThis->szPrf, cb, pDesc->u64BufAddr, pDesc->status.fEOP));
2194 PDMDevHlpPCIPhysWrite(pThis->CTX_SUFF(pDevIns), pDesc->u64BufAddr, pvBuf, cb);
2195 pDesc->u16Length = (uint16_t)cb; Assert(pDesc->u16Length == cb);
2196 STAM_PROFILE_ADV_STOP(&pThis->StatReceiveStore, a);
2197}
2198
2199# endif
2200
2201#else /* !E1K_WITH_RXD_CACHE */
2202
2203/**
2204 * Store a fragment of received packet that fits into the next available RX
2205 * buffer.
2206 *
2207 * @remarks Trigger the RXT0 interrupt if it is the last fragment of the packet.
2208 *
2209 * @param pThis The device state structure.
2210 * @param pDesc The next available RX descriptor.
2211 * @param pvBuf The fragment.
2212 * @param cb The size of the fragment.
2213 */
2214static DECLCALLBACK(void) e1kStoreRxFragment(PE1KSTATE pThis, E1KRXDESC *pDesc, const void *pvBuf, size_t cb)
2215{
2216 STAM_PROFILE_ADV_START(&pThis->StatReceiveStore, a);
2217 E1kLog2(("%s e1kStoreRxFragment: store fragment of %04X at %016LX, EOP=%d\n", pThis->szPrf, cb, pDesc->u64BufAddr, pDesc->status.fEOP));
2218 PDMDevHlpPCIPhysWrite(pThis->CTX_SUFF(pDevIns), pDesc->u64BufAddr, pvBuf, cb);
2219 pDesc->u16Length = (uint16_t)cb; Assert(pDesc->u16Length == cb);
2220 /* Write back the descriptor */
2221 PDMDevHlpPCIPhysWrite(pThis->CTX_SUFF(pDevIns), e1kDescAddr(RDBAH, RDBAL, RDH), pDesc, sizeof(E1KRXDESC));
2222 e1kPrintRDesc(pThis, pDesc);
2223 E1kLogRel(("E1000: Wrote back RX desc, RDH=%x\n", RDH));
2224 /* Advance head */
2225 e1kAdvanceRDH(pThis);
2226 //E1kLog2(("%s e1kStoreRxFragment: EOP=%d RDTR=%08X RADV=%08X\n", pThis->szPrf, pDesc->fEOP, RDTR, RADV));
2227 if (pDesc->status.fEOP)
2228 {
2229 /* Complete packet has been stored -- it is time to let the guest know. */
2230#ifdef E1K_USE_RX_TIMERS
2231 if (RDTR)
2232 {
2233 /* Arm the timer to fire in RDTR usec (discard .024) */
2234 e1kArmTimer(pThis, pThis->CTX_SUFF(pRIDTimer), RDTR);
2235 /* If absolute timer delay is enabled and the timer is not running yet, arm it. */
2236 if (RADV != 0 && !TMTimerIsActive(pThis->CTX_SUFF(pRADTimer)))
2237 e1kArmTimer(pThis, pThis->CTX_SUFF(pRADTimer), RADV);
2238 }
2239 else
2240 {
2241#endif
2242 /* 0 delay means immediate interrupt */
2243 E1K_INC_ISTAT_CNT(pThis->uStatIntRx);
2244 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_RXT0);
2245#ifdef E1K_USE_RX_TIMERS
2246 }
2247#endif
2248 }
2249 STAM_PROFILE_ADV_STOP(&pThis->StatReceiveStore, a);
2250}
2251
2252#endif /* !E1K_WITH_RXD_CACHE */
2253
2254/**
2255 * Returns true if it is a broadcast packet.
2256 *
2257 * @returns true if destination address indicates broadcast.
2258 * @param pvBuf The ethernet packet.
2259 */
2260DECLINLINE(bool) e1kIsBroadcast(const void *pvBuf)
2261{
2262 static const uint8_t s_abBcastAddr[] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
2263 return memcmp(pvBuf, s_abBcastAddr, sizeof(s_abBcastAddr)) == 0;
2264}
2265
2266/**
2267 * Returns true if it is a multicast packet.
2268 *
2269 * @remarks returns true for broadcast packets as well.
2270 * @returns true if destination address indicates multicast.
2271 * @param pvBuf The ethernet packet.
2272 */
2273DECLINLINE(bool) e1kIsMulticast(const void *pvBuf)
2274{
2275 return (*(char*)pvBuf) & 1;
2276}
2277
2278#ifdef IN_RING3 /* currently only used in ring-3 due to stack space requirements of the caller */
2279/**
2280 * Set IXSM, IPCS and TCPCS flags according to the packet type.
2281 *
2282 * @remarks We emulate checksum offloading for major packets types only.
2283 *
2284 * @returns VBox status code.
2285 * @param pThis The device state structure.
2286 * @param pFrame The available data.
2287 * @param cb Number of bytes available in the buffer.
2288 * @param status Bit fields containing status info.
2289 */
2290static int e1kRxChecksumOffload(PE1KSTATE pThis, const uint8_t *pFrame, size_t cb, E1KRXDST *pStatus)
2291{
2292 /** @todo
2293 * It is not safe to bypass checksum verification for packets coming
2294 * from real wire. We currently unable to tell where packets are
2295 * coming from so we tell the driver to ignore our checksum flags
2296 * and do verification in software.
2297 */
2298# if 0
2299 uint16_t uEtherType = ntohs(*(uint16_t*)(pFrame + 12));
2300
2301 E1kLog2(("%s e1kRxChecksumOffload: EtherType=%x\n", pThis->szPrf, uEtherType));
2302
2303 switch (uEtherType)
2304 {
2305 case 0x800: /* IPv4 */
2306 {
2307 pStatus->fIXSM = false;
2308 pStatus->fIPCS = true;
2309 PRTNETIPV4 pIpHdr4 = (PRTNETIPV4)(pFrame + 14);
2310 /* TCP/UDP checksum offloading works with TCP and UDP only */
2311 pStatus->fTCPCS = pIpHdr4->ip_p == 6 || pIpHdr4->ip_p == 17;
2312 break;
2313 }
2314 case 0x86DD: /* IPv6 */
2315 pStatus->fIXSM = false;
2316 pStatus->fIPCS = false;
2317 pStatus->fTCPCS = true;
2318 break;
2319 default: /* ARP, VLAN, etc. */
2320 pStatus->fIXSM = true;
2321 break;
2322 }
2323# else
2324 pStatus->fIXSM = true;
2325 RT_NOREF_PV(pThis); RT_NOREF_PV(pFrame); RT_NOREF_PV(cb);
2326# endif
2327 return VINF_SUCCESS;
2328}
2329#endif /* IN_RING3 */
2330
2331/**
2332 * Pad and store received packet.
2333 *
2334 * @remarks Make sure that the packet appears to upper layer as one coming
2335 * from real Ethernet: pad it and insert FCS.
2336 *
2337 * @returns VBox status code.
2338 * @param pThis The device state structure.
2339 * @param pvBuf The available data.
2340 * @param cb Number of bytes available in the buffer.
2341 * @param status Bit fields containing status info.
2342 */
2343static int e1kHandleRxPacket(PE1KSTATE pThis, const void *pvBuf, size_t cb, E1KRXDST status)
2344{
2345#if defined(IN_RING3) /** @todo Remove this extra copying, it's gonna make us run out of kernel / hypervisor stack! */
2346 uint8_t rxPacket[E1K_MAX_RX_PKT_SIZE];
2347 uint8_t *ptr = rxPacket;
2348
2349 int rc = e1kCsRxEnter(pThis, VERR_SEM_BUSY);
2350 if (RT_UNLIKELY(rc != VINF_SUCCESS))
2351 return rc;
2352
2353 if (cb > 70) /* unqualified guess */
2354 pThis->led.Asserted.s.fReading = pThis->led.Actual.s.fReading = 1;
2355
2356 Assert(cb <= E1K_MAX_RX_PKT_SIZE);
2357 Assert(cb > 16);
2358 size_t cbMax = ((RCTL & RCTL_LPE) ? E1K_MAX_RX_PKT_SIZE - 4 : 1518) - (status.fVP ? 0 : 4);
2359 E1kLog3(("%s Max RX packet size is %u\n", pThis->szPrf, cbMax));
2360 if (status.fVP)
2361 {
2362 /* VLAN packet -- strip VLAN tag in VLAN mode */
2363 if ((CTRL & CTRL_VME) && cb > 16)
2364 {
2365 uint16_t *u16Ptr = (uint16_t*)pvBuf;
2366 memcpy(rxPacket, pvBuf, 12); /* Copy src and dst addresses */
2367 status.u16Special = RT_BE2H_U16(u16Ptr[7]); /* Extract VLAN tag */
2368 memcpy(rxPacket + 12, (uint8_t*)pvBuf + 16, cb - 16); /* Copy the rest of the packet */
2369 cb -= 4;
2370 E1kLog3(("%s Stripped tag for VLAN %u (cb=%u)\n",
2371 pThis->szPrf, status.u16Special, cb));
2372 }
2373 else
2374 status.fVP = false; /* Set VP only if we stripped the tag */
2375 }
2376 else
2377 memcpy(rxPacket, pvBuf, cb);
2378 /* Pad short packets */
2379 if (cb < 60)
2380 {
2381 memset(rxPacket + cb, 0, 60 - cb);
2382 cb = 60;
2383 }
2384 if (!(RCTL & RCTL_SECRC) && cb <= cbMax)
2385 {
2386 STAM_PROFILE_ADV_START(&pThis->StatReceiveCRC, a);
2387 /*
2388 * Add FCS if CRC stripping is not enabled. Since the value of CRC
2389 * is ignored by most of drivers we may as well save us the trouble
2390 * of calculating it (see EthernetCRC CFGM parameter).
2391 */
2392 if (pThis->fEthernetCRC)
2393 *(uint32_t*)(rxPacket + cb) = RTCrc32(rxPacket, cb);
2394 cb += sizeof(uint32_t);
2395 STAM_PROFILE_ADV_STOP(&pThis->StatReceiveCRC, a);
2396 E1kLog3(("%s Added FCS (cb=%u)\n", pThis->szPrf, cb));
2397 }
2398 /* Compute checksum of complete packet */
2399 uint16_t checksum = e1kCSum16(rxPacket + GET_BITS(RXCSUM, PCSS), cb);
2400 e1kRxChecksumOffload(pThis, rxPacket, cb, &status);
2401
2402 /* Update stats */
2403 E1K_INC_CNT32(GPRC);
2404 if (e1kIsBroadcast(pvBuf))
2405 E1K_INC_CNT32(BPRC);
2406 else if (e1kIsMulticast(pvBuf))
2407 E1K_INC_CNT32(MPRC);
2408 /* Update octet receive counter */
2409 E1K_ADD_CNT64(GORCL, GORCH, cb);
2410 STAM_REL_COUNTER_ADD(&pThis->StatReceiveBytes, cb);
2411 if (cb == 64)
2412 E1K_INC_CNT32(PRC64);
2413 else if (cb < 128)
2414 E1K_INC_CNT32(PRC127);
2415 else if (cb < 256)
2416 E1K_INC_CNT32(PRC255);
2417 else if (cb < 512)
2418 E1K_INC_CNT32(PRC511);
2419 else if (cb < 1024)
2420 E1K_INC_CNT32(PRC1023);
2421 else
2422 E1K_INC_CNT32(PRC1522);
2423
2424 E1K_INC_ISTAT_CNT(pThis->uStatRxFrm);
2425
2426# ifdef E1K_WITH_RXD_CACHE
2427 while (cb > 0)
2428 {
2429 E1KRXDESC *pDesc = e1kRxDGet(pThis);
2430
2431 if (pDesc == NULL)
2432 {
2433 E1kLog(("%s Out of receive buffers, dropping the packet "
2434 "(cb=%u, in_cache=%u, RDH=%x RDT=%x)\n",
2435 pThis->szPrf, cb, e1kRxDInCache(pThis), RDH, RDT));
2436 break;
2437 }
2438# else /* !E1K_WITH_RXD_CACHE */
2439 if (RDH == RDT)
2440 {
2441 E1kLog(("%s Out of receive buffers, dropping the packet\n",
2442 pThis->szPrf));
2443 }
2444 /* Store the packet to receive buffers */
2445 while (RDH != RDT)
2446 {
2447 /* Load the descriptor pointed by head */
2448 E1KRXDESC desc, *pDesc = &desc;
2449 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), e1kDescAddr(RDBAH, RDBAL, RDH),
2450 &desc, sizeof(desc));
2451# endif /* !E1K_WITH_RXD_CACHE */
2452 if (pDesc->u64BufAddr)
2453 {
2454 /* Update descriptor */
2455 pDesc->status = status;
2456 pDesc->u16Checksum = checksum;
2457 pDesc->status.fDD = true;
2458
2459 /*
2460 * We need to leave Rx critical section here or we risk deadlocking
2461 * with EMT in e1kRegWriteRDT when the write is to an unallocated
2462 * page or has an access handler associated with it.
2463 * Note that it is safe to leave the critical section here since
2464 * e1kRegWriteRDT() never modifies RDH. It never touches already
2465 * fetched RxD cache entries either.
2466 */
2467 if (cb > pThis->u16RxBSize)
2468 {
2469 pDesc->status.fEOP = false;
2470 e1kCsRxLeave(pThis);
2471 e1kStoreRxFragment(pThis, pDesc, ptr, pThis->u16RxBSize);
2472 rc = e1kCsRxEnter(pThis, VERR_SEM_BUSY);
2473 if (RT_UNLIKELY(rc != VINF_SUCCESS))
2474 return rc;
2475 ptr += pThis->u16RxBSize;
2476 cb -= pThis->u16RxBSize;
2477 }
2478 else
2479 {
2480 pDesc->status.fEOP = true;
2481 e1kCsRxLeave(pThis);
2482 e1kStoreRxFragment(pThis, pDesc, ptr, cb);
2483# ifdef E1K_WITH_RXD_CACHE
2484 rc = e1kCsRxEnter(pThis, VERR_SEM_BUSY);
2485 if (RT_UNLIKELY(rc != VINF_SUCCESS))
2486 return rc;
2487 cb = 0;
2488# else /* !E1K_WITH_RXD_CACHE */
2489 pThis->led.Actual.s.fReading = 0;
2490 return VINF_SUCCESS;
2491# endif /* !E1K_WITH_RXD_CACHE */
2492 }
2493 /*
2494 * Note: RDH is advanced by e1kStoreRxFragment if E1K_WITH_RXD_CACHE
2495 * is not defined.
2496 */
2497 }
2498# ifdef E1K_WITH_RXD_CACHE
2499 /* Write back the descriptor. */
2500 pDesc->status.fDD = true;
2501 e1kRxDPut(pThis, pDesc);
2502# else /* !E1K_WITH_RXD_CACHE */
2503 else
2504 {
2505 /* Write back the descriptor. */
2506 pDesc->status.fDD = true;
2507 PDMDevHlpPCIPhysWrite(pThis->CTX_SUFF(pDevIns),
2508 e1kDescAddr(RDBAH, RDBAL, RDH),
2509 pDesc, sizeof(E1KRXDESC));
2510 e1kAdvanceRDH(pThis);
2511 }
2512# endif /* !E1K_WITH_RXD_CACHE */
2513 }
2514
2515 if (cb > 0)
2516 E1kLog(("%s Out of receive buffers, dropping %u bytes", pThis->szPrf, cb));
2517
2518 pThis->led.Actual.s.fReading = 0;
2519
2520 e1kCsRxLeave(pThis);
2521# ifdef E1K_WITH_RXD_CACHE
2522 /* Complete packet has been stored -- it is time to let the guest know. */
2523# ifdef E1K_USE_RX_TIMERS
2524 if (RDTR)
2525 {
2526 /* Arm the timer to fire in RDTR usec (discard .024) */
2527 e1kArmTimer(pThis, pThis->CTX_SUFF(pRIDTimer), RDTR);
2528 /* If absolute timer delay is enabled and the timer is not running yet, arm it. */
2529 if (RADV != 0 && !TMTimerIsActive(pThis->CTX_SUFF(pRADTimer)))
2530 e1kArmTimer(pThis, pThis->CTX_SUFF(pRADTimer), RADV);
2531 }
2532 else
2533 {
2534# endif /* E1K_USE_RX_TIMERS */
2535 /* 0 delay means immediate interrupt */
2536 E1K_INC_ISTAT_CNT(pThis->uStatIntRx);
2537 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_RXT0);
2538# ifdef E1K_USE_RX_TIMERS
2539 }
2540# endif /* E1K_USE_RX_TIMERS */
2541# endif /* E1K_WITH_RXD_CACHE */
2542
2543 return VINF_SUCCESS;
2544#else /* !IN_RING3 */
2545 RT_NOREF_PV(pThis); RT_NOREF_PV(pvBuf); RT_NOREF_PV(cb); RT_NOREF_PV(status);
2546 return VERR_INTERNAL_ERROR_2;
2547#endif /* !IN_RING3 */
2548}
2549
2550
2551#ifdef IN_RING3
2552/**
2553 * Bring the link up after the configured delay, 5 seconds by default.
2554 *
2555 * @param pThis The device state structure.
2556 * @thread any
2557 */
2558DECLINLINE(void) e1kBringLinkUpDelayed(PE1KSTATE pThis)
2559{
2560 E1kLog(("%s Will bring up the link in %d seconds...\n",
2561 pThis->szPrf, pThis->cMsLinkUpDelay / 1000));
2562 e1kArmTimer(pThis, pThis->CTX_SUFF(pLUTimer), pThis->cMsLinkUpDelay * 1000);
2563}
2564
2565/**
2566 * Bring up the link immediately.
2567 *
2568 * @param pThis The device state structure.
2569 */
2570DECLINLINE(void) e1kR3LinkUp(PE1KSTATE pThis)
2571{
2572 E1kLog(("%s Link is up\n", pThis->szPrf));
2573 STATUS |= STATUS_LU;
2574 Phy::setLinkStatus(&pThis->phy, true);
2575 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_LSC);
2576 if (pThis->pDrvR3)
2577 pThis->pDrvR3->pfnNotifyLinkChanged(pThis->pDrvR3, PDMNETWORKLINKSTATE_UP);
2578 /* Process pending TX descriptors (see @bugref{8942}) */
2579 PPDMQUEUEITEMCORE pItem = PDMQueueAlloc(pThis->CTX_SUFF(pTxQueue));
2580 if (RT_UNLIKELY(pItem))
2581 PDMQueueInsert(pThis->CTX_SUFF(pTxQueue), pItem);
2582}
2583
2584/**
2585 * Bring down the link immediately.
2586 *
2587 * @param pThis The device state structure.
2588 */
2589DECLINLINE(void) e1kR3LinkDown(PE1KSTATE pThis)
2590{
2591 E1kLog(("%s Link is down\n", pThis->szPrf));
2592 STATUS &= ~STATUS_LU;
2593#ifdef E1K_LSC_ON_RESET
2594 Phy::setLinkStatus(&pThis->phy, false);
2595#endif /* E1K_LSC_ON_RESET */
2596 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_LSC);
2597 if (pThis->pDrvR3)
2598 pThis->pDrvR3->pfnNotifyLinkChanged(pThis->pDrvR3, PDMNETWORKLINKSTATE_DOWN);
2599}
2600
2601/**
2602 * Bring down the link temporarily.
2603 *
2604 * @param pThis The device state structure.
2605 */
2606DECLINLINE(void) e1kR3LinkDownTemp(PE1KSTATE pThis)
2607{
2608 E1kLog(("%s Link is down temporarily\n", pThis->szPrf));
2609 STATUS &= ~STATUS_LU;
2610 Phy::setLinkStatus(&pThis->phy, false);
2611 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_LSC);
2612 /*
2613 * Notifying the associated driver that the link went down (even temporarily)
2614 * seems to be the right thing, but it was not done before. This may cause
2615 * a regression if the driver does not expect the link to go down as a result
2616 * of sending PDMNETWORKLINKSTATE_DOWN_RESUME to this device. Earlier versions
2617 * of code notified the driver that the link was up! See @bugref{7057}.
2618 */
2619 if (pThis->pDrvR3)
2620 pThis->pDrvR3->pfnNotifyLinkChanged(pThis->pDrvR3, PDMNETWORKLINKSTATE_DOWN);
2621 e1kBringLinkUpDelayed(pThis);
2622}
2623#endif /* IN_RING3 */
2624
2625#if 0 /* unused */
2626/**
2627 * Read handler for Device Status register.
2628 *
2629 * Get the link status from PHY.
2630 *
2631 * @returns VBox status code.
2632 *
2633 * @param pThis The device state structure.
2634 * @param offset Register offset in memory-mapped frame.
2635 * @param index Register index in register array.
2636 * @param mask Used to implement partial reads (8 and 16-bit).
2637 */
2638static int e1kRegReadCTRL(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
2639{
2640 E1kLog(("%s e1kRegReadCTRL: mdio dir=%s mdc dir=%s mdc=%d\n",
2641 pThis->szPrf, (CTRL & CTRL_MDIO_DIR)?"OUT":"IN ",
2642 (CTRL & CTRL_MDC_DIR)?"OUT":"IN ", !!(CTRL & CTRL_MDC)));
2643 if ((CTRL & CTRL_MDIO_DIR) == 0 && (CTRL & CTRL_MDC))
2644 {
2645 /* MDC is high and MDIO pin is used for input, read MDIO pin from PHY */
2646 if (Phy::readMDIO(&pThis->phy))
2647 *pu32Value = CTRL | CTRL_MDIO;
2648 else
2649 *pu32Value = CTRL & ~CTRL_MDIO;
2650 E1kLog(("%s e1kRegReadCTRL: Phy::readMDIO(%d)\n",
2651 pThis->szPrf, !!(*pu32Value & CTRL_MDIO)));
2652 }
2653 else
2654 {
2655 /* MDIO pin is used for output, ignore it */
2656 *pu32Value = CTRL;
2657 }
2658 return VINF_SUCCESS;
2659}
2660#endif /* unused */
2661
2662/**
2663 * A callback used by PHY to indicate that the link needs to be updated due to
2664 * reset of PHY.
2665 *
2666 * @param pPhy A pointer to phy member of the device state structure.
2667 * @thread any
2668 */
2669void e1kPhyLinkResetCallback(PPHY pPhy)
2670{
2671 /* PHY is aggregated into e1000, get pThis from pPhy. */
2672 PE1KSTATE pThis = RT_FROM_MEMBER(pPhy, E1KSTATE, phy);
2673 /* Make sure we have cable connected and MAC can talk to PHY */
2674 if (pThis->fCableConnected && (CTRL & CTRL_SLU))
2675 e1kArmTimer(pThis, pThis->CTX_SUFF(pLUTimer), E1K_INIT_LINKUP_DELAY_US);
2676}
2677
2678/**
2679 * Write handler for Device Control register.
2680 *
2681 * Handles reset.
2682 *
2683 * @param pThis The device state structure.
2684 * @param offset Register offset in memory-mapped frame.
2685 * @param index Register index in register array.
2686 * @param value The value to store.
2687 * @param mask Used to implement partial writes (8 and 16-bit).
2688 * @thread EMT
2689 */
2690static int e1kRegWriteCTRL(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
2691{
2692 int rc = VINF_SUCCESS;
2693
2694 if (value & CTRL_RESET)
2695 { /* RST */
2696#ifndef IN_RING3
2697 return VINF_IOM_R3_MMIO_WRITE;
2698#else
2699 e1kHardReset(pThis);
2700#endif
2701 }
2702 else
2703 {
2704#ifdef E1K_LSC_ON_SLU
2705 /*
2706 * When the guest changes 'Set Link Up' bit from 0 to 1 we check if
2707 * the link is down and the cable is connected, and if they are we
2708 * bring the link up, see @bugref{8624}.
2709 */
2710 if ( (value & CTRL_SLU)
2711 && !(CTRL & CTRL_SLU)
2712 && pThis->fCableConnected
2713 && !(STATUS & STATUS_LU))
2714 {
2715 /* It should take about 2 seconds for the link to come up */
2716 e1kArmTimer(pThis, pThis->CTX_SUFF(pLUTimer), E1K_INIT_LINKUP_DELAY_US);
2717 }
2718#endif /* E1K_LSC_ON_SLU */
2719 if ((value & CTRL_VME) != (CTRL & CTRL_VME))
2720 {
2721 E1kLog(("%s VLAN Mode %s\n", pThis->szPrf, (value & CTRL_VME) ? "Enabled" : "Disabled"));
2722 }
2723 Log7(("%s e1kRegWriteCTRL: mdio dir=%s mdc dir=%s mdc=%s mdio=%d\n",
2724 pThis->szPrf, (value & CTRL_MDIO_DIR)?"OUT":"IN ",
2725 (value & CTRL_MDC_DIR)?"OUT":"IN ", (value & CTRL_MDC)?"HIGH":"LOW ", !!(value & CTRL_MDIO)));
2726 if (value & CTRL_MDC)
2727 {
2728 if (value & CTRL_MDIO_DIR)
2729 {
2730 Log7(("%s e1kRegWriteCTRL: Phy::writeMDIO(%d)\n", pThis->szPrf, !!(value & CTRL_MDIO)));
2731 /* MDIO direction pin is set to output and MDC is high, write MDIO pin value to PHY */
2732 Phy::writeMDIO(&pThis->phy, !!(value & CTRL_MDIO));
2733 }
2734 else
2735 {
2736 if (Phy::readMDIO(&pThis->phy))
2737 value |= CTRL_MDIO;
2738 else
2739 value &= ~CTRL_MDIO;
2740 Log7(("%s e1kRegWriteCTRL: Phy::readMDIO(%d)\n", pThis->szPrf, !!(value & CTRL_MDIO)));
2741 }
2742 }
2743 rc = e1kRegWriteDefault(pThis, offset, index, value);
2744 }
2745
2746 return rc;
2747}
2748
2749/**
2750 * Write handler for EEPROM/Flash Control/Data register.
2751 *
2752 * Handles EEPROM access requests; forwards writes to EEPROM device if access has been granted.
2753 *
2754 * @param pThis The device state structure.
2755 * @param offset Register offset in memory-mapped frame.
2756 * @param index Register index in register array.
2757 * @param value The value to store.
2758 * @param mask Used to implement partial writes (8 and 16-bit).
2759 * @thread EMT
2760 */
2761static int e1kRegWriteEECD(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
2762{
2763 RT_NOREF(offset, index);
2764#ifdef IN_RING3
2765 /* So far we are concerned with lower byte only */
2766 if ((EECD & EECD_EE_GNT) || pThis->eChip == E1K_CHIP_82543GC)
2767 {
2768 /* Access to EEPROM granted -- forward 4-wire bits to EEPROM device */
2769 /* Note: 82543GC does not need to request EEPROM access */
2770 STAM_PROFILE_ADV_START(&pThis->StatEEPROMWrite, a);
2771 pThis->eeprom.write(value & EECD_EE_WIRES);
2772 STAM_PROFILE_ADV_STOP(&pThis->StatEEPROMWrite, a);
2773 }
2774 if (value & EECD_EE_REQ)
2775 EECD |= EECD_EE_REQ|EECD_EE_GNT;
2776 else
2777 EECD &= ~EECD_EE_GNT;
2778 //e1kRegWriteDefault(pThis, offset, index, value );
2779
2780 return VINF_SUCCESS;
2781#else /* !IN_RING3 */
2782 RT_NOREF(pThis, value);
2783 return VINF_IOM_R3_MMIO_WRITE;
2784#endif /* !IN_RING3 */
2785}
2786
2787/**
2788 * Read handler for EEPROM/Flash Control/Data register.
2789 *
2790 * Lower 4 bits come from EEPROM device if EEPROM access has been granted.
2791 *
2792 * @returns VBox status code.
2793 *
2794 * @param pThis The device state structure.
2795 * @param offset Register offset in memory-mapped frame.
2796 * @param index Register index in register array.
2797 * @param mask Used to implement partial reads (8 and 16-bit).
2798 * @thread EMT
2799 */
2800static int e1kRegReadEECD(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
2801{
2802#ifdef IN_RING3
2803 uint32_t value;
2804 int rc = e1kRegReadDefault(pThis, offset, index, &value);
2805 if (RT_SUCCESS(rc))
2806 {
2807 if ((value & EECD_EE_GNT) || pThis->eChip == E1K_CHIP_82543GC)
2808 {
2809 /* Note: 82543GC does not need to request EEPROM access */
2810 /* Access to EEPROM granted -- get 4-wire bits to EEPROM device */
2811 STAM_PROFILE_ADV_START(&pThis->StatEEPROMRead, a);
2812 value |= pThis->eeprom.read();
2813 STAM_PROFILE_ADV_STOP(&pThis->StatEEPROMRead, a);
2814 }
2815 *pu32Value = value;
2816 }
2817
2818 return rc;
2819#else /* !IN_RING3 */
2820 RT_NOREF_PV(pThis); RT_NOREF_PV(offset); RT_NOREF_PV(index); RT_NOREF_PV(pu32Value);
2821 return VINF_IOM_R3_MMIO_READ;
2822#endif /* !IN_RING3 */
2823}
2824
2825/**
2826 * Write handler for EEPROM Read register.
2827 *
2828 * Handles EEPROM word access requests, reads EEPROM and stores the result
2829 * into DATA field.
2830 *
2831 * @param pThis The device state structure.
2832 * @param offset Register offset in memory-mapped frame.
2833 * @param index Register index in register array.
2834 * @param value The value to store.
2835 * @param mask Used to implement partial writes (8 and 16-bit).
2836 * @thread EMT
2837 */
2838static int e1kRegWriteEERD(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
2839{
2840#ifdef IN_RING3
2841 /* Make use of 'writable' and 'readable' masks. */
2842 e1kRegWriteDefault(pThis, offset, index, value);
2843 /* DONE and DATA are set only if read was triggered by START. */
2844 if (value & EERD_START)
2845 {
2846 uint16_t tmp;
2847 STAM_PROFILE_ADV_START(&pThis->StatEEPROMRead, a);
2848 if (pThis->eeprom.readWord(GET_BITS_V(value, EERD, ADDR), &tmp))
2849 SET_BITS(EERD, DATA, tmp);
2850 EERD |= EERD_DONE;
2851 STAM_PROFILE_ADV_STOP(&pThis->StatEEPROMRead, a);
2852 }
2853
2854 return VINF_SUCCESS;
2855#else /* !IN_RING3 */
2856 RT_NOREF_PV(pThis); RT_NOREF_PV(offset); RT_NOREF_PV(index); RT_NOREF_PV(value);
2857 return VINF_IOM_R3_MMIO_WRITE;
2858#endif /* !IN_RING3 */
2859}
2860
2861
2862/**
2863 * Write handler for MDI Control register.
2864 *
2865 * Handles PHY read/write requests; forwards requests to internal PHY device.
2866 *
2867 * @param pThis The device state structure.
2868 * @param offset Register offset in memory-mapped frame.
2869 * @param index Register index in register array.
2870 * @param value The value to store.
2871 * @param mask Used to implement partial writes (8 and 16-bit).
2872 * @thread EMT
2873 */
2874static int e1kRegWriteMDIC(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
2875{
2876 if (value & MDIC_INT_EN)
2877 {
2878 E1kLog(("%s ERROR! Interrupt at the end of an MDI cycle is not supported yet.\n",
2879 pThis->szPrf));
2880 }
2881 else if (value & MDIC_READY)
2882 {
2883 E1kLog(("%s ERROR! Ready bit is not reset by software during write operation.\n",
2884 pThis->szPrf));
2885 }
2886 else if (GET_BITS_V(value, MDIC, PHY) != 1)
2887 {
2888 E1kLog(("%s WARNING! Access to invalid PHY detected, phy=%d.\n",
2889 pThis->szPrf, GET_BITS_V(value, MDIC, PHY)));
2890 /*
2891 * Some drivers scan the MDIO bus for a PHY. We can work with these
2892 * drivers if we set MDIC_READY and MDIC_ERROR when there isn't a PHY
2893 * at the requested address, see @bugref{7346}.
2894 */
2895 MDIC = MDIC_READY | MDIC_ERROR;
2896 }
2897 else
2898 {
2899 /* Store the value */
2900 e1kRegWriteDefault(pThis, offset, index, value);
2901 STAM_COUNTER_INC(&pThis->StatPHYAccesses);
2902 /* Forward op to PHY */
2903 if (value & MDIC_OP_READ)
2904 SET_BITS(MDIC, DATA, Phy::readRegister(&pThis->phy, GET_BITS_V(value, MDIC, REG)));
2905 else
2906 Phy::writeRegister(&pThis->phy, GET_BITS_V(value, MDIC, REG), value & MDIC_DATA_MASK);
2907 /* Let software know that we are done */
2908 MDIC |= MDIC_READY;
2909 }
2910
2911 return VINF_SUCCESS;
2912}
2913
2914/**
2915 * Write handler for Interrupt Cause Read register.
2916 *
2917 * Bits corresponding to 1s in 'value' will be cleared in ICR register.
2918 *
2919 * @param pThis The device state structure.
2920 * @param offset Register offset in memory-mapped frame.
2921 * @param index Register index in register array.
2922 * @param value The value to store.
2923 * @param mask Used to implement partial writes (8 and 16-bit).
2924 * @thread EMT
2925 */
2926static int e1kRegWriteICR(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
2927{
2928 ICR &= ~value;
2929
2930 RT_NOREF_PV(pThis); RT_NOREF_PV(offset); RT_NOREF_PV(index);
2931 return VINF_SUCCESS;
2932}
2933
2934/**
2935 * Read handler for Interrupt Cause Read register.
2936 *
2937 * Reading this register acknowledges all interrupts.
2938 *
2939 * @returns VBox status code.
2940 *
2941 * @param pThis The device state structure.
2942 * @param offset Register offset in memory-mapped frame.
2943 * @param index Register index in register array.
2944 * @param mask Not used.
2945 * @thread EMT
2946 */
2947static int e1kRegReadICR(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
2948{
2949 int rc = e1kCsEnter(pThis, VINF_IOM_R3_MMIO_READ);
2950 if (RT_UNLIKELY(rc != VINF_SUCCESS))
2951 return rc;
2952
2953 uint32_t value = 0;
2954 rc = e1kRegReadDefault(pThis, offset, index, &value);
2955 if (RT_SUCCESS(rc))
2956 {
2957 if (value)
2958 {
2959 if (!pThis->fIntRaised)
2960 E1K_INC_ISTAT_CNT(pThis->uStatNoIntICR);
2961 /*
2962 * Not clearing ICR causes QNX to hang as it reads ICR in a loop
2963 * with disabled interrupts.
2964 */
2965 //if (IMS)
2966 if (1)
2967 {
2968 /*
2969 * Interrupts were enabled -- we are supposedly at the very
2970 * beginning of interrupt handler
2971 */
2972 E1kLogRel(("E1000: irq lowered, icr=0x%x\n", ICR));
2973 E1kLog(("%s e1kRegReadICR: Lowered IRQ (%08x)\n", pThis->szPrf, ICR));
2974 /* Clear all pending interrupts */
2975 ICR = 0;
2976 pThis->fIntRaised = false;
2977 /* Lower(0) INTA(0) */
2978 PDMDevHlpPCISetIrq(pThis->CTX_SUFF(pDevIns), 0, 0);
2979
2980 pThis->u64AckedAt = TMTimerGet(pThis->CTX_SUFF(pIntTimer));
2981 if (pThis->fIntMaskUsed)
2982 pThis->fDelayInts = true;
2983 }
2984 else
2985 {
2986 /*
2987 * Interrupts are disabled -- in windows guests ICR read is done
2988 * just before re-enabling interrupts
2989 */
2990 E1kLog(("%s e1kRegReadICR: Suppressing auto-clear due to disabled interrupts (%08x)\n", pThis->szPrf, ICR));
2991 }
2992 }
2993 *pu32Value = value;
2994 }
2995 e1kCsLeave(pThis);
2996
2997 return rc;
2998}
2999
3000/**
3001 * Write handler for Interrupt Cause Set register.
3002 *
3003 * Bits corresponding to 1s in 'value' will be set in ICR register.
3004 *
3005 * @param pThis The device state structure.
3006 * @param offset Register offset in memory-mapped frame.
3007 * @param index Register index in register array.
3008 * @param value The value to store.
3009 * @param mask Used to implement partial writes (8 and 16-bit).
3010 * @thread EMT
3011 */
3012static int e1kRegWriteICS(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
3013{
3014 RT_NOREF_PV(offset); RT_NOREF_PV(index);
3015 E1K_INC_ISTAT_CNT(pThis->uStatIntICS);
3016 return e1kRaiseInterrupt(pThis, VINF_IOM_R3_MMIO_WRITE, value & g_aE1kRegMap[ICS_IDX].writable);
3017}
3018
3019/**
3020 * Write handler for Interrupt Mask Set register.
3021 *
3022 * Will trigger pending interrupts.
3023 *
3024 * @param pThis The device state structure.
3025 * @param offset Register offset in memory-mapped frame.
3026 * @param index Register index in register array.
3027 * @param value The value to store.
3028 * @param mask Used to implement partial writes (8 and 16-bit).
3029 * @thread EMT
3030 */
3031static int e1kRegWriteIMS(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
3032{
3033 RT_NOREF_PV(offset); RT_NOREF_PV(index);
3034
3035 IMS |= value;
3036 E1kLogRel(("E1000: irq enabled, RDH=%x RDT=%x TDH=%x TDT=%x\n", RDH, RDT, TDH, TDT));
3037 E1kLog(("%s e1kRegWriteIMS: IRQ enabled\n", pThis->szPrf));
3038 /*
3039 * We cannot raise an interrupt here as it will occasionally cause an interrupt storm
3040 * in Windows guests (see @bugref{8624}, @bugref{5023}).
3041 */
3042 if ((ICR & IMS) && !pThis->fLocked)
3043 {
3044 E1K_INC_ISTAT_CNT(pThis->uStatIntIMS);
3045 e1kPostponeInterrupt(pThis, E1K_IMS_INT_DELAY_NS);
3046 }
3047
3048 return VINF_SUCCESS;
3049}
3050
3051/**
3052 * Write handler for Interrupt Mask Clear register.
3053 *
3054 * Bits corresponding to 1s in 'value' will be cleared in IMS register.
3055 *
3056 * @param pThis The device state structure.
3057 * @param offset Register offset in memory-mapped frame.
3058 * @param index Register index in register array.
3059 * @param value The value to store.
3060 * @param mask Used to implement partial writes (8 and 16-bit).
3061 * @thread EMT
3062 */
3063static int e1kRegWriteIMC(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
3064{
3065 RT_NOREF_PV(offset); RT_NOREF_PV(index);
3066
3067 int rc = e1kCsEnter(pThis, VINF_IOM_R3_MMIO_WRITE);
3068 if (RT_UNLIKELY(rc != VINF_SUCCESS))
3069 return rc;
3070 if (pThis->fIntRaised)
3071 {
3072 /*
3073 * Technically we should reset fIntRaised in ICR read handler, but it will cause
3074 * Windows to freeze since it may receive an interrupt while still in the very beginning
3075 * of interrupt handler.
3076 */
3077 E1K_INC_ISTAT_CNT(pThis->uStatIntLower);
3078 STAM_COUNTER_INC(&pThis->StatIntsPrevented);
3079 E1kLogRel(("E1000: irq lowered (IMC), icr=0x%x\n", ICR));
3080 /* Lower(0) INTA(0) */
3081 PDMDevHlpPCISetIrq(pThis->CTX_SUFF(pDevIns), 0, 0);
3082 pThis->fIntRaised = false;
3083 E1kLog(("%s e1kRegWriteIMC: Lowered IRQ: ICR=%08x\n", pThis->szPrf, ICR));
3084 }
3085 IMS &= ~value;
3086 E1kLog(("%s e1kRegWriteIMC: IRQ disabled\n", pThis->szPrf));
3087 e1kCsLeave(pThis);
3088
3089 return VINF_SUCCESS;
3090}
3091
3092/**
3093 * Write handler for Receive Control register.
3094 *
3095 * @param pThis The device state structure.
3096 * @param offset Register offset in memory-mapped frame.
3097 * @param index Register index in register array.
3098 * @param value The value to store.
3099 * @param mask Used to implement partial writes (8 and 16-bit).
3100 * @thread EMT
3101 */
3102static int e1kRegWriteRCTL(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
3103{
3104 /* Update promiscuous mode */
3105 bool fBecomePromiscous = !!(value & (RCTL_UPE | RCTL_MPE));
3106 if (fBecomePromiscous != !!( RCTL & (RCTL_UPE | RCTL_MPE)))
3107 {
3108 /* Promiscuity has changed, pass the knowledge on. */
3109#ifndef IN_RING3
3110 return VINF_IOM_R3_MMIO_WRITE;
3111#else
3112 if (pThis->pDrvR3)
3113 pThis->pDrvR3->pfnSetPromiscuousMode(pThis->pDrvR3, fBecomePromiscous);
3114#endif
3115 }
3116
3117 /* Adjust receive buffer size */
3118 unsigned cbRxBuf = 2048 >> GET_BITS_V(value, RCTL, BSIZE);
3119 if (value & RCTL_BSEX)
3120 cbRxBuf *= 16;
3121 if (cbRxBuf != pThis->u16RxBSize)
3122 E1kLog2(("%s e1kRegWriteRCTL: Setting receive buffer size to %d (old %d)\n",
3123 pThis->szPrf, cbRxBuf, pThis->u16RxBSize));
3124 pThis->u16RxBSize = cbRxBuf;
3125
3126 /* Update the register */
3127 e1kRegWriteDefault(pThis, offset, index, value);
3128
3129 return VINF_SUCCESS;
3130}
3131
3132/**
3133 * Write handler for Packet Buffer Allocation register.
3134 *
3135 * TXA = 64 - RXA.
3136 *
3137 * @param pThis The device state structure.
3138 * @param offset Register offset in memory-mapped frame.
3139 * @param index Register index in register array.
3140 * @param value The value to store.
3141 * @param mask Used to implement partial writes (8 and 16-bit).
3142 * @thread EMT
3143 */
3144static int e1kRegWritePBA(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
3145{
3146 e1kRegWriteDefault(pThis, offset, index, value);
3147 PBA_st->txa = 64 - PBA_st->rxa;
3148
3149 return VINF_SUCCESS;
3150}
3151
3152/**
3153 * Write handler for Receive Descriptor Tail register.
3154 *
3155 * @remarks Write into RDT forces switch to HC and signal to
3156 * e1kR3NetworkDown_WaitReceiveAvail().
3157 *
3158 * @returns VBox status code.
3159 *
3160 * @param pThis The device state structure.
3161 * @param offset Register offset in memory-mapped frame.
3162 * @param index Register index in register array.
3163 * @param value The value to store.
3164 * @param mask Used to implement partial writes (8 and 16-bit).
3165 * @thread EMT
3166 */
3167static int e1kRegWriteRDT(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
3168{
3169#ifndef IN_RING3
3170 /* XXX */
3171// return VINF_IOM_R3_MMIO_WRITE;
3172#endif
3173 int rc = e1kCsRxEnter(pThis, VINF_IOM_R3_MMIO_WRITE);
3174 if (RT_LIKELY(rc == VINF_SUCCESS))
3175 {
3176 E1kLog(("%s e1kRegWriteRDT\n", pThis->szPrf));
3177 /*
3178 * Some drivers advance RDT too far, so that it equals RDH. This
3179 * somehow manages to work with real hardware but not with this
3180 * emulated device. We can work with these drivers if we just
3181 * write 1 less when we see a driver writing RDT equal to RDH,
3182 * see @bugref{7346}.
3183 */
3184 if (value == RDH)
3185 {
3186 if (RDH == 0)
3187 value = (RDLEN / sizeof(E1KRXDESC)) - 1;
3188 else
3189 value = RDH - 1;
3190 }
3191 rc = e1kRegWriteDefault(pThis, offset, index, value);
3192#ifdef E1K_WITH_RXD_CACHE
3193 /*
3194 * We need to fetch descriptors now as RDT may go whole circle
3195 * before we attempt to store a received packet. For example,
3196 * Intel's DOS drivers use 2 (!) RX descriptors with the total ring
3197 * size being only 8 descriptors! Note that we fetch descriptors
3198 * only when the cache is empty to reduce the number of memory reads
3199 * in case of frequent RDT writes. Don't fetch anything when the
3200 * receiver is disabled either as RDH, RDT, RDLEN can be in some
3201 * messed up state.
3202 * Note that despite the cache may seem empty, meaning that there are
3203 * no more available descriptors in it, it may still be used by RX
3204 * thread which has not yet written the last descriptor back but has
3205 * temporarily released the RX lock in order to write the packet body
3206 * to descriptor's buffer. At this point we still going to do prefetch
3207 * but it won't actually fetch anything if there are no unused slots in
3208 * our "empty" cache (nRxDFetched==E1K_RXD_CACHE_SIZE). We must not
3209 * reset the cache here even if it appears empty. It will be reset at
3210 * a later point in e1kRxDGet().
3211 */
3212 if (e1kRxDIsCacheEmpty(pThis) && (RCTL & RCTL_EN))
3213 e1kRxDPrefetch(pThis);
3214#endif /* E1K_WITH_RXD_CACHE */
3215 e1kCsRxLeave(pThis);
3216 if (RT_SUCCESS(rc))
3217 {
3218/** @todo bird: Use SUPSem* for this so we can signal it in ring-0 as well
3219 * without requiring any context switches. We should also check the
3220 * wait condition before bothering to queue the item as we're currently
3221 * queuing thousands of items per second here in a normal transmit
3222 * scenario. Expect performance changes when fixing this! */
3223#ifdef IN_RING3
3224 /* Signal that we have more receive descriptors available. */
3225 e1kWakeupReceive(pThis->CTX_SUFF(pDevIns));
3226#else
3227 PPDMQUEUEITEMCORE pItem = PDMQueueAlloc(pThis->CTX_SUFF(pCanRxQueue));
3228 if (pItem)
3229 PDMQueueInsert(pThis->CTX_SUFF(pCanRxQueue), pItem);
3230#endif
3231 }
3232 }
3233 return rc;
3234}
3235
3236/**
3237 * Write handler for Receive Delay Timer register.
3238 *
3239 * @param pThis The device state structure.
3240 * @param offset Register offset in memory-mapped frame.
3241 * @param index Register index in register array.
3242 * @param value The value to store.
3243 * @param mask Used to implement partial writes (8 and 16-bit).
3244 * @thread EMT
3245 */
3246static int e1kRegWriteRDTR(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
3247{
3248 e1kRegWriteDefault(pThis, offset, index, value);
3249 if (value & RDTR_FPD)
3250 {
3251 /* Flush requested, cancel both timers and raise interrupt */
3252#ifdef E1K_USE_RX_TIMERS
3253 e1kCancelTimer(pThis, pThis->CTX_SUFF(pRIDTimer));
3254 e1kCancelTimer(pThis, pThis->CTX_SUFF(pRADTimer));
3255#endif
3256 E1K_INC_ISTAT_CNT(pThis->uStatIntRDTR);
3257 return e1kRaiseInterrupt(pThis, VINF_IOM_R3_MMIO_WRITE, ICR_RXT0);
3258 }
3259
3260 return VINF_SUCCESS;
3261}
3262
3263DECLINLINE(uint32_t) e1kGetTxLen(PE1KSTATE pThis)
3264{
3265 /**
3266 * Make sure TDT won't change during computation. EMT may modify TDT at
3267 * any moment.
3268 */
3269 uint32_t tdt = TDT;
3270 return (TDH>tdt ? TDLEN/sizeof(E1KTXDESC) : 0) + tdt - TDH;
3271}
3272
3273#ifdef IN_RING3
3274
3275# ifdef E1K_TX_DELAY
3276/**
3277 * Transmit Delay Timer handler.
3278 *
3279 * @remarks We only get here when the timer expires.
3280 *
3281 * @param pDevIns Pointer to device instance structure.
3282 * @param pTimer Pointer to the timer.
3283 * @param pvUser NULL.
3284 * @thread EMT
3285 */
3286static DECLCALLBACK(void) e1kTxDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
3287{
3288 PE1KSTATE pThis = (PE1KSTATE )pvUser;
3289 Assert(PDMCritSectIsOwner(&pThis->csTx));
3290
3291 E1K_INC_ISTAT_CNT(pThis->uStatTxDelayExp);
3292# ifdef E1K_INT_STATS
3293 uint64_t u64Elapsed = RTTimeNanoTS() - pThis->u64ArmedAt;
3294 if (u64Elapsed > pThis->uStatMaxTxDelay)
3295 pThis->uStatMaxTxDelay = u64Elapsed;
3296# endif
3297 int rc = e1kXmitPending(pThis, false /*fOnWorkerThread*/);
3298 AssertMsg(RT_SUCCESS(rc) || rc == VERR_TRY_AGAIN, ("%Rrc\n", rc));
3299}
3300# endif /* E1K_TX_DELAY */
3301
3302//# ifdef E1K_USE_TX_TIMERS
3303
3304/**
3305 * Transmit Interrupt Delay Timer handler.
3306 *
3307 * @remarks We only get here when the timer expires.
3308 *
3309 * @param pDevIns Pointer to device instance structure.
3310 * @param pTimer Pointer to the timer.
3311 * @param pvUser NULL.
3312 * @thread EMT
3313 */
3314static DECLCALLBACK(void) e1kTxIntDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
3315{
3316 RT_NOREF(pDevIns);
3317 RT_NOREF(pTimer);
3318 PE1KSTATE pThis = (PE1KSTATE )pvUser;
3319
3320 E1K_INC_ISTAT_CNT(pThis->uStatTID);
3321 /* Cancel absolute delay timer as we have already got attention */
3322# ifndef E1K_NO_TAD
3323 e1kCancelTimer(pThis, pThis->CTX_SUFF(pTADTimer));
3324# endif
3325 e1kRaiseInterrupt(pThis, ICR_TXDW);
3326}
3327
3328/**
3329 * Transmit Absolute Delay Timer handler.
3330 *
3331 * @remarks We only get here when the timer expires.
3332 *
3333 * @param pDevIns Pointer to device instance structure.
3334 * @param pTimer Pointer to the timer.
3335 * @param pvUser NULL.
3336 * @thread EMT
3337 */
3338static DECLCALLBACK(void) e1kTxAbsDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
3339{
3340 RT_NOREF(pDevIns);
3341 RT_NOREF(pTimer);
3342 PE1KSTATE pThis = (PE1KSTATE )pvUser;
3343
3344 E1K_INC_ISTAT_CNT(pThis->uStatTAD);
3345 /* Cancel interrupt delay timer as we have already got attention */
3346 e1kCancelTimer(pThis, pThis->CTX_SUFF(pTIDTimer));
3347 e1kRaiseInterrupt(pThis, ICR_TXDW);
3348}
3349
3350//# endif /* E1K_USE_TX_TIMERS */
3351# ifdef E1K_USE_RX_TIMERS
3352
3353/**
3354 * Receive Interrupt Delay Timer handler.
3355 *
3356 * @remarks We only get here when the timer expires.
3357 *
3358 * @param pDevIns Pointer to device instance structure.
3359 * @param pTimer Pointer to the timer.
3360 * @param pvUser NULL.
3361 * @thread EMT
3362 */
3363static DECLCALLBACK(void) e1kRxIntDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
3364{
3365 PE1KSTATE pThis = (PE1KSTATE )pvUser;
3366
3367 E1K_INC_ISTAT_CNT(pThis->uStatRID);
3368 /* Cancel absolute delay timer as we have already got attention */
3369 e1kCancelTimer(pThis, pThis->CTX_SUFF(pRADTimer));
3370 e1kRaiseInterrupt(pThis, ICR_RXT0);
3371}
3372
3373/**
3374 * Receive Absolute Delay Timer handler.
3375 *
3376 * @remarks We only get here when the timer expires.
3377 *
3378 * @param pDevIns Pointer to device instance structure.
3379 * @param pTimer Pointer to the timer.
3380 * @param pvUser NULL.
3381 * @thread EMT
3382 */
3383static DECLCALLBACK(void) e1kRxAbsDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
3384{
3385 PE1KSTATE pThis = (PE1KSTATE )pvUser;
3386
3387 E1K_INC_ISTAT_CNT(pThis->uStatRAD);
3388 /* Cancel interrupt delay timer as we have already got attention */
3389 e1kCancelTimer(pThis, pThis->CTX_SUFF(pRIDTimer));
3390 e1kRaiseInterrupt(pThis, ICR_RXT0);
3391}
3392
3393# endif /* E1K_USE_RX_TIMERS */
3394
3395/**
3396 * Late Interrupt Timer handler.
3397 *
3398 * @param pDevIns Pointer to device instance structure.
3399 * @param pTimer Pointer to the timer.
3400 * @param pvUser NULL.
3401 * @thread EMT
3402 */
3403static DECLCALLBACK(void) e1kLateIntTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
3404{
3405 RT_NOREF(pDevIns, pTimer);
3406 PE1KSTATE pThis = (PE1KSTATE )pvUser;
3407
3408 STAM_PROFILE_ADV_START(&pThis->StatLateIntTimer, a);
3409 STAM_COUNTER_INC(&pThis->StatLateInts);
3410 E1K_INC_ISTAT_CNT(pThis->uStatIntLate);
3411# if 0
3412 if (pThis->iStatIntLost > -100)
3413 pThis->iStatIntLost--;
3414# endif
3415 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, 0);
3416 STAM_PROFILE_ADV_STOP(&pThis->StatLateIntTimer, a);
3417}
3418
3419/**
3420 * Link Up Timer handler.
3421 *
3422 * @param pDevIns Pointer to device instance structure.
3423 * @param pTimer Pointer to the timer.
3424 * @param pvUser NULL.
3425 * @thread EMT
3426 */
3427static DECLCALLBACK(void) e1kLinkUpTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
3428{
3429 RT_NOREF(pDevIns, pTimer);
3430 PE1KSTATE pThis = (PE1KSTATE )pvUser;
3431
3432 /*
3433 * This can happen if we set the link status to down when the Link up timer was
3434 * already armed (shortly after e1kLoadDone() or when the cable was disconnected
3435 * and connect+disconnect the cable very quick. Moreover, 82543GC triggers LSC
3436 * on reset even if the cable is unplugged (see @bugref{8942}).
3437 */
3438 if (pThis->fCableConnected)
3439 {
3440 /* 82543GC does not have an internal PHY */
3441 if (pThis->eChip == E1K_CHIP_82543GC || (CTRL & CTRL_SLU))
3442 e1kR3LinkUp(pThis);
3443 }
3444#ifdef E1K_LSC_ON_RESET
3445 else if (pThis->eChip == E1K_CHIP_82543GC)
3446 e1kR3LinkDown(pThis);
3447#endif /* E1K_LSC_ON_RESET */
3448}
3449
3450#endif /* IN_RING3 */
3451
3452/**
3453 * Sets up the GSO context according to the TSE new context descriptor.
3454 *
3455 * @param pGso The GSO context to setup.
3456 * @param pCtx The context descriptor.
3457 */
3458DECLINLINE(void) e1kSetupGsoCtx(PPDMNETWORKGSO pGso, E1KTXCTX const *pCtx)
3459{
3460 pGso->u8Type = PDMNETWORKGSOTYPE_INVALID;
3461
3462 /*
3463 * See if the context descriptor describes something that could be TCP or
3464 * UDP over IPv[46].
3465 */
3466 /* Check the header ordering and spacing: 1. Ethernet, 2. IP, 3. TCP/UDP. */
3467 if (RT_UNLIKELY( pCtx->ip.u8CSS < sizeof(RTNETETHERHDR) ))
3468 {
3469 E1kLog(("e1kSetupGsoCtx: IPCSS=%#x\n", pCtx->ip.u8CSS));
3470 return;
3471 }
3472 if (RT_UNLIKELY( pCtx->tu.u8CSS < (size_t)pCtx->ip.u8CSS + (pCtx->dw2.fIP ? RTNETIPV4_MIN_LEN : RTNETIPV6_MIN_LEN) ))
3473 {
3474 E1kLog(("e1kSetupGsoCtx: TUCSS=%#x\n", pCtx->tu.u8CSS));
3475 return;
3476 }
3477 if (RT_UNLIKELY( pCtx->dw2.fTCP
3478 ? pCtx->dw3.u8HDRLEN < (size_t)pCtx->tu.u8CSS + RTNETTCP_MIN_LEN
3479 : pCtx->dw3.u8HDRLEN != (size_t)pCtx->tu.u8CSS + RTNETUDP_MIN_LEN ))
3480 {
3481 E1kLog(("e1kSetupGsoCtx: HDRLEN=%#x TCP=%d\n", pCtx->dw3.u8HDRLEN, pCtx->dw2.fTCP));
3482 return;
3483 }
3484
3485 /* The end of the TCP/UDP checksum should stop at the end of the packet or at least after the headers. */
3486 if (RT_UNLIKELY( pCtx->tu.u16CSE > 0 && pCtx->tu.u16CSE <= pCtx->dw3.u8HDRLEN ))
3487 {
3488 E1kLog(("e1kSetupGsoCtx: TUCSE=%#x HDRLEN=%#x\n", pCtx->tu.u16CSE, pCtx->dw3.u8HDRLEN));
3489 return;
3490 }
3491
3492 /* IPv4 checksum offset. */
3493 if (RT_UNLIKELY( pCtx->dw2.fIP && (size_t)pCtx->ip.u8CSO - pCtx->ip.u8CSS != RT_UOFFSETOF(RTNETIPV4, ip_sum) ))
3494 {
3495 E1kLog(("e1kSetupGsoCtx: IPCSO=%#x IPCSS=%#x\n", pCtx->ip.u8CSO, pCtx->ip.u8CSS));
3496 return;
3497 }
3498
3499 /* TCP/UDP checksum offsets. */
3500 if (RT_UNLIKELY( (size_t)pCtx->tu.u8CSO - pCtx->tu.u8CSS
3501 != ( pCtx->dw2.fTCP
3502 ? RT_UOFFSETOF(RTNETTCP, th_sum)
3503 : RT_UOFFSETOF(RTNETUDP, uh_sum) ) ))
3504 {
3505 E1kLog(("e1kSetupGsoCtx: TUCSO=%#x TUCSS=%#x TCP=%d\n", pCtx->ip.u8CSO, pCtx->ip.u8CSS, pCtx->dw2.fTCP));
3506 return;
3507 }
3508
3509 /*
3510 * Because of internal networking using a 16-bit size field for GSO context
3511 * plus frame, we have to make sure we don't exceed this.
3512 */
3513 if (RT_UNLIKELY( pCtx->dw3.u8HDRLEN + pCtx->dw2.u20PAYLEN > VBOX_MAX_GSO_SIZE ))
3514 {
3515 E1kLog(("e1kSetupGsoCtx: HDRLEN(=%#x) + PAYLEN(=%#x) = %#x, max is %#x\n",
3516 pCtx->dw3.u8HDRLEN, pCtx->dw2.u20PAYLEN, pCtx->dw3.u8HDRLEN + pCtx->dw2.u20PAYLEN, VBOX_MAX_GSO_SIZE));
3517 return;
3518 }
3519
3520 /*
3521 * We're good for now - we'll do more checks when seeing the data.
3522 * So, figure the type of offloading and setup the context.
3523 */
3524 if (pCtx->dw2.fIP)
3525 {
3526 if (pCtx->dw2.fTCP)
3527 {
3528 pGso->u8Type = PDMNETWORKGSOTYPE_IPV4_TCP;
3529 pGso->cbHdrsSeg = pCtx->dw3.u8HDRLEN;
3530 }
3531 else
3532 {
3533 pGso->u8Type = PDMNETWORKGSOTYPE_IPV4_UDP;
3534 pGso->cbHdrsSeg = pCtx->tu.u8CSS; /* IP header only */
3535 }
3536 /** @todo Detect IPv4-IPv6 tunneling (need test setup since linux doesn't do
3537 * this yet it seems)... */
3538 }
3539 else
3540 {
3541 pGso->cbHdrsSeg = pCtx->dw3.u8HDRLEN; /** @todo IPv6 UFO */
3542 if (pCtx->dw2.fTCP)
3543 pGso->u8Type = PDMNETWORKGSOTYPE_IPV6_TCP;
3544 else
3545 pGso->u8Type = PDMNETWORKGSOTYPE_IPV6_UDP;
3546 }
3547 pGso->offHdr1 = pCtx->ip.u8CSS;
3548 pGso->offHdr2 = pCtx->tu.u8CSS;
3549 pGso->cbHdrsTotal = pCtx->dw3.u8HDRLEN;
3550 pGso->cbMaxSeg = pCtx->dw3.u16MSS;
3551 Assert(PDMNetGsoIsValid(pGso, sizeof(*pGso), pGso->cbMaxSeg * 5));
3552 E1kLog2(("e1kSetupGsoCtx: mss=%#x hdr=%#x hdrseg=%#x hdr1=%#x hdr2=%#x %s\n",
3553 pGso->cbMaxSeg, pGso->cbHdrsTotal, pGso->cbHdrsSeg, pGso->offHdr1, pGso->offHdr2, PDMNetGsoTypeName((PDMNETWORKGSOTYPE)pGso->u8Type) ));
3554}
3555
3556/**
3557 * Checks if we can use GSO processing for the current TSE frame.
3558 *
3559 * @param pThis The device state structure.
3560 * @param pGso The GSO context.
3561 * @param pData The first data descriptor of the frame.
3562 * @param pCtx The TSO context descriptor.
3563 */
3564DECLINLINE(bool) e1kCanDoGso(PE1KSTATE pThis, PCPDMNETWORKGSO pGso, E1KTXDAT const *pData, E1KTXCTX const *pCtx)
3565{
3566 if (!pData->cmd.fTSE)
3567 {
3568 E1kLog2(("e1kCanDoGso: !TSE\n"));
3569 return false;
3570 }
3571 if (pData->cmd.fVLE) /** @todo VLAN tagging. */
3572 {
3573 E1kLog(("e1kCanDoGso: VLE\n"));
3574 return false;
3575 }
3576 if (RT_UNLIKELY(!pThis->fGSOEnabled))
3577 {
3578 E1kLog3(("e1kCanDoGso: GSO disabled via CFGM\n"));
3579 return false;
3580 }
3581
3582 switch ((PDMNETWORKGSOTYPE)pGso->u8Type)
3583 {
3584 case PDMNETWORKGSOTYPE_IPV4_TCP:
3585 case PDMNETWORKGSOTYPE_IPV4_UDP:
3586 if (!pData->dw3.fIXSM)
3587 {
3588 E1kLog(("e1kCanDoGso: !IXSM (IPv4)\n"));
3589 return false;
3590 }
3591 if (!pData->dw3.fTXSM)
3592 {
3593 E1kLog(("e1kCanDoGso: !TXSM (IPv4)\n"));
3594 return false;
3595 }
3596 /** @todo what more check should we perform here? Ethernet frame type? */
3597 E1kLog2(("e1kCanDoGso: OK, IPv4\n"));
3598 return true;
3599
3600 case PDMNETWORKGSOTYPE_IPV6_TCP:
3601 case PDMNETWORKGSOTYPE_IPV6_UDP:
3602 if (pData->dw3.fIXSM && pCtx->ip.u8CSO)
3603 {
3604 E1kLog(("e1kCanDoGso: IXSM (IPv6)\n"));
3605 return false;
3606 }
3607 if (!pData->dw3.fTXSM)
3608 {
3609 E1kLog(("e1kCanDoGso: TXSM (IPv6)\n"));
3610 return false;
3611 }
3612 /** @todo what more check should we perform here? Ethernet frame type? */
3613 E1kLog2(("e1kCanDoGso: OK, IPv4\n"));
3614 return true;
3615
3616 default:
3617 Assert(pGso->u8Type == PDMNETWORKGSOTYPE_INVALID);
3618 E1kLog2(("e1kCanDoGso: e1kSetupGsoCtx failed\n"));
3619 return false;
3620 }
3621}
3622
3623/**
3624 * Frees the current xmit buffer.
3625 *
3626 * @param pThis The device state structure.
3627 */
3628static void e1kXmitFreeBuf(PE1KSTATE pThis)
3629{
3630 PPDMSCATTERGATHER pSg = pThis->CTX_SUFF(pTxSg);
3631 if (pSg)
3632 {
3633 pThis->CTX_SUFF(pTxSg) = NULL;
3634
3635 if (pSg->pvAllocator != pThis)
3636 {
3637 PPDMINETWORKUP pDrv = pThis->CTX_SUFF(pDrv);
3638 if (pDrv)
3639 pDrv->pfnFreeBuf(pDrv, pSg);
3640 }
3641 else
3642 {
3643 /* loopback */
3644 AssertCompileMemberSize(E1KSTATE, uTxFallback.Sg, 8 * sizeof(size_t));
3645 Assert(pSg->fFlags == (PDMSCATTERGATHER_FLAGS_MAGIC | PDMSCATTERGATHER_FLAGS_OWNER_3));
3646 pSg->fFlags = 0;
3647 pSg->pvAllocator = NULL;
3648 }
3649 }
3650}
3651
3652#ifndef E1K_WITH_TXD_CACHE
3653/**
3654 * Allocates an xmit buffer.
3655 *
3656 * @returns See PDMINETWORKUP::pfnAllocBuf.
3657 * @param pThis The device state structure.
3658 * @param cbMin The minimum frame size.
3659 * @param fExactSize Whether cbMin is exact or if we have to max it
3660 * out to the max MTU size.
3661 * @param fGso Whether this is a GSO frame or not.
3662 */
3663DECLINLINE(int) e1kXmitAllocBuf(PE1KSTATE pThis, size_t cbMin, bool fExactSize, bool fGso)
3664{
3665 /* Adjust cbMin if necessary. */
3666 if (!fExactSize)
3667 cbMin = RT_MAX(cbMin, E1K_MAX_TX_PKT_SIZE);
3668
3669 /* Deal with existing buffer (descriptor screw up, reset, etc). */
3670 if (RT_UNLIKELY(pThis->CTX_SUFF(pTxSg)))
3671 e1kXmitFreeBuf(pThis);
3672 Assert(pThis->CTX_SUFF(pTxSg) == NULL);
3673
3674 /*
3675 * Allocate the buffer.
3676 */
3677 PPDMSCATTERGATHER pSg;
3678 if (RT_LIKELY(GET_BITS(RCTL, LBM) != RCTL_LBM_TCVR))
3679 {
3680 PPDMINETWORKUP pDrv = pThis->CTX_SUFF(pDrv);
3681 if (RT_UNLIKELY(!pDrv))
3682 return VERR_NET_DOWN;
3683 int rc = pDrv->pfnAllocBuf(pDrv, cbMin, fGso ? &pThis->GsoCtx : NULL, &pSg);
3684 if (RT_FAILURE(rc))
3685 {
3686 /* Suspend TX as we are out of buffers atm */
3687 STATUS |= STATUS_TXOFF;
3688 return rc;
3689 }
3690 }
3691 else
3692 {
3693 /* Create a loopback using the fallback buffer and preallocated SG. */
3694 AssertCompileMemberSize(E1KSTATE, uTxFallback.Sg, 8 * sizeof(size_t));
3695 pSg = &pThis->uTxFallback.Sg;
3696 pSg->fFlags = PDMSCATTERGATHER_FLAGS_MAGIC | PDMSCATTERGATHER_FLAGS_OWNER_3;
3697 pSg->cbUsed = 0;
3698 pSg->cbAvailable = 0;
3699 pSg->pvAllocator = pThis;
3700 pSg->pvUser = NULL; /* No GSO here. */
3701 pSg->cSegs = 1;
3702 pSg->aSegs[0].pvSeg = pThis->aTxPacketFallback;
3703 pSg->aSegs[0].cbSeg = sizeof(pThis->aTxPacketFallback);
3704 }
3705
3706 pThis->CTX_SUFF(pTxSg) = pSg;
3707 return VINF_SUCCESS;
3708}
3709#else /* E1K_WITH_TXD_CACHE */
3710/**
3711 * Allocates an xmit buffer.
3712 *
3713 * @returns See PDMINETWORKUP::pfnAllocBuf.
3714 * @param pThis The device state structure.
3715 * @param cbMin The minimum frame size.
3716 * @param fExactSize Whether cbMin is exact or if we have to max it
3717 * out to the max MTU size.
3718 * @param fGso Whether this is a GSO frame or not.
3719 */
3720DECLINLINE(int) e1kXmitAllocBuf(PE1KSTATE pThis, bool fGso)
3721{
3722 /* Deal with existing buffer (descriptor screw up, reset, etc). */
3723 if (RT_UNLIKELY(pThis->CTX_SUFF(pTxSg)))
3724 e1kXmitFreeBuf(pThis);
3725 Assert(pThis->CTX_SUFF(pTxSg) == NULL);
3726
3727 /*
3728 * Allocate the buffer.
3729 */
3730 PPDMSCATTERGATHER pSg;
3731 if (RT_LIKELY(GET_BITS(RCTL, LBM) != RCTL_LBM_TCVR))
3732 {
3733 if (pThis->cbTxAlloc == 0)
3734 {
3735 /* Zero packet, no need for the buffer */
3736 return VINF_SUCCESS;
3737 }
3738
3739 PPDMINETWORKUP pDrv = pThis->CTX_SUFF(pDrv);
3740 if (RT_UNLIKELY(!pDrv))
3741 return VERR_NET_DOWN;
3742 int rc = pDrv->pfnAllocBuf(pDrv, pThis->cbTxAlloc, fGso ? &pThis->GsoCtx : NULL, &pSg);
3743 if (RT_FAILURE(rc))
3744 {
3745 /* Suspend TX as we are out of buffers atm */
3746 STATUS |= STATUS_TXOFF;
3747 return rc;
3748 }
3749 E1kLog3(("%s Allocated buffer for TX packet: cb=%u %s%s\n",
3750 pThis->szPrf, pThis->cbTxAlloc,
3751 pThis->fVTag ? "VLAN " : "",
3752 pThis->fGSO ? "GSO " : ""));
3753 }
3754 else
3755 {
3756 /* Create a loopback using the fallback buffer and preallocated SG. */
3757 AssertCompileMemberSize(E1KSTATE, uTxFallback.Sg, 8 * sizeof(size_t));
3758 pSg = &pThis->uTxFallback.Sg;
3759 pSg->fFlags = PDMSCATTERGATHER_FLAGS_MAGIC | PDMSCATTERGATHER_FLAGS_OWNER_3;
3760 pSg->cbUsed = 0;
3761 pSg->cbAvailable = 0;
3762 pSg->pvAllocator = pThis;
3763 pSg->pvUser = NULL; /* No GSO here. */
3764 pSg->cSegs = 1;
3765 pSg->aSegs[0].pvSeg = pThis->aTxPacketFallback;
3766 pSg->aSegs[0].cbSeg = sizeof(pThis->aTxPacketFallback);
3767 }
3768 pThis->cbTxAlloc = 0;
3769
3770 pThis->CTX_SUFF(pTxSg) = pSg;
3771 return VINF_SUCCESS;
3772}
3773#endif /* E1K_WITH_TXD_CACHE */
3774
3775/**
3776 * Checks if it's a GSO buffer or not.
3777 *
3778 * @returns true / false.
3779 * @param pTxSg The scatter / gather buffer.
3780 */
3781DECLINLINE(bool) e1kXmitIsGsoBuf(PDMSCATTERGATHER const *pTxSg)
3782{
3783#if 0
3784 if (!pTxSg)
3785 E1kLog(("e1kXmitIsGsoBuf: pTxSG is NULL\n"));
3786 if (pTxSg && pTxSg->pvUser)
3787 E1kLog(("e1kXmitIsGsoBuf: pvUser is NULL\n"));
3788#endif
3789 return pTxSg && pTxSg->pvUser /* GSO indicator */;
3790}
3791
3792#ifndef E1K_WITH_TXD_CACHE
3793/**
3794 * Load transmit descriptor from guest memory.
3795 *
3796 * @param pThis The device state structure.
3797 * @param pDesc Pointer to descriptor union.
3798 * @param addr Physical address in guest context.
3799 * @thread E1000_TX
3800 */
3801DECLINLINE(void) e1kLoadDesc(PE1KSTATE pThis, E1KTXDESC *pDesc, RTGCPHYS addr)
3802{
3803 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), addr, pDesc, sizeof(E1KTXDESC));
3804}
3805#else /* E1K_WITH_TXD_CACHE */
3806/**
3807 * Load transmit descriptors from guest memory.
3808 *
3809 * We need two physical reads in case the tail wrapped around the end of TX
3810 * descriptor ring.
3811 *
3812 * @returns the actual number of descriptors fetched.
3813 * @param pThis The device state structure.
3814 * @param pDesc Pointer to descriptor union.
3815 * @param addr Physical address in guest context.
3816 * @thread E1000_TX
3817 */
3818DECLINLINE(unsigned) e1kTxDLoadMore(PE1KSTATE pThis)
3819{
3820 Assert(pThis->iTxDCurrent == 0);
3821 /* We've already loaded pThis->nTxDFetched descriptors past TDH. */
3822 unsigned nDescsAvailable = e1kGetTxLen(pThis) - pThis->nTxDFetched;
3823 unsigned nDescsToFetch = RT_MIN(nDescsAvailable, E1K_TXD_CACHE_SIZE - pThis->nTxDFetched);
3824 unsigned nDescsTotal = TDLEN / sizeof(E1KTXDESC);
3825 unsigned nFirstNotLoaded = (TDH + pThis->nTxDFetched) % nDescsTotal;
3826 unsigned nDescsInSingleRead = RT_MIN(nDescsToFetch, nDescsTotal - nFirstNotLoaded);
3827 E1kLog3(("%s e1kTxDLoadMore: nDescsAvailable=%u nDescsToFetch=%u "
3828 "nDescsTotal=%u nFirstNotLoaded=0x%x nDescsInSingleRead=%u\n",
3829 pThis->szPrf, nDescsAvailable, nDescsToFetch, nDescsTotal,
3830 nFirstNotLoaded, nDescsInSingleRead));
3831 if (nDescsToFetch == 0)
3832 return 0;
3833 E1KTXDESC* pFirstEmptyDesc = &pThis->aTxDescriptors[pThis->nTxDFetched];
3834 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns),
3835 ((uint64_t)TDBAH << 32) + TDBAL + nFirstNotLoaded * sizeof(E1KTXDESC),
3836 pFirstEmptyDesc, nDescsInSingleRead * sizeof(E1KTXDESC));
3837 E1kLog3(("%s Fetched %u TX descriptors at %08x%08x(0x%x), TDLEN=%08x, TDH=%08x, TDT=%08x\n",
3838 pThis->szPrf, nDescsInSingleRead,
3839 TDBAH, TDBAL + TDH * sizeof(E1KTXDESC),
3840 nFirstNotLoaded, TDLEN, TDH, TDT));
3841 if (nDescsToFetch > nDescsInSingleRead)
3842 {
3843 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns),
3844 ((uint64_t)TDBAH << 32) + TDBAL,
3845 pFirstEmptyDesc + nDescsInSingleRead,
3846 (nDescsToFetch - nDescsInSingleRead) * sizeof(E1KTXDESC));
3847 E1kLog3(("%s Fetched %u TX descriptors at %08x%08x\n",
3848 pThis->szPrf, nDescsToFetch - nDescsInSingleRead,
3849 TDBAH, TDBAL));
3850 }
3851 pThis->nTxDFetched += nDescsToFetch;
3852 return nDescsToFetch;
3853}
3854
3855/**
3856 * Load transmit descriptors from guest memory only if there are no loaded
3857 * descriptors.
3858 *
3859 * @returns true if there are descriptors in cache.
3860 * @param pThis The device state structure.
3861 * @param pDesc Pointer to descriptor union.
3862 * @param addr Physical address in guest context.
3863 * @thread E1000_TX
3864 */
3865DECLINLINE(bool) e1kTxDLazyLoad(PE1KSTATE pThis)
3866{
3867 if (pThis->nTxDFetched == 0)
3868 return e1kTxDLoadMore(pThis) != 0;
3869 return true;
3870}
3871#endif /* E1K_WITH_TXD_CACHE */
3872
3873/**
3874 * Write back transmit descriptor to guest memory.
3875 *
3876 * @param pThis The device state structure.
3877 * @param pDesc Pointer to descriptor union.
3878 * @param addr Physical address in guest context.
3879 * @thread E1000_TX
3880 */
3881DECLINLINE(void) e1kWriteBackDesc(PE1KSTATE pThis, E1KTXDESC *pDesc, RTGCPHYS addr)
3882{
3883 /* Only the last half of the descriptor has to be written back. */
3884 e1kPrintTDesc(pThis, pDesc, "^^^");
3885 PDMDevHlpPCIPhysWrite(pThis->CTX_SUFF(pDevIns), addr, pDesc, sizeof(E1KTXDESC));
3886}
3887
3888/**
3889 * Transmit complete frame.
3890 *
3891 * @remarks We skip the FCS since we're not responsible for sending anything to
3892 * a real ethernet wire.
3893 *
3894 * @param pThis The device state structure.
3895 * @param fOnWorkerThread Whether we're on a worker thread or an EMT.
3896 * @thread E1000_TX
3897 */
3898static void e1kTransmitFrame(PE1KSTATE pThis, bool fOnWorkerThread)
3899{
3900 PPDMSCATTERGATHER pSg = pThis->CTX_SUFF(pTxSg);
3901 uint32_t cbFrame = pSg ? (uint32_t)pSg->cbUsed : 0;
3902 Assert(!pSg || pSg->cSegs == 1);
3903
3904 if (cbFrame > 70) /* unqualified guess */
3905 pThis->led.Asserted.s.fWriting = pThis->led.Actual.s.fWriting = 1;
3906
3907#ifdef E1K_INT_STATS
3908 if (cbFrame <= 1514)
3909 E1K_INC_ISTAT_CNT(pThis->uStatTx1514);
3910 else if (cbFrame <= 2962)
3911 E1K_INC_ISTAT_CNT(pThis->uStatTx2962);
3912 else if (cbFrame <= 4410)
3913 E1K_INC_ISTAT_CNT(pThis->uStatTx4410);
3914 else if (cbFrame <= 5858)
3915 E1K_INC_ISTAT_CNT(pThis->uStatTx5858);
3916 else if (cbFrame <= 7306)
3917 E1K_INC_ISTAT_CNT(pThis->uStatTx7306);
3918 else if (cbFrame <= 8754)
3919 E1K_INC_ISTAT_CNT(pThis->uStatTx8754);
3920 else if (cbFrame <= 16384)
3921 E1K_INC_ISTAT_CNT(pThis->uStatTx16384);
3922 else if (cbFrame <= 32768)
3923 E1K_INC_ISTAT_CNT(pThis->uStatTx32768);
3924 else
3925 E1K_INC_ISTAT_CNT(pThis->uStatTxLarge);
3926#endif /* E1K_INT_STATS */
3927
3928 /* Add VLAN tag */
3929 if (cbFrame > 12 && pThis->fVTag)
3930 {
3931 E1kLog3(("%s Inserting VLAN tag %08x\n",
3932 pThis->szPrf, RT_BE2H_U16(VET) | (RT_BE2H_U16(pThis->u16VTagTCI) << 16)));
3933 memmove((uint8_t*)pSg->aSegs[0].pvSeg + 16, (uint8_t*)pSg->aSegs[0].pvSeg + 12, cbFrame - 12);
3934 *((uint32_t*)pSg->aSegs[0].pvSeg + 3) = RT_BE2H_U16(VET) | (RT_BE2H_U16(pThis->u16VTagTCI) << 16);
3935 pSg->cbUsed += 4;
3936 cbFrame += 4;
3937 Assert(pSg->cbUsed == cbFrame);
3938 Assert(pSg->cbUsed <= pSg->cbAvailable);
3939 }
3940/* E1kLog2(("%s < < < Outgoing packet. Dump follows: > > >\n"
3941 "%.*Rhxd\n"
3942 "%s < < < < < < < < < < < < < End of dump > > > > > > > > > > > >\n",
3943 pThis->szPrf, cbFrame, pSg->aSegs[0].pvSeg, pThis->szPrf));*/
3944
3945 /* Update the stats */
3946 E1K_INC_CNT32(TPT);
3947 E1K_ADD_CNT64(TOTL, TOTH, cbFrame);
3948 E1K_INC_CNT32(GPTC);
3949 if (pSg && e1kIsBroadcast(pSg->aSegs[0].pvSeg))
3950 E1K_INC_CNT32(BPTC);
3951 else if (pSg && e1kIsMulticast(pSg->aSegs[0].pvSeg))
3952 E1K_INC_CNT32(MPTC);
3953 /* Update octet transmit counter */
3954 E1K_ADD_CNT64(GOTCL, GOTCH, cbFrame);
3955 if (pThis->CTX_SUFF(pDrv))
3956 STAM_REL_COUNTER_ADD(&pThis->StatTransmitBytes, cbFrame);
3957 if (cbFrame == 64)
3958 E1K_INC_CNT32(PTC64);
3959 else if (cbFrame < 128)
3960 E1K_INC_CNT32(PTC127);
3961 else if (cbFrame < 256)
3962 E1K_INC_CNT32(PTC255);
3963 else if (cbFrame < 512)
3964 E1K_INC_CNT32(PTC511);
3965 else if (cbFrame < 1024)
3966 E1K_INC_CNT32(PTC1023);
3967 else
3968 E1K_INC_CNT32(PTC1522);
3969
3970 E1K_INC_ISTAT_CNT(pThis->uStatTxFrm);
3971
3972 /*
3973 * Dump and send the packet.
3974 */
3975 int rc = VERR_NET_DOWN;
3976 if (pSg && pSg->pvAllocator != pThis)
3977 {
3978 e1kPacketDump(pThis, (uint8_t const *)pSg->aSegs[0].pvSeg, cbFrame, "--> Outgoing");
3979
3980 pThis->CTX_SUFF(pTxSg) = NULL;
3981 PPDMINETWORKUP pDrv = pThis->CTX_SUFF(pDrv);
3982 if (pDrv)
3983 {
3984 /* Release critical section to avoid deadlock in CanReceive */
3985 //e1kCsLeave(pThis);
3986 STAM_PROFILE_START(&pThis->CTX_SUFF_Z(StatTransmitSend), a);
3987 rc = pDrv->pfnSendBuf(pDrv, pSg, fOnWorkerThread);
3988 STAM_PROFILE_STOP(&pThis->CTX_SUFF_Z(StatTransmitSend), a);
3989 //e1kCsEnter(pThis, RT_SRC_POS);
3990 }
3991 }
3992 else if (pSg)
3993 {
3994 Assert(pSg->aSegs[0].pvSeg == pThis->aTxPacketFallback);
3995 e1kPacketDump(pThis, (uint8_t const *)pSg->aSegs[0].pvSeg, cbFrame, "--> Loopback");
3996
3997 /** @todo do we actually need to check that we're in loopback mode here? */
3998 if (GET_BITS(RCTL, LBM) == RCTL_LBM_TCVR)
3999 {
4000 E1KRXDST status;
4001 RT_ZERO(status);
4002 status.fPIF = true;
4003 e1kHandleRxPacket(pThis, pSg->aSegs[0].pvSeg, cbFrame, status);
4004 rc = VINF_SUCCESS;
4005 }
4006 e1kXmitFreeBuf(pThis);
4007 }
4008 else
4009 rc = VERR_NET_DOWN;
4010 if (RT_FAILURE(rc))
4011 {
4012 E1kLogRel(("E1000: ERROR! pfnSend returned %Rrc\n", rc));
4013 /** @todo handle VERR_NET_DOWN and VERR_NET_NO_BUFFER_SPACE. Signal error ? */
4014 }
4015
4016 pThis->led.Actual.s.fWriting = 0;
4017}
4018
4019/**
4020 * Compute and write internet checksum (e1kCSum16) at the specified offset.
4021 *
4022 * @param pThis The device state structure.
4023 * @param pPkt Pointer to the packet.
4024 * @param u16PktLen Total length of the packet.
4025 * @param cso Offset in packet to write checksum at.
4026 * @param css Offset in packet to start computing
4027 * checksum from.
4028 * @param cse Offset in packet to stop computing
4029 * checksum at.
4030 * @thread E1000_TX
4031 */
4032static void e1kInsertChecksum(PE1KSTATE pThis, uint8_t *pPkt, uint16_t u16PktLen, uint8_t cso, uint8_t css, uint16_t cse)
4033{
4034 RT_NOREF1(pThis);
4035
4036 if (css >= u16PktLen)
4037 {
4038 E1kLog2(("%s css(%X) is greater than packet length-1(%X), checksum is not inserted\n",
4039 pThis->szPrf, cso, u16PktLen));
4040 return;
4041 }
4042
4043 if (cso >= u16PktLen - 1)
4044 {
4045 E1kLog2(("%s cso(%X) is greater than packet length-2(%X), checksum is not inserted\n",
4046 pThis->szPrf, cso, u16PktLen));
4047 return;
4048 }
4049
4050 if (cse == 0)
4051 cse = u16PktLen - 1;
4052 else if (cse < css)
4053 {
4054 E1kLog2(("%s css(%X) is greater than cse(%X), checksum is not inserted\n",
4055 pThis->szPrf, css, cse));
4056 return;
4057 }
4058
4059 uint16_t u16ChkSum = e1kCSum16(pPkt + css, cse - css + 1);
4060 E1kLog2(("%s Inserting csum: %04X at %02X, old value: %04X\n", pThis->szPrf,
4061 u16ChkSum, cso, *(uint16_t*)(pPkt + cso)));
4062 *(uint16_t*)(pPkt + cso) = u16ChkSum;
4063}
4064
4065/**
4066 * Add a part of descriptor's buffer to transmit frame.
4067 *
4068 * @remarks data.u64BufAddr is used unconditionally for both data
4069 * and legacy descriptors since it is identical to
4070 * legacy.u64BufAddr.
4071 *
4072 * @param pThis The device state structure.
4073 * @param pDesc Pointer to the descriptor to transmit.
4074 * @param u16Len Length of buffer to the end of segment.
4075 * @param fSend Force packet sending.
4076 * @param fOnWorkerThread Whether we're on a worker thread or an EMT.
4077 * @thread E1000_TX
4078 */
4079#ifndef E1K_WITH_TXD_CACHE
4080static void e1kFallbackAddSegment(PE1KSTATE pThis, RTGCPHYS PhysAddr, uint16_t u16Len, bool fSend, bool fOnWorkerThread)
4081{
4082 /* TCP header being transmitted */
4083 struct E1kTcpHeader *pTcpHdr = (struct E1kTcpHeader *)
4084 (pThis->aTxPacketFallback + pThis->contextTSE.tu.u8CSS);
4085 /* IP header being transmitted */
4086 struct E1kIpHeader *pIpHdr = (struct E1kIpHeader *)
4087 (pThis->aTxPacketFallback + pThis->contextTSE.ip.u8CSS);
4088
4089 E1kLog3(("%s e1kFallbackAddSegment: Length=%x, remaining payload=%x, header=%x, send=%RTbool\n",
4090 pThis->szPrf, u16Len, pThis->u32PayRemain, pThis->u16HdrRemain, fSend));
4091 Assert(pThis->u32PayRemain + pThis->u16HdrRemain > 0);
4092
4093 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), PhysAddr,
4094 pThis->aTxPacketFallback + pThis->u16TxPktLen, u16Len);
4095 E1kLog3(("%s Dump of the segment:\n"
4096 "%.*Rhxd\n"
4097 "%s --- End of dump ---\n",
4098 pThis->szPrf, u16Len, pThis->aTxPacketFallback + pThis->u16TxPktLen, pThis->szPrf));
4099 pThis->u16TxPktLen += u16Len;
4100 E1kLog3(("%s e1kFallbackAddSegment: pThis->u16TxPktLen=%x\n",
4101 pThis->szPrf, pThis->u16TxPktLen));
4102 if (pThis->u16HdrRemain > 0)
4103 {
4104 /* The header was not complete, check if it is now */
4105 if (u16Len >= pThis->u16HdrRemain)
4106 {
4107 /* The rest is payload */
4108 u16Len -= pThis->u16HdrRemain;
4109 pThis->u16HdrRemain = 0;
4110 /* Save partial checksum and flags */
4111 pThis->u32SavedCsum = pTcpHdr->chksum;
4112 pThis->u16SavedFlags = pTcpHdr->hdrlen_flags;
4113 /* Clear FIN and PSH flags now and set them only in the last segment */
4114 pTcpHdr->hdrlen_flags &= ~htons(E1K_TCP_FIN | E1K_TCP_PSH);
4115 }
4116 else
4117 {
4118 /* Still not */
4119 pThis->u16HdrRemain -= u16Len;
4120 E1kLog3(("%s e1kFallbackAddSegment: Header is still incomplete, 0x%x bytes remain.\n",
4121 pThis->szPrf, pThis->u16HdrRemain));
4122 return;
4123 }
4124 }
4125
4126 pThis->u32PayRemain -= u16Len;
4127
4128 if (fSend)
4129 {
4130 /* Leave ethernet header intact */
4131 /* IP Total Length = payload + headers - ethernet header */
4132 pIpHdr->total_len = htons(pThis->u16TxPktLen - pThis->contextTSE.ip.u8CSS);
4133 E1kLog3(("%s e1kFallbackAddSegment: End of packet, pIpHdr->total_len=%x\n",
4134 pThis->szPrf, ntohs(pIpHdr->total_len)));
4135 /* Update IP Checksum */
4136 pIpHdr->chksum = 0;
4137 e1kInsertChecksum(pThis, pThis->aTxPacketFallback, pThis->u16TxPktLen,
4138 pThis->contextTSE.ip.u8CSO,
4139 pThis->contextTSE.ip.u8CSS,
4140 pThis->contextTSE.ip.u16CSE);
4141
4142 /* Update TCP flags */
4143 /* Restore original FIN and PSH flags for the last segment */
4144 if (pThis->u32PayRemain == 0)
4145 {
4146 pTcpHdr->hdrlen_flags = pThis->u16SavedFlags;
4147 E1K_INC_CNT32(TSCTC);
4148 }
4149 /* Add TCP length to partial pseudo header sum */
4150 uint32_t csum = pThis->u32SavedCsum
4151 + htons(pThis->u16TxPktLen - pThis->contextTSE.tu.u8CSS);
4152 while (csum >> 16)
4153 csum = (csum >> 16) + (csum & 0xFFFF);
4154 pTcpHdr->chksum = csum;
4155 /* Compute final checksum */
4156 e1kInsertChecksum(pThis, pThis->aTxPacketFallback, pThis->u16TxPktLen,
4157 pThis->contextTSE.tu.u8CSO,
4158 pThis->contextTSE.tu.u8CSS,
4159 pThis->contextTSE.tu.u16CSE);
4160
4161 /*
4162 * Transmit it. If we've use the SG already, allocate a new one before
4163 * we copy of the data.
4164 */
4165 if (!pThis->CTX_SUFF(pTxSg))
4166 e1kXmitAllocBuf(pThis, pThis->u16TxPktLen + (pThis->fVTag ? 4 : 0), true /*fExactSize*/, false /*fGso*/);
4167 if (pThis->CTX_SUFF(pTxSg))
4168 {
4169 Assert(pThis->u16TxPktLen <= pThis->CTX_SUFF(pTxSg)->cbAvailable);
4170 Assert(pThis->CTX_SUFF(pTxSg)->cSegs == 1);
4171 if (pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg != pThis->aTxPacketFallback)
4172 memcpy(pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg, pThis->aTxPacketFallback, pThis->u16TxPktLen);
4173 pThis->CTX_SUFF(pTxSg)->cbUsed = pThis->u16TxPktLen;
4174 pThis->CTX_SUFF(pTxSg)->aSegs[0].cbSeg = pThis->u16TxPktLen;
4175 }
4176 e1kTransmitFrame(pThis, fOnWorkerThread);
4177
4178 /* Update Sequence Number */
4179 pTcpHdr->seqno = htonl(ntohl(pTcpHdr->seqno) + pThis->u16TxPktLen
4180 - pThis->contextTSE.dw3.u8HDRLEN);
4181 /* Increment IP identification */
4182 pIpHdr->ident = htons(ntohs(pIpHdr->ident) + 1);
4183 }
4184}
4185#else /* E1K_WITH_TXD_CACHE */
4186static int e1kFallbackAddSegment(PE1KSTATE pThis, RTGCPHYS PhysAddr, uint16_t u16Len, bool fSend, bool fOnWorkerThread)
4187{
4188 int rc = VINF_SUCCESS;
4189 /* TCP header being transmitted */
4190 struct E1kTcpHeader *pTcpHdr = (struct E1kTcpHeader *)
4191 (pThis->aTxPacketFallback + pThis->contextTSE.tu.u8CSS);
4192 /* IP header being transmitted */
4193 struct E1kIpHeader *pIpHdr = (struct E1kIpHeader *)
4194 (pThis->aTxPacketFallback + pThis->contextTSE.ip.u8CSS);
4195
4196 E1kLog3(("%s e1kFallbackAddSegment: Length=%x, remaining payload=%x, header=%x, send=%RTbool\n",
4197 pThis->szPrf, u16Len, pThis->u32PayRemain, pThis->u16HdrRemain, fSend));
4198 Assert(pThis->u32PayRemain + pThis->u16HdrRemain > 0);
4199
4200 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), PhysAddr,
4201 pThis->aTxPacketFallback + pThis->u16TxPktLen, u16Len);
4202 E1kLog3(("%s Dump of the segment:\n"
4203 "%.*Rhxd\n"
4204 "%s --- End of dump ---\n",
4205 pThis->szPrf, u16Len, pThis->aTxPacketFallback + pThis->u16TxPktLen, pThis->szPrf));
4206 pThis->u16TxPktLen += u16Len;
4207 E1kLog3(("%s e1kFallbackAddSegment: pThis->u16TxPktLen=%x\n",
4208 pThis->szPrf, pThis->u16TxPktLen));
4209 if (pThis->u16HdrRemain > 0)
4210 {
4211 /* The header was not complete, check if it is now */
4212 if (u16Len >= pThis->u16HdrRemain)
4213 {
4214 /* The rest is payload */
4215 u16Len -= pThis->u16HdrRemain;
4216 pThis->u16HdrRemain = 0;
4217 /* Save partial checksum and flags */
4218 pThis->u32SavedCsum = pTcpHdr->chksum;
4219 pThis->u16SavedFlags = pTcpHdr->hdrlen_flags;
4220 /* Clear FIN and PSH flags now and set them only in the last segment */
4221 pTcpHdr->hdrlen_flags &= ~htons(E1K_TCP_FIN | E1K_TCP_PSH);
4222 }
4223 else
4224 {
4225 /* Still not */
4226 pThis->u16HdrRemain -= u16Len;
4227 E1kLog3(("%s e1kFallbackAddSegment: Header is still incomplete, 0x%x bytes remain.\n",
4228 pThis->szPrf, pThis->u16HdrRemain));
4229 return rc;
4230 }
4231 }
4232
4233 pThis->u32PayRemain -= u16Len;
4234
4235 if (fSend)
4236 {
4237 /* Leave ethernet header intact */
4238 /* IP Total Length = payload + headers - ethernet header */
4239 pIpHdr->total_len = htons(pThis->u16TxPktLen - pThis->contextTSE.ip.u8CSS);
4240 E1kLog3(("%s e1kFallbackAddSegment: End of packet, pIpHdr->total_len=%x\n",
4241 pThis->szPrf, ntohs(pIpHdr->total_len)));
4242 /* Update IP Checksum */
4243 pIpHdr->chksum = 0;
4244 e1kInsertChecksum(pThis, pThis->aTxPacketFallback, pThis->u16TxPktLen,
4245 pThis->contextTSE.ip.u8CSO,
4246 pThis->contextTSE.ip.u8CSS,
4247 pThis->contextTSE.ip.u16CSE);
4248
4249 /* Update TCP flags */
4250 /* Restore original FIN and PSH flags for the last segment */
4251 if (pThis->u32PayRemain == 0)
4252 {
4253 pTcpHdr->hdrlen_flags = pThis->u16SavedFlags;
4254 E1K_INC_CNT32(TSCTC);
4255 }
4256 /* Add TCP length to partial pseudo header sum */
4257 uint32_t csum = pThis->u32SavedCsum
4258 + htons(pThis->u16TxPktLen - pThis->contextTSE.tu.u8CSS);
4259 while (csum >> 16)
4260 csum = (csum >> 16) + (csum & 0xFFFF);
4261 pTcpHdr->chksum = csum;
4262 /* Compute final checksum */
4263 e1kInsertChecksum(pThis, pThis->aTxPacketFallback, pThis->u16TxPktLen,
4264 pThis->contextTSE.tu.u8CSO,
4265 pThis->contextTSE.tu.u8CSS,
4266 pThis->contextTSE.tu.u16CSE);
4267
4268 /*
4269 * Transmit it.
4270 */
4271 if (pThis->CTX_SUFF(pTxSg))
4272 {
4273 Assert(pThis->u16TxPktLen <= pThis->CTX_SUFF(pTxSg)->cbAvailable);
4274 Assert(pThis->CTX_SUFF(pTxSg)->cSegs == 1);
4275 if (pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg != pThis->aTxPacketFallback)
4276 memcpy(pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg, pThis->aTxPacketFallback, pThis->u16TxPktLen);
4277 pThis->CTX_SUFF(pTxSg)->cbUsed = pThis->u16TxPktLen;
4278 pThis->CTX_SUFF(pTxSg)->aSegs[0].cbSeg = pThis->u16TxPktLen;
4279 }
4280 e1kTransmitFrame(pThis, fOnWorkerThread);
4281
4282 /* Update Sequence Number */
4283 pTcpHdr->seqno = htonl(ntohl(pTcpHdr->seqno) + pThis->u16TxPktLen
4284 - pThis->contextTSE.dw3.u8HDRLEN);
4285 /* Increment IP identification */
4286 pIpHdr->ident = htons(ntohs(pIpHdr->ident) + 1);
4287
4288 /* Allocate new buffer for the next segment. */
4289 if (pThis->u32PayRemain)
4290 {
4291 pThis->cbTxAlloc = RT_MIN(pThis->u32PayRemain,
4292 pThis->contextTSE.dw3.u16MSS)
4293 + pThis->contextTSE.dw3.u8HDRLEN
4294 + (pThis->fVTag ? 4 : 0);
4295 rc = e1kXmitAllocBuf(pThis, false /* fGSO */);
4296 }
4297 }
4298
4299 return rc;
4300}
4301#endif /* E1K_WITH_TXD_CACHE */
4302
4303#ifndef E1K_WITH_TXD_CACHE
4304/**
4305 * TCP segmentation offloading fallback: Add descriptor's buffer to transmit
4306 * frame.
4307 *
4308 * We construct the frame in the fallback buffer first and the copy it to the SG
4309 * buffer before passing it down to the network driver code.
4310 *
4311 * @returns true if the frame should be transmitted, false if not.
4312 *
4313 * @param pThis The device state structure.
4314 * @param pDesc Pointer to the descriptor to transmit.
4315 * @param cbFragment Length of descriptor's buffer.
4316 * @param fOnWorkerThread Whether we're on a worker thread or an EMT.
4317 * @thread E1000_TX
4318 */
4319static bool e1kFallbackAddToFrame(PE1KSTATE pThis, E1KTXDESC *pDesc, uint32_t cbFragment, bool fOnWorkerThread)
4320{
4321 PPDMSCATTERGATHER pTxSg = pThis->CTX_SUFF(pTxSg);
4322 Assert(e1kGetDescType(pDesc) == E1K_DTYP_DATA);
4323 Assert(pDesc->data.cmd.fTSE);
4324 Assert(!e1kXmitIsGsoBuf(pTxSg));
4325
4326 uint16_t u16MaxPktLen = pThis->contextTSE.dw3.u8HDRLEN + pThis->contextTSE.dw3.u16MSS;
4327 Assert(u16MaxPktLen != 0);
4328 Assert(u16MaxPktLen < E1K_MAX_TX_PKT_SIZE);
4329
4330 /*
4331 * Carve out segments.
4332 */
4333 do
4334 {
4335 /* Calculate how many bytes we have left in this TCP segment */
4336 uint32_t cb = u16MaxPktLen - pThis->u16TxPktLen;
4337 if (cb > cbFragment)
4338 {
4339 /* This descriptor fits completely into current segment */
4340 cb = cbFragment;
4341 e1kFallbackAddSegment(pThis, pDesc->data.u64BufAddr, cb, pDesc->data.cmd.fEOP /*fSend*/, fOnWorkerThread);
4342 }
4343 else
4344 {
4345 e1kFallbackAddSegment(pThis, pDesc->data.u64BufAddr, cb, true /*fSend*/, fOnWorkerThread);
4346 /*
4347 * Rewind the packet tail pointer to the beginning of payload,
4348 * so we continue writing right beyond the header.
4349 */
4350 pThis->u16TxPktLen = pThis->contextTSE.dw3.u8HDRLEN;
4351 }
4352
4353 pDesc->data.u64BufAddr += cb;
4354 cbFragment -= cb;
4355 } while (cbFragment > 0);
4356
4357 if (pDesc->data.cmd.fEOP)
4358 {
4359 /* End of packet, next segment will contain header. */
4360 if (pThis->u32PayRemain != 0)
4361 E1K_INC_CNT32(TSCTFC);
4362 pThis->u16TxPktLen = 0;
4363 e1kXmitFreeBuf(pThis);
4364 }
4365
4366 return false;
4367}
4368#else /* E1K_WITH_TXD_CACHE */
4369/**
4370 * TCP segmentation offloading fallback: Add descriptor's buffer to transmit
4371 * frame.
4372 *
4373 * We construct the frame in the fallback buffer first and the copy it to the SG
4374 * buffer before passing it down to the network driver code.
4375 *
4376 * @returns error code
4377 *
4378 * @param pThis The device state structure.
4379 * @param pDesc Pointer to the descriptor to transmit.
4380 * @param cbFragment Length of descriptor's buffer.
4381 * @param fOnWorkerThread Whether we're on a worker thread or an EMT.
4382 * @thread E1000_TX
4383 */
4384static int e1kFallbackAddToFrame(PE1KSTATE pThis, E1KTXDESC *pDesc, bool fOnWorkerThread)
4385{
4386#ifdef VBOX_STRICT
4387 PPDMSCATTERGATHER pTxSg = pThis->CTX_SUFF(pTxSg);
4388 Assert(e1kGetDescType(pDesc) == E1K_DTYP_DATA);
4389 Assert(pDesc->data.cmd.fTSE);
4390 Assert(!e1kXmitIsGsoBuf(pTxSg));
4391#endif
4392
4393 uint16_t u16MaxPktLen = pThis->contextTSE.dw3.u8HDRLEN + pThis->contextTSE.dw3.u16MSS;
4394
4395 /*
4396 * Carve out segments.
4397 */
4398 int rc = VINF_SUCCESS;
4399 do
4400 {
4401 /* Calculate how many bytes we have left in this TCP segment */
4402 uint32_t cb = u16MaxPktLen - pThis->u16TxPktLen;
4403 if (cb > pDesc->data.cmd.u20DTALEN)
4404 {
4405 /* This descriptor fits completely into current segment */
4406 cb = pDesc->data.cmd.u20DTALEN;
4407 rc = e1kFallbackAddSegment(pThis, pDesc->data.u64BufAddr, cb, pDesc->data.cmd.fEOP /*fSend*/, fOnWorkerThread);
4408 }
4409 else
4410 {
4411 rc = e1kFallbackAddSegment(pThis, pDesc->data.u64BufAddr, cb, true /*fSend*/, fOnWorkerThread);
4412 /*
4413 * Rewind the packet tail pointer to the beginning of payload,
4414 * so we continue writing right beyond the header.
4415 */
4416 pThis->u16TxPktLen = pThis->contextTSE.dw3.u8HDRLEN;
4417 }
4418
4419 pDesc->data.u64BufAddr += cb;
4420 pDesc->data.cmd.u20DTALEN -= cb;
4421 } while (pDesc->data.cmd.u20DTALEN > 0 && RT_SUCCESS(rc));
4422
4423 if (pDesc->data.cmd.fEOP)
4424 {
4425 /* End of packet, next segment will contain header. */
4426 if (pThis->u32PayRemain != 0)
4427 E1K_INC_CNT32(TSCTFC);
4428 pThis->u16TxPktLen = 0;
4429 e1kXmitFreeBuf(pThis);
4430 }
4431
4432 return VINF_SUCCESS; /// @todo consider rc;
4433}
4434#endif /* E1K_WITH_TXD_CACHE */
4435
4436
4437/**
4438 * Add descriptor's buffer to transmit frame.
4439 *
4440 * This deals with GSO and normal frames, e1kFallbackAddToFrame deals with the
4441 * TSE frames we cannot handle as GSO.
4442 *
4443 * @returns true on success, false on failure.
4444 *
4445 * @param pThis The device state structure.
4446 * @param PhysAddr The physical address of the descriptor buffer.
4447 * @param cbFragment Length of descriptor's buffer.
4448 * @thread E1000_TX
4449 */
4450static bool e1kAddToFrame(PE1KSTATE pThis, RTGCPHYS PhysAddr, uint32_t cbFragment)
4451{
4452 PPDMSCATTERGATHER pTxSg = pThis->CTX_SUFF(pTxSg);
4453 bool const fGso = e1kXmitIsGsoBuf(pTxSg);
4454 uint32_t const cbNewPkt = cbFragment + pThis->u16TxPktLen;
4455
4456 if (RT_UNLIKELY( !fGso && cbNewPkt > E1K_MAX_TX_PKT_SIZE ))
4457 {
4458 E1kLog(("%s Transmit packet is too large: %u > %u(max)\n", pThis->szPrf, cbNewPkt, E1K_MAX_TX_PKT_SIZE));
4459 return false;
4460 }
4461 if (RT_UNLIKELY( fGso && cbNewPkt > pTxSg->cbAvailable ))
4462 {
4463 E1kLog(("%s Transmit packet is too large: %u > %u(max)/GSO\n", pThis->szPrf, cbNewPkt, pTxSg->cbAvailable));
4464 return false;
4465 }
4466
4467 if (RT_LIKELY(pTxSg))
4468 {
4469 Assert(pTxSg->cSegs == 1);
4470 Assert(pTxSg->cbUsed == pThis->u16TxPktLen);
4471
4472 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), PhysAddr,
4473 (uint8_t *)pTxSg->aSegs[0].pvSeg + pThis->u16TxPktLen, cbFragment);
4474
4475 pTxSg->cbUsed = cbNewPkt;
4476 }
4477 pThis->u16TxPktLen = cbNewPkt;
4478
4479 return true;
4480}
4481
4482
4483/**
4484 * Write the descriptor back to guest memory and notify the guest.
4485 *
4486 * @param pThis The device state structure.
4487 * @param pDesc Pointer to the descriptor have been transmitted.
4488 * @param addr Physical address of the descriptor in guest memory.
4489 * @thread E1000_TX
4490 */
4491static void e1kDescReport(PE1KSTATE pThis, E1KTXDESC *pDesc, RTGCPHYS addr)
4492{
4493 /*
4494 * We fake descriptor write-back bursting. Descriptors are written back as they are
4495 * processed.
4496 */
4497 /* Let's pretend we process descriptors. Write back with DD set. */
4498 /*
4499 * Prior to r71586 we tried to accomodate the case when write-back bursts
4500 * are enabled without actually implementing bursting by writing back all
4501 * descriptors, even the ones that do not have RS set. This caused kernel
4502 * panics with Linux SMP kernels, as the e1000 driver tried to free up skb
4503 * associated with written back descriptor if it happened to be a context
4504 * descriptor since context descriptors do not have skb associated to them.
4505 * Starting from r71586 we write back only the descriptors with RS set,
4506 * which is a little bit different from what the real hardware does in
4507 * case there is a chain of data descritors where some of them have RS set
4508 * and others do not. It is very uncommon scenario imho.
4509 * We need to check RPS as well since some legacy drivers use it instead of
4510 * RS even with newer cards.
4511 */
4512 if (pDesc->legacy.cmd.fRS || pDesc->legacy.cmd.fRPS)
4513 {
4514 pDesc->legacy.dw3.fDD = 1; /* Descriptor Done */
4515 e1kWriteBackDesc(pThis, pDesc, addr);
4516 if (pDesc->legacy.cmd.fEOP)
4517 {
4518//#ifdef E1K_USE_TX_TIMERS
4519 if (pThis->fTidEnabled && pDesc->legacy.cmd.fIDE)
4520 {
4521 E1K_INC_ISTAT_CNT(pThis->uStatTxIDE);
4522 //if (pThis->fIntRaised)
4523 //{
4524 // /* Interrupt is already pending, no need for timers */
4525 // ICR |= ICR_TXDW;
4526 //}
4527 //else {
4528 /* Arm the timer to fire in TIVD usec (discard .024) */
4529 e1kArmTimer(pThis, pThis->CTX_SUFF(pTIDTimer), TIDV);
4530# ifndef E1K_NO_TAD
4531 /* If absolute timer delay is enabled and the timer is not running yet, arm it. */
4532 E1kLog2(("%s Checking if TAD timer is running\n",
4533 pThis->szPrf));
4534 if (TADV != 0 && !TMTimerIsActive(pThis->CTX_SUFF(pTADTimer)))
4535 e1kArmTimer(pThis, pThis->CTX_SUFF(pTADTimer), TADV);
4536# endif /* E1K_NO_TAD */
4537 }
4538 else
4539 {
4540 if (pThis->fTidEnabled)
4541 {
4542 E1kLog2(("%s No IDE set, cancel TAD timer and raise interrupt\n",
4543 pThis->szPrf));
4544 /* Cancel both timers if armed and fire immediately. */
4545# ifndef E1K_NO_TAD
4546 TMTimerStop(pThis->CTX_SUFF(pTADTimer));
4547# endif
4548 TMTimerStop(pThis->CTX_SUFF(pTIDTimer));
4549 }
4550//#endif /* E1K_USE_TX_TIMERS */
4551 E1K_INC_ISTAT_CNT(pThis->uStatIntTx);
4552 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_TXDW);
4553//#ifdef E1K_USE_TX_TIMERS
4554 }
4555//#endif /* E1K_USE_TX_TIMERS */
4556 }
4557 }
4558 else
4559 {
4560 E1K_INC_ISTAT_CNT(pThis->uStatTxNoRS);
4561 }
4562}
4563
4564#ifndef E1K_WITH_TXD_CACHE
4565
4566/**
4567 * Process Transmit Descriptor.
4568 *
4569 * E1000 supports three types of transmit descriptors:
4570 * - legacy data descriptors of older format (context-less).
4571 * - data the same as legacy but providing new offloading capabilities.
4572 * - context sets up the context for following data descriptors.
4573 *
4574 * @param pThis The device state structure.
4575 * @param pDesc Pointer to descriptor union.
4576 * @param addr Physical address of descriptor in guest memory.
4577 * @param fOnWorkerThread Whether we're on a worker thread or an EMT.
4578 * @thread E1000_TX
4579 */
4580static int e1kXmitDesc(PE1KSTATE pThis, E1KTXDESC *pDesc, RTGCPHYS addr, bool fOnWorkerThread)
4581{
4582 int rc = VINF_SUCCESS;
4583 uint32_t cbVTag = 0;
4584
4585 e1kPrintTDesc(pThis, pDesc, "vvv");
4586
4587//#ifdef E1K_USE_TX_TIMERS
4588 if (pThis->fTidEnabled)
4589 e1kCancelTimer(pThis, pThis->CTX_SUFF(pTIDTimer));
4590//#endif /* E1K_USE_TX_TIMERS */
4591
4592 switch (e1kGetDescType(pDesc))
4593 {
4594 case E1K_DTYP_CONTEXT:
4595 if (pDesc->context.dw2.fTSE)
4596 {
4597 pThis->contextTSE = pDesc->context;
4598 pThis->u32PayRemain = pDesc->context.dw2.u20PAYLEN;
4599 pThis->u16HdrRemain = pDesc->context.dw3.u8HDRLEN;
4600 e1kSetupGsoCtx(&pThis->GsoCtx, &pDesc->context);
4601 STAM_COUNTER_INC(&pThis->StatTxDescCtxTSE);
4602 }
4603 else
4604 {
4605 pThis->contextNormal = pDesc->context;
4606 STAM_COUNTER_INC(&pThis->StatTxDescCtxNormal);
4607 }
4608 E1kLog2(("%s %s context updated: IP CSS=%02X, IP CSO=%02X, IP CSE=%04X"
4609 ", TU CSS=%02X, TU CSO=%02X, TU CSE=%04X\n", pThis->szPrf,
4610 pDesc->context.dw2.fTSE ? "TSE" : "Normal",
4611 pDesc->context.ip.u8CSS,
4612 pDesc->context.ip.u8CSO,
4613 pDesc->context.ip.u16CSE,
4614 pDesc->context.tu.u8CSS,
4615 pDesc->context.tu.u8CSO,
4616 pDesc->context.tu.u16CSE));
4617 E1K_INC_ISTAT_CNT(pThis->uStatDescCtx);
4618 e1kDescReport(pThis, pDesc, addr);
4619 break;
4620
4621 case E1K_DTYP_DATA:
4622 {
4623 if (pDesc->data.cmd.u20DTALEN == 0 || pDesc->data.u64BufAddr == 0)
4624 {
4625 E1kLog2(("% Empty data descriptor, skipped.\n", pThis->szPrf));
4626 /** @todo Same as legacy when !TSE. See below. */
4627 break;
4628 }
4629 STAM_COUNTER_INC(pDesc->data.cmd.fTSE?
4630 &pThis->StatTxDescTSEData:
4631 &pThis->StatTxDescData);
4632 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatTransmit), a);
4633 E1K_INC_ISTAT_CNT(pThis->uStatDescDat);
4634
4635 /*
4636 * The last descriptor of non-TSE packet must contain VLE flag.
4637 * TSE packets have VLE flag in the first descriptor. The later
4638 * case is taken care of a bit later when cbVTag gets assigned.
4639 *
4640 * 1) pDesc->data.cmd.fEOP && !pDesc->data.cmd.fTSE
4641 */
4642 if (pDesc->data.cmd.fEOP && !pDesc->data.cmd.fTSE)
4643 {
4644 pThis->fVTag = pDesc->data.cmd.fVLE;
4645 pThis->u16VTagTCI = pDesc->data.dw3.u16Special;
4646 }
4647 /*
4648 * First fragment: Allocate new buffer and save the IXSM and TXSM
4649 * packet options as these are only valid in the first fragment.
4650 */
4651 if (pThis->u16TxPktLen == 0)
4652 {
4653 pThis->fIPcsum = pDesc->data.dw3.fIXSM;
4654 pThis->fTCPcsum = pDesc->data.dw3.fTXSM;
4655 E1kLog2(("%s Saving checksum flags:%s%s; \n", pThis->szPrf,
4656 pThis->fIPcsum ? " IP" : "",
4657 pThis->fTCPcsum ? " TCP/UDP" : ""));
4658 if (pDesc->data.cmd.fTSE)
4659 {
4660 /* 2) pDesc->data.cmd.fTSE && pThis->u16TxPktLen == 0 */
4661 pThis->fVTag = pDesc->data.cmd.fVLE;
4662 pThis->u16VTagTCI = pDesc->data.dw3.u16Special;
4663 cbVTag = pThis->fVTag ? 4 : 0;
4664 }
4665 else if (pDesc->data.cmd.fEOP)
4666 cbVTag = pDesc->data.cmd.fVLE ? 4 : 0;
4667 else
4668 cbVTag = 4;
4669 E1kLog3(("%s About to allocate TX buffer: cbVTag=%u\n", pThis->szPrf, cbVTag));
4670 if (e1kCanDoGso(pThis, &pThis->GsoCtx, &pDesc->data, &pThis->contextTSE))
4671 rc = e1kXmitAllocBuf(pThis, pThis->contextTSE.dw2.u20PAYLEN + pThis->contextTSE.dw3.u8HDRLEN + cbVTag,
4672 true /*fExactSize*/, true /*fGso*/);
4673 else if (pDesc->data.cmd.fTSE)
4674 rc = e1kXmitAllocBuf(pThis, pThis->contextTSE.dw3.u16MSS + pThis->contextTSE.dw3.u8HDRLEN + cbVTag,
4675 pDesc->data.cmd.fTSE /*fExactSize*/, false /*fGso*/);
4676 else
4677 rc = e1kXmitAllocBuf(pThis, pDesc->data.cmd.u20DTALEN + cbVTag,
4678 pDesc->data.cmd.fEOP /*fExactSize*/, false /*fGso*/);
4679
4680 /**
4681 * @todo: Perhaps it is not that simple for GSO packets! We may
4682 * need to unwind some changes.
4683 */
4684 if (RT_FAILURE(rc))
4685 {
4686 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
4687 break;
4688 }
4689 /** @todo Is there any way to indicating errors other than collisions? Like
4690 * VERR_NET_DOWN. */
4691 }
4692
4693 /*
4694 * Add the descriptor data to the frame. If the frame is complete,
4695 * transmit it and reset the u16TxPktLen field.
4696 */
4697 if (e1kXmitIsGsoBuf(pThis->CTX_SUFF(pTxSg)))
4698 {
4699 STAM_COUNTER_INC(&pThis->StatTxPathGSO);
4700 bool fRc = e1kAddToFrame(pThis, pDesc->data.u64BufAddr, pDesc->data.cmd.u20DTALEN);
4701 if (pDesc->data.cmd.fEOP)
4702 {
4703 if ( fRc
4704 && pThis->CTX_SUFF(pTxSg)
4705 && pThis->CTX_SUFF(pTxSg)->cbUsed == (size_t)pThis->contextTSE.dw3.u8HDRLEN + pThis->contextTSE.dw2.u20PAYLEN)
4706 {
4707 e1kTransmitFrame(pThis, fOnWorkerThread);
4708 E1K_INC_CNT32(TSCTC);
4709 }
4710 else
4711 {
4712 if (fRc)
4713 E1kLog(("%s bad GSO/TSE %p or %u < %u\n" , pThis->szPrf,
4714 pThis->CTX_SUFF(pTxSg), pThis->CTX_SUFF(pTxSg) ? pThis->CTX_SUFF(pTxSg)->cbUsed : 0,
4715 pThis->contextTSE.dw3.u8HDRLEN + pThis->contextTSE.dw2.u20PAYLEN));
4716 e1kXmitFreeBuf(pThis);
4717 E1K_INC_CNT32(TSCTFC);
4718 }
4719 pThis->u16TxPktLen = 0;
4720 }
4721 }
4722 else if (!pDesc->data.cmd.fTSE)
4723 {
4724 STAM_COUNTER_INC(&pThis->StatTxPathRegular);
4725 bool fRc = e1kAddToFrame(pThis, pDesc->data.u64BufAddr, pDesc->data.cmd.u20DTALEN);
4726 if (pDesc->data.cmd.fEOP)
4727 {
4728 if (fRc && pThis->CTX_SUFF(pTxSg))
4729 {
4730 Assert(pThis->CTX_SUFF(pTxSg)->cSegs == 1);
4731 if (pThis->fIPcsum)
4732 e1kInsertChecksum(pThis, (uint8_t *)pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg, pThis->u16TxPktLen,
4733 pThis->contextNormal.ip.u8CSO,
4734 pThis->contextNormal.ip.u8CSS,
4735 pThis->contextNormal.ip.u16CSE);
4736 if (pThis->fTCPcsum)
4737 e1kInsertChecksum(pThis, (uint8_t *)pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg, pThis->u16TxPktLen,
4738 pThis->contextNormal.tu.u8CSO,
4739 pThis->contextNormal.tu.u8CSS,
4740 pThis->contextNormal.tu.u16CSE);
4741 e1kTransmitFrame(pThis, fOnWorkerThread);
4742 }
4743 else
4744 e1kXmitFreeBuf(pThis);
4745 pThis->u16TxPktLen = 0;
4746 }
4747 }
4748 else
4749 {
4750 STAM_COUNTER_INC(&pThis->StatTxPathFallback);
4751 e1kFallbackAddToFrame(pThis, pDesc, pDesc->data.cmd.u20DTALEN, fOnWorkerThread);
4752 }
4753
4754 e1kDescReport(pThis, pDesc, addr);
4755 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
4756 break;
4757 }
4758
4759 case E1K_DTYP_LEGACY:
4760 if (pDesc->legacy.cmd.u16Length == 0 || pDesc->legacy.u64BufAddr == 0)
4761 {
4762 E1kLog(("%s Empty legacy descriptor, skipped.\n", pThis->szPrf));
4763 /** @todo 3.3.3, Length/Buffer Address: RS set -> write DD when processing. */
4764 break;
4765 }
4766 STAM_COUNTER_INC(&pThis->StatTxDescLegacy);
4767 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatTransmit), a);
4768
4769 /* First fragment: allocate new buffer. */
4770 if (pThis->u16TxPktLen == 0)
4771 {
4772 if (pDesc->legacy.cmd.fEOP)
4773 cbVTag = pDesc->legacy.cmd.fVLE ? 4 : 0;
4774 else
4775 cbVTag = 4;
4776 E1kLog3(("%s About to allocate TX buffer: cbVTag=%u\n", pThis->szPrf, cbVTag));
4777 /** @todo reset status bits? */
4778 rc = e1kXmitAllocBuf(pThis, pDesc->legacy.cmd.u16Length + cbVTag, pDesc->legacy.cmd.fEOP, false /*fGso*/);
4779 if (RT_FAILURE(rc))
4780 {
4781 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
4782 break;
4783 }
4784
4785 /** @todo Is there any way to indicating errors other than collisions? Like
4786 * VERR_NET_DOWN. */
4787 }
4788
4789 /* Add fragment to frame. */
4790 if (e1kAddToFrame(pThis, pDesc->data.u64BufAddr, pDesc->legacy.cmd.u16Length))
4791 {
4792 E1K_INC_ISTAT_CNT(pThis->uStatDescLeg);
4793
4794 /* Last fragment: Transmit and reset the packet storage counter. */
4795 if (pDesc->legacy.cmd.fEOP)
4796 {
4797 pThis->fVTag = pDesc->legacy.cmd.fVLE;
4798 pThis->u16VTagTCI = pDesc->legacy.dw3.u16Special;
4799 /** @todo Offload processing goes here. */
4800 e1kTransmitFrame(pThis, fOnWorkerThread);
4801 pThis->u16TxPktLen = 0;
4802 }
4803 }
4804 /* Last fragment + failure: free the buffer and reset the storage counter. */
4805 else if (pDesc->legacy.cmd.fEOP)
4806 {
4807 e1kXmitFreeBuf(pThis);
4808 pThis->u16TxPktLen = 0;
4809 }
4810
4811 e1kDescReport(pThis, pDesc, addr);
4812 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
4813 break;
4814
4815 default:
4816 E1kLog(("%s ERROR Unsupported transmit descriptor type: 0x%04x\n",
4817 pThis->szPrf, e1kGetDescType(pDesc)));
4818 break;
4819 }
4820
4821 return rc;
4822}
4823
4824#else /* E1K_WITH_TXD_CACHE */
4825
4826/**
4827 * Process Transmit Descriptor.
4828 *
4829 * E1000 supports three types of transmit descriptors:
4830 * - legacy data descriptors of older format (context-less).
4831 * - data the same as legacy but providing new offloading capabilities.
4832 * - context sets up the context for following data descriptors.
4833 *
4834 * @param pThis The device state structure.
4835 * @param pDesc Pointer to descriptor union.
4836 * @param addr Physical address of descriptor in guest memory.
4837 * @param fOnWorkerThread Whether we're on a worker thread or an EMT.
4838 * @param cbPacketSize Size of the packet as previously computed.
4839 * @thread E1000_TX
4840 */
4841static int e1kXmitDesc(PE1KSTATE pThis, E1KTXDESC *pDesc, RTGCPHYS addr,
4842 bool fOnWorkerThread)
4843{
4844 int rc = VINF_SUCCESS;
4845
4846 e1kPrintTDesc(pThis, pDesc, "vvv");
4847
4848//#ifdef E1K_USE_TX_TIMERS
4849 if (pThis->fTidEnabled)
4850 TMTimerStop(pThis->CTX_SUFF(pTIDTimer));
4851//#endif /* E1K_USE_TX_TIMERS */
4852
4853 switch (e1kGetDescType(pDesc))
4854 {
4855 case E1K_DTYP_CONTEXT:
4856 /* The caller have already updated the context */
4857 E1K_INC_ISTAT_CNT(pThis->uStatDescCtx);
4858 e1kDescReport(pThis, pDesc, addr);
4859 break;
4860
4861 case E1K_DTYP_DATA:
4862 {
4863 STAM_COUNTER_INC(pDesc->data.cmd.fTSE?
4864 &pThis->StatTxDescTSEData:
4865 &pThis->StatTxDescData);
4866 E1K_INC_ISTAT_CNT(pThis->uStatDescDat);
4867 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatTransmit), a);
4868 if (pDesc->data.cmd.u20DTALEN == 0 || pDesc->data.u64BufAddr == 0)
4869 {
4870 E1kLog2(("% Empty data descriptor, skipped.\n", pThis->szPrf));
4871 }
4872 else
4873 {
4874 /*
4875 * Add the descriptor data to the frame. If the frame is complete,
4876 * transmit it and reset the u16TxPktLen field.
4877 */
4878 if (e1kXmitIsGsoBuf(pThis->CTX_SUFF(pTxSg)))
4879 {
4880 STAM_COUNTER_INC(&pThis->StatTxPathGSO);
4881 bool fRc = e1kAddToFrame(pThis, pDesc->data.u64BufAddr, pDesc->data.cmd.u20DTALEN);
4882 if (pDesc->data.cmd.fEOP)
4883 {
4884 if ( fRc
4885 && pThis->CTX_SUFF(pTxSg)
4886 && pThis->CTX_SUFF(pTxSg)->cbUsed == (size_t)pThis->contextTSE.dw3.u8HDRLEN + pThis->contextTSE.dw2.u20PAYLEN)
4887 {
4888 e1kTransmitFrame(pThis, fOnWorkerThread);
4889 E1K_INC_CNT32(TSCTC);
4890 }
4891 else
4892 {
4893 if (fRc)
4894 E1kLog(("%s bad GSO/TSE %p or %u < %u\n" , pThis->szPrf,
4895 pThis->CTX_SUFF(pTxSg), pThis->CTX_SUFF(pTxSg) ? pThis->CTX_SUFF(pTxSg)->cbUsed : 0,
4896 pThis->contextTSE.dw3.u8HDRLEN + pThis->contextTSE.dw2.u20PAYLEN));
4897 e1kXmitFreeBuf(pThis);
4898 E1K_INC_CNT32(TSCTFC);
4899 }
4900 pThis->u16TxPktLen = 0;
4901 }
4902 }
4903 else if (!pDesc->data.cmd.fTSE)
4904 {
4905 STAM_COUNTER_INC(&pThis->StatTxPathRegular);
4906 bool fRc = e1kAddToFrame(pThis, pDesc->data.u64BufAddr, pDesc->data.cmd.u20DTALEN);
4907 if (pDesc->data.cmd.fEOP)
4908 {
4909 if (fRc && pThis->CTX_SUFF(pTxSg))
4910 {
4911 Assert(pThis->CTX_SUFF(pTxSg)->cSegs == 1);
4912 if (pThis->fIPcsum)
4913 e1kInsertChecksum(pThis, (uint8_t *)pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg, pThis->u16TxPktLen,
4914 pThis->contextNormal.ip.u8CSO,
4915 pThis->contextNormal.ip.u8CSS,
4916 pThis->contextNormal.ip.u16CSE);
4917 if (pThis->fTCPcsum)
4918 e1kInsertChecksum(pThis, (uint8_t *)pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg, pThis->u16TxPktLen,
4919 pThis->contextNormal.tu.u8CSO,
4920 pThis->contextNormal.tu.u8CSS,
4921 pThis->contextNormal.tu.u16CSE);
4922 e1kTransmitFrame(pThis, fOnWorkerThread);
4923 }
4924 else
4925 e1kXmitFreeBuf(pThis);
4926 pThis->u16TxPktLen = 0;
4927 }
4928 }
4929 else
4930 {
4931 STAM_COUNTER_INC(&pThis->StatTxPathFallback);
4932 rc = e1kFallbackAddToFrame(pThis, pDesc, fOnWorkerThread);
4933 }
4934 }
4935 e1kDescReport(pThis, pDesc, addr);
4936 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
4937 break;
4938 }
4939
4940 case E1K_DTYP_LEGACY:
4941 STAM_COUNTER_INC(&pThis->StatTxDescLegacy);
4942 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatTransmit), a);
4943 if (pDesc->legacy.cmd.u16Length == 0 || pDesc->legacy.u64BufAddr == 0)
4944 {
4945 E1kLog(("%s Empty legacy descriptor, skipped.\n", pThis->szPrf));
4946 }
4947 else
4948 {
4949 /* Add fragment to frame. */
4950 if (e1kAddToFrame(pThis, pDesc->data.u64BufAddr, pDesc->legacy.cmd.u16Length))
4951 {
4952 E1K_INC_ISTAT_CNT(pThis->uStatDescLeg);
4953
4954 /* Last fragment: Transmit and reset the packet storage counter. */
4955 if (pDesc->legacy.cmd.fEOP)
4956 {
4957 if (pDesc->legacy.cmd.fIC)
4958 {
4959 e1kInsertChecksum(pThis,
4960 (uint8_t *)pThis->CTX_SUFF(pTxSg)->aSegs[0].pvSeg,
4961 pThis->u16TxPktLen,
4962 pDesc->legacy.cmd.u8CSO,
4963 pDesc->legacy.dw3.u8CSS,
4964 0);
4965 }
4966 e1kTransmitFrame(pThis, fOnWorkerThread);
4967 pThis->u16TxPktLen = 0;
4968 }
4969 }
4970 /* Last fragment + failure: free the buffer and reset the storage counter. */
4971 else if (pDesc->legacy.cmd.fEOP)
4972 {
4973 e1kXmitFreeBuf(pThis);
4974 pThis->u16TxPktLen = 0;
4975 }
4976 }
4977 e1kDescReport(pThis, pDesc, addr);
4978 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
4979 break;
4980
4981 default:
4982 E1kLog(("%s ERROR Unsupported transmit descriptor type: 0x%04x\n",
4983 pThis->szPrf, e1kGetDescType(pDesc)));
4984 break;
4985 }
4986
4987 return rc;
4988}
4989
4990DECLINLINE(void) e1kUpdateTxContext(PE1KSTATE pThis, E1KTXDESC *pDesc)
4991{
4992 if (pDesc->context.dw2.fTSE)
4993 {
4994 pThis->contextTSE = pDesc->context;
4995 uint32_t cbMaxSegmentSize = pThis->contextTSE.dw3.u16MSS + pThis->contextTSE.dw3.u8HDRLEN + 4; /*VTAG*/
4996 if (RT_UNLIKELY(cbMaxSegmentSize > E1K_MAX_TX_PKT_SIZE))
4997 {
4998 pThis->contextTSE.dw3.u16MSS = E1K_MAX_TX_PKT_SIZE - pThis->contextTSE.dw3.u8HDRLEN - 4; /*VTAG*/
4999 LogRelMax(10, ("%s Transmit packet is too large: %u > %u(max). Adjusted MSS to %u.\n",
5000 pThis->szPrf, cbMaxSegmentSize, E1K_MAX_TX_PKT_SIZE, pThis->contextTSE.dw3.u16MSS));
5001 }
5002 pThis->u32PayRemain = pThis->contextTSE.dw2.u20PAYLEN;
5003 pThis->u16HdrRemain = pThis->contextTSE.dw3.u8HDRLEN;
5004 e1kSetupGsoCtx(&pThis->GsoCtx, &pThis->contextTSE);
5005 STAM_COUNTER_INC(&pThis->StatTxDescCtxTSE);
5006 }
5007 else
5008 {
5009 pThis->contextNormal = pDesc->context;
5010 STAM_COUNTER_INC(&pThis->StatTxDescCtxNormal);
5011 }
5012 E1kLog2(("%s %s context updated: IP CSS=%02X, IP CSO=%02X, IP CSE=%04X"
5013 ", TU CSS=%02X, TU CSO=%02X, TU CSE=%04X\n", pThis->szPrf,
5014 pDesc->context.dw2.fTSE ? "TSE" : "Normal",
5015 pDesc->context.ip.u8CSS,
5016 pDesc->context.ip.u8CSO,
5017 pDesc->context.ip.u16CSE,
5018 pDesc->context.tu.u8CSS,
5019 pDesc->context.tu.u8CSO,
5020 pDesc->context.tu.u16CSE));
5021}
5022
5023static bool e1kLocateTxPacket(PE1KSTATE pThis)
5024{
5025 LogFlow(("%s e1kLocateTxPacket: ENTER cbTxAlloc=%d\n",
5026 pThis->szPrf, pThis->cbTxAlloc));
5027 /* Check if we have located the packet already. */
5028 if (pThis->cbTxAlloc)
5029 {
5030 LogFlow(("%s e1kLocateTxPacket: RET true cbTxAlloc=%d\n",
5031 pThis->szPrf, pThis->cbTxAlloc));
5032 return true;
5033 }
5034
5035 bool fTSE = false;
5036 uint32_t cbPacket = 0;
5037
5038 for (int i = pThis->iTxDCurrent; i < pThis->nTxDFetched; ++i)
5039 {
5040 E1KTXDESC *pDesc = &pThis->aTxDescriptors[i];
5041 switch (e1kGetDescType(pDesc))
5042 {
5043 case E1K_DTYP_CONTEXT:
5044 e1kUpdateTxContext(pThis, pDesc);
5045 continue;
5046 case E1K_DTYP_LEGACY:
5047 /* Skip empty descriptors. */
5048 if (!pDesc->legacy.u64BufAddr || !pDesc->legacy.cmd.u16Length)
5049 break;
5050 cbPacket += pDesc->legacy.cmd.u16Length;
5051 pThis->fGSO = false;
5052 break;
5053 case E1K_DTYP_DATA:
5054 /* Skip empty descriptors. */
5055 if (!pDesc->data.u64BufAddr || !pDesc->data.cmd.u20DTALEN)
5056 break;
5057 if (cbPacket == 0)
5058 {
5059 /*
5060 * The first fragment: save IXSM and TXSM options
5061 * as these are only valid in the first fragment.
5062 */
5063 pThis->fIPcsum = pDesc->data.dw3.fIXSM;
5064 pThis->fTCPcsum = pDesc->data.dw3.fTXSM;
5065 fTSE = pDesc->data.cmd.fTSE;
5066 /*
5067 * TSE descriptors have VLE bit properly set in
5068 * the first fragment.
5069 */
5070 if (fTSE)
5071 {
5072 pThis->fVTag = pDesc->data.cmd.fVLE;
5073 pThis->u16VTagTCI = pDesc->data.dw3.u16Special;
5074 }
5075 pThis->fGSO = e1kCanDoGso(pThis, &pThis->GsoCtx, &pDesc->data, &pThis->contextTSE);
5076 }
5077 cbPacket += pDesc->data.cmd.u20DTALEN;
5078 break;
5079 default:
5080 AssertMsgFailed(("Impossible descriptor type!"));
5081 }
5082 if (pDesc->legacy.cmd.fEOP)
5083 {
5084 /*
5085 * Non-TSE descriptors have VLE bit properly set in
5086 * the last fragment.
5087 */
5088 if (!fTSE)
5089 {
5090 pThis->fVTag = pDesc->data.cmd.fVLE;
5091 pThis->u16VTagTCI = pDesc->data.dw3.u16Special;
5092 }
5093 /*
5094 * Compute the required buffer size. If we cannot do GSO but still
5095 * have to do segmentation we allocate the first segment only.
5096 */
5097 pThis->cbTxAlloc = (!fTSE || pThis->fGSO) ?
5098 cbPacket :
5099 RT_MIN(cbPacket, pThis->contextTSE.dw3.u16MSS + pThis->contextTSE.dw3.u8HDRLEN);
5100 if (pThis->fVTag)
5101 pThis->cbTxAlloc += 4;
5102 LogFlow(("%s e1kLocateTxPacket: RET true cbTxAlloc=%d\n",
5103 pThis->szPrf, pThis->cbTxAlloc));
5104 return true;
5105 }
5106 }
5107
5108 if (cbPacket == 0 && pThis->nTxDFetched - pThis->iTxDCurrent > 0)
5109 {
5110 /* All descriptors were empty, we need to process them as a dummy packet */
5111 LogFlow(("%s e1kLocateTxPacket: RET true cbTxAlloc=%d, zero packet!\n",
5112 pThis->szPrf, pThis->cbTxAlloc));
5113 return true;
5114 }
5115 LogFlow(("%s e1kLocateTxPacket: RET false cbTxAlloc=%d\n",
5116 pThis->szPrf, pThis->cbTxAlloc));
5117 return false;
5118}
5119
5120static int e1kXmitPacket(PE1KSTATE pThis, bool fOnWorkerThread)
5121{
5122 int rc = VINF_SUCCESS;
5123
5124 LogFlow(("%s e1kXmitPacket: ENTER current=%d fetched=%d\n",
5125 pThis->szPrf, pThis->iTxDCurrent, pThis->nTxDFetched));
5126
5127 while (pThis->iTxDCurrent < pThis->nTxDFetched)
5128 {
5129 E1KTXDESC *pDesc = &pThis->aTxDescriptors[pThis->iTxDCurrent];
5130 E1kLog3(("%s About to process new TX descriptor at %08x%08x, TDLEN=%08x, TDH=%08x, TDT=%08x\n",
5131 pThis->szPrf, TDBAH, TDBAL + TDH * sizeof(E1KTXDESC), TDLEN, TDH, TDT));
5132 rc = e1kXmitDesc(pThis, pDesc, e1kDescAddr(TDBAH, TDBAL, TDH), fOnWorkerThread);
5133 if (RT_FAILURE(rc))
5134 break;
5135 if (++TDH * sizeof(E1KTXDESC) >= TDLEN)
5136 TDH = 0;
5137 uint32_t uLowThreshold = GET_BITS(TXDCTL, LWTHRESH)*8;
5138 if (uLowThreshold != 0 && e1kGetTxLen(pThis) <= uLowThreshold)
5139 {
5140 E1kLog2(("%s Low on transmit descriptors, raise ICR.TXD_LOW, len=%x thresh=%x\n",
5141 pThis->szPrf, e1kGetTxLen(pThis), GET_BITS(TXDCTL, LWTHRESH)*8));
5142 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_TXD_LOW);
5143 }
5144 ++pThis->iTxDCurrent;
5145 if (e1kGetDescType(pDesc) != E1K_DTYP_CONTEXT && pDesc->legacy.cmd.fEOP)
5146 break;
5147 }
5148
5149 LogFlow(("%s e1kXmitPacket: RET %Rrc current=%d fetched=%d\n",
5150 pThis->szPrf, rc, pThis->iTxDCurrent, pThis->nTxDFetched));
5151 return rc;
5152}
5153
5154#endif /* E1K_WITH_TXD_CACHE */
5155#ifndef E1K_WITH_TXD_CACHE
5156
5157/**
5158 * Transmit pending descriptors.
5159 *
5160 * @returns VBox status code. VERR_TRY_AGAIN is returned if we're busy.
5161 *
5162 * @param pThis The E1000 state.
5163 * @param fOnWorkerThread Whether we're on a worker thread or on an EMT.
5164 */
5165static int e1kXmitPending(PE1KSTATE pThis, bool fOnWorkerThread)
5166{
5167 int rc = VINF_SUCCESS;
5168
5169 /* Check if transmitter is enabled. */
5170 if (!(TCTL & TCTL_EN))
5171 return VINF_SUCCESS;
5172 /*
5173 * Grab the xmit lock of the driver as well as the E1K device state.
5174 */
5175 rc = e1kCsTxEnter(pThis, VERR_SEM_BUSY);
5176 if (RT_LIKELY(rc == VINF_SUCCESS))
5177 {
5178 PPDMINETWORKUP pDrv = pThis->CTX_SUFF(pDrv);
5179 if (pDrv)
5180 {
5181 rc = pDrv->pfnBeginXmit(pDrv, fOnWorkerThread);
5182 if (RT_FAILURE(rc))
5183 {
5184 e1kCsTxLeave(pThis);
5185 return rc;
5186 }
5187 }
5188 /*
5189 * Process all pending descriptors.
5190 * Note! Do not process descriptors in locked state
5191 */
5192 while (TDH != TDT && !pThis->fLocked)
5193 {
5194 E1KTXDESC desc;
5195 E1kLog3(("%s About to process new TX descriptor at %08x%08x, TDLEN=%08x, TDH=%08x, TDT=%08x\n",
5196 pThis->szPrf, TDBAH, TDBAL + TDH * sizeof(desc), TDLEN, TDH, TDT));
5197
5198 e1kLoadDesc(pThis, &desc, ((uint64_t)TDBAH << 32) + TDBAL + TDH * sizeof(desc));
5199 rc = e1kXmitDesc(pThis, &desc, e1kDescAddr(TDBAH, TDBAL, TDH), fOnWorkerThread);
5200 /* If we failed to transmit descriptor we will try it again later */
5201 if (RT_FAILURE(rc))
5202 break;
5203 if (++TDH * sizeof(desc) >= TDLEN)
5204 TDH = 0;
5205
5206 if (e1kGetTxLen(pThis) <= GET_BITS(TXDCTL, LWTHRESH)*8)
5207 {
5208 E1kLog2(("%s Low on transmit descriptors, raise ICR.TXD_LOW, len=%x thresh=%x\n",
5209 pThis->szPrf, e1kGetTxLen(pThis), GET_BITS(TXDCTL, LWTHRESH)*8));
5210 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_TXD_LOW);
5211 }
5212
5213 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
5214 }
5215
5216 /// @todo uncomment: pThis->uStatIntTXQE++;
5217 /// @todo uncomment: e1kRaiseInterrupt(pThis, ICR_TXQE);
5218 /*
5219 * Release the lock.
5220 */
5221 if (pDrv)
5222 pDrv->pfnEndXmit(pDrv);
5223 e1kCsTxLeave(pThis);
5224 }
5225
5226 return rc;
5227}
5228
5229#else /* E1K_WITH_TXD_CACHE */
5230
5231static void e1kDumpTxDCache(PE1KSTATE pThis)
5232{
5233 unsigned i, cDescs = TDLEN / sizeof(E1KTXDESC);
5234 uint32_t tdh = TDH;
5235 LogRel(("-- Transmit Descriptors (%d total) --\n", cDescs));
5236 for (i = 0; i < cDescs; ++i)
5237 {
5238 E1KTXDESC desc;
5239 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), e1kDescAddr(TDBAH, TDBAL, i),
5240 &desc, sizeof(desc));
5241 if (i == tdh)
5242 LogRel((">>> "));
5243 LogRel(("%RGp: %R[e1ktxd]\n", e1kDescAddr(TDBAH, TDBAL, i), &desc));
5244 }
5245 LogRel(("-- Transmit Descriptors in Cache (at %d (TDH %d)/ fetched %d / max %d) --\n",
5246 pThis->iTxDCurrent, TDH, pThis->nTxDFetched, E1K_TXD_CACHE_SIZE));
5247 if (tdh > pThis->iTxDCurrent)
5248 tdh -= pThis->iTxDCurrent;
5249 else
5250 tdh = cDescs + tdh - pThis->iTxDCurrent;
5251 for (i = 0; i < pThis->nTxDFetched; ++i)
5252 {
5253 if (i == pThis->iTxDCurrent)
5254 LogRel((">>> "));
5255 LogRel(("%RGp: %R[e1ktxd]\n", e1kDescAddr(TDBAH, TDBAL, tdh++ % cDescs), &pThis->aTxDescriptors[i]));
5256 }
5257}
5258
5259/**
5260 * Transmit pending descriptors.
5261 *
5262 * @returns VBox status code. VERR_TRY_AGAIN is returned if we're busy.
5263 *
5264 * @param pThis The E1000 state.
5265 * @param fOnWorkerThread Whether we're on a worker thread or on an EMT.
5266 */
5267static int e1kXmitPending(PE1KSTATE pThis, bool fOnWorkerThread)
5268{
5269 int rc = VINF_SUCCESS;
5270
5271 /* Check if transmitter is enabled. */
5272 if (!(TCTL & TCTL_EN))
5273 return VINF_SUCCESS;
5274 /*
5275 * Grab the xmit lock of the driver as well as the E1K device state.
5276 */
5277 PPDMINETWORKUP pDrv = pThis->CTX_SUFF(pDrv);
5278 if (pDrv)
5279 {
5280 rc = pDrv->pfnBeginXmit(pDrv, fOnWorkerThread);
5281 if (RT_FAILURE(rc))
5282 return rc;
5283 }
5284
5285 /*
5286 * Process all pending descriptors.
5287 * Note! Do not process descriptors in locked state
5288 */
5289 rc = e1kCsTxEnter(pThis, VERR_SEM_BUSY);
5290 if (RT_LIKELY(rc == VINF_SUCCESS))
5291 {
5292 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatTransmit), a);
5293 /*
5294 * fIncomplete is set whenever we try to fetch additional descriptors
5295 * for an incomplete packet. If fail to locate a complete packet on
5296 * the next iteration we need to reset the cache or we risk to get
5297 * stuck in this loop forever.
5298 */
5299 bool fIncomplete = false;
5300 while (!pThis->fLocked && e1kTxDLazyLoad(pThis))
5301 {
5302 while (e1kLocateTxPacket(pThis))
5303 {
5304 fIncomplete = false;
5305 /* Found a complete packet, allocate it. */
5306 rc = e1kXmitAllocBuf(pThis, pThis->fGSO);
5307 /* If we're out of bandwidth we'll come back later. */
5308 if (RT_FAILURE(rc))
5309 goto out;
5310 /* Copy the packet to allocated buffer and send it. */
5311 rc = e1kXmitPacket(pThis, fOnWorkerThread);
5312 /* If we're out of bandwidth we'll come back later. */
5313 if (RT_FAILURE(rc))
5314 goto out;
5315 }
5316 uint8_t u8Remain = pThis->nTxDFetched - pThis->iTxDCurrent;
5317 if (RT_UNLIKELY(fIncomplete))
5318 {
5319 static bool fTxDCacheDumped = false;
5320 /*
5321 * The descriptor cache is full, but we were unable to find
5322 * a complete packet in it. Drop the cache and hope that
5323 * the guest driver can recover from network card error.
5324 */
5325 LogRel(("%s No complete packets in%s TxD cache! "
5326 "Fetched=%d, current=%d, TX len=%d.\n",
5327 pThis->szPrf,
5328 u8Remain == E1K_TXD_CACHE_SIZE ? " full" : "",
5329 pThis->nTxDFetched, pThis->iTxDCurrent,
5330 e1kGetTxLen(pThis)));
5331 if (!fTxDCacheDumped)
5332 {
5333 fTxDCacheDumped = true;
5334 e1kDumpTxDCache(pThis);
5335 }
5336 pThis->iTxDCurrent = pThis->nTxDFetched = 0;
5337 /*
5338 * Returning an error at this point means Guru in R0
5339 * (see @bugref{6428}).
5340 */
5341# ifdef IN_RING3
5342 rc = VERR_NET_INCOMPLETE_TX_PACKET;
5343# else /* !IN_RING3 */
5344 rc = VINF_IOM_R3_MMIO_WRITE;
5345# endif /* !IN_RING3 */
5346 goto out;
5347 }
5348 if (u8Remain > 0)
5349 {
5350 Log4(("%s Incomplete packet at %d. Already fetched %d, "
5351 "%d more are available\n",
5352 pThis->szPrf, pThis->iTxDCurrent, u8Remain,
5353 e1kGetTxLen(pThis) - u8Remain));
5354
5355 /*
5356 * A packet was partially fetched. Move incomplete packet to
5357 * the beginning of cache buffer, then load more descriptors.
5358 */
5359 memmove(pThis->aTxDescriptors,
5360 &pThis->aTxDescriptors[pThis->iTxDCurrent],
5361 u8Remain * sizeof(E1KTXDESC));
5362 pThis->iTxDCurrent = 0;
5363 pThis->nTxDFetched = u8Remain;
5364 e1kTxDLoadMore(pThis);
5365 fIncomplete = true;
5366 }
5367 else
5368 pThis->nTxDFetched = 0;
5369 pThis->iTxDCurrent = 0;
5370 }
5371 if (!pThis->fLocked && GET_BITS(TXDCTL, LWTHRESH) == 0)
5372 {
5373 E1kLog2(("%s Out of transmit descriptors, raise ICR.TXD_LOW\n",
5374 pThis->szPrf));
5375 e1kRaiseInterrupt(pThis, VERR_SEM_BUSY, ICR_TXD_LOW);
5376 }
5377out:
5378 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatTransmit), a);
5379
5380 /// @todo uncomment: pThis->uStatIntTXQE++;
5381 /// @todo uncomment: e1kRaiseInterrupt(pThis, ICR_TXQE);
5382
5383 e1kCsTxLeave(pThis);
5384 }
5385
5386
5387 /*
5388 * Release the lock.
5389 */
5390 if (pDrv)
5391 pDrv->pfnEndXmit(pDrv);
5392 return rc;
5393}
5394
5395#endif /* E1K_WITH_TXD_CACHE */
5396#ifdef IN_RING3
5397
5398/**
5399 * @interface_method_impl{PDMINETWORKDOWN,pfnXmitPending}
5400 */
5401static DECLCALLBACK(void) e1kR3NetworkDown_XmitPending(PPDMINETWORKDOWN pInterface)
5402{
5403 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, INetworkDown);
5404 /* Resume suspended transmission */
5405 STATUS &= ~STATUS_TXOFF;
5406 e1kXmitPending(pThis, true /*fOnWorkerThread*/);
5407}
5408
5409/**
5410 * Callback for consuming from transmit queue. It gets called in R3 whenever
5411 * we enqueue something in R0/GC.
5412 *
5413 * @returns true
5414 * @param pDevIns Pointer to device instance structure.
5415 * @param pItem Pointer to the element being dequeued (not used).
5416 * @thread ???
5417 */
5418static DECLCALLBACK(bool) e1kTxQueueConsumer(PPDMDEVINS pDevIns, PPDMQUEUEITEMCORE pItem)
5419{
5420 NOREF(pItem);
5421 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, PE1KSTATE);
5422 E1kLog2(("%s e1kTxQueueConsumer:\n", pThis->szPrf));
5423
5424 int rc = e1kXmitPending(pThis, false /*fOnWorkerThread*/); NOREF(rc);
5425#ifndef DEBUG_andy /** @todo r=andy Happens for me a lot, mute this for me. */
5426 AssertMsg(RT_SUCCESS(rc) || rc == VERR_TRY_AGAIN, ("%Rrc\n", rc));
5427#endif
5428 return true;
5429}
5430
5431/**
5432 * Handler for the wakeup signaller queue.
5433 */
5434static DECLCALLBACK(bool) e1kCanRxQueueConsumer(PPDMDEVINS pDevIns, PPDMQUEUEITEMCORE pItem)
5435{
5436 RT_NOREF(pItem);
5437 e1kWakeupReceive(pDevIns);
5438 return true;
5439}
5440
5441#endif /* IN_RING3 */
5442
5443/**
5444 * Write handler for Transmit Descriptor Tail register.
5445 *
5446 * @param pThis The device state structure.
5447 * @param offset Register offset in memory-mapped frame.
5448 * @param index Register index in register array.
5449 * @param value The value to store.
5450 * @param mask Used to implement partial writes (8 and 16-bit).
5451 * @thread EMT
5452 */
5453static int e1kRegWriteTDT(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
5454{
5455 int rc = e1kRegWriteDefault(pThis, offset, index, value);
5456
5457 /* All descriptors starting with head and not including tail belong to us. */
5458 /* Process them. */
5459 E1kLog2(("%s e1kRegWriteTDT: TDBAL=%08x, TDBAH=%08x, TDLEN=%08x, TDH=%08x, TDT=%08x\n",
5460 pThis->szPrf, TDBAL, TDBAH, TDLEN, TDH, TDT));
5461
5462 /* Ignore TDT writes when the link is down. */
5463 if (TDH != TDT && (STATUS & STATUS_LU))
5464 {
5465 Log5(("E1000: TDT write: TDH=%08x, TDT=%08x, %d descriptors to process\n", TDH, TDT, e1kGetTxLen(pThis)));
5466 E1kLog(("%s e1kRegWriteTDT: %d descriptors to process\n",
5467 pThis->szPrf, e1kGetTxLen(pThis)));
5468
5469 /* Transmit pending packets if possible, defer it if we cannot do it
5470 in the current context. */
5471#ifdef E1K_TX_DELAY
5472 rc = e1kCsTxEnter(pThis, VERR_SEM_BUSY);
5473 if (RT_LIKELY(rc == VINF_SUCCESS))
5474 {
5475 if (!TMTimerIsActive(pThis->CTX_SUFF(pTXDTimer)))
5476 {
5477#ifdef E1K_INT_STATS
5478 pThis->u64ArmedAt = RTTimeNanoTS();
5479#endif
5480 e1kArmTimer(pThis, pThis->CTX_SUFF(pTXDTimer), E1K_TX_DELAY);
5481 }
5482 E1K_INC_ISTAT_CNT(pThis->uStatTxDelayed);
5483 e1kCsTxLeave(pThis);
5484 return rc;
5485 }
5486 /* We failed to enter the TX critical section -- transmit as usual. */
5487#endif /* E1K_TX_DELAY */
5488#ifndef IN_RING3
5489 if (!pThis->CTX_SUFF(pDrv))
5490 {
5491 PPDMQUEUEITEMCORE pItem = PDMQueueAlloc(pThis->CTX_SUFF(pTxQueue));
5492 if (RT_UNLIKELY(pItem))
5493 PDMQueueInsert(pThis->CTX_SUFF(pTxQueue), pItem);
5494 }
5495 else
5496#endif
5497 {
5498 rc = e1kXmitPending(pThis, false /*fOnWorkerThread*/);
5499 if (rc == VERR_TRY_AGAIN)
5500 rc = VINF_SUCCESS;
5501 else if (rc == VERR_SEM_BUSY)
5502 rc = VINF_IOM_R3_MMIO_WRITE;
5503 AssertRC(rc);
5504 }
5505 }
5506
5507 return rc;
5508}
5509
5510/**
5511 * Write handler for Multicast Table Array registers.
5512 *
5513 * @param pThis The device state structure.
5514 * @param offset Register offset in memory-mapped frame.
5515 * @param index Register index in register array.
5516 * @param value The value to store.
5517 * @thread EMT
5518 */
5519static int e1kRegWriteMTA(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
5520{
5521 AssertReturn(offset - g_aE1kRegMap[index].offset < sizeof(pThis->auMTA), VERR_DEV_IO_ERROR);
5522 pThis->auMTA[(offset - g_aE1kRegMap[index].offset)/sizeof(pThis->auMTA[0])] = value;
5523
5524 return VINF_SUCCESS;
5525}
5526
5527/**
5528 * Read handler for Multicast Table Array registers.
5529 *
5530 * @returns VBox status code.
5531 *
5532 * @param pThis The device state structure.
5533 * @param offset Register offset in memory-mapped frame.
5534 * @param index Register index in register array.
5535 * @thread EMT
5536 */
5537static int e1kRegReadMTA(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
5538{
5539 AssertReturn(offset - g_aE1kRegMap[index].offset< sizeof(pThis->auMTA), VERR_DEV_IO_ERROR);
5540 *pu32Value = pThis->auMTA[(offset - g_aE1kRegMap[index].offset)/sizeof(pThis->auMTA[0])];
5541
5542 return VINF_SUCCESS;
5543}
5544
5545/**
5546 * Write handler for Receive Address registers.
5547 *
5548 * @param pThis The device state structure.
5549 * @param offset Register offset in memory-mapped frame.
5550 * @param index Register index in register array.
5551 * @param value The value to store.
5552 * @thread EMT
5553 */
5554static int e1kRegWriteRA(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
5555{
5556 AssertReturn(offset - g_aE1kRegMap[index].offset < sizeof(pThis->aRecAddr.au32), VERR_DEV_IO_ERROR);
5557 pThis->aRecAddr.au32[(offset - g_aE1kRegMap[index].offset)/sizeof(pThis->aRecAddr.au32[0])] = value;
5558
5559 return VINF_SUCCESS;
5560}
5561
5562/**
5563 * Read handler for Receive Address registers.
5564 *
5565 * @returns VBox status code.
5566 *
5567 * @param pThis The device state structure.
5568 * @param offset Register offset in memory-mapped frame.
5569 * @param index Register index in register array.
5570 * @thread EMT
5571 */
5572static int e1kRegReadRA(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
5573{
5574 AssertReturn(offset - g_aE1kRegMap[index].offset< sizeof(pThis->aRecAddr.au32), VERR_DEV_IO_ERROR);
5575 *pu32Value = pThis->aRecAddr.au32[(offset - g_aE1kRegMap[index].offset)/sizeof(pThis->aRecAddr.au32[0])];
5576
5577 return VINF_SUCCESS;
5578}
5579
5580/**
5581 * Write handler for VLAN Filter Table Array registers.
5582 *
5583 * @param pThis The device state structure.
5584 * @param offset Register offset in memory-mapped frame.
5585 * @param index Register index in register array.
5586 * @param value The value to store.
5587 * @thread EMT
5588 */
5589static int e1kRegWriteVFTA(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
5590{
5591 AssertReturn(offset - g_aE1kRegMap[index].offset < sizeof(pThis->auVFTA), VINF_SUCCESS);
5592 pThis->auVFTA[(offset - g_aE1kRegMap[index].offset)/sizeof(pThis->auVFTA[0])] = value;
5593
5594 return VINF_SUCCESS;
5595}
5596
5597/**
5598 * Read handler for VLAN Filter Table Array registers.
5599 *
5600 * @returns VBox status code.
5601 *
5602 * @param pThis The device state structure.
5603 * @param offset Register offset in memory-mapped frame.
5604 * @param index Register index in register array.
5605 * @thread EMT
5606 */
5607static int e1kRegReadVFTA(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
5608{
5609 AssertReturn(offset - g_aE1kRegMap[index].offset< sizeof(pThis->auVFTA), VERR_DEV_IO_ERROR);
5610 *pu32Value = pThis->auVFTA[(offset - g_aE1kRegMap[index].offset)/sizeof(pThis->auVFTA[0])];
5611
5612 return VINF_SUCCESS;
5613}
5614
5615/**
5616 * Read handler for unimplemented registers.
5617 *
5618 * Merely reports reads from unimplemented registers.
5619 *
5620 * @returns VBox status code.
5621 *
5622 * @param pThis The device state structure.
5623 * @param offset Register offset in memory-mapped frame.
5624 * @param index Register index in register array.
5625 * @thread EMT
5626 */
5627static int e1kRegReadUnimplemented(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
5628{
5629 RT_NOREF3(pThis, offset, index);
5630 E1kLog(("%s At %08X read (00000000) attempt from unimplemented register %s (%s)\n",
5631 pThis->szPrf, offset, g_aE1kRegMap[index].abbrev, g_aE1kRegMap[index].name));
5632 *pu32Value = 0;
5633
5634 return VINF_SUCCESS;
5635}
5636
5637/**
5638 * Default register read handler with automatic clear operation.
5639 *
5640 * Retrieves the value of register from register array in device state structure.
5641 * Then resets all bits.
5642 *
5643 * @remarks The 'mask' parameter is simply ignored as masking and shifting is
5644 * done in the caller.
5645 *
5646 * @returns VBox status code.
5647 *
5648 * @param pThis The device state structure.
5649 * @param offset Register offset in memory-mapped frame.
5650 * @param index Register index in register array.
5651 * @thread EMT
5652 */
5653static int e1kRegReadAutoClear(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
5654{
5655 AssertReturn(index < E1K_NUM_OF_32BIT_REGS, VERR_DEV_IO_ERROR);
5656 int rc = e1kRegReadDefault(pThis, offset, index, pu32Value);
5657 pThis->auRegs[index] = 0;
5658
5659 return rc;
5660}
5661
5662/**
5663 * Default register read handler.
5664 *
5665 * Retrieves the value of register from register array in device state structure.
5666 * Bits corresponding to 0s in 'readable' mask will always read as 0s.
5667 *
5668 * @remarks The 'mask' parameter is simply ignored as masking and shifting is
5669 * done in the caller.
5670 *
5671 * @returns VBox status code.
5672 *
5673 * @param pThis The device state structure.
5674 * @param offset Register offset in memory-mapped frame.
5675 * @param index Register index in register array.
5676 * @thread EMT
5677 */
5678static int e1kRegReadDefault(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t *pu32Value)
5679{
5680 RT_NOREF_PV(offset);
5681
5682 AssertReturn(index < E1K_NUM_OF_32BIT_REGS, VERR_DEV_IO_ERROR);
5683 *pu32Value = pThis->auRegs[index] & g_aE1kRegMap[index].readable;
5684
5685 return VINF_SUCCESS;
5686}
5687
5688/**
5689 * Write handler for unimplemented registers.
5690 *
5691 * Merely reports writes to unimplemented registers.
5692 *
5693 * @param pThis The device state structure.
5694 * @param offset Register offset in memory-mapped frame.
5695 * @param index Register index in register array.
5696 * @param value The value to store.
5697 * @thread EMT
5698 */
5699
5700 static int e1kRegWriteUnimplemented(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
5701{
5702 RT_NOREF_PV(pThis); RT_NOREF_PV(offset); RT_NOREF_PV(index); RT_NOREF_PV(value);
5703
5704 E1kLog(("%s At %08X write attempt (%08X) to unimplemented register %s (%s)\n",
5705 pThis->szPrf, offset, value, g_aE1kRegMap[index].abbrev, g_aE1kRegMap[index].name));
5706
5707 return VINF_SUCCESS;
5708}
5709
5710/**
5711 * Default register write handler.
5712 *
5713 * Stores the value to the register array in device state structure. Only bits
5714 * corresponding to 1s both in 'writable' and 'mask' will be stored.
5715 *
5716 * @returns VBox status code.
5717 *
5718 * @param pThis The device state structure.
5719 * @param offset Register offset in memory-mapped frame.
5720 * @param index Register index in register array.
5721 * @param value The value to store.
5722 * @param mask Used to implement partial writes (8 and 16-bit).
5723 * @thread EMT
5724 */
5725
5726static int e1kRegWriteDefault(PE1KSTATE pThis, uint32_t offset, uint32_t index, uint32_t value)
5727{
5728 RT_NOREF_PV(offset);
5729
5730 AssertReturn(index < E1K_NUM_OF_32BIT_REGS, VERR_DEV_IO_ERROR);
5731 pThis->auRegs[index] = (value & g_aE1kRegMap[index].writable)
5732 | (pThis->auRegs[index] & ~g_aE1kRegMap[index].writable);
5733
5734 return VINF_SUCCESS;
5735}
5736
5737/**
5738 * Search register table for matching register.
5739 *
5740 * @returns Index in the register table or -1 if not found.
5741 *
5742 * @param offReg Register offset in memory-mapped region.
5743 * @thread EMT
5744 */
5745static int e1kRegLookup(uint32_t offReg)
5746{
5747
5748#if 0
5749 int index;
5750
5751 for (index = 0; index < E1K_NUM_OF_REGS; index++)
5752 {
5753 if (g_aE1kRegMap[index].offset <= offReg && offReg < g_aE1kRegMap[index].offset + g_aE1kRegMap[index].size)
5754 {
5755 return index;
5756 }
5757 }
5758#else
5759 int iStart = 0;
5760 int iEnd = E1K_NUM_OF_BINARY_SEARCHABLE;
5761 for (;;)
5762 {
5763 int i = (iEnd - iStart) / 2 + iStart;
5764 uint32_t offCur = g_aE1kRegMap[i].offset;
5765 if (offReg < offCur)
5766 {
5767 if (i == iStart)
5768 break;
5769 iEnd = i;
5770 }
5771 else if (offReg >= offCur + g_aE1kRegMap[i].size)
5772 {
5773 i++;
5774 if (i == iEnd)
5775 break;
5776 iStart = i;
5777 }
5778 else
5779 return i;
5780 Assert(iEnd > iStart);
5781 }
5782
5783 for (unsigned i = E1K_NUM_OF_BINARY_SEARCHABLE; i < RT_ELEMENTS(g_aE1kRegMap); i++)
5784 if (offReg - g_aE1kRegMap[i].offset < g_aE1kRegMap[i].size)
5785 return i;
5786
5787# ifdef VBOX_STRICT
5788 for (unsigned i = 0; i < RT_ELEMENTS(g_aE1kRegMap); i++)
5789 Assert(offReg - g_aE1kRegMap[i].offset >= g_aE1kRegMap[i].size);
5790# endif
5791
5792#endif
5793
5794 return -1;
5795}
5796
5797/**
5798 * Handle unaligned register read operation.
5799 *
5800 * Looks up and calls appropriate handler.
5801 *
5802 * @returns VBox status code.
5803 *
5804 * @param pThis The device state structure.
5805 * @param offReg Register offset in memory-mapped frame.
5806 * @param pv Where to store the result.
5807 * @param cb Number of bytes to read.
5808 * @thread EMT
5809 * @remarks IOM takes care of unaligned and small reads via MMIO. For I/O port
5810 * accesses we have to take care of that ourselves.
5811 */
5812static int e1kRegReadUnaligned(PE1KSTATE pThis, uint32_t offReg, void *pv, uint32_t cb)
5813{
5814 uint32_t u32 = 0;
5815 uint32_t shift;
5816 int rc = VINF_SUCCESS;
5817 int index = e1kRegLookup(offReg);
5818#ifdef LOG_ENABLED
5819 char buf[9];
5820#endif
5821
5822 /*
5823 * From the spec:
5824 * For registers that should be accessed as 32-bit double words, partial writes (less than a 32-bit
5825 * double word) is ignored. Partial reads return all 32 bits of data regardless of the byte enables.
5826 */
5827
5828 /*
5829 * To be able to read bytes and short word we convert them to properly
5830 * shifted 32-bit words and masks. The idea is to keep register-specific
5831 * handlers simple. Most accesses will be 32-bit anyway.
5832 */
5833 uint32_t mask;
5834 switch (cb)
5835 {
5836 case 4: mask = 0xFFFFFFFF; break;
5837 case 2: mask = 0x0000FFFF; break;
5838 case 1: mask = 0x000000FF; break;
5839 default:
5840 return PDMDevHlpDBGFStop(pThis->CTX_SUFF(pDevIns), RT_SRC_POS,
5841 "unsupported op size: offset=%#10x cb=%#10x\n", offReg, cb);
5842 }
5843 if (index != -1)
5844 {
5845 if (g_aE1kRegMap[index].readable)
5846 {
5847 /* Make the mask correspond to the bits we are about to read. */
5848 shift = (offReg - g_aE1kRegMap[index].offset) % sizeof(uint32_t) * 8;
5849 mask <<= shift;
5850 if (!mask)
5851 return PDMDevHlpDBGFStop(pThis->CTX_SUFF(pDevIns), RT_SRC_POS, "Zero mask: offset=%#10x cb=%#10x\n", offReg, cb);
5852 /*
5853 * Read it. Pass the mask so the handler knows what has to be read.
5854 * Mask out irrelevant bits.
5855 */
5856 //rc = e1kCsEnter(pThis, VERR_SEM_BUSY, RT_SRC_POS);
5857 if (RT_UNLIKELY(rc != VINF_SUCCESS))
5858 return rc;
5859 //pThis->fDelayInts = false;
5860 //pThis->iStatIntLost += pThis->iStatIntLostOne;
5861 //pThis->iStatIntLostOne = 0;
5862 rc = g_aE1kRegMap[index].pfnRead(pThis, offReg & 0xFFFFFFFC, index, &u32);
5863 u32 &= mask;
5864 //e1kCsLeave(pThis);
5865 E1kLog2(("%s At %08X read %s from %s (%s)\n",
5866 pThis->szPrf, offReg, e1kU32toHex(u32, mask, buf), g_aE1kRegMap[index].abbrev, g_aE1kRegMap[index].name));
5867 Log6(("%s At %08X read %s from %s (%s) [UNALIGNED]\n",
5868 pThis->szPrf, offReg, e1kU32toHex(u32, mask, buf), g_aE1kRegMap[index].abbrev, g_aE1kRegMap[index].name));
5869 /* Shift back the result. */
5870 u32 >>= shift;
5871 }
5872 else
5873 E1kLog(("%s At %08X read (%s) attempt from write-only register %s (%s)\n",
5874 pThis->szPrf, offReg, e1kU32toHex(u32, mask, buf), g_aE1kRegMap[index].abbrev, g_aE1kRegMap[index].name));
5875 if (IOM_SUCCESS(rc))
5876 STAM_COUNTER_INC(&pThis->aStatRegReads[index]);
5877 }
5878 else
5879 E1kLog(("%s At %08X read (%s) attempt from non-existing register\n",
5880 pThis->szPrf, offReg, e1kU32toHex(u32, mask, buf)));
5881
5882 memcpy(pv, &u32, cb);
5883 return rc;
5884}
5885
5886/**
5887 * Handle 4 byte aligned and sized read operation.
5888 *
5889 * Looks up and calls appropriate handler.
5890 *
5891 * @returns VBox status code.
5892 *
5893 * @param pThis The device state structure.
5894 * @param offReg Register offset in memory-mapped frame.
5895 * @param pu32 Where to store the result.
5896 * @thread EMT
5897 */
5898static int e1kRegReadAlignedU32(PE1KSTATE pThis, uint32_t offReg, uint32_t *pu32)
5899{
5900 Assert(!(offReg & 3));
5901
5902 /*
5903 * Lookup the register and check that it's readable.
5904 */
5905 int rc = VINF_SUCCESS;
5906 int idxReg = e1kRegLookup(offReg);
5907 if (RT_LIKELY(idxReg != -1))
5908 {
5909 if (RT_UNLIKELY(g_aE1kRegMap[idxReg].readable))
5910 {
5911 /*
5912 * Read it. Pass the mask so the handler knows what has to be read.
5913 * Mask out irrelevant bits.
5914 */
5915 //rc = e1kCsEnter(pThis, VERR_SEM_BUSY, RT_SRC_POS);
5916 //if (RT_UNLIKELY(rc != VINF_SUCCESS))
5917 // return rc;
5918 //pThis->fDelayInts = false;
5919 //pThis->iStatIntLost += pThis->iStatIntLostOne;
5920 //pThis->iStatIntLostOne = 0;
5921 rc = g_aE1kRegMap[idxReg].pfnRead(pThis, offReg & 0xFFFFFFFC, idxReg, pu32);
5922 //e1kCsLeave(pThis);
5923 Log6(("%s At %08X read %08X from %s (%s)\n",
5924 pThis->szPrf, offReg, *pu32, g_aE1kRegMap[idxReg].abbrev, g_aE1kRegMap[idxReg].name));
5925 if (IOM_SUCCESS(rc))
5926 STAM_COUNTER_INC(&pThis->aStatRegReads[idxReg]);
5927 }
5928 else
5929 E1kLog(("%s At %08X read attempt from non-readable register %s (%s)\n",
5930 pThis->szPrf, offReg, g_aE1kRegMap[idxReg].abbrev, g_aE1kRegMap[idxReg].name));
5931 }
5932 else
5933 E1kLog(("%s At %08X read attempt from non-existing register\n", pThis->szPrf, offReg));
5934 return rc;
5935}
5936
5937/**
5938 * Handle 4 byte sized and aligned register write operation.
5939 *
5940 * Looks up and calls appropriate handler.
5941 *
5942 * @returns VBox status code.
5943 *
5944 * @param pThis The device state structure.
5945 * @param offReg Register offset in memory-mapped frame.
5946 * @param u32Value The value to write.
5947 * @thread EMT
5948 */
5949static int e1kRegWriteAlignedU32(PE1KSTATE pThis, uint32_t offReg, uint32_t u32Value)
5950{
5951 int rc = VINF_SUCCESS;
5952 int index = e1kRegLookup(offReg);
5953 if (RT_LIKELY(index != -1))
5954 {
5955 if (RT_LIKELY(g_aE1kRegMap[index].writable))
5956 {
5957 /*
5958 * Write it. Pass the mask so the handler knows what has to be written.
5959 * Mask out irrelevant bits.
5960 */
5961 Log6(("%s At %08X write %08X to %s (%s)\n",
5962 pThis->szPrf, offReg, u32Value, g_aE1kRegMap[index].abbrev, g_aE1kRegMap[index].name));
5963 //rc = e1kCsEnter(pThis, VERR_SEM_BUSY, RT_SRC_POS);
5964 //if (RT_UNLIKELY(rc != VINF_SUCCESS))
5965 // return rc;
5966 //pThis->fDelayInts = false;
5967 //pThis->iStatIntLost += pThis->iStatIntLostOne;
5968 //pThis->iStatIntLostOne = 0;
5969 rc = g_aE1kRegMap[index].pfnWrite(pThis, offReg, index, u32Value);
5970 //e1kCsLeave(pThis);
5971 }
5972 else
5973 E1kLog(("%s At %08X write attempt (%08X) to read-only register %s (%s)\n",
5974 pThis->szPrf, offReg, u32Value, g_aE1kRegMap[index].abbrev, g_aE1kRegMap[index].name));
5975 if (IOM_SUCCESS(rc))
5976 STAM_COUNTER_INC(&pThis->aStatRegWrites[index]);
5977 }
5978 else
5979 E1kLog(("%s At %08X write attempt (%08X) to non-existing register\n",
5980 pThis->szPrf, offReg, u32Value));
5981 return rc;
5982}
5983
5984
5985/* -=-=-=-=- MMIO and I/O Port Callbacks -=-=-=-=- */
5986
5987/**
5988 * @callback_method_impl{FNIOMMMIOREAD}
5989 */
5990PDMBOTHCBDECL(int) e1kMMIORead(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void *pv, unsigned cb)
5991{
5992 RT_NOREF2(pvUser, cb);
5993 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, PE1KSTATE);
5994 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatMMIORead), a);
5995
5996 uint32_t offReg = GCPhysAddr - pThis->addrMMReg;
5997 Assert(offReg < E1K_MM_SIZE);
5998 Assert(cb == 4);
5999 Assert(!(GCPhysAddr & 3));
6000
6001 int rc = e1kRegReadAlignedU32(pThis, offReg, (uint32_t *)pv);
6002
6003 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatMMIORead), a);
6004 return rc;
6005}
6006
6007/**
6008 * @callback_method_impl{FNIOMMMIOWRITE}
6009 */
6010PDMBOTHCBDECL(int) e1kMMIOWrite(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void const *pv, unsigned cb)
6011{
6012 RT_NOREF2(pvUser, cb);
6013 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, PE1KSTATE);
6014 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatMMIOWrite), a);
6015
6016 uint32_t offReg = GCPhysAddr - pThis->addrMMReg;
6017 Assert(offReg < E1K_MM_SIZE);
6018 Assert(cb == 4);
6019 Assert(!(GCPhysAddr & 3));
6020
6021 int rc = e1kRegWriteAlignedU32(pThis, offReg, *(uint32_t const *)pv);
6022
6023 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatMMIOWrite), a);
6024 return rc;
6025}
6026
6027/**
6028 * @callback_method_impl{FNIOMIOPORTIN}
6029 */
6030PDMBOTHCBDECL(int) e1kIOPortIn(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t *pu32, unsigned cb)
6031{
6032 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, PE1KSTATE);
6033 int rc;
6034 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatIORead), a);
6035 RT_NOREF_PV(pvUser);
6036
6037 uPort -= pThis->IOPortBase;
6038 if (RT_LIKELY(cb == 4))
6039 switch (uPort)
6040 {
6041 case 0x00: /* IOADDR */
6042 *pu32 = pThis->uSelectedReg;
6043 E1kLog2(("%s e1kIOPortIn: IOADDR(0), selecting register %#010x, val=%#010x\n", pThis->szPrf, pThis->uSelectedReg, *pu32));
6044 rc = VINF_SUCCESS;
6045 break;
6046
6047 case 0x04: /* IODATA */
6048 if (!(pThis->uSelectedReg & 3))
6049 rc = e1kRegReadAlignedU32(pThis, pThis->uSelectedReg, pu32);
6050 else /** @todo r=bird: I wouldn't be surprised if this unaligned branch wasn't necessary. */
6051 rc = e1kRegReadUnaligned(pThis, pThis->uSelectedReg, pu32, cb);
6052 if (rc == VINF_IOM_R3_MMIO_READ)
6053 rc = VINF_IOM_R3_IOPORT_READ;
6054 E1kLog2(("%s e1kIOPortIn: IODATA(4), reading from selected register %#010x, val=%#010x\n", pThis->szPrf, pThis->uSelectedReg, *pu32));
6055 break;
6056
6057 default:
6058 E1kLog(("%s e1kIOPortIn: invalid port %#010x\n", pThis->szPrf, uPort));
6059 //rc = VERR_IOM_IOPORT_UNUSED; /* Why not? */
6060 rc = VINF_SUCCESS;
6061 }
6062 else
6063 {
6064 E1kLog(("%s e1kIOPortIn: invalid op size: uPort=%RTiop cb=%08x", pThis->szPrf, uPort, cb));
6065 rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS, "%s e1kIOPortIn: invalid op size: uPort=%RTiop cb=%08x\n", pThis->szPrf, uPort, cb);
6066 }
6067 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatIORead), a);
6068 return rc;
6069}
6070
6071
6072/**
6073 * @callback_method_impl{FNIOMIOPORTOUT}
6074 */
6075PDMBOTHCBDECL(int) e1kIOPortOut(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
6076{
6077 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, PE1KSTATE);
6078 int rc;
6079 STAM_PROFILE_ADV_START(&pThis->CTX_SUFF_Z(StatIOWrite), a);
6080 RT_NOREF_PV(pvUser);
6081
6082 E1kLog2(("%s e1kIOPortOut: uPort=%RTiop value=%08x\n", pThis->szPrf, uPort, u32));
6083 if (RT_LIKELY(cb == 4))
6084 {
6085 uPort -= pThis->IOPortBase;
6086 switch (uPort)
6087 {
6088 case 0x00: /* IOADDR */
6089 pThis->uSelectedReg = u32;
6090 E1kLog2(("%s e1kIOPortOut: IOADDR(0), selected register %08x\n", pThis->szPrf, pThis->uSelectedReg));
6091 rc = VINF_SUCCESS;
6092 break;
6093
6094 case 0x04: /* IODATA */
6095 E1kLog2(("%s e1kIOPortOut: IODATA(4), writing to selected register %#010x, value=%#010x\n", pThis->szPrf, pThis->uSelectedReg, u32));
6096 if (RT_LIKELY(!(pThis->uSelectedReg & 3)))
6097 {
6098 rc = e1kRegWriteAlignedU32(pThis, pThis->uSelectedReg, u32);
6099 if (rc == VINF_IOM_R3_MMIO_WRITE)
6100 rc = VINF_IOM_R3_IOPORT_WRITE;
6101 }
6102 else
6103 rc = PDMDevHlpDBGFStop(pThis->CTX_SUFF(pDevIns), RT_SRC_POS,
6104 "Spec violation: misaligned offset: %#10x, ignored.\n", pThis->uSelectedReg);
6105 break;
6106
6107 default:
6108 E1kLog(("%s e1kIOPortOut: invalid port %#010x\n", pThis->szPrf, uPort));
6109 rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS, "invalid port %#010x\n", uPort);
6110 }
6111 }
6112 else
6113 {
6114 E1kLog(("%s e1kIOPortOut: invalid op size: uPort=%RTiop cb=%08x\n", pThis->szPrf, uPort, cb));
6115 rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS, "%s: invalid op size: uPort=%RTiop cb=%#x\n", pThis->szPrf, uPort, cb);
6116 }
6117
6118 STAM_PROFILE_ADV_STOP(&pThis->CTX_SUFF_Z(StatIOWrite), a);
6119 return rc;
6120}
6121
6122#ifdef IN_RING3
6123
6124/**
6125 * Dump complete device state to log.
6126 *
6127 * @param pThis Pointer to device state.
6128 */
6129static void e1kDumpState(PE1KSTATE pThis)
6130{
6131 RT_NOREF(pThis);
6132 for (int i = 0; i < E1K_NUM_OF_32BIT_REGS; ++i)
6133 E1kLog2(("%s %8.8s = %08x\n", pThis->szPrf, g_aE1kRegMap[i].abbrev, pThis->auRegs[i]));
6134# ifdef E1K_INT_STATS
6135 LogRel(("%s Interrupt attempts: %d\n", pThis->szPrf, pThis->uStatIntTry));
6136 LogRel(("%s Interrupts raised : %d\n", pThis->szPrf, pThis->uStatInt));
6137 LogRel(("%s Interrupts lowered: %d\n", pThis->szPrf, pThis->uStatIntLower));
6138 LogRel(("%s ICR outside ISR : %d\n", pThis->szPrf, pThis->uStatNoIntICR));
6139 LogRel(("%s IMS raised ints : %d\n", pThis->szPrf, pThis->uStatIntIMS));
6140 LogRel(("%s Interrupts skipped: %d\n", pThis->szPrf, pThis->uStatIntSkip));
6141 LogRel(("%s Masked interrupts : %d\n", pThis->szPrf, pThis->uStatIntMasked));
6142 LogRel(("%s Early interrupts : %d\n", pThis->szPrf, pThis->uStatIntEarly));
6143 LogRel(("%s Late interrupts : %d\n", pThis->szPrf, pThis->uStatIntLate));
6144 LogRel(("%s Lost interrupts : %d\n", pThis->szPrf, pThis->iStatIntLost));
6145 LogRel(("%s Interrupts by RX : %d\n", pThis->szPrf, pThis->uStatIntRx));
6146 LogRel(("%s Interrupts by TX : %d\n", pThis->szPrf, pThis->uStatIntTx));
6147 LogRel(("%s Interrupts by ICS : %d\n", pThis->szPrf, pThis->uStatIntICS));
6148 LogRel(("%s Interrupts by RDTR: %d\n", pThis->szPrf, pThis->uStatIntRDTR));
6149 LogRel(("%s Interrupts by RDMT: %d\n", pThis->szPrf, pThis->uStatIntRXDMT0));
6150 LogRel(("%s Interrupts by TXQE: %d\n", pThis->szPrf, pThis->uStatIntTXQE));
6151 LogRel(("%s TX int delay asked: %d\n", pThis->szPrf, pThis->uStatTxIDE));
6152 LogRel(("%s TX delayed: %d\n", pThis->szPrf, pThis->uStatTxDelayed));
6153 LogRel(("%s TX delay expired: %d\n", pThis->szPrf, pThis->uStatTxDelayExp));
6154 LogRel(("%s TX no report asked: %d\n", pThis->szPrf, pThis->uStatTxNoRS));
6155 LogRel(("%s TX abs timer expd : %d\n", pThis->szPrf, pThis->uStatTAD));
6156 LogRel(("%s TX int timer expd : %d\n", pThis->szPrf, pThis->uStatTID));
6157 LogRel(("%s RX abs timer expd : %d\n", pThis->szPrf, pThis->uStatRAD));
6158 LogRel(("%s RX int timer expd : %d\n", pThis->szPrf, pThis->uStatRID));
6159 LogRel(("%s TX CTX descriptors: %d\n", pThis->szPrf, pThis->uStatDescCtx));
6160 LogRel(("%s TX DAT descriptors: %d\n", pThis->szPrf, pThis->uStatDescDat));
6161 LogRel(("%s TX LEG descriptors: %d\n", pThis->szPrf, pThis->uStatDescLeg));
6162 LogRel(("%s Received frames : %d\n", pThis->szPrf, pThis->uStatRxFrm));
6163 LogRel(("%s Transmitted frames: %d\n", pThis->szPrf, pThis->uStatTxFrm));
6164 LogRel(("%s TX frames up to 1514: %d\n", pThis->szPrf, pThis->uStatTx1514));
6165 LogRel(("%s TX frames up to 2962: %d\n", pThis->szPrf, pThis->uStatTx2962));
6166 LogRel(("%s TX frames up to 4410: %d\n", pThis->szPrf, pThis->uStatTx4410));
6167 LogRel(("%s TX frames up to 5858: %d\n", pThis->szPrf, pThis->uStatTx5858));
6168 LogRel(("%s TX frames up to 7306: %d\n", pThis->szPrf, pThis->uStatTx7306));
6169 LogRel(("%s TX frames up to 8754: %d\n", pThis->szPrf, pThis->uStatTx8754));
6170 LogRel(("%s TX frames up to 16384: %d\n", pThis->szPrf, pThis->uStatTx16384));
6171 LogRel(("%s TX frames up to 32768: %d\n", pThis->szPrf, pThis->uStatTx32768));
6172 LogRel(("%s Larger TX frames : %d\n", pThis->szPrf, pThis->uStatTxLarge));
6173 LogRel(("%s Max TX Delay : %lld\n", pThis->szPrf, pThis->uStatMaxTxDelay));
6174# endif /* E1K_INT_STATS */
6175}
6176
6177/**
6178 * @callback_method_impl{FNPCIIOREGIONMAP}
6179 */
6180static DECLCALLBACK(int) e1kMap(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t iRegion,
6181 RTGCPHYS GCPhysAddress, RTGCPHYS cb, PCIADDRESSSPACE enmType)
6182{
6183 RT_NOREF(pPciDev, iRegion);
6184 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE *);
6185 int rc;
6186
6187 switch (enmType)
6188 {
6189 case PCI_ADDRESS_SPACE_IO:
6190 pThis->IOPortBase = (RTIOPORT)GCPhysAddress;
6191 rc = PDMDevHlpIOPortRegister(pDevIns, pThis->IOPortBase, cb, NULL /*pvUser*/,
6192 e1kIOPortOut, e1kIOPortIn, NULL, NULL, "E1000");
6193 if (pThis->fR0Enabled && RT_SUCCESS(rc))
6194 rc = PDMDevHlpIOPortRegisterR0(pDevIns, pThis->IOPortBase, cb, NIL_RTR0PTR /*pvUser*/,
6195 "e1kIOPortOut", "e1kIOPortIn", NULL, NULL, "E1000");
6196 if (pThis->fRCEnabled && RT_SUCCESS(rc))
6197 rc = PDMDevHlpIOPortRegisterRC(pDevIns, pThis->IOPortBase, cb, NIL_RTRCPTR /*pvUser*/,
6198 "e1kIOPortOut", "e1kIOPortIn", NULL, NULL, "E1000");
6199 break;
6200
6201 case PCI_ADDRESS_SPACE_MEM:
6202 /*
6203 * From the spec:
6204 * For registers that should be accessed as 32-bit double words,
6205 * partial writes (less than a 32-bit double word) is ignored.
6206 * Partial reads return all 32 bits of data regardless of the
6207 * byte enables.
6208 */
6209#ifdef E1K_WITH_PREREG_MMIO
6210 pThis->addrMMReg = GCPhysAddress;
6211 if (GCPhysAddress == NIL_RTGCPHYS)
6212 rc = VINF_SUCCESS;
6213 else
6214 {
6215 Assert(!(GCPhysAddress & 7));
6216 rc = PDMDevHlpMMIOExMap(pDevIns, pPciDev, iRegion, GCPhysAddress);
6217 }
6218#else
6219 pThis->addrMMReg = GCPhysAddress; Assert(!(GCPhysAddress & 7));
6220 rc = PDMDevHlpMMIORegister(pDevIns, GCPhysAddress, cb, NULL /*pvUser*/,
6221 IOMMMIO_FLAGS_READ_DWORD | IOMMMIO_FLAGS_WRITE_ONLY_DWORD,
6222 e1kMMIOWrite, e1kMMIORead, "E1000");
6223 if (pThis->fR0Enabled && RT_SUCCESS(rc))
6224 rc = PDMDevHlpMMIORegisterR0(pDevIns, GCPhysAddress, cb, NIL_RTR0PTR /*pvUser*/,
6225 "e1kMMIOWrite", "e1kMMIORead");
6226 if (pThis->fRCEnabled && RT_SUCCESS(rc))
6227 rc = PDMDevHlpMMIORegisterRC(pDevIns, GCPhysAddress, cb, NIL_RTRCPTR /*pvUser*/,
6228 "e1kMMIOWrite", "e1kMMIORead");
6229#endif
6230 break;
6231
6232 default:
6233 /* We should never get here */
6234 AssertMsgFailed(("Invalid PCI address space param in map callback"));
6235 rc = VERR_INTERNAL_ERROR;
6236 break;
6237 }
6238 return rc;
6239}
6240
6241
6242/* -=-=-=-=- PDMINETWORKDOWN -=-=-=-=- */
6243
6244/**
6245 * Check if the device can receive data now.
6246 * This must be called before the pfnRecieve() method is called.
6247 *
6248 * @returns Number of bytes the device can receive.
6249 * @param pInterface Pointer to the interface structure containing the called function pointer.
6250 * @thread EMT
6251 */
6252static int e1kCanReceive(PE1KSTATE pThis)
6253{
6254#ifndef E1K_WITH_RXD_CACHE
6255 size_t cb;
6256
6257 if (RT_UNLIKELY(e1kCsRxEnter(pThis, VERR_SEM_BUSY) != VINF_SUCCESS))
6258 return VERR_NET_NO_BUFFER_SPACE;
6259
6260 if (RT_UNLIKELY(RDLEN == sizeof(E1KRXDESC)))
6261 {
6262 E1KRXDESC desc;
6263 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), e1kDescAddr(RDBAH, RDBAL, RDH),
6264 &desc, sizeof(desc));
6265 if (desc.status.fDD)
6266 cb = 0;
6267 else
6268 cb = pThis->u16RxBSize;
6269 }
6270 else if (RDH < RDT)
6271 cb = (RDT - RDH) * pThis->u16RxBSize;
6272 else if (RDH > RDT)
6273 cb = (RDLEN/sizeof(E1KRXDESC) - RDH + RDT) * pThis->u16RxBSize;
6274 else
6275 {
6276 cb = 0;
6277 E1kLogRel(("E1000: OUT of RX descriptors!\n"));
6278 }
6279 E1kLog2(("%s e1kCanReceive: at exit RDH=%d RDT=%d RDLEN=%d u16RxBSize=%d cb=%lu\n",
6280 pThis->szPrf, RDH, RDT, RDLEN, pThis->u16RxBSize, cb));
6281
6282 e1kCsRxLeave(pThis);
6283 return cb > 0 ? VINF_SUCCESS : VERR_NET_NO_BUFFER_SPACE;
6284#else /* E1K_WITH_RXD_CACHE */
6285 int rc = VINF_SUCCESS;
6286
6287 if (RT_UNLIKELY(e1kCsRxEnter(pThis, VERR_SEM_BUSY) != VINF_SUCCESS))
6288 return VERR_NET_NO_BUFFER_SPACE;
6289
6290 if (RT_UNLIKELY(RDLEN == sizeof(E1KRXDESC)))
6291 {
6292 E1KRXDESC desc;
6293 PDMDevHlpPhysRead(pThis->CTX_SUFF(pDevIns), e1kDescAddr(RDBAH, RDBAL, RDH),
6294 &desc, sizeof(desc));
6295 if (desc.status.fDD)
6296 rc = VERR_NET_NO_BUFFER_SPACE;
6297 }
6298 else if (e1kRxDIsCacheEmpty(pThis) && RDH == RDT)
6299 {
6300 /* Cache is empty, so is the RX ring. */
6301 rc = VERR_NET_NO_BUFFER_SPACE;
6302 }
6303 E1kLog2(("%s e1kCanReceive: at exit in_cache=%d RDH=%d RDT=%d RDLEN=%d"
6304 " u16RxBSize=%d rc=%Rrc\n", pThis->szPrf,
6305 e1kRxDInCache(pThis), RDH, RDT, RDLEN, pThis->u16RxBSize, rc));
6306
6307 e1kCsRxLeave(pThis);
6308 return rc;
6309#endif /* E1K_WITH_RXD_CACHE */
6310}
6311
6312/**
6313 * @interface_method_impl{PDMINETWORKDOWN,pfnWaitReceiveAvail}
6314 */
6315static DECLCALLBACK(int) e1kR3NetworkDown_WaitReceiveAvail(PPDMINETWORKDOWN pInterface, RTMSINTERVAL cMillies)
6316{
6317 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, INetworkDown);
6318 int rc = e1kCanReceive(pThis);
6319
6320 if (RT_SUCCESS(rc))
6321 return VINF_SUCCESS;
6322 if (RT_UNLIKELY(cMillies == 0))
6323 return VERR_NET_NO_BUFFER_SPACE;
6324
6325 rc = VERR_INTERRUPTED;
6326 ASMAtomicXchgBool(&pThis->fMaybeOutOfSpace, true);
6327 STAM_PROFILE_START(&pThis->StatRxOverflow, a);
6328 VMSTATE enmVMState;
6329 while (RT_LIKELY( (enmVMState = PDMDevHlpVMState(pThis->CTX_SUFF(pDevIns))) == VMSTATE_RUNNING
6330 || enmVMState == VMSTATE_RUNNING_LS))
6331 {
6332 int rc2 = e1kCanReceive(pThis);
6333 if (RT_SUCCESS(rc2))
6334 {
6335 rc = VINF_SUCCESS;
6336 break;
6337 }
6338 E1kLogRel(("E1000 e1kR3NetworkDown_WaitReceiveAvail: waiting cMillies=%u...\n", cMillies));
6339 E1kLog(("%s e1kR3NetworkDown_WaitReceiveAvail: waiting cMillies=%u...\n", pThis->szPrf, cMillies));
6340 RTSemEventWait(pThis->hEventMoreRxDescAvail, cMillies);
6341 }
6342 STAM_PROFILE_STOP(&pThis->StatRxOverflow, a);
6343 ASMAtomicXchgBool(&pThis->fMaybeOutOfSpace, false);
6344
6345 return rc;
6346}
6347
6348
6349/**
6350 * Matches the packet addresses against Receive Address table. Looks for
6351 * exact matches only.
6352 *
6353 * @returns true if address matches.
6354 * @param pThis Pointer to the state structure.
6355 * @param pvBuf The ethernet packet.
6356 * @param cb Number of bytes available in the packet.
6357 * @thread EMT
6358 */
6359static bool e1kPerfectMatch(PE1KSTATE pThis, const void *pvBuf)
6360{
6361 for (unsigned i = 0; i < RT_ELEMENTS(pThis->aRecAddr.array); i++)
6362 {
6363 E1KRAELEM* ra = pThis->aRecAddr.array + i;
6364
6365 /* Valid address? */
6366 if (ra->ctl & RA_CTL_AV)
6367 {
6368 Assert((ra->ctl & RA_CTL_AS) < 2);
6369 //unsigned char *pAddr = (unsigned char*)pvBuf + sizeof(ra->addr)*(ra->ctl & RA_CTL_AS);
6370 //E1kLog3(("%s Matching %02x:%02x:%02x:%02x:%02x:%02x against %02x:%02x:%02x:%02x:%02x:%02x...\n",
6371 // pThis->szPrf, pAddr[0], pAddr[1], pAddr[2], pAddr[3], pAddr[4], pAddr[5],
6372 // ra->addr[0], ra->addr[1], ra->addr[2], ra->addr[3], ra->addr[4], ra->addr[5]));
6373 /*
6374 * Address Select:
6375 * 00b = Destination address
6376 * 01b = Source address
6377 * 10b = Reserved
6378 * 11b = Reserved
6379 * Since ethernet header is (DA, SA, len) we can use address
6380 * select as index.
6381 */
6382 if (memcmp((char*)pvBuf + sizeof(ra->addr)*(ra->ctl & RA_CTL_AS),
6383 ra->addr, sizeof(ra->addr)) == 0)
6384 return true;
6385 }
6386 }
6387
6388 return false;
6389}
6390
6391/**
6392 * Matches the packet addresses against Multicast Table Array.
6393 *
6394 * @remarks This is imperfect match since it matches not exact address but
6395 * a subset of addresses.
6396 *
6397 * @returns true if address matches.
6398 * @param pThis Pointer to the state structure.
6399 * @param pvBuf The ethernet packet.
6400 * @param cb Number of bytes available in the packet.
6401 * @thread EMT
6402 */
6403static bool e1kImperfectMatch(PE1KSTATE pThis, const void *pvBuf)
6404{
6405 /* Get bits 32..47 of destination address */
6406 uint16_t u16Bit = ((uint16_t*)pvBuf)[2];
6407
6408 unsigned offset = GET_BITS(RCTL, MO);
6409 /*
6410 * offset means:
6411 * 00b = bits 36..47
6412 * 01b = bits 35..46
6413 * 10b = bits 34..45
6414 * 11b = bits 32..43
6415 */
6416 if (offset < 3)
6417 u16Bit = u16Bit >> (4 - offset);
6418 return ASMBitTest(pThis->auMTA, u16Bit & 0xFFF);
6419}
6420
6421/**
6422 * Determines if the packet is to be delivered to upper layer.
6423 *
6424 * The following filters supported:
6425 * - Exact Unicast/Multicast
6426 * - Promiscuous Unicast/Multicast
6427 * - Multicast
6428 * - VLAN
6429 *
6430 * @returns true if packet is intended for this node.
6431 * @param pThis Pointer to the state structure.
6432 * @param pvBuf The ethernet packet.
6433 * @param cb Number of bytes available in the packet.
6434 * @param pStatus Bit field to store status bits.
6435 * @thread EMT
6436 */
6437static bool e1kAddressFilter(PE1KSTATE pThis, const void *pvBuf, size_t cb, E1KRXDST *pStatus)
6438{
6439 Assert(cb > 14);
6440 /* Assume that we fail to pass exact filter. */
6441 pStatus->fPIF = false;
6442 pStatus->fVP = false;
6443 /* Discard oversized packets */
6444 if (cb > E1K_MAX_RX_PKT_SIZE)
6445 {
6446 E1kLog(("%s ERROR: Incoming packet is too big, cb=%d > max=%d\n",
6447 pThis->szPrf, cb, E1K_MAX_RX_PKT_SIZE));
6448 E1K_INC_CNT32(ROC);
6449 return false;
6450 }
6451 else if (!(RCTL & RCTL_LPE) && cb > 1522)
6452 {
6453 /* When long packet reception is disabled packets over 1522 are discarded */
6454 E1kLog(("%s Discarding incoming packet (LPE=0), cb=%d\n",
6455 pThis->szPrf, cb));
6456 E1K_INC_CNT32(ROC);
6457 return false;
6458 }
6459
6460 uint16_t *u16Ptr = (uint16_t*)pvBuf;
6461 /* Compare TPID with VLAN Ether Type */
6462 if (RT_BE2H_U16(u16Ptr[6]) == VET)
6463 {
6464 pStatus->fVP = true;
6465 /* Is VLAN filtering enabled? */
6466 if (RCTL & RCTL_VFE)
6467 {
6468 /* It is 802.1q packet indeed, let's filter by VID */
6469 if (RCTL & RCTL_CFIEN)
6470 {
6471 E1kLog3(("%s VLAN filter: VLAN=%d CFI=%d RCTL_CFI=%d\n", pThis->szPrf,
6472 E1K_SPEC_VLAN(RT_BE2H_U16(u16Ptr[7])),
6473 E1K_SPEC_CFI(RT_BE2H_U16(u16Ptr[7])),
6474 !!(RCTL & RCTL_CFI)));
6475 if (E1K_SPEC_CFI(RT_BE2H_U16(u16Ptr[7])) != !!(RCTL & RCTL_CFI))
6476 {
6477 E1kLog2(("%s Packet filter: CFIs do not match in packet and RCTL (%d!=%d)\n",
6478 pThis->szPrf, E1K_SPEC_CFI(RT_BE2H_U16(u16Ptr[7])), !!(RCTL & RCTL_CFI)));
6479 return false;
6480 }
6481 }
6482 else
6483 E1kLog3(("%s VLAN filter: VLAN=%d\n", pThis->szPrf,
6484 E1K_SPEC_VLAN(RT_BE2H_U16(u16Ptr[7]))));
6485 if (!ASMBitTest(pThis->auVFTA, E1K_SPEC_VLAN(RT_BE2H_U16(u16Ptr[7]))))
6486 {
6487 E1kLog2(("%s Packet filter: no VLAN match (id=%d)\n",
6488 pThis->szPrf, E1K_SPEC_VLAN(RT_BE2H_U16(u16Ptr[7]))));
6489 return false;
6490 }
6491 }
6492 }
6493 /* Broadcast filtering */
6494 if (e1kIsBroadcast(pvBuf) && (RCTL & RCTL_BAM))
6495 return true;
6496 E1kLog2(("%s Packet filter: not a broadcast\n", pThis->szPrf));
6497 if (e1kIsMulticast(pvBuf))
6498 {
6499 /* Is multicast promiscuous enabled? */
6500 if (RCTL & RCTL_MPE)
6501 return true;
6502 E1kLog2(("%s Packet filter: no promiscuous multicast\n", pThis->szPrf));
6503 /* Try perfect matches first */
6504 if (e1kPerfectMatch(pThis, pvBuf))
6505 {
6506 pStatus->fPIF = true;
6507 return true;
6508 }
6509 E1kLog2(("%s Packet filter: no perfect match\n", pThis->szPrf));
6510 if (e1kImperfectMatch(pThis, pvBuf))
6511 return true;
6512 E1kLog2(("%s Packet filter: no imperfect match\n", pThis->szPrf));
6513 }
6514 else {
6515 /* Is unicast promiscuous enabled? */
6516 if (RCTL & RCTL_UPE)
6517 return true;
6518 E1kLog2(("%s Packet filter: no promiscuous unicast\n", pThis->szPrf));
6519 if (e1kPerfectMatch(pThis, pvBuf))
6520 {
6521 pStatus->fPIF = true;
6522 return true;
6523 }
6524 E1kLog2(("%s Packet filter: no perfect match\n", pThis->szPrf));
6525 }
6526 E1kLog2(("%s Packet filter: packet discarded\n", pThis->szPrf));
6527 return false;
6528}
6529
6530/**
6531 * @interface_method_impl{PDMINETWORKDOWN,pfnReceive}
6532 */
6533static DECLCALLBACK(int) e1kR3NetworkDown_Receive(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb)
6534{
6535 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, INetworkDown);
6536 int rc = VINF_SUCCESS;
6537
6538 /*
6539 * Drop packets if the VM is not running yet/anymore.
6540 */
6541 VMSTATE enmVMState = PDMDevHlpVMState(STATE_TO_DEVINS(pThis));
6542 if ( enmVMState != VMSTATE_RUNNING
6543 && enmVMState != VMSTATE_RUNNING_LS)
6544 {
6545 E1kLog(("%s Dropping incoming packet as VM is not running.\n", pThis->szPrf));
6546 return VINF_SUCCESS;
6547 }
6548
6549 /* Discard incoming packets in locked state */
6550 if (!(RCTL & RCTL_EN) || pThis->fLocked || !(STATUS & STATUS_LU))
6551 {
6552 E1kLog(("%s Dropping incoming packet as receive operation is disabled.\n", pThis->szPrf));
6553 return VINF_SUCCESS;
6554 }
6555
6556 STAM_PROFILE_ADV_START(&pThis->StatReceive, a);
6557
6558 //if (!e1kCsEnter(pThis, RT_SRC_POS))
6559 // return VERR_PERMISSION_DENIED;
6560
6561 e1kPacketDump(pThis, (const uint8_t*)pvBuf, cb, "<-- Incoming");
6562
6563 /* Update stats */
6564 if (RT_LIKELY(e1kCsEnter(pThis, VERR_SEM_BUSY) == VINF_SUCCESS))
6565 {
6566 E1K_INC_CNT32(TPR);
6567 E1K_ADD_CNT64(TORL, TORH, cb < 64? 64 : cb);
6568 e1kCsLeave(pThis);
6569 }
6570 STAM_PROFILE_ADV_START(&pThis->StatReceiveFilter, a);
6571 E1KRXDST status;
6572 RT_ZERO(status);
6573 bool fPassed = e1kAddressFilter(pThis, pvBuf, cb, &status);
6574 STAM_PROFILE_ADV_STOP(&pThis->StatReceiveFilter, a);
6575 if (fPassed)
6576 {
6577 rc = e1kHandleRxPacket(pThis, pvBuf, cb, status);
6578 }
6579 //e1kCsLeave(pThis);
6580 STAM_PROFILE_ADV_STOP(&pThis->StatReceive, a);
6581
6582 return rc;
6583}
6584
6585
6586/* -=-=-=-=- PDMILEDPORTS -=-=-=-=- */
6587
6588/**
6589 * @interface_method_impl{PDMILEDPORTS,pfnQueryStatusLed}
6590 */
6591static DECLCALLBACK(int) e1kR3QueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
6592{
6593 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, ILeds);
6594 int rc = VERR_PDM_LUN_NOT_FOUND;
6595
6596 if (iLUN == 0)
6597 {
6598 *ppLed = &pThis->led;
6599 rc = VINF_SUCCESS;
6600 }
6601 return rc;
6602}
6603
6604
6605/* -=-=-=-=- PDMINETWORKCONFIG -=-=-=-=- */
6606
6607/**
6608 * @interface_method_impl{PDMINETWORKCONFIG,pfnGetMac}
6609 */
6610static DECLCALLBACK(int) e1kR3GetMac(PPDMINETWORKCONFIG pInterface, PRTMAC pMac)
6611{
6612 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, INetworkConfig);
6613 pThis->eeprom.getMac(pMac);
6614 return VINF_SUCCESS;
6615}
6616
6617/**
6618 * @interface_method_impl{PDMINETWORKCONFIG,pfnGetLinkState}
6619 */
6620static DECLCALLBACK(PDMNETWORKLINKSTATE) e1kR3GetLinkState(PPDMINETWORKCONFIG pInterface)
6621{
6622 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, INetworkConfig);
6623 if (STATUS & STATUS_LU)
6624 return PDMNETWORKLINKSTATE_UP;
6625 return PDMNETWORKLINKSTATE_DOWN;
6626}
6627
6628/**
6629 * @interface_method_impl{PDMINETWORKCONFIG,pfnSetLinkState}
6630 */
6631static DECLCALLBACK(int) e1kR3SetLinkState(PPDMINETWORKCONFIG pInterface, PDMNETWORKLINKSTATE enmState)
6632{
6633 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, INetworkConfig);
6634
6635 E1kLog(("%s e1kR3SetLinkState: enmState=%d\n", pThis->szPrf, enmState));
6636 switch (enmState)
6637 {
6638 case PDMNETWORKLINKSTATE_UP:
6639 pThis->fCableConnected = true;
6640 /* If link was down, bring it up after a while. */
6641 if (!(STATUS & STATUS_LU))
6642 e1kBringLinkUpDelayed(pThis);
6643 break;
6644 case PDMNETWORKLINKSTATE_DOWN:
6645 pThis->fCableConnected = false;
6646 /* Always set the phy link state to down, regardless of the STATUS_LU bit.
6647 * We might have to set the link state before the driver initializes us. */
6648 Phy::setLinkStatus(&pThis->phy, false);
6649 /* If link was up, bring it down. */
6650 if (STATUS & STATUS_LU)
6651 e1kR3LinkDown(pThis);
6652 break;
6653 case PDMNETWORKLINKSTATE_DOWN_RESUME:
6654 /*
6655 * There is not much sense in bringing down the link if it has not come up yet.
6656 * If it is up though, we bring it down temporarely, then bring it up again.
6657 */
6658 if (STATUS & STATUS_LU)
6659 e1kR3LinkDownTemp(pThis);
6660 break;
6661 default:
6662 ;
6663 }
6664 return VINF_SUCCESS;
6665}
6666
6667
6668/* -=-=-=-=- PDMIBASE -=-=-=-=- */
6669
6670/**
6671 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
6672 */
6673static DECLCALLBACK(void *) e1kR3QueryInterface(struct PDMIBASE *pInterface, const char *pszIID)
6674{
6675 PE1KSTATE pThis = RT_FROM_MEMBER(pInterface, E1KSTATE, IBase);
6676 Assert(&pThis->IBase == pInterface);
6677
6678 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->IBase);
6679 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKDOWN, &pThis->INetworkDown);
6680 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKCONFIG, &pThis->INetworkConfig);
6681 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThis->ILeds);
6682 return NULL;
6683}
6684
6685
6686/* -=-=-=-=- Saved State -=-=-=-=- */
6687
6688/**
6689 * Saves the configuration.
6690 *
6691 * @param pThis The E1K state.
6692 * @param pSSM The handle to the saved state.
6693 */
6694static void e1kSaveConfig(PE1KSTATE pThis, PSSMHANDLE pSSM)
6695{
6696 SSMR3PutMem(pSSM, &pThis->macConfigured, sizeof(pThis->macConfigured));
6697 SSMR3PutU32(pSSM, pThis->eChip);
6698}
6699
6700/**
6701 * @callback_method_impl{FNSSMDEVLIVEEXEC,Save basic configuration.}
6702 */
6703static DECLCALLBACK(int) e1kLiveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uPass)
6704{
6705 RT_NOREF(uPass);
6706 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
6707 e1kSaveConfig(pThis, pSSM);
6708 return VINF_SSM_DONT_CALL_AGAIN;
6709}
6710
6711/**
6712 * @callback_method_impl{FNSSMDEVSAVEPREP,Synchronize.}
6713 */
6714static DECLCALLBACK(int) e1kSavePrep(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
6715{
6716 RT_NOREF(pSSM);
6717 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
6718
6719 int rc = e1kCsEnter(pThis, VERR_SEM_BUSY);
6720 if (RT_UNLIKELY(rc != VINF_SUCCESS))
6721 return rc;
6722 e1kCsLeave(pThis);
6723 return VINF_SUCCESS;
6724#if 0
6725 /* 1) Prevent all threads from modifying the state and memory */
6726 //pThis->fLocked = true;
6727 /* 2) Cancel all timers */
6728#ifdef E1K_TX_DELAY
6729 e1kCancelTimer(pThis, pThis->CTX_SUFF(pTXDTimer));
6730#endif /* E1K_TX_DELAY */
6731//#ifdef E1K_USE_TX_TIMERS
6732 if (pThis->fTidEnabled)
6733 {
6734 e1kCancelTimer(pThis, pThis->CTX_SUFF(pTIDTimer));
6735#ifndef E1K_NO_TAD
6736 e1kCancelTimer(pThis, pThis->CTX_SUFF(pTADTimer));
6737#endif /* E1K_NO_TAD */
6738 }
6739//#endif /* E1K_USE_TX_TIMERS */
6740#ifdef E1K_USE_RX_TIMERS
6741 e1kCancelTimer(pThis, pThis->CTX_SUFF(pRIDTimer));
6742 e1kCancelTimer(pThis, pThis->CTX_SUFF(pRADTimer));
6743#endif /* E1K_USE_RX_TIMERS */
6744 e1kCancelTimer(pThis, pThis->CTX_SUFF(pIntTimer));
6745 /* 3) Did I forget anything? */
6746 E1kLog(("%s Locked\n", pThis->szPrf));
6747 return VINF_SUCCESS;
6748#endif
6749}
6750
6751/**
6752 * @callback_method_impl{FNSSMDEVSAVEEXEC}
6753 */
6754static DECLCALLBACK(int) e1kSaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
6755{
6756 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
6757
6758 e1kSaveConfig(pThis, pSSM);
6759 pThis->eeprom.save(pSSM);
6760 e1kDumpState(pThis);
6761 SSMR3PutMem(pSSM, pThis->auRegs, sizeof(pThis->auRegs));
6762 SSMR3PutBool(pSSM, pThis->fIntRaised);
6763 Phy::saveState(pSSM, &pThis->phy);
6764 SSMR3PutU32(pSSM, pThis->uSelectedReg);
6765 SSMR3PutMem(pSSM, pThis->auMTA, sizeof(pThis->auMTA));
6766 SSMR3PutMem(pSSM, &pThis->aRecAddr, sizeof(pThis->aRecAddr));
6767 SSMR3PutMem(pSSM, pThis->auVFTA, sizeof(pThis->auVFTA));
6768 SSMR3PutU64(pSSM, pThis->u64AckedAt);
6769 SSMR3PutU16(pSSM, pThis->u16RxBSize);
6770 //SSMR3PutBool(pSSM, pThis->fDelayInts);
6771 //SSMR3PutBool(pSSM, pThis->fIntMaskUsed);
6772 SSMR3PutU16(pSSM, pThis->u16TxPktLen);
6773/** @todo State wrt to the TSE buffer is incomplete, so little point in
6774 * saving this actually. */
6775 SSMR3PutMem(pSSM, pThis->aTxPacketFallback, pThis->u16TxPktLen);
6776 SSMR3PutBool(pSSM, pThis->fIPcsum);
6777 SSMR3PutBool(pSSM, pThis->fTCPcsum);
6778 SSMR3PutMem(pSSM, &pThis->contextTSE, sizeof(pThis->contextTSE));
6779 SSMR3PutMem(pSSM, &pThis->contextNormal, sizeof(pThis->contextNormal));
6780 SSMR3PutBool(pSSM, pThis->fVTag);
6781 SSMR3PutU16(pSSM, pThis->u16VTagTCI);
6782#ifdef E1K_WITH_TXD_CACHE
6783#if 0
6784 SSMR3PutU8(pSSM, pThis->nTxDFetched);
6785 SSMR3PutMem(pSSM, pThis->aTxDescriptors,
6786 pThis->nTxDFetched * sizeof(pThis->aTxDescriptors[0]));
6787#else
6788 /*
6789 * There is no point in storing TX descriptor cache entries as we can simply
6790 * fetch them again. Moreover, normally the cache is always empty when we
6791 * save the state. Store zero entries for compatibility.
6792 */
6793 SSMR3PutU8(pSSM, 0);
6794#endif
6795#endif /* E1K_WITH_TXD_CACHE */
6796/** @todo GSO requires some more state here. */
6797 E1kLog(("%s State has been saved\n", pThis->szPrf));
6798 return VINF_SUCCESS;
6799}
6800
6801#if 0
6802/**
6803 * @callback_method_impl{FNSSMDEVSAVEDONE}
6804 */
6805static DECLCALLBACK(int) e1kSaveDone(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
6806{
6807 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
6808
6809 /* If VM is being powered off unlocking will result in assertions in PGM */
6810 if (PDMDevHlpGetVM(pDevIns)->enmVMState == VMSTATE_RUNNING)
6811 pThis->fLocked = false;
6812 else
6813 E1kLog(("%s VM is not running -- remain locked\n", pThis->szPrf));
6814 E1kLog(("%s Unlocked\n", pThis->szPrf));
6815 return VINF_SUCCESS;
6816}
6817#endif
6818
6819/**
6820 * @callback_method_impl{FNSSMDEVLOADPREP,Synchronize.}
6821 */
6822static DECLCALLBACK(int) e1kLoadPrep(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
6823{
6824 RT_NOREF(pSSM);
6825 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
6826
6827 int rc = e1kCsEnter(pThis, VERR_SEM_BUSY);
6828 if (RT_UNLIKELY(rc != VINF_SUCCESS))
6829 return rc;
6830 e1kCsLeave(pThis);
6831 return VINF_SUCCESS;
6832}
6833
6834/**
6835 * @callback_method_impl{FNSSMDEVLOADEXEC}
6836 */
6837static DECLCALLBACK(int) e1kLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
6838{
6839 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
6840 int rc;
6841
6842 if ( uVersion != E1K_SAVEDSTATE_VERSION
6843#ifdef E1K_WITH_TXD_CACHE
6844 && uVersion != E1K_SAVEDSTATE_VERSION_VBOX_42_VTAG
6845#endif /* E1K_WITH_TXD_CACHE */
6846 && uVersion != E1K_SAVEDSTATE_VERSION_VBOX_41
6847 && uVersion != E1K_SAVEDSTATE_VERSION_VBOX_30)
6848 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
6849
6850 if ( uVersion > E1K_SAVEDSTATE_VERSION_VBOX_30
6851 || uPass != SSM_PASS_FINAL)
6852 {
6853 /* config checks */
6854 RTMAC macConfigured;
6855 rc = SSMR3GetMem(pSSM, &macConfigured, sizeof(macConfigured));
6856 AssertRCReturn(rc, rc);
6857 if ( memcmp(&macConfigured, &pThis->macConfigured, sizeof(macConfigured))
6858 && (uPass == 0 || !PDMDevHlpVMTeleportedAndNotFullyResumedYet(pDevIns)) )
6859 LogRel(("%s: The mac address differs: config=%RTmac saved=%RTmac\n", pThis->szPrf, &pThis->macConfigured, &macConfigured));
6860
6861 E1KCHIP eChip;
6862 rc = SSMR3GetU32(pSSM, &eChip);
6863 AssertRCReturn(rc, rc);
6864 if (eChip != pThis->eChip)
6865 return SSMR3SetCfgError(pSSM, RT_SRC_POS, N_("The chip type differs: config=%u saved=%u"), pThis->eChip, eChip);
6866 }
6867
6868 if (uPass == SSM_PASS_FINAL)
6869 {
6870 if (uVersion > E1K_SAVEDSTATE_VERSION_VBOX_30)
6871 {
6872 rc = pThis->eeprom.load(pSSM);
6873 AssertRCReturn(rc, rc);
6874 }
6875 /* the state */
6876 SSMR3GetMem(pSSM, &pThis->auRegs, sizeof(pThis->auRegs));
6877 SSMR3GetBool(pSSM, &pThis->fIntRaised);
6878 /** @todo PHY could be made a separate device with its own versioning */
6879 Phy::loadState(pSSM, &pThis->phy);
6880 SSMR3GetU32(pSSM, &pThis->uSelectedReg);
6881 SSMR3GetMem(pSSM, &pThis->auMTA, sizeof(pThis->auMTA));
6882 SSMR3GetMem(pSSM, &pThis->aRecAddr, sizeof(pThis->aRecAddr));
6883 SSMR3GetMem(pSSM, &pThis->auVFTA, sizeof(pThis->auVFTA));
6884 SSMR3GetU64(pSSM, &pThis->u64AckedAt);
6885 SSMR3GetU16(pSSM, &pThis->u16RxBSize);
6886 //SSMR3GetBool(pSSM, pThis->fDelayInts);
6887 //SSMR3GetBool(pSSM, pThis->fIntMaskUsed);
6888 SSMR3GetU16(pSSM, &pThis->u16TxPktLen);
6889 SSMR3GetMem(pSSM, &pThis->aTxPacketFallback[0], pThis->u16TxPktLen);
6890 SSMR3GetBool(pSSM, &pThis->fIPcsum);
6891 SSMR3GetBool(pSSM, &pThis->fTCPcsum);
6892 SSMR3GetMem(pSSM, &pThis->contextTSE, sizeof(pThis->contextTSE));
6893 rc = SSMR3GetMem(pSSM, &pThis->contextNormal, sizeof(pThis->contextNormal));
6894 AssertRCReturn(rc, rc);
6895 if (uVersion > E1K_SAVEDSTATE_VERSION_VBOX_41)
6896 {
6897 SSMR3GetBool(pSSM, &pThis->fVTag);
6898 rc = SSMR3GetU16(pSSM, &pThis->u16VTagTCI);
6899 AssertRCReturn(rc, rc);
6900 }
6901 else
6902 {
6903 pThis->fVTag = false;
6904 pThis->u16VTagTCI = 0;
6905 }
6906#ifdef E1K_WITH_TXD_CACHE
6907 if (uVersion > E1K_SAVEDSTATE_VERSION_VBOX_42_VTAG)
6908 {
6909 rc = SSMR3GetU8(pSSM, &pThis->nTxDFetched);
6910 AssertRCReturn(rc, rc);
6911 if (pThis->nTxDFetched)
6912 SSMR3GetMem(pSSM, pThis->aTxDescriptors,
6913 pThis->nTxDFetched * sizeof(pThis->aTxDescriptors[0]));
6914 }
6915 else
6916 pThis->nTxDFetched = 0;
6917 /*
6918 * @todo: Perhaps we should not store TXD cache as the entries can be
6919 * simply fetched again from guest's memory. Or can't they?
6920 */
6921#endif /* E1K_WITH_TXD_CACHE */
6922#ifdef E1K_WITH_RXD_CACHE
6923 /*
6924 * There is no point in storing the RX descriptor cache in the saved
6925 * state, we just need to make sure it is empty.
6926 */
6927 pThis->iRxDCurrent = pThis->nRxDFetched = 0;
6928#endif /* E1K_WITH_RXD_CACHE */
6929 /* derived state */
6930 e1kSetupGsoCtx(&pThis->GsoCtx, &pThis->contextTSE);
6931
6932 E1kLog(("%s State has been restored\n", pThis->szPrf));
6933 e1kDumpState(pThis);
6934 }
6935 return VINF_SUCCESS;
6936}
6937
6938/**
6939 * @callback_method_impl{FNSSMDEVLOADDONE, Link status adjustments after loading.}
6940 */
6941static DECLCALLBACK(int) e1kLoadDone(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
6942{
6943 RT_NOREF(pSSM);
6944 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
6945
6946 /* Update promiscuous mode */
6947 if (pThis->pDrvR3)
6948 pThis->pDrvR3->pfnSetPromiscuousMode(pThis->pDrvR3,
6949 !!(RCTL & (RCTL_UPE | RCTL_MPE)));
6950
6951 /*
6952 * Force the link down here, since PDMNETWORKLINKSTATE_DOWN_RESUME is never
6953 * passed to us. We go through all this stuff if the link was up and we
6954 * wasn't teleported.
6955 */
6956 if ( (STATUS & STATUS_LU)
6957 && !PDMDevHlpVMTeleportedAndNotFullyResumedYet(pDevIns)
6958 && pThis->cMsLinkUpDelay)
6959 {
6960 e1kR3LinkDownTemp(pThis);
6961 }
6962 return VINF_SUCCESS;
6963}
6964
6965
6966
6967/* -=-=-=-=- Debug Info + Log Types -=-=-=-=- */
6968
6969/**
6970 * @callback_method_impl{FNRTSTRFORMATTYPE}
6971 */
6972static DECLCALLBACK(size_t) e1kFmtRxDesc(PFNRTSTROUTPUT pfnOutput,
6973 void *pvArgOutput,
6974 const char *pszType,
6975 void const *pvValue,
6976 int cchWidth,
6977 int cchPrecision,
6978 unsigned fFlags,
6979 void *pvUser)
6980{
6981 RT_NOREF(cchWidth, cchPrecision, fFlags, pvUser);
6982 AssertReturn(strcmp(pszType, "e1krxd") == 0, 0);
6983 E1KRXDESC* pDesc = (E1KRXDESC*)pvValue;
6984 if (!pDesc)
6985 return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "NULL_RXD");
6986
6987 size_t cbPrintf = 0;
6988 cbPrintf += RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "Address=%16LX Length=%04X Csum=%04X\n",
6989 pDesc->u64BufAddr, pDesc->u16Length, pDesc->u16Checksum);
6990 cbPrintf += RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, " STA: %s %s %s %s %s %s %s ERR: %s %s %s %s SPECIAL: %s VLAN=%03x PRI=%x",
6991 pDesc->status.fPIF ? "PIF" : "pif",
6992 pDesc->status.fIPCS ? "IPCS" : "ipcs",
6993 pDesc->status.fTCPCS ? "TCPCS" : "tcpcs",
6994 pDesc->status.fVP ? "VP" : "vp",
6995 pDesc->status.fIXSM ? "IXSM" : "ixsm",
6996 pDesc->status.fEOP ? "EOP" : "eop",
6997 pDesc->status.fDD ? "DD" : "dd",
6998 pDesc->status.fRXE ? "RXE" : "rxe",
6999 pDesc->status.fIPE ? "IPE" : "ipe",
7000 pDesc->status.fTCPE ? "TCPE" : "tcpe",
7001 pDesc->status.fCE ? "CE" : "ce",
7002 E1K_SPEC_CFI(pDesc->status.u16Special) ? "CFI" :"cfi",
7003 E1K_SPEC_VLAN(pDesc->status.u16Special),
7004 E1K_SPEC_PRI(pDesc->status.u16Special));
7005 return cbPrintf;
7006}
7007
7008/**
7009 * @callback_method_impl{FNRTSTRFORMATTYPE}
7010 */
7011static DECLCALLBACK(size_t) e1kFmtTxDesc(PFNRTSTROUTPUT pfnOutput,
7012 void *pvArgOutput,
7013 const char *pszType,
7014 void const *pvValue,
7015 int cchWidth,
7016 int cchPrecision,
7017 unsigned fFlags,
7018 void *pvUser)
7019{
7020 RT_NOREF(cchWidth, cchPrecision, fFlags, pvUser);
7021 AssertReturn(strcmp(pszType, "e1ktxd") == 0, 0);
7022 E1KTXDESC *pDesc = (E1KTXDESC*)pvValue;
7023 if (!pDesc)
7024 return RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "NULL_TXD");
7025
7026 size_t cbPrintf = 0;
7027 switch (e1kGetDescType(pDesc))
7028 {
7029 case E1K_DTYP_CONTEXT:
7030 cbPrintf += RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "Type=Context\n"
7031 " IPCSS=%02X IPCSO=%02X IPCSE=%04X TUCSS=%02X TUCSO=%02X TUCSE=%04X\n"
7032 " TUCMD:%s%s%s %s %s PAYLEN=%04x HDRLEN=%04x MSS=%04x STA: %s",
7033 pDesc->context.ip.u8CSS, pDesc->context.ip.u8CSO, pDesc->context.ip.u16CSE,
7034 pDesc->context.tu.u8CSS, pDesc->context.tu.u8CSO, pDesc->context.tu.u16CSE,
7035 pDesc->context.dw2.fIDE ? " IDE":"",
7036 pDesc->context.dw2.fRS ? " RS" :"",
7037 pDesc->context.dw2.fTSE ? " TSE":"",
7038 pDesc->context.dw2.fIP ? "IPv4":"IPv6",
7039 pDesc->context.dw2.fTCP ? "TCP":"UDP",
7040 pDesc->context.dw2.u20PAYLEN,
7041 pDesc->context.dw3.u8HDRLEN,
7042 pDesc->context.dw3.u16MSS,
7043 pDesc->context.dw3.fDD?"DD":"");
7044 break;
7045 case E1K_DTYP_DATA:
7046 cbPrintf += RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "Type=Data Address=%16LX DTALEN=%05X\n"
7047 " DCMD:%s%s%s%s%s%s%s STA:%s%s%s POPTS:%s%s SPECIAL:%s VLAN=%03x PRI=%x",
7048 pDesc->data.u64BufAddr,
7049 pDesc->data.cmd.u20DTALEN,
7050 pDesc->data.cmd.fIDE ? " IDE" :"",
7051 pDesc->data.cmd.fVLE ? " VLE" :"",
7052 pDesc->data.cmd.fRPS ? " RPS" :"",
7053 pDesc->data.cmd.fRS ? " RS" :"",
7054 pDesc->data.cmd.fTSE ? " TSE" :"",
7055 pDesc->data.cmd.fIFCS? " IFCS":"",
7056 pDesc->data.cmd.fEOP ? " EOP" :"",
7057 pDesc->data.dw3.fDD ? " DD" :"",
7058 pDesc->data.dw3.fEC ? " EC" :"",
7059 pDesc->data.dw3.fLC ? " LC" :"",
7060 pDesc->data.dw3.fTXSM? " TXSM":"",
7061 pDesc->data.dw3.fIXSM? " IXSM":"",
7062 E1K_SPEC_CFI(pDesc->data.dw3.u16Special) ? "CFI" :"cfi",
7063 E1K_SPEC_VLAN(pDesc->data.dw3.u16Special),
7064 E1K_SPEC_PRI(pDesc->data.dw3.u16Special));
7065 break;
7066 case E1K_DTYP_LEGACY:
7067 cbPrintf += RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "Type=Legacy Address=%16LX DTALEN=%05X\n"
7068 " CMD:%s%s%s%s%s%s%s STA:%s%s%s CSO=%02x CSS=%02x SPECIAL:%s VLAN=%03x PRI=%x",
7069 pDesc->data.u64BufAddr,
7070 pDesc->legacy.cmd.u16Length,
7071 pDesc->legacy.cmd.fIDE ? " IDE" :"",
7072 pDesc->legacy.cmd.fVLE ? " VLE" :"",
7073 pDesc->legacy.cmd.fRPS ? " RPS" :"",
7074 pDesc->legacy.cmd.fRS ? " RS" :"",
7075 pDesc->legacy.cmd.fIC ? " IC" :"",
7076 pDesc->legacy.cmd.fIFCS? " IFCS":"",
7077 pDesc->legacy.cmd.fEOP ? " EOP" :"",
7078 pDesc->legacy.dw3.fDD ? " DD" :"",
7079 pDesc->legacy.dw3.fEC ? " EC" :"",
7080 pDesc->legacy.dw3.fLC ? " LC" :"",
7081 pDesc->legacy.cmd.u8CSO,
7082 pDesc->legacy.dw3.u8CSS,
7083 E1K_SPEC_CFI(pDesc->legacy.dw3.u16Special) ? "CFI" :"cfi",
7084 E1K_SPEC_VLAN(pDesc->legacy.dw3.u16Special),
7085 E1K_SPEC_PRI(pDesc->legacy.dw3.u16Special));
7086 break;
7087 default:
7088 cbPrintf += RTStrFormat(pfnOutput, pvArgOutput, NULL, 0, "Invalid Transmit Descriptor");
7089 break;
7090 }
7091
7092 return cbPrintf;
7093}
7094
7095/** Initializes debug helpers (logging format types). */
7096static int e1kInitDebugHelpers(void)
7097{
7098 int rc = VINF_SUCCESS;
7099 static bool s_fHelpersRegistered = false;
7100 if (!s_fHelpersRegistered)
7101 {
7102 s_fHelpersRegistered = true;
7103 rc = RTStrFormatTypeRegister("e1krxd", e1kFmtRxDesc, NULL);
7104 AssertRCReturn(rc, rc);
7105 rc = RTStrFormatTypeRegister("e1ktxd", e1kFmtTxDesc, NULL);
7106 AssertRCReturn(rc, rc);
7107 }
7108 return rc;
7109}
7110
7111/**
7112 * Status info callback.
7113 *
7114 * @param pDevIns The device instance.
7115 * @param pHlp The output helpers.
7116 * @param pszArgs The arguments.
7117 */
7118static DECLCALLBACK(void) e1kInfo(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
7119{
7120 RT_NOREF(pszArgs);
7121 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
7122 unsigned i;
7123 // bool fRcvRing = false;
7124 // bool fXmtRing = false;
7125
7126 /*
7127 * Parse args.
7128 if (pszArgs)
7129 {
7130 fRcvRing = strstr(pszArgs, "verbose") || strstr(pszArgs, "rcv");
7131 fXmtRing = strstr(pszArgs, "verbose") || strstr(pszArgs, "xmt");
7132 }
7133 */
7134
7135 /*
7136 * Show info.
7137 */
7138 pHlp->pfnPrintf(pHlp, "E1000 #%d: port=%RTiop mmio=%RGp mac-cfg=%RTmac %s%s%s\n",
7139 pDevIns->iInstance, pThis->IOPortBase, pThis->addrMMReg,
7140 &pThis->macConfigured, g_aChips[pThis->eChip].pcszName,
7141 pThis->fRCEnabled ? " GC" : "", pThis->fR0Enabled ? " R0" : "");
7142
7143 e1kCsEnter(pThis, VERR_INTERNAL_ERROR); /* Not sure why but PCNet does it */
7144
7145 for (i = 0; i < E1K_NUM_OF_32BIT_REGS; ++i)
7146 pHlp->pfnPrintf(pHlp, "%8.8s = %08x\n", g_aE1kRegMap[i].abbrev, pThis->auRegs[i]);
7147
7148 for (i = 0; i < RT_ELEMENTS(pThis->aRecAddr.array); i++)
7149 {
7150 E1KRAELEM* ra = pThis->aRecAddr.array + i;
7151 if (ra->ctl & RA_CTL_AV)
7152 {
7153 const char *pcszTmp;
7154 switch (ra->ctl & RA_CTL_AS)
7155 {
7156 case 0: pcszTmp = "DST"; break;
7157 case 1: pcszTmp = "SRC"; break;
7158 default: pcszTmp = "reserved";
7159 }
7160 pHlp->pfnPrintf(pHlp, "RA%02d: %s %RTmac\n", i, pcszTmp, ra->addr);
7161 }
7162 }
7163 unsigned cDescs = RDLEN / sizeof(E1KRXDESC);
7164 uint32_t rdh = RDH;
7165 pHlp->pfnPrintf(pHlp, "\n-- Receive Descriptors (%d total) --\n", cDescs);
7166 for (i = 0; i < cDescs; ++i)
7167 {
7168 E1KRXDESC desc;
7169 PDMDevHlpPhysRead(pDevIns, e1kDescAddr(RDBAH, RDBAL, i),
7170 &desc, sizeof(desc));
7171 if (i == rdh)
7172 pHlp->pfnPrintf(pHlp, ">>> ");
7173 pHlp->pfnPrintf(pHlp, "%RGp: %R[e1krxd]\n", e1kDescAddr(RDBAH, RDBAL, i), &desc);
7174 }
7175#ifdef E1K_WITH_RXD_CACHE
7176 pHlp->pfnPrintf(pHlp, "\n-- Receive Descriptors in Cache (at %d (RDH %d)/ fetched %d / max %d) --\n",
7177 pThis->iRxDCurrent, RDH, pThis->nRxDFetched, E1K_RXD_CACHE_SIZE);
7178 if (rdh > pThis->iRxDCurrent)
7179 rdh -= pThis->iRxDCurrent;
7180 else
7181 rdh = cDescs + rdh - pThis->iRxDCurrent;
7182 for (i = 0; i < pThis->nRxDFetched; ++i)
7183 {
7184 if (i == pThis->iRxDCurrent)
7185 pHlp->pfnPrintf(pHlp, ">>> ");
7186 pHlp->pfnPrintf(pHlp, "%RGp: %R[e1krxd]\n",
7187 e1kDescAddr(RDBAH, RDBAL, rdh++ % cDescs),
7188 &pThis->aRxDescriptors[i]);
7189 }
7190#endif /* E1K_WITH_RXD_CACHE */
7191
7192 cDescs = TDLEN / sizeof(E1KTXDESC);
7193 uint32_t tdh = TDH;
7194 pHlp->pfnPrintf(pHlp, "\n-- Transmit Descriptors (%d total) --\n", cDescs);
7195 for (i = 0; i < cDescs; ++i)
7196 {
7197 E1KTXDESC desc;
7198 PDMDevHlpPhysRead(pDevIns, e1kDescAddr(TDBAH, TDBAL, i),
7199 &desc, sizeof(desc));
7200 if (i == tdh)
7201 pHlp->pfnPrintf(pHlp, ">>> ");
7202 pHlp->pfnPrintf(pHlp, "%RGp: %R[e1ktxd]\n", e1kDescAddr(TDBAH, TDBAL, i), &desc);
7203 }
7204#ifdef E1K_WITH_TXD_CACHE
7205 pHlp->pfnPrintf(pHlp, "\n-- Transmit Descriptors in Cache (at %d (TDH %d)/ fetched %d / max %d) --\n",
7206 pThis->iTxDCurrent, TDH, pThis->nTxDFetched, E1K_TXD_CACHE_SIZE);
7207 if (tdh > pThis->iTxDCurrent)
7208 tdh -= pThis->iTxDCurrent;
7209 else
7210 tdh = cDescs + tdh - pThis->iTxDCurrent;
7211 for (i = 0; i < pThis->nTxDFetched; ++i)
7212 {
7213 if (i == pThis->iTxDCurrent)
7214 pHlp->pfnPrintf(pHlp, ">>> ");
7215 pHlp->pfnPrintf(pHlp, "%RGp: %R[e1ktxd]\n",
7216 e1kDescAddr(TDBAH, TDBAL, tdh++ % cDescs),
7217 &pThis->aTxDescriptors[i]);
7218 }
7219#endif /* E1K_WITH_TXD_CACHE */
7220
7221
7222#ifdef E1K_INT_STATS
7223 pHlp->pfnPrintf(pHlp, "Interrupt attempts: %d\n", pThis->uStatIntTry);
7224 pHlp->pfnPrintf(pHlp, "Interrupts raised : %d\n", pThis->uStatInt);
7225 pHlp->pfnPrintf(pHlp, "Interrupts lowered: %d\n", pThis->uStatIntLower);
7226 pHlp->pfnPrintf(pHlp, "ICR outside ISR : %d\n", pThis->uStatNoIntICR);
7227 pHlp->pfnPrintf(pHlp, "IMS raised ints : %d\n", pThis->uStatIntIMS);
7228 pHlp->pfnPrintf(pHlp, "Interrupts skipped: %d\n", pThis->uStatIntSkip);
7229 pHlp->pfnPrintf(pHlp, "Masked interrupts : %d\n", pThis->uStatIntMasked);
7230 pHlp->pfnPrintf(pHlp, "Early interrupts : %d\n", pThis->uStatIntEarly);
7231 pHlp->pfnPrintf(pHlp, "Late interrupts : %d\n", pThis->uStatIntLate);
7232 pHlp->pfnPrintf(pHlp, "Lost interrupts : %d\n", pThis->iStatIntLost);
7233 pHlp->pfnPrintf(pHlp, "Interrupts by RX : %d\n", pThis->uStatIntRx);
7234 pHlp->pfnPrintf(pHlp, "Interrupts by TX : %d\n", pThis->uStatIntTx);
7235 pHlp->pfnPrintf(pHlp, "Interrupts by ICS : %d\n", pThis->uStatIntICS);
7236 pHlp->pfnPrintf(pHlp, "Interrupts by RDTR: %d\n", pThis->uStatIntRDTR);
7237 pHlp->pfnPrintf(pHlp, "Interrupts by RDMT: %d\n", pThis->uStatIntRXDMT0);
7238 pHlp->pfnPrintf(pHlp, "Interrupts by TXQE: %d\n", pThis->uStatIntTXQE);
7239 pHlp->pfnPrintf(pHlp, "TX int delay asked: %d\n", pThis->uStatTxIDE);
7240 pHlp->pfnPrintf(pHlp, "TX delayed: %d\n", pThis->uStatTxDelayed);
7241 pHlp->pfnPrintf(pHlp, "TX delayed expired: %d\n", pThis->uStatTxDelayExp);
7242 pHlp->pfnPrintf(pHlp, "TX no report asked: %d\n", pThis->uStatTxNoRS);
7243 pHlp->pfnPrintf(pHlp, "TX abs timer expd : %d\n", pThis->uStatTAD);
7244 pHlp->pfnPrintf(pHlp, "TX int timer expd : %d\n", pThis->uStatTID);
7245 pHlp->pfnPrintf(pHlp, "RX abs timer expd : %d\n", pThis->uStatRAD);
7246 pHlp->pfnPrintf(pHlp, "RX int timer expd : %d\n", pThis->uStatRID);
7247 pHlp->pfnPrintf(pHlp, "TX CTX descriptors: %d\n", pThis->uStatDescCtx);
7248 pHlp->pfnPrintf(pHlp, "TX DAT descriptors: %d\n", pThis->uStatDescDat);
7249 pHlp->pfnPrintf(pHlp, "TX LEG descriptors: %d\n", pThis->uStatDescLeg);
7250 pHlp->pfnPrintf(pHlp, "Received frames : %d\n", pThis->uStatRxFrm);
7251 pHlp->pfnPrintf(pHlp, "Transmitted frames: %d\n", pThis->uStatTxFrm);
7252 pHlp->pfnPrintf(pHlp, "TX frames up to 1514: %d\n", pThis->uStatTx1514);
7253 pHlp->pfnPrintf(pHlp, "TX frames up to 2962: %d\n", pThis->uStatTx2962);
7254 pHlp->pfnPrintf(pHlp, "TX frames up to 4410: %d\n", pThis->uStatTx4410);
7255 pHlp->pfnPrintf(pHlp, "TX frames up to 5858: %d\n", pThis->uStatTx5858);
7256 pHlp->pfnPrintf(pHlp, "TX frames up to 7306: %d\n", pThis->uStatTx7306);
7257 pHlp->pfnPrintf(pHlp, "TX frames up to 8754: %d\n", pThis->uStatTx8754);
7258 pHlp->pfnPrintf(pHlp, "TX frames up to 16384: %d\n", pThis->uStatTx16384);
7259 pHlp->pfnPrintf(pHlp, "TX frames up to 32768: %d\n", pThis->uStatTx32768);
7260 pHlp->pfnPrintf(pHlp, "Larger TX frames : %d\n", pThis->uStatTxLarge);
7261#endif /* E1K_INT_STATS */
7262
7263 e1kCsLeave(pThis);
7264}
7265
7266
7267
7268/* -=-=-=-=- PDMDEVREG -=-=-=-=- */
7269
7270/**
7271 * Detach notification.
7272 *
7273 * One port on the network card has been disconnected from the network.
7274 *
7275 * @param pDevIns The device instance.
7276 * @param iLUN The logical unit which is being detached.
7277 * @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
7278 */
7279static DECLCALLBACK(void) e1kR3Detach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
7280{
7281 RT_NOREF(fFlags);
7282 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
7283 Log(("%s e1kR3Detach:\n", pThis->szPrf));
7284
7285 AssertLogRelReturnVoid(iLUN == 0);
7286
7287 PDMCritSectEnter(&pThis->cs, VERR_SEM_BUSY);
7288
7289 /** @todo r=pritesh still need to check if i missed
7290 * to clean something in this function
7291 */
7292
7293 /*
7294 * Zero some important members.
7295 */
7296 pThis->pDrvBase = NULL;
7297 pThis->pDrvR3 = NULL;
7298 pThis->pDrvR0 = NIL_RTR0PTR;
7299 pThis->pDrvRC = NIL_RTRCPTR;
7300
7301 PDMCritSectLeave(&pThis->cs);
7302}
7303
7304/**
7305 * Attach the Network attachment.
7306 *
7307 * One port on the network card has been connected to a network.
7308 *
7309 * @returns VBox status code.
7310 * @param pDevIns The device instance.
7311 * @param iLUN The logical unit which is being attached.
7312 * @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
7313 *
7314 * @remarks This code path is not used during construction.
7315 */
7316static DECLCALLBACK(int) e1kR3Attach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
7317{
7318 RT_NOREF(fFlags);
7319 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
7320 LogFlow(("%s e1kR3Attach:\n", pThis->szPrf));
7321
7322 AssertLogRelReturn(iLUN == 0, VERR_PDM_NO_SUCH_LUN);
7323
7324 PDMCritSectEnter(&pThis->cs, VERR_SEM_BUSY);
7325
7326 /*
7327 * Attach the driver.
7328 */
7329 int rc = PDMDevHlpDriverAttach(pDevIns, 0, &pThis->IBase, &pThis->pDrvBase, "Network Port");
7330 if (RT_SUCCESS(rc))
7331 {
7332 if (rc == VINF_NAT_DNS)
7333 {
7334#ifdef RT_OS_LINUX
7335 PDMDevHlpVMSetRuntimeError(pDevIns, 0 /*fFlags*/, "NoDNSforNAT",
7336 N_("A Domain Name Server (DNS) for NAT networking could not be determined. Please check your /etc/resolv.conf for <tt>nameserver</tt> entries. Either add one manually (<i>man resolv.conf</i>) or ensure that your host is correctly connected to an ISP. If you ignore this warning the guest will not be able to perform nameserver lookups and it will probably observe delays if trying so"));
7337#else
7338 PDMDevHlpVMSetRuntimeError(pDevIns, 0 /*fFlags*/, "NoDNSforNAT",
7339 N_("A Domain Name Server (DNS) for NAT networking could not be determined. Ensure that your host is correctly connected to an ISP. If you ignore this warning the guest will not be able to perform nameserver lookups and it will probably observe delays if trying so"));
7340#endif
7341 }
7342 pThis->pDrvR3 = PDMIBASE_QUERY_INTERFACE(pThis->pDrvBase, PDMINETWORKUP);
7343 AssertMsgStmt(pThis->pDrvR3, ("Failed to obtain the PDMINETWORKUP interface!\n"),
7344 rc = VERR_PDM_MISSING_INTERFACE_BELOW);
7345 if (RT_SUCCESS(rc))
7346 {
7347 PPDMIBASER0 pBaseR0 = PDMIBASE_QUERY_INTERFACE(pThis->pDrvBase, PDMIBASER0);
7348 pThis->pDrvR0 = pBaseR0 ? pBaseR0->pfnQueryInterface(pBaseR0, PDMINETWORKUP_IID) : NIL_RTR0PTR;
7349
7350 PPDMIBASERC pBaseRC = PDMIBASE_QUERY_INTERFACE(pThis->pDrvBase, PDMIBASERC);
7351 pThis->pDrvRC = pBaseRC ? pBaseRC->pfnQueryInterface(pBaseRC, PDMINETWORKUP_IID) : NIL_RTR0PTR;
7352 }
7353 }
7354 else if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
7355 || rc == VERR_PDM_CFG_MISSING_DRIVER_NAME)
7356 {
7357 /* This should never happen because this function is not called
7358 * if there is no driver to attach! */
7359 Log(("%s No attached driver!\n", pThis->szPrf));
7360 }
7361
7362 /*
7363 * Temporary set the link down if it was up so that the guest
7364 * will know that we have change the configuration of the
7365 * network card
7366 */
7367 if ((STATUS & STATUS_LU) && RT_SUCCESS(rc))
7368 e1kR3LinkDownTemp(pThis);
7369
7370 PDMCritSectLeave(&pThis->cs);
7371 return rc;
7372
7373}
7374
7375/**
7376 * @copydoc FNPDMDEVPOWEROFF
7377 */
7378static DECLCALLBACK(void) e1kR3PowerOff(PPDMDEVINS pDevIns)
7379{
7380 /* Poke thread waiting for buffer space. */
7381 e1kWakeupReceive(pDevIns);
7382}
7383
7384/**
7385 * @copydoc FNPDMDEVRESET
7386 */
7387static DECLCALLBACK(void) e1kR3Reset(PPDMDEVINS pDevIns)
7388{
7389 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
7390#ifdef E1K_TX_DELAY
7391 e1kCancelTimer(pThis, pThis->CTX_SUFF(pTXDTimer));
7392#endif /* E1K_TX_DELAY */
7393 e1kCancelTimer(pThis, pThis->CTX_SUFF(pIntTimer));
7394 e1kCancelTimer(pThis, pThis->CTX_SUFF(pLUTimer));
7395 e1kXmitFreeBuf(pThis);
7396 pThis->u16TxPktLen = 0;
7397 pThis->fIPcsum = false;
7398 pThis->fTCPcsum = false;
7399 pThis->fIntMaskUsed = false;
7400 pThis->fDelayInts = false;
7401 pThis->fLocked = false;
7402 pThis->u64AckedAt = 0;
7403 e1kHardReset(pThis);
7404}
7405
7406/**
7407 * @copydoc FNPDMDEVSUSPEND
7408 */
7409static DECLCALLBACK(void) e1kR3Suspend(PPDMDEVINS pDevIns)
7410{
7411 /* Poke thread waiting for buffer space. */
7412 e1kWakeupReceive(pDevIns);
7413}
7414
7415/**
7416 * Device relocation callback.
7417 *
7418 * When this callback is called the device instance data, and if the
7419 * device have a GC component, is being relocated, or/and the selectors
7420 * have been changed. The device must use the chance to perform the
7421 * necessary pointer relocations and data updates.
7422 *
7423 * Before the GC code is executed the first time, this function will be
7424 * called with a 0 delta so GC pointer calculations can be one in one place.
7425 *
7426 * @param pDevIns Pointer to the device instance.
7427 * @param offDelta The relocation delta relative to the old location.
7428 *
7429 * @remark A relocation CANNOT fail.
7430 */
7431static DECLCALLBACK(void) e1kR3Relocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
7432{
7433 RT_NOREF(offDelta);
7434 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
7435 pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
7436 pThis->pTxQueueRC = PDMQueueRCPtr(pThis->pTxQueueR3);
7437 pThis->pCanRxQueueRC = PDMQueueRCPtr(pThis->pCanRxQueueR3);
7438#ifdef E1K_USE_RX_TIMERS
7439 pThis->pRIDTimerRC = TMTimerRCPtr(pThis->pRIDTimerR3);
7440 pThis->pRADTimerRC = TMTimerRCPtr(pThis->pRADTimerR3);
7441#endif /* E1K_USE_RX_TIMERS */
7442//#ifdef E1K_USE_TX_TIMERS
7443 if (pThis->fTidEnabled)
7444 {
7445 pThis->pTIDTimerRC = TMTimerRCPtr(pThis->pTIDTimerR3);
7446# ifndef E1K_NO_TAD
7447 pThis->pTADTimerRC = TMTimerRCPtr(pThis->pTADTimerR3);
7448# endif /* E1K_NO_TAD */
7449 }
7450//#endif /* E1K_USE_TX_TIMERS */
7451#ifdef E1K_TX_DELAY
7452 pThis->pTXDTimerRC = TMTimerRCPtr(pThis->pTXDTimerR3);
7453#endif /* E1K_TX_DELAY */
7454 pThis->pIntTimerRC = TMTimerRCPtr(pThis->pIntTimerR3);
7455 pThis->pLUTimerRC = TMTimerRCPtr(pThis->pLUTimerR3);
7456}
7457
7458/**
7459 * Destruct a device instance.
7460 *
7461 * We need to free non-VM resources only.
7462 *
7463 * @returns VBox status code.
7464 * @param pDevIns The device instance data.
7465 * @thread EMT
7466 */
7467static DECLCALLBACK(int) e1kR3Destruct(PPDMDEVINS pDevIns)
7468{
7469 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
7470 PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
7471
7472 e1kDumpState(pThis);
7473 E1kLog(("%s Destroying instance\n", pThis->szPrf));
7474 if (PDMCritSectIsInitialized(&pThis->cs))
7475 {
7476 if (pThis->hEventMoreRxDescAvail != NIL_RTSEMEVENT)
7477 {
7478 RTSemEventSignal(pThis->hEventMoreRxDescAvail);
7479 RTSemEventDestroy(pThis->hEventMoreRxDescAvail);
7480 pThis->hEventMoreRxDescAvail = NIL_RTSEMEVENT;
7481 }
7482#ifdef E1K_WITH_TX_CS
7483 PDMR3CritSectDelete(&pThis->csTx);
7484#endif /* E1K_WITH_TX_CS */
7485 PDMR3CritSectDelete(&pThis->csRx);
7486 PDMR3CritSectDelete(&pThis->cs);
7487 }
7488 return VINF_SUCCESS;
7489}
7490
7491
7492/**
7493 * Set PCI configuration space registers.
7494 *
7495 * @param pci Reference to PCI device structure.
7496 * @thread EMT
7497 */
7498static DECLCALLBACK(void) e1kConfigurePciDev(PPDMPCIDEV pPciDev, E1KCHIP eChip)
7499{
7500 Assert(eChip < RT_ELEMENTS(g_aChips));
7501 /* Configure PCI Device, assume 32-bit mode ******************************/
7502 PCIDevSetVendorId(pPciDev, g_aChips[eChip].uPCIVendorId);
7503 PCIDevSetDeviceId(pPciDev, g_aChips[eChip].uPCIDeviceId);
7504 PCIDevSetWord( pPciDev, VBOX_PCI_SUBSYSTEM_VENDOR_ID, g_aChips[eChip].uPCISubsystemVendorId);
7505 PCIDevSetWord( pPciDev, VBOX_PCI_SUBSYSTEM_ID, g_aChips[eChip].uPCISubsystemId);
7506
7507 PCIDevSetWord( pPciDev, VBOX_PCI_COMMAND, 0x0000);
7508 /* DEVSEL Timing (medium device), 66 MHz Capable, New capabilities */
7509 PCIDevSetWord( pPciDev, VBOX_PCI_STATUS,
7510 VBOX_PCI_STATUS_DEVSEL_MEDIUM | VBOX_PCI_STATUS_CAP_LIST | VBOX_PCI_STATUS_66MHZ);
7511 /* Stepping A2 */
7512 PCIDevSetByte( pPciDev, VBOX_PCI_REVISION_ID, 0x02);
7513 /* Ethernet adapter */
7514 PCIDevSetByte( pPciDev, VBOX_PCI_CLASS_PROG, 0x00);
7515 PCIDevSetWord( pPciDev, VBOX_PCI_CLASS_DEVICE, 0x0200);
7516 /* normal single function Ethernet controller */
7517 PCIDevSetByte( pPciDev, VBOX_PCI_HEADER_TYPE, 0x00);
7518 /* Memory Register Base Address */
7519 PCIDevSetDWord(pPciDev, VBOX_PCI_BASE_ADDRESS_0, 0x00000000);
7520 /* Memory Flash Base Address */
7521 PCIDevSetDWord(pPciDev, VBOX_PCI_BASE_ADDRESS_1, 0x00000000);
7522 /* IO Register Base Address */
7523 PCIDevSetDWord(pPciDev, VBOX_PCI_BASE_ADDRESS_2, 0x00000001);
7524 /* Expansion ROM Base Address */
7525 PCIDevSetDWord(pPciDev, VBOX_PCI_ROM_ADDRESS, 0x00000000);
7526 /* Capabilities Pointer */
7527 PCIDevSetByte( pPciDev, VBOX_PCI_CAPABILITY_LIST, 0xDC);
7528 /* Interrupt Pin: INTA# */
7529 PCIDevSetByte( pPciDev, VBOX_PCI_INTERRUPT_PIN, 0x01);
7530 /* Max_Lat/Min_Gnt: very high priority and time slice */
7531 PCIDevSetByte( pPciDev, VBOX_PCI_MIN_GNT, 0xFF);
7532 PCIDevSetByte( pPciDev, VBOX_PCI_MAX_LAT, 0x00);
7533
7534 /* PCI Power Management Registers ****************************************/
7535 /* Capability ID: PCI Power Management Registers */
7536 PCIDevSetByte( pPciDev, 0xDC, VBOX_PCI_CAP_ID_PM);
7537 /* Next Item Pointer: PCI-X */
7538 PCIDevSetByte( pPciDev, 0xDC + 1, 0xE4);
7539 /* Power Management Capabilities: PM disabled, DSI */
7540 PCIDevSetWord( pPciDev, 0xDC + 2,
7541 0x0002 | VBOX_PCI_PM_CAP_DSI);
7542 /* Power Management Control / Status Register: PM disabled */
7543 PCIDevSetWord( pPciDev, 0xDC + 4, 0x0000);
7544 /* PMCSR_BSE Bridge Support Extensions: Not supported */
7545 PCIDevSetByte( pPciDev, 0xDC + 6, 0x00);
7546 /* Data Register: PM disabled, always 0 */
7547 PCIDevSetByte( pPciDev, 0xDC + 7, 0x00);
7548
7549 /* PCI-X Configuration Registers *****************************************/
7550 /* Capability ID: PCI-X Configuration Registers */
7551 PCIDevSetByte( pPciDev, 0xE4, VBOX_PCI_CAP_ID_PCIX);
7552#ifdef E1K_WITH_MSI
7553 PCIDevSetByte( pPciDev, 0xE4 + 1, 0x80);
7554#else
7555 /* Next Item Pointer: None (Message Signalled Interrupts are disabled) */
7556 PCIDevSetByte( pPciDev, 0xE4 + 1, 0x00);
7557#endif
7558 /* PCI-X Command: Enable Relaxed Ordering */
7559 PCIDevSetWord( pPciDev, 0xE4 + 2, VBOX_PCI_X_CMD_ERO);
7560 /* PCI-X Status: 32-bit, 66MHz*/
7561 /** @todo is this value really correct? fff8 doesn't look like actual PCI address */
7562 PCIDevSetDWord(pPciDev, 0xE4 + 4, 0x0040FFF8);
7563}
7564
7565/**
7566 * @interface_method_impl{PDMDEVREG,pfnConstruct}
7567 */
7568static DECLCALLBACK(int) e1kR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
7569{
7570 PE1KSTATE pThis = PDMINS_2_DATA(pDevIns, E1KSTATE*);
7571 int rc;
7572 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
7573
7574 /*
7575 * Initialize the instance data (state).
7576 * Note! Caller has initialized it to ZERO already.
7577 */
7578 RTStrPrintf(pThis->szPrf, sizeof(pThis->szPrf), "E1000#%d", iInstance);
7579 E1kLog(("%s Constructing new instance sizeof(E1KRXDESC)=%d\n", pThis->szPrf, sizeof(E1KRXDESC)));
7580 pThis->hEventMoreRxDescAvail = NIL_RTSEMEVENT;
7581 pThis->pDevInsR3 = pDevIns;
7582 pThis->pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns);
7583 pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
7584 pThis->u16TxPktLen = 0;
7585 pThis->fIPcsum = false;
7586 pThis->fTCPcsum = false;
7587 pThis->fIntMaskUsed = false;
7588 pThis->fDelayInts = false;
7589 pThis->fLocked = false;
7590 pThis->u64AckedAt = 0;
7591 pThis->led.u32Magic = PDMLED_MAGIC;
7592 pThis->u32PktNo = 1;
7593
7594 /* Interfaces */
7595 pThis->IBase.pfnQueryInterface = e1kR3QueryInterface;
7596
7597 pThis->INetworkDown.pfnWaitReceiveAvail = e1kR3NetworkDown_WaitReceiveAvail;
7598 pThis->INetworkDown.pfnReceive = e1kR3NetworkDown_Receive;
7599 pThis->INetworkDown.pfnXmitPending = e1kR3NetworkDown_XmitPending;
7600
7601 pThis->ILeds.pfnQueryStatusLed = e1kR3QueryStatusLed;
7602
7603 pThis->INetworkConfig.pfnGetMac = e1kR3GetMac;
7604 pThis->INetworkConfig.pfnGetLinkState = e1kR3GetLinkState;
7605 pThis->INetworkConfig.pfnSetLinkState = e1kR3SetLinkState;
7606
7607 /*
7608 * Internal validations.
7609 */
7610 for (uint32_t iReg = 1; iReg < E1K_NUM_OF_BINARY_SEARCHABLE; iReg++)
7611 AssertLogRelMsgReturn( g_aE1kRegMap[iReg].offset > g_aE1kRegMap[iReg - 1].offset
7612 && g_aE1kRegMap[iReg].offset + g_aE1kRegMap[iReg].size
7613 >= g_aE1kRegMap[iReg - 1].offset + g_aE1kRegMap[iReg - 1].size,
7614 ("%s@%#xLB%#x vs %s@%#xLB%#x\n",
7615 g_aE1kRegMap[iReg].abbrev, g_aE1kRegMap[iReg].offset, g_aE1kRegMap[iReg].size,
7616 g_aE1kRegMap[iReg - 1].abbrev, g_aE1kRegMap[iReg - 1].offset, g_aE1kRegMap[iReg - 1].size),
7617 VERR_INTERNAL_ERROR_4);
7618
7619 /*
7620 * Validate configuration.
7621 */
7622 if (!CFGMR3AreValuesValid(pCfg, "MAC\0" "CableConnected\0" "AdapterType\0"
7623 "LineSpeed\0" "GCEnabled\0" "R0Enabled\0"
7624 "ItrEnabled\0" "ItrRxEnabled\0"
7625 "EthernetCRC\0" "GSOEnabled\0" "LinkUpDelay\0"))
7626 return PDMDEV_SET_ERROR(pDevIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES,
7627 N_("Invalid configuration for E1000 device"));
7628
7629 /** @todo LineSpeed unused! */
7630
7631 /* Get config params */
7632 rc = CFGMR3QueryBytes(pCfg, "MAC", pThis->macConfigured.au8, sizeof(pThis->macConfigured.au8));
7633 if (RT_FAILURE(rc))
7634 return PDMDEV_SET_ERROR(pDevIns, rc,
7635 N_("Configuration error: Failed to get MAC address"));
7636 rc = CFGMR3QueryBool(pCfg, "CableConnected", &pThis->fCableConnected);
7637 if (RT_FAILURE(rc))
7638 return PDMDEV_SET_ERROR(pDevIns, rc,
7639 N_("Configuration error: Failed to get the value of 'CableConnected'"));
7640 rc = CFGMR3QueryU32(pCfg, "AdapterType", (uint32_t*)&pThis->eChip);
7641 if (RT_FAILURE(rc))
7642 return PDMDEV_SET_ERROR(pDevIns, rc,
7643 N_("Configuration error: Failed to get the value of 'AdapterType'"));
7644 Assert(pThis->eChip <= E1K_CHIP_82545EM);
7645 rc = CFGMR3QueryBoolDef(pCfg, "GCEnabled", &pThis->fRCEnabled, true);
7646 if (RT_FAILURE(rc))
7647 return PDMDEV_SET_ERROR(pDevIns, rc,
7648 N_("Configuration error: Failed to get the value of 'GCEnabled'"));
7649
7650 rc = CFGMR3QueryBoolDef(pCfg, "R0Enabled", &pThis->fR0Enabled, true);
7651 if (RT_FAILURE(rc))
7652 return PDMDEV_SET_ERROR(pDevIns, rc,
7653 N_("Configuration error: Failed to get the value of 'R0Enabled'"));
7654
7655 rc = CFGMR3QueryBoolDef(pCfg, "EthernetCRC", &pThis->fEthernetCRC, true);
7656 if (RT_FAILURE(rc))
7657 return PDMDEV_SET_ERROR(pDevIns, rc,
7658 N_("Configuration error: Failed to get the value of 'EthernetCRC'"));
7659
7660 rc = CFGMR3QueryBoolDef(pCfg, "GSOEnabled", &pThis->fGSOEnabled, true);
7661 if (RT_FAILURE(rc))
7662 return PDMDEV_SET_ERROR(pDevIns, rc,
7663 N_("Configuration error: Failed to get the value of 'GSOEnabled'"));
7664
7665 rc = CFGMR3QueryBoolDef(pCfg, "ItrEnabled", &pThis->fItrEnabled, false);
7666 if (RT_FAILURE(rc))
7667 return PDMDEV_SET_ERROR(pDevIns, rc,
7668 N_("Configuration error: Failed to get the value of 'ItrEnabled'"));
7669
7670 rc = CFGMR3QueryBoolDef(pCfg, "ItrRxEnabled", &pThis->fItrRxEnabled, true);
7671 if (RT_FAILURE(rc))
7672 return PDMDEV_SET_ERROR(pDevIns, rc,
7673 N_("Configuration error: Failed to get the value of 'ItrRxEnabled'"));
7674
7675 rc = CFGMR3QueryBoolDef(pCfg, "TidEnabled", &pThis->fTidEnabled, false);
7676 if (RT_FAILURE(rc))
7677 return PDMDEV_SET_ERROR(pDevIns, rc,
7678 N_("Configuration error: Failed to get the value of 'TidEnabled'"));
7679
7680 rc = CFGMR3QueryU32Def(pCfg, "LinkUpDelay", (uint32_t*)&pThis->cMsLinkUpDelay, 3000); /* ms */
7681 if (RT_FAILURE(rc))
7682 return PDMDEV_SET_ERROR(pDevIns, rc,
7683 N_("Configuration error: Failed to get the value of 'LinkUpDelay'"));
7684 Assert(pThis->cMsLinkUpDelay <= 300000); /* less than 5 minutes */
7685 if (pThis->cMsLinkUpDelay > 5000)
7686 LogRel(("%s WARNING! Link up delay is set to %u seconds!\n", pThis->szPrf, pThis->cMsLinkUpDelay / 1000));
7687 else if (pThis->cMsLinkUpDelay == 0)
7688 LogRel(("%s WARNING! Link up delay is disabled!\n", pThis->szPrf));
7689
7690 LogRel(("%s Chip=%s LinkUpDelay=%ums EthernetCRC=%s GSO=%s Itr=%s ItrRx=%s TID=%s R0=%s GC=%s\n", pThis->szPrf,
7691 g_aChips[pThis->eChip].pcszName, pThis->cMsLinkUpDelay,
7692 pThis->fEthernetCRC ? "on" : "off",
7693 pThis->fGSOEnabled ? "enabled" : "disabled",
7694 pThis->fItrEnabled ? "enabled" : "disabled",
7695 pThis->fItrRxEnabled ? "enabled" : "disabled",
7696 pThis->fTidEnabled ? "enabled" : "disabled",
7697 pThis->fR0Enabled ? "enabled" : "disabled",
7698 pThis->fRCEnabled ? "enabled" : "disabled"));
7699
7700 /* Initialize the EEPROM. */
7701 pThis->eeprom.init(pThis->macConfigured);
7702
7703 /* Initialize internal PHY. */
7704 Phy::init(&pThis->phy, iInstance, pThis->eChip == E1K_CHIP_82543GC ? PHY_EPID_M881000 : PHY_EPID_M881011);
7705
7706 /* Initialize critical sections. We do our own locking. */
7707 rc = PDMDevHlpSetDeviceCritSect(pDevIns, PDMDevHlpCritSectGetNop(pDevIns));
7708 AssertRCReturn(rc, rc);
7709
7710 rc = PDMDevHlpCritSectInit(pDevIns, &pThis->cs, RT_SRC_POS, "E1000#%d", iInstance);
7711 if (RT_FAILURE(rc))
7712 return rc;
7713 rc = PDMDevHlpCritSectInit(pDevIns, &pThis->csRx, RT_SRC_POS, "E1000#%dRX", iInstance);
7714 if (RT_FAILURE(rc))
7715 return rc;
7716#ifdef E1K_WITH_TX_CS
7717 rc = PDMDevHlpCritSectInit(pDevIns, &pThis->csTx, RT_SRC_POS, "E1000#%dTX", iInstance);
7718 if (RT_FAILURE(rc))
7719 return rc;
7720#endif /* E1K_WITH_TX_CS */
7721
7722 /* Saved state registration. */
7723 rc = PDMDevHlpSSMRegisterEx(pDevIns, E1K_SAVEDSTATE_VERSION, sizeof(E1KSTATE), NULL,
7724 NULL, e1kLiveExec, NULL,
7725 e1kSavePrep, e1kSaveExec, NULL,
7726 e1kLoadPrep, e1kLoadExec, e1kLoadDone);
7727 if (RT_FAILURE(rc))
7728 return rc;
7729
7730 /* Set PCI config registers and register ourselves with the PCI bus. */
7731 e1kConfigurePciDev(&pThis->pciDevice, pThis->eChip);
7732 rc = PDMDevHlpPCIRegister(pDevIns, &pThis->pciDevice);
7733 if (RT_FAILURE(rc))
7734 return rc;
7735
7736#ifdef E1K_WITH_MSI
7737 PDMMSIREG MsiReg;
7738 RT_ZERO(MsiReg);
7739 MsiReg.cMsiVectors = 1;
7740 MsiReg.iMsiCapOffset = 0x80;
7741 MsiReg.iMsiNextOffset = 0x0;
7742 MsiReg.fMsi64bit = false;
7743 rc = PDMDevHlpPCIRegisterMsi(pDevIns, &MsiReg);
7744 AssertRCReturn(rc, rc);
7745#endif
7746
7747
7748 /* Map our registers to memory space (region 0, see e1kConfigurePCI)*/
7749 rc = PDMDevHlpPCIIORegionRegister(pDevIns, 0, E1K_MM_SIZE, PCI_ADDRESS_SPACE_MEM, e1kMap);
7750 if (RT_FAILURE(rc))
7751 return rc;
7752#ifdef E1K_WITH_PREREG_MMIO
7753 rc = PDMDevHlpMMIOExPreRegister(pDevIns, 0, E1K_MM_SIZE, IOMMMIO_FLAGS_READ_DWORD | IOMMMIO_FLAGS_WRITE_ONLY_DWORD, "E1000",
7754 NULL /*pvUserR3*/, e1kMMIOWrite, e1kMMIORead, NULL /*pfnFillR3*/,
7755 NIL_RTR0PTR /*pvUserR0*/, pThis->fR0Enabled ? "e1kMMIOWrite" : NULL,
7756 pThis->fR0Enabled ? "e1kMMIORead" : NULL, NULL /*pszFillR0*/,
7757 NIL_RTRCPTR /*pvUserRC*/, pThis->fRCEnabled ? "e1kMMIOWrite" : NULL,
7758 pThis->fRCEnabled ? "e1kMMIORead" : NULL, NULL /*pszFillRC*/);
7759 AssertLogRelRCReturn(rc, rc);
7760#endif
7761 /* Map our registers to IO space (region 2, see e1kConfigurePCI) */
7762 rc = PDMDevHlpPCIIORegionRegister(pDevIns, 2, E1K_IOPORT_SIZE, PCI_ADDRESS_SPACE_IO, e1kMap);
7763 if (RT_FAILURE(rc))
7764 return rc;
7765
7766 /* Create transmit queue */
7767 rc = PDMDevHlpQueueCreate(pDevIns, sizeof(PDMQUEUEITEMCORE), 1, 0,
7768 e1kTxQueueConsumer, true, "E1000-Xmit", &pThis->pTxQueueR3);
7769 if (RT_FAILURE(rc))
7770 return rc;
7771 pThis->pTxQueueR0 = PDMQueueR0Ptr(pThis->pTxQueueR3);
7772 pThis->pTxQueueRC = PDMQueueRCPtr(pThis->pTxQueueR3);
7773
7774 /* Create the RX notifier signaller. */
7775 rc = PDMDevHlpQueueCreate(pDevIns, sizeof(PDMQUEUEITEMCORE), 1, 0,
7776 e1kCanRxQueueConsumer, true, "E1000-Rcv", &pThis->pCanRxQueueR3);
7777 if (RT_FAILURE(rc))
7778 return rc;
7779 pThis->pCanRxQueueR0 = PDMQueueR0Ptr(pThis->pCanRxQueueR3);
7780 pThis->pCanRxQueueRC = PDMQueueRCPtr(pThis->pCanRxQueueR3);
7781
7782#ifdef E1K_TX_DELAY
7783 /* Create Transmit Delay Timer */
7784 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, e1kTxDelayTimer, pThis,
7785 TMTIMER_FLAGS_NO_CRIT_SECT,
7786 "E1000 Transmit Delay Timer", &pThis->pTXDTimerR3);
7787 if (RT_FAILURE(rc))
7788 return rc;
7789 pThis->pTXDTimerR0 = TMTimerR0Ptr(pThis->pTXDTimerR3);
7790 pThis->pTXDTimerRC = TMTimerRCPtr(pThis->pTXDTimerR3);
7791 TMR3TimerSetCritSect(pThis->pTXDTimerR3, &pThis->csTx);
7792#endif /* E1K_TX_DELAY */
7793
7794//#ifdef E1K_USE_TX_TIMERS
7795 if (pThis->fTidEnabled)
7796 {
7797 /* Create Transmit Interrupt Delay Timer */
7798 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, e1kTxIntDelayTimer, pThis,
7799 TMTIMER_FLAGS_NO_CRIT_SECT,
7800 "E1000 Transmit Interrupt Delay Timer", &pThis->pTIDTimerR3);
7801 if (RT_FAILURE(rc))
7802 return rc;
7803 pThis->pTIDTimerR0 = TMTimerR0Ptr(pThis->pTIDTimerR3);
7804 pThis->pTIDTimerRC = TMTimerRCPtr(pThis->pTIDTimerR3);
7805
7806# ifndef E1K_NO_TAD
7807 /* Create Transmit Absolute Delay Timer */
7808 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, e1kTxAbsDelayTimer, pThis,
7809 TMTIMER_FLAGS_NO_CRIT_SECT,
7810 "E1000 Transmit Absolute Delay Timer", &pThis->pTADTimerR3);
7811 if (RT_FAILURE(rc))
7812 return rc;
7813 pThis->pTADTimerR0 = TMTimerR0Ptr(pThis->pTADTimerR3);
7814 pThis->pTADTimerRC = TMTimerRCPtr(pThis->pTADTimerR3);
7815# endif /* E1K_NO_TAD */
7816 }
7817//#endif /* E1K_USE_TX_TIMERS */
7818
7819#ifdef E1K_USE_RX_TIMERS
7820 /* Create Receive Interrupt Delay Timer */
7821 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, e1kRxIntDelayTimer, pThis,
7822 TMTIMER_FLAGS_NO_CRIT_SECT,
7823 "E1000 Receive Interrupt Delay Timer", &pThis->pRIDTimerR3);
7824 if (RT_FAILURE(rc))
7825 return rc;
7826 pThis->pRIDTimerR0 = TMTimerR0Ptr(pThis->pRIDTimerR3);
7827 pThis->pRIDTimerRC = TMTimerRCPtr(pThis->pRIDTimerR3);
7828
7829 /* Create Receive Absolute Delay Timer */
7830 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, e1kRxAbsDelayTimer, pThis,
7831 TMTIMER_FLAGS_NO_CRIT_SECT,
7832 "E1000 Receive Absolute Delay Timer", &pThis->pRADTimerR3);
7833 if (RT_FAILURE(rc))
7834 return rc;
7835 pThis->pRADTimerR0 = TMTimerR0Ptr(pThis->pRADTimerR3);
7836 pThis->pRADTimerRC = TMTimerRCPtr(pThis->pRADTimerR3);
7837#endif /* E1K_USE_RX_TIMERS */
7838
7839 /* Create Late Interrupt Timer */
7840 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, e1kLateIntTimer, pThis,
7841 TMTIMER_FLAGS_NO_CRIT_SECT,
7842 "E1000 Late Interrupt Timer", &pThis->pIntTimerR3);
7843 if (RT_FAILURE(rc))
7844 return rc;
7845 pThis->pIntTimerR0 = TMTimerR0Ptr(pThis->pIntTimerR3);
7846 pThis->pIntTimerRC = TMTimerRCPtr(pThis->pIntTimerR3);
7847
7848 /* Create Link Up Timer */
7849 rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, e1kLinkUpTimer, pThis,
7850 TMTIMER_FLAGS_NO_CRIT_SECT,
7851 "E1000 Link Up Timer", &pThis->pLUTimerR3);
7852 if (RT_FAILURE(rc))
7853 return rc;
7854 pThis->pLUTimerR0 = TMTimerR0Ptr(pThis->pLUTimerR3);
7855 pThis->pLUTimerRC = TMTimerRCPtr(pThis->pLUTimerR3);
7856
7857 /* Register the info item */
7858 char szTmp[20];
7859 RTStrPrintf(szTmp, sizeof(szTmp), "e1k%d", iInstance);
7860 PDMDevHlpDBGFInfoRegister(pDevIns, szTmp, "E1000 info.", e1kInfo);
7861
7862 /* Status driver */
7863 PPDMIBASE pBase;
7864 rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThis->IBase, &pBase, "Status Port");
7865 if (RT_FAILURE(rc))
7866 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
7867 pThis->pLedsConnector = PDMIBASE_QUERY_INTERFACE(pBase, PDMILEDCONNECTORS);
7868
7869 /* Network driver */
7870 rc = PDMDevHlpDriverAttach(pDevIns, 0, &pThis->IBase, &pThis->pDrvBase, "Network Port");
7871 if (RT_SUCCESS(rc))
7872 {
7873 if (rc == VINF_NAT_DNS)
7874 PDMDevHlpVMSetRuntimeError(pDevIns, 0 /*fFlags*/, "NoDNSforNAT",
7875 N_("A Domain Name Server (DNS) for NAT networking could not be determined. Ensure that your host is correctly connected to an ISP. If you ignore this warning the guest will not be able to perform nameserver lookups and it will probably observe delays if trying so"));
7876 pThis->pDrvR3 = PDMIBASE_QUERY_INTERFACE(pThis->pDrvBase, PDMINETWORKUP);
7877 AssertMsgReturn(pThis->pDrvR3, ("Failed to obtain the PDMINETWORKUP interface!\n"), VERR_PDM_MISSING_INTERFACE_BELOW);
7878
7879 pThis->pDrvR0 = PDMIBASER0_QUERY_INTERFACE(PDMIBASE_QUERY_INTERFACE(pThis->pDrvBase, PDMIBASER0), PDMINETWORKUP);
7880 pThis->pDrvRC = PDMIBASERC_QUERY_INTERFACE(PDMIBASE_QUERY_INTERFACE(pThis->pDrvBase, PDMIBASERC), PDMINETWORKUP);
7881 }
7882 else if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
7883 || rc == VERR_PDM_CFG_MISSING_DRIVER_NAME)
7884 {
7885 /* No error! */
7886 E1kLog(("%s This adapter is not attached to any network!\n", pThis->szPrf));
7887 }
7888 else
7889 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the network LUN"));
7890
7891 rc = RTSemEventCreate(&pThis->hEventMoreRxDescAvail);
7892 if (RT_FAILURE(rc))
7893 return rc;
7894
7895 rc = e1kInitDebugHelpers();
7896 if (RT_FAILURE(rc))
7897 return rc;
7898
7899 e1kHardReset(pThis);
7900
7901 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceiveBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Amount of data received", "/Public/Net/E1k%u/BytesReceived", iInstance);
7902 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Amount of data transmitted", "/Public/Net/E1k%u/BytesTransmitted", iInstance);
7903
7904 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceiveBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Amount of data received", "/Devices/E1k%d/ReceiveBytes", iInstance);
7905 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Amount of data transmitted", "/Devices/E1k%d/TransmitBytes", iInstance);
7906
7907#if defined(VBOX_WITH_STATISTICS)
7908 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatMMIOReadRZ, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling MMIO reads in RZ", "/Devices/E1k%d/MMIO/ReadRZ", iInstance);
7909 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatMMIOReadR3, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling MMIO reads in R3", "/Devices/E1k%d/MMIO/ReadR3", iInstance);
7910 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatMMIOWriteRZ, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling MMIO writes in RZ", "/Devices/E1k%d/MMIO/WriteRZ", iInstance);
7911 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatMMIOWriteR3, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling MMIO writes in R3", "/Devices/E1k%d/MMIO/WriteR3", iInstance);
7912 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatEEPROMRead, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling EEPROM reads", "/Devices/E1k%d/EEPROM/Read", iInstance);
7913 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatEEPROMWrite, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling EEPROM writes", "/Devices/E1k%d/EEPROM/Write", iInstance);
7914 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatIOReadRZ, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO reads in RZ", "/Devices/E1k%d/IO/ReadRZ", iInstance);
7915 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatIOReadR3, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO reads in R3", "/Devices/E1k%d/IO/ReadR3", iInstance);
7916 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatIOWriteRZ, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO writes in RZ", "/Devices/E1k%d/IO/WriteRZ", iInstance);
7917 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatIOWriteR3, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO writes in R3", "/Devices/E1k%d/IO/WriteR3", iInstance);
7918 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatLateIntTimer, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling late int timer", "/Devices/E1k%d/LateInt/Timer", iInstance);
7919 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatLateInts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of late interrupts", "/Devices/E1k%d/LateInt/Occured", iInstance);
7920 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatIntsRaised, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of raised interrupts", "/Devices/E1k%d/Interrupts/Raised", iInstance);
7921 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatIntsPrevented, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of prevented interrupts", "/Devices/E1k%d/Interrupts/Prevented", iInstance);
7922 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceive, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling receive", "/Devices/E1k%d/Receive/Total", iInstance);
7923 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceiveCRC, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling receive checksumming", "/Devices/E1k%d/Receive/CRC", iInstance);
7924 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceiveFilter, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling receive filtering", "/Devices/E1k%d/Receive/Filter", iInstance);
7925 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceiveStore, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling receive storing", "/Devices/E1k%d/Receive/Store", iInstance);
7926 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatRxOverflow, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_OCCURENCE, "Profiling RX overflows", "/Devices/E1k%d/RxOverflow", iInstance);
7927 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatRxOverflowWakeup, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Nr of RX overflow wakeups", "/Devices/E1k%d/RxOverflowWakeup", iInstance);
7928 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitRZ, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling transmits in RZ", "/Devices/E1k%d/Transmit/TotalRZ", iInstance);
7929 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitR3, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling transmits in R3", "/Devices/E1k%d/Transmit/TotalR3", iInstance);
7930 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitSendRZ, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling send transmit in RZ", "/Devices/E1k%d/Transmit/SendRZ", iInstance);
7931 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitSendR3, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling send transmit in R3", "/Devices/E1k%d/Transmit/SendR3", iInstance);
7932
7933 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxDescCtxNormal, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of normal context descriptors","/Devices/E1k%d/TxDesc/ContexNormal", iInstance);
7934 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxDescCtxTSE, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of TSE context descriptors", "/Devices/E1k%d/TxDesc/ContextTSE", iInstance);
7935 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxDescData, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of TX data descriptors", "/Devices/E1k%d/TxDesc/Data", iInstance);
7936 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxDescLegacy, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of TX legacy descriptors", "/Devices/E1k%d/TxDesc/Legacy", iInstance);
7937 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxDescTSEData, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of TX TSE data descriptors", "/Devices/E1k%d/TxDesc/TSEData", iInstance);
7938 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxPathFallback, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Fallback TSE descriptor path", "/Devices/E1k%d/TxPath/Fallback", iInstance);
7939 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxPathGSO, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "GSO TSE descriptor path", "/Devices/E1k%d/TxPath/GSO", iInstance);
7940 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTxPathRegular, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Regular descriptor path", "/Devices/E1k%d/TxPath/Normal", iInstance);
7941 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatPHYAccesses, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of PHY accesses", "/Devices/E1k%d/PHYAccesses", iInstance);
7942 for (unsigned iReg = 0; iReg < E1K_NUM_OF_REGS; iReg++)
7943 {
7944 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->aStatRegReads[iReg], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES,
7945 g_aE1kRegMap[iReg].name, "/Devices/E1k%d/Regs/%s-Reads", iInstance, g_aE1kRegMap[iReg].abbrev);
7946 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->aStatRegWrites[iReg], STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES,
7947 g_aE1kRegMap[iReg].name, "/Devices/E1k%d/Regs/%s-Writes", iInstance, g_aE1kRegMap[iReg].abbrev);
7948 }
7949#endif /* VBOX_WITH_STATISTICS */
7950
7951#ifdef E1K_INT_STATS
7952 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->u64ArmedAt, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "u64ArmedAt", "/Devices/E1k%d/u64ArmedAt", iInstance);
7953 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatMaxTxDelay, STAMTYPE_U64, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatMaxTxDelay", "/Devices/E1k%d/uStatMaxTxDelay", iInstance);
7954 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatInt, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatInt", "/Devices/E1k%d/uStatInt", iInstance);
7955 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntTry, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntTry", "/Devices/E1k%d/uStatIntTry", iInstance);
7956 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntLower, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntLower", "/Devices/E1k%d/uStatIntLower", iInstance);
7957 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatNoIntICR, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatNoIntICR", "/Devices/E1k%d/uStatNoIntICR", iInstance);
7958 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->iStatIntLost, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "iStatIntLost", "/Devices/E1k%d/iStatIntLost", iInstance);
7959 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->iStatIntLostOne, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "iStatIntLostOne", "/Devices/E1k%d/iStatIntLostOne", iInstance);
7960 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntIMS, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntIMS", "/Devices/E1k%d/uStatIntIMS", iInstance);
7961 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntSkip, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntSkip", "/Devices/E1k%d/uStatIntSkip", iInstance);
7962 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntLate, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntLate", "/Devices/E1k%d/uStatIntLate", iInstance);
7963 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntMasked, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntMasked", "/Devices/E1k%d/uStatIntMasked", iInstance);
7964 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntEarly, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntEarly", "/Devices/E1k%d/uStatIntEarly", iInstance);
7965 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntRx, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntRx", "/Devices/E1k%d/uStatIntRx", iInstance);
7966 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntTx, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntTx", "/Devices/E1k%d/uStatIntTx", iInstance);
7967 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntICS, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntICS", "/Devices/E1k%d/uStatIntICS", iInstance);
7968 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntRDTR, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntRDTR", "/Devices/E1k%d/uStatIntRDTR", iInstance);
7969 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntRXDMT0, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntRXDMT0", "/Devices/E1k%d/uStatIntRXDMT0", iInstance);
7970 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatIntTXQE, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatIntTXQE", "/Devices/E1k%d/uStatIntTXQE", iInstance);
7971 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTxNoRS, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTxNoRS", "/Devices/E1k%d/uStatTxNoRS", iInstance);
7972 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTxIDE, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTxIDE", "/Devices/E1k%d/uStatTxIDE", iInstance);
7973 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTxDelayed, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTxDelayed", "/Devices/E1k%d/uStatTxDelayed", iInstance);
7974 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTxDelayExp, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTxDelayExp", "/Devices/E1k%d/uStatTxDelayExp", iInstance);
7975 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTAD, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTAD", "/Devices/E1k%d/uStatTAD", iInstance);
7976 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTID, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTID", "/Devices/E1k%d/uStatTID", iInstance);
7977 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatRAD, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatRAD", "/Devices/E1k%d/uStatRAD", iInstance);
7978 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatRID, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatRID", "/Devices/E1k%d/uStatRID", iInstance);
7979 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatRxFrm, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatRxFrm", "/Devices/E1k%d/uStatRxFrm", iInstance);
7980 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTxFrm, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTxFrm", "/Devices/E1k%d/uStatTxFrm", iInstance);
7981 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatDescCtx, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatDescCtx", "/Devices/E1k%d/uStatDescCtx", iInstance);
7982 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatDescDat, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatDescDat", "/Devices/E1k%d/uStatDescDat", iInstance);
7983 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatDescLeg, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatDescLeg", "/Devices/E1k%d/uStatDescLeg", iInstance);
7984 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx1514, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx1514", "/Devices/E1k%d/uStatTx1514", iInstance);
7985 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx2962, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx2962", "/Devices/E1k%d/uStatTx2962", iInstance);
7986 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx4410, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx4410", "/Devices/E1k%d/uStatTx4410", iInstance);
7987 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx5858, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx5858", "/Devices/E1k%d/uStatTx5858", iInstance);
7988 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx7306, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx7306", "/Devices/E1k%d/uStatTx7306", iInstance);
7989 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx8754, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx8754", "/Devices/E1k%d/uStatTx8754", iInstance);
7990 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx16384, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx16384", "/Devices/E1k%d/uStatTx16384", iInstance);
7991 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTx32768, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTx32768", "/Devices/E1k%d/uStatTx32768", iInstance);
7992 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->uStatTxLarge, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NS, "uStatTxLarge", "/Devices/E1k%d/uStatTxLarge", iInstance);
7993#endif /* E1K_INT_STATS */
7994
7995 return VINF_SUCCESS;
7996}
7997
7998/**
7999 * The device registration structure.
8000 */
8001const PDMDEVREG g_DeviceE1000 =
8002{
8003 /* Structure version. PDM_DEVREG_VERSION defines the current version. */
8004 PDM_DEVREG_VERSION,
8005 /* Device name. */
8006 "e1000",
8007 /* Name of guest context module (no path).
8008 * Only evalutated if PDM_DEVREG_FLAGS_RC is set. */
8009 "VBoxDDRC.rc",
8010 /* Name of ring-0 module (no path).
8011 * Only evalutated if PDM_DEVREG_FLAGS_RC is set. */
8012 "VBoxDDR0.r0",
8013 /* The description of the device. The UTF-8 string pointed to shall, like this structure,
8014 * remain unchanged from registration till VM destruction. */
8015 "Intel PRO/1000 MT Desktop Ethernet.\n",
8016
8017 /* Flags, combination of the PDM_DEVREG_FLAGS_* \#defines. */
8018 PDM_DEVREG_FLAGS_DEFAULT_BITS | PDM_DEVREG_FLAGS_RC | PDM_DEVREG_FLAGS_R0,
8019 /* Device class(es), combination of the PDM_DEVREG_CLASS_* \#defines. */
8020 PDM_DEVREG_CLASS_NETWORK,
8021 /* Maximum number of instances (per VM). */
8022 ~0U,
8023 /* Size of the instance data. */
8024 sizeof(E1KSTATE),
8025
8026 /* pfnConstruct */
8027 e1kR3Construct,
8028 /* pfnDestruct */
8029 e1kR3Destruct,
8030 /* pfnRelocate */
8031 e1kR3Relocate,
8032 /* pfnMemSetup */
8033 NULL,
8034 /* pfnPowerOn */
8035 NULL,
8036 /* pfnReset */
8037 e1kR3Reset,
8038 /* pfnSuspend */
8039 e1kR3Suspend,
8040 /* pfnResume */
8041 NULL,
8042 /* pfnAttach */
8043 e1kR3Attach,
8044 /* pfnDeatch */
8045 e1kR3Detach,
8046 /* pfnQueryInterface */
8047 NULL,
8048 /* pfnInitComplete */
8049 NULL,
8050 /* pfnPowerOff */
8051 e1kR3PowerOff,
8052 /* pfnSoftReset */
8053 NULL,
8054
8055 /* u32VersionEnd */
8056 PDM_DEVREG_VERSION
8057};
8058
8059#endif /* IN_RING3 */
8060#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette