VIRTUTECH CONFIDENTIAL    Previous - Up - Next

cassini

Provided by

cassini

Class Hierarchy

conf-object → log-object → cassini

Interfaces Implemented

log_object, ethernet_device, io_memory, pci_device, event_poster

Description

The cassini class implements a Cassini+ GBit Ethernet device, also called GigaSwift Ethernet. The device supports stalling, i.e. timing models can stall DMA operations initiated by Cassini, but the reissue field in the generic_transaction_t may not be cleared by the timing model. Features not implemented include TCP reassembly, jumbo packets, multiple MAC addresses, multicast address hashing, receive ring 2 (encrypted packets) and statistics counters.

Attributes

Attributes inherited from class conf-object

attributes, classname, component, iface, name, object_id, queue

Attributes inherited from class log-object

access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask

Attribute List

add_crc_on_inject

Optional attribute; read/write access; type: Integer.

Frames injected using the 'inject_packet' will get a correctly calculated CRC added at the end when this attribute is set to 1 (default). When set to 0, the user has to supply a CRC field with the injected frame. Note that you must always provide room for the CRC field, even when this attribute is set to 1.

address_filter_0_mask

Optional attribute; read/write access; type: Integer.

Internal register.

address_filter_0_register

Optional attribute; read/write access; type: Integer.

Internal register.

address_filter_1_register

Optional attribute; read/write access; type: Integer.

Internal register.

address_filter_2_1_mask

Optional attribute; read/write access; type: Integer.

Internal register.

address_filter_2_register

Optional attribute; read/write access; type: Integer.

Internal register.

alias_clear_mask_register

Optional attribute; read/write access; type: Integer.

Internal register.

alias_clear_mask_register2

Optional attribute; read/write access; type: Integer.

Internal register.

alias_clear_mask_register3

Optional attribute; read/write access; type: Integer.

Internal register.

alias_clear_mask_register4

Optional attribute; read/write access; type: Integer.

Internal register.

anar

Optional attribute; read/write access; type: unknown type.

Internal Register

aner

Optional attribute; read/write access; type: unknown type.

Internal Register

anlpar

Optional attribute; read/write access; type: unknown type.

Internal Register

attempt_limit_register

Optional attribute; read/write access; type: Integer.

Internal register.

bim_buffer_address

Optional attribute; read/write access; type: Integer.

Internal register.

bim_buffer_data_high

Optional attribute; read/write access; type: Integer.

Internal register.

bim_buffer_data_low

Optional attribute; read/write access; type: Integer.

Internal register.

bim_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

bim_local_device_output_en

Optional attribute; read/write access; type: Integer.

Internal register.

bmcr

Optional attribute; read/write access; type: unknown type.

Internal Register

bmsr

Optional attribute; read/write access; type: unknown type.

Internal Register

cas_alignment_error_counter

Optional attribute; read/write access; type: Integer.

Internal register.

cas_fcs_error_counter

Optional attribute; read/write access; type: Integer.

Internal register.

cas_length_error_counter

Optional attribute; read/write access; type: Integer.

Internal register.

cas_receive_frame_counter

Optional attribute; read/write access; type: Integer.

Internal register.

cas_rx_code_viol_error_counter

Optional attribute; read/write access; type: Integer.

Internal register.

config_register_info

Pseudo attribute; read-only access; type: [[isii]*].

Register info for all registered configuration registers. The format for each entry is (offset, name, size, write-mask).

config_registers

Optional attribute; read/write access; type: [i{64}]; integer indexed; indexed type: Integer.

The 64 PCI configuration registers, each 32 bits in size.

core_arbitration_weight

Optional attribute; read/write access; type: Integer.

Internal register.

cs_conf

Optional attribute; read/write access; type: unknown type.

Internal Register

current_packet

Pseudo attribute; read/write access; type: d|n.

(Obsolete - see the "last-frame" attribute instead). The packet that is currently about to be sent or received. The format is a raw Ethernet frame. This attribute is only valid in Ethernet_Transmit and Ethernet_Receive hap callbacks. It is possible to override the packet by assigning this attribute. The device will drop the current packet if the attribute is set to Nil, or with data of zero length.

