CDEC21143 Class Reference

#include <DEC21143.h>

Inheritance diagram for CDEC21143:

[legend]

Collaboration diagram for CDEC21143:

[legend]

Detailed Description

Emulated DEC 21143 NIC device.

Documentation consulted:

21143 PCI/Cardbus 10/100Mb/s Ethernet LAN Controller Hardware Reference Manual [HRM]. (http://download.intel.com/design/network/manuals/27807401.pdf)
Tru64 Device Driver Kit Version 2 (Ethernet sample = tu driver!) [T64]. (http://h30097.www3.hp.com/docs/dev_doc/DOCUMENTATION/HTML/dev_docs_r2.html)

Definition at line 106 of file DEC21143.h.


Public Member Functions
virtual int	SaveState (FILE *f)
	Save state to a Virtual Machine State file.
virtual int	RestoreState (FILE *f)
	Restore state from a Virtual Machine State file.
void	instant_tick ()
virtual void	check_state ()
	Check if threads are still running.
virtual void	WriteMem_Bar (int func, int bar, u32 address, int dsize, u32 data)
virtual u32	ReadMem_Bar (int func, int bar, u32 address, int dsize)
	CDEC21143 (CConfigurator confg, class CSystem c, int pcibus, int pcidev)
	Constructor.
virtual	~CDEC21143 ()
	Destructor.
virtual void	ResetPCI ()
	Reset the network interface internals to their condition immediately after power-up, including the PCI configuration.
void	ResetNIC ()
	Reset the network interface internals to their condition immediately after power-up.
void	SetupFilter ()
void	receive_process ()
virtual void	run ()
	Thread entry point.
virtual void	init ()
	Initialize the network device.
virtual void	start_threads ()
virtual void	stop_threads ()
Private Member Functions
u32	nic_read (u32 address, int dsize)
	Read from the NIC registers.
void	nic_write (u32 address, int dsize, u32 data)
	Write to the NIC registers.
void	mii_access (uint32_t oldreg, uint32_t idata)
	This function handles accesses to the MII.
void	srom_access (uint32_t oldreg, uint32_t idata)
	This function handles reads from the Ethernet Address ROM.
int	dec21143_rx ()
	Receive a packet.
int	dec21143_tx ()
	Transmit a packet, if the guest OS has marked a descriptor as containing data to transmit.
void	set_tx_state (int tx_state)
void	set_rx_state (int rx_state)
Private Attributes
Poco::Thread *	myThread
bool	StopThread
CPacketQueue *	rx_queue
pcap_t *	fp
struct bpf_program	fcode
bool	calc_crc
struct CDEC21143::SNIC_state	state
Static Private Attributes
static int	nic_num = 0
Data Structures
struct	SNIC_state
	The state structure contains all elements that need to be saved to the statefile. More...

Constructor & Destructor Documentation

CDEC21143::CDEC21143	(	CConfigurator *	confg,
		class CSystem *	c,
		int	pcibus,
		int	pcidev
	)

Constructor.

Definition at line 261 of file DEC21143.cpp.

CDEC21143::~CDEC21143 ( ) [virtual]

Destructor.

Definition at line 447 of file DEC21143.cpp.

References fp, rx_queue, and stop_threads().

Member Function Documentation

int CDEC21143::SaveState ( FILE * f ) [virtual]

Save state to a Virtual Machine State file.

Reimplemented from CPCIDevice.

Definition at line 1719 of file DEC21143.cpp.

int CDEC21143::RestoreState ( FILE * f ) [virtual]

Restore state from a Virtual Machine State file.

Reimplemented from CPCIDevice.

Definition at line 1738 of file DEC21143.cpp.

void CDEC21143::instant_tick ( )

void CDEC21143::check_state ( ) [virtual]

Check if threads are still running.

Reimplemented from CSystemComponent.

Definition at line 484 of file DEC21143.cpp.

References FAILURE, Poco::Thread::isRunning(), and myThread.

void CDEC21143::WriteMem_Bar	(	int	func,
		int	bar,
		u32	address,
		int	dsize,
		u32	data
	)			`[virtual]`

Reimplemented from CPCIDevice.

Definition at line 468 of file DEC21143.cpp.

References endian_bits(), and nic_write().

u32 CDEC21143::ReadMem_Bar	(	int	func,
		int	bar,
		u32	address,
		int	dsize
	)			`[virtual]`

Reimplemented from CPCIDevice.

Definition at line 455 of file DEC21143.cpp.

References nic_read().

void CDEC21143::ResetPCI ( ) [virtual]

Reset the network interface internals to their condition immediately after power-up, including the PCI configuration.

Reimplemented from CPCIDevice.

Definition at line 1578 of file DEC21143.cpp.

Referenced by init().

void CDEC21143::ResetNIC ( )

Reset the network interface internals to their condition immediately after power-up.

This does not affect the PCI configuration.

Code for computing the SROM checksum is taken from [T64].

Definition at line 1591 of file DEC21143.cpp.

Referenced by nic_write().

void CDEC21143::SetupFilter ( )

Definition at line 1479 of file DEC21143.cpp.

void CDEC21143::receive_process ( )

Definition at line 490 of file DEC21143.cpp.

References CPacketQueue::add_tail(), calc_crc, CSR_OPMODE, CSR_SIASTAT, dec21143_rx(), fp, OPMODE_OM_INTLOOP, OPMODE_SR, CDEC21143::SNIC_state::reg, rx_queue, SIASTAT_TRA, and state.

Referenced by run().

void CDEC21143::run ( void ) [virtual]

Thread entry point.

Implements Poco::Runnable.

Definition at line 170 of file DEC21143.cpp.

References CSR_INTEN, CSR_OPMODE, CSR_STATUS, dec21143_tx(), Poco::Exception::displayText(), CPCIDevice::do_pci_interrupt(), CDEC21143::SNIC_state::irq_was_asserted, OPMODE_ST, receive_process(), CDEC21143::SNIC_state::reg, Poco::Thread::sleep(), state, STATUS_AIS, STATUS_NIS, and StopThread.

void CDEC21143::init ( ) [virtual]

Initialize the network device.

Reimplemented from CSystemComponent.

Definition at line 267 of file DEC21143.cpp.

References CPCIDevice::add_function(), calc_crc, CDEC21143::SNIC_state::SNIC_tx::cur_buf, CDEC21143::SNIC_state::SNIC_rx::cur_buf, dec21143_cfg_data, dec21143_cfg_mask, CSystemComponent::devid_string, FAILURE, FAILURE_1, fp, CConfigurator::get_bool_value(), CConfigurator::get_num_value(), CConfigurator::get_text_value(), CDEC21143::SNIC_state::SNIC_tx::idling, CDEC21143::SNIC_state::irq_was_asserted, CDEC21143::SNIC_state::mac, CSystemComponent::myCfg, myThread, nic_num, ResetPCI(), CDEC21143::SNIC_state::rx, rx_queue, state, and CDEC21143::SNIC_state::tx.

void CDEC21143::start_threads ( ) [virtual]

Reimplemented from CSystemComponent.

Definition at line 421 of file DEC21143.cpp.

References Poco::Thread::getName(), myThread, Poco::Thread::start(), and StopThread.

void CDEC21143::stop_threads ( ) [virtual]

Reimplemented from CSystemComponent.

Definition at line 432 of file DEC21143.cpp.

References Poco::Thread::getName(), Poco::Thread::join(), myThread, and StopThread.

Referenced by ~CDEC21143().

u32 CDEC21143::nic_read	(	u32	address,
		int	dsize
	)			`[private]`

Read from the NIC registers.

Definition at line 519 of file DEC21143.cpp.

References CDEC21143::SNIC_state::reg, and state.

Referenced by ReadMem_Bar().

void CDEC21143::nic_write	(	u32	address,
		int	dsize,
		u32	data
	)			`[private]`

Write to the NIC registers.

Definition at line 541 of file DEC21143.cpp.

Referenced by WriteMem_Bar().

void CDEC21143::mii_access	(	uint32_t	oldreg,
		uint32_t	idata
	)			`[private]`

This function handles accesses to the MII.

Data streams seem to be of the following format:

vv---- starting delimiter ... 01 xx yyyyy zzzzz a[a] dddddddddddddddd ^---- I am starting with mii_bit = 0 here

where x = opcode (10 = read, 01 = write) y = PHY address z = register address a = on Reads: ACK bit (returned, should be 0) on Writes: _TWO_ dummy bits (10) d = 16 bits of data (MSB first)

Definition at line 797 of file DEC21143.cpp.

Referenced by nic_write().

void CDEC21143::srom_access	(	uint32_t	oldreg,
		uint32_t	idata
	)			`[private]`

This function handles reads from the Ethernet Address ROM.

This is not a 100% correct implementation, as it was reverse-engineered from OpenBSD sources; it seems to work with OpenBSD, NetBSD, and Linux, though.

Each transfer (if I understood this correctly) is of the following format:

1xx yyyyyy zzzzzzzzzzzzzzzz

where 1xx = operation (6 means a Read), yyyyyy = ROM address zz...z = data

y and z are _both_ read and written to at the same time; this enables the operating system to sense the number of bits in y (when reading, all y bits are 1 except the last one).

Definition at line 985 of file DEC21143.cpp.

References CDEC21143::SNIC_state::SNIC_srom::addr, CDEC21143::SNIC_state::SNIC_srom::curbit, CDEC21143::SNIC_state::SNIC_srom::opcode, CDEC21143::SNIC_state::SNIC_srom::opcode_has_started, CDEC21143::SNIC_state::srom, and state.

Referenced by nic_write().

int CDEC21143::dec21143_rx ( ) [private]

Receive a packet.

(If there is no current packet, then check for newly arrived ones. If the current packet couldn't be fully transfered the last time, then continue on that packet.)

Definition at line 1105 of file DEC21143.cpp.

References CPacketQueue::count(), CDEC21143::SNIC_state::SNIC_rx::current, CPacketQueue::get_head(), CDEC21143::SNIC_state::rx, rx_queue, and state.

Referenced by receive_process().

int CDEC21143::dec21143_tx ( ) [private]

Transmit a packet, if the guest OS has marked a descriptor as containing data to transmit.

Definition at line 1271 of file DEC21143.cpp.

Referenced by run().

void CDEC21143::set_tx_state ( int tx_state ) [private]

Definition at line 770 of file DEC21143.cpp.

References CSR_STATUS, CDEC21143::SNIC_state::reg, state, and STATUS_TS.

Referenced by nic_write().

void CDEC21143::set_rx_state ( int rx_state ) [private]