VirtualBox

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

Last change on this file since 65904 was 64966, checked in by vboxsync, 8 years ago

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