datapath_mode_register

Optional attribute; read/write access; type: Integer.

Internal register.

descriptor_base_low_4

Optional attribute; read/write access; type: Integer.

Internal register.

excessive_collision_counter

Optional attribute; read/write access; type: Integer.

Internal register.

expansion_rom

Optional attribute; read/write access; type: [oii].

ROM object, map size, and map function number for the Expansion ROM.

first_collision_counter

Optional attribute; read/write access; type: Integer.

Internal register.

header_buffer_index

Optional attribute; read/write access; type: Integer.

Internal register.

header_buffer_valid

Optional attribute; read/write access; type: Integer.

Internal register.

hp_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

hp_instruction_ram_address

Optional attribute; read/write access; type: Integer.

Internal register.

hp_instructions

Optional attribute; read/write access; type: [[iii]{64}].

Header Parser instruction words.

infinite_burst_en_register

Optional attribute; read/write access; type: Integer.

Internal register.

inject_packet

Pseudo attribute; write-only access; type: Data.

Attribute used to send a packet to the network device. Writing this attribute at any time injects a new packet into the device (without involving the network simulation). Injecting a packet copies the packet data, allowing the caller to reuse or dispose of the buffer used for creating the packet, after the attribute is written.

interpacketgap0_register

Optional attribute; read/write access; type: Integer.

Internal register.

interpacketgap1_register

Optional attribute; read/write access; type: Integer.

Internal register.

interpacketgap2_register

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_mask_register

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_mask_register2

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_mask_register3

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_mask_register4

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_pin

Optional attribute; read/write access; type: [iiii].

State of the interrupt pin.

interrupt_status_register

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_status_register2

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_status_register3

Optional attribute; read/write access; type: Integer.

Internal register.

interrupt_status_register4

Optional attribute; read/write access; type: Integer.

Internal register.

jam_size_register

Optional attribute; read/write access; type: Integer.

Internal register.

last_frame

Pseudo attribute; read/write access; type: d|n.

The frame that is currently about to be sent or received. The format is a raw Ethernet frame. This attribute is only valid in Ethernet_Transmit and Ethernet_Receive hap callbacks. It is possible to override the packet by assigning this attribute. The device will drop the current packet if the attribute is set to Nil, or with data of zero length.

late_collision_counter

Optional attribute; read/write access; type: Integer.

Internal register.

link

Optional attribute; read/write access; type: Object or Nil.

The Ethernet link that the network device is connected to.

mac_address

Optional attribute; read/write access; type: s|[i{6}]|n.

Ethernet (MAC) address of the network interface.

mac_control_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

mac_control_mask_register

Optional attribute; read/write access; type: Integer.

Internal register.

mac_control_type_register

Optional attribute; read/write access; type: Integer.

Internal register.

mappings

Optional attribute; read/write access; type: [[i{5:8}]|[iiiiiiiio|nii]*].

List of all current PCI IO and memory mappings.

max_framesize_register

Optional attribute; read/write access; type: Integer.

Internal register.

mif_bit_bang_clock

Optional attribute; read/write access; type: Integer.

Internal register.

mif_bit_bang_data

Optional attribute; read/write access; type: Integer.

Internal register.

mif_bit_bang_output_enable

Optional attribute; read/write access; type: Integer.

Internal register.

mif_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

mif_mask_register

Optional attribute; read/write access; type: Integer.

Internal register.

mif_status_register

Optional attribute; read/write access; type: Integer.

Internal register.

mii_value

Optional attribute; read/write access; type: Integer.

Internal register.

min_framesize_register

Optional attribute; read/write access; type: Integer.

Internal register.

mode

Optional attribute; read/write access; type: unknown type.

Internal Register

model_crc

Optional attribute; read/write access; type: Integer.

If set to 1, the device will calculate and include an Ethernet CRC on all transmitted frames, and check the CRC on received frames.

mtu_buffer_index

Optional attribute; read/write access; type: Integer.

Internal register.

mtu_buffer_valid

Optional attribute; read/write access; type: Integer.

Internal register.

network

Pseudo attribute; read/write access; type: Object or Nil.

Obsolete attribute. Use link instead.

normal_collision_counter

Optional attribute; read/write access; type: Integer.

Internal register.

num_header_bufs

Optional attribute; read/write access; type: Integer.

Internal register.

num_mtu_bufs

Optional attribute; read/write access; type: Integer.

Internal register.

pa_size_register

Optional attribute; read/write access; type: Integer.

Internal register.

pci_bus

Optional attribute; read/write access; type: Object or Nil.

The PCI bus this device is connected to, implementing the pci-bus interface.

pci_error_mask_register

Optional attribute; read/write access; type: Integer.

Internal register.

pio_latency

Optional attribute; read/write access; type: Integer.

Internal register.

poll_reg

Optional attribute; read/write access; type: unknown type.

Internal Register

random_number_seed_register

Optional attribute; read/write access; type: Integer.

Internal register.

recorder

Required attribute; read/write access; type: Object.

Recorder object that allows recording and later playback of network traffic to the interface.

reliability

Optional attribute; read/write access; type: Integer.

This value determined how reliable an established connection is. If set to N it means that with a probability of 1 out of N a package will be lost (not sent to the receiver). The default value is 0 which means that no packages will be lost.

reliability_seed

Optional attribute; read/write access; type: Integer.

The seed value for the randomization of packet loss. See the reliability attribute

rx_almost_empty_threshold

Optional attribute; read/write access; type: Integer.

Internal register.

rx_blanking_reg_for_isr

Optional attribute; read/write access; type: Integer.

Internal register.

rx_cached_compl

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion2_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_head2_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_head3_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_head4_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_head_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring2_base_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring2_base_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring3_base_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring3_base_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring4_base_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring4_base_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring_base_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_ring_base_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_tail2_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_tail3_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_tail4_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_completion_tail_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_counter

Optional attribute; read/write access; type: Integer.

Internal register.

rx_descriptor_ring2_base_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_descriptor_ring2_base_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_descriptor_ring_base_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_descriptor_ring_base_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_fifo

Optional attribute; read/write access; type: [[dii]*].

Receive packet FIFO.

rx_fifo_read_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

rx_fifo_write_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

rx_header_page_pointer_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_header_page_pointer_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_ipp_fifo_read_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

rx_ipp_fifo_shadow_write_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

rx_ipp_fifo_write_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

rx_kick2_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_kick_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_mac_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_mac_mask_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_mac_status_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_mtu_page_pointer_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_mtu_page_pointer_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_page_size_register

Optional attribute; read/write access; type: Integer.

Internal register.

rx_pause_thresholds

Optional attribute; read/write access; type: Integer.

Internal register.

rx_random_early_detection_en

Optional attribute; read/write access; type: Integer.

Internal register.

rx_reassembly_dma_address

Optional attribute; read/write access; type: Integer.

Internal register.

rx_reassembly_dma_high

Optional attribute; read/write access; type: Integer.

Internal register.

rx_reassembly_dma_low

Optional attribute; read/write access; type: Integer.

Internal register.

rx_reassembly_dma_mid

Optional attribute; read/write access; type: Integer.

Internal register.

rx_state_state

Optional attribute; read/write access; type: String.

State of receive machine.

rx_state_tx_stall

Optional attribute; read/write access; type: Integer.

Internal register.

send_pause_command_register

Optional attribute; read/write access; type: Integer.

Internal register.

slottime_register

Optional attribute; read/write access; type: Integer.

Internal register.

software_reset_register

Optional attribute; read/write access; type: Integer.

Internal register.

tp10_conf

Optional attribute; read/write access; type: unknown type.

Internal Register

tx_bandwidth

Optional attribute; read/write access; type: Integer.

The transmit bandwidth of the network interface in bits per second. The network interface will limit the rate at which it sends packets to remain below this bandwidth. Set to 0 for unlimited bandwidth.

tx_completion_register_1

Optional attribute; read/write access; type: Integer.

Internal register.

tx_completion_register_2

Optional attribute; read/write access; type: Integer.

Internal register.

tx_completion_register_3

Optional attribute; read/write access; type: Integer.

Internal register.

tx_completion_register_4

Optional attribute; read/write access; type: Integer.

Internal register.

tx_completion_wb_base_high

Optional attribute; read/write access; type: Integer.

Internal register.

tx_completion_wb_base_low

Optional attribute; read/write access; type: Integer.

Internal register.

tx_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

tx_data_pointer_high

Optional attribute; read/write access; type: Integer.

Internal register.

tx_data_pointer_low

Optional attribute; read/write access; type: Integer.

Internal register.

tx_descriptor_base_high_1

Optional attribute; read/write access; type: Integer.

Internal register.

tx_descriptor_base_high_2

Optional attribute; read/write access; type: Integer.

Internal register.

tx_descriptor_base_high_3

Optional attribute; read/write access; type: Integer.

Internal register.

tx_descriptor_base_high_4

Optional attribute; read/write access; type: Integer.

Internal register.

tx_descriptor_base_low_1

Optional attribute; read/write access; type: Integer.

Internal register.

tx_descriptor_base_low_2

Optional attribute; read/write access; type: Integer.

Internal register.

tx_descriptor_base_low_3

Optional attribute; read/write access; type: Integer.

Internal register.

tx_fifo_address

Optional attribute; read/write access; type: Integer.

Internal register.

tx_fifo_read_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

tx_fifo_shadow_read_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

tx_fifo_shadow_write_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

tx_fifo_write_pointer

Optional attribute; read/write access; type: Integer.

Internal register.

tx_kick_register_1

Optional attribute; read/write access; type: Integer.

Internal register.

tx_kick_register_2

Optional attribute; read/write access; type: Integer.

Internal register.

tx_kick_register_3

Optional attribute; read/write access; type: Integer.

Internal register.

tx_kick_register_4

Optional attribute; read/write access; type: Integer.

Internal register.

tx_mac_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

tx_mac_mask_register

Optional attribute; read/write access; type: Integer.

Internal register.

tx_mac_status_register

Optional attribute; read/write access; type: Integer.

Internal register.

tx_maxburst_1

Optional attribute; read/write access; type: Integer.

Internal register.

tx_maxburst_2

Optional attribute; read/write access; type: Integer.

Internal register.

tx_maxburst_3

Optional attribute; read/write access; type: Integer.

Internal register.

tx_maxburst_4

Optional attribute; read/write access; type: Integer.

Internal register.

tx_next_time

Optional attribute; read/write access; type: Float.

The earliest time at which that the network interface may send another packet. Used for transmit bandwidth limitation.

tx_packet

Optional attribute; read/write access; type: Data.

Incomplete packet to be transmitted.

tx_state_addr

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_cksum_en

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_cksum_off

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_cksum_stuf

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_eof

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_first_pt

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_int_me

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_len

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_no_crc

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_ring

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_rx_stall

Optional attribute; read/write access; type: Integer.

Internal register.

tx_state_state

Optional attribute; read/write access; type: String.

State of transmit machine.

write_masks

Optional attribute; read/write access; type: [[ii]*].

Write masks for all registered configuration registers. The format for each entry is (offset, mask).

xif_configuration_register

Optional attribute; read/write access; type: Integer.

Internal register.

Command List

Commands defined by interface log_object

log, log-group, log-level, log-size, log-type

Commands

connect	connect to a simulated Ethernet link
disconnect	disconnect from simulated link
info	print information about the device
pci-header	print PCI device header
status	print status of the device

Command Descriptions

<cassini>.connect

Synopsis

<cassini>.connect [-auto] (link|"link-name")

Description

Connect the device to a simulated Ethernet link. The flag '-auto' is deprecated and shouldn't be used.

See Also

<cassini>.disconnect

<cassini>.disconnect

Synopsis

<cassini>.disconnect

Description

Disconnect the device from a simulated Ethernet link.

See Also

<cassini>.connect

<cassini>.info

Synopsis

<cassini>.info

Description

Print detailed information about the configuration of the device.

<cassini>.pci-header

Synopsis

<cassini>.pci-header

Description

Print the PCI header, i.e the configuration registers.

<cassini>.status

Synopsis

<cassini>.status

Description

Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL    Previous - Up - Next