CS8900A

VIRTUTECH CONFIDENTIAL Previous - Up - Next

Provided by: CS8900A
Class Hierarchy: conf-object → log-object → CS8900A
Interfaces Implemented: log_object, event_poster, ethernet_device, io_memory
Description: The CS8900A device simulates the embedded ethernet controller from Cirrus Logic

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

ISQ: Optional attribute; read/write access; type: unknown type.
Interrupt status queue values

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_shift: Optional attribute; read/write access; type: unknown type.
For address calculation. This attribute specifies how many bits the offset should be shifted right to, for building appropriate addresses. Used by architectures which maps this 16 bit device as a 64 bit device.

ctrl_regs: Optional attribute; read/write access; type: unknown type.
Status and control registers

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.

eeprom_data: Optional attribute; read/write access; type: unknown type.
Data for current eeprom transaction

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.

interrupt_number: Optional attribute; read/write access; type: unknown type.
Register, Packetpage base + 0x22

io_base: Optional attribute; read/write access; type: unknown type.
Register, Packetpage base + 0x20

irq_dev: Required attribute; read/write access; type: unknown type.
Device to send IRQ to, implementingsimple-interrupt.

irq_level: Required attribute; read/write access; type: unknown type.
Level at which IRQs are sent.

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.

link: Optional attribute; read/write access; type: Object or Nil.
The Ethernet link that the network device is connected to.

logical_address_filter: Optional attribute; read/write access; type: unknown type.
Registers, Packetpage base + 0x150

mac_address: Optional attribute; read/write access; type: s|[i{6}]|n.
Ethernet (MAC) address of the network interface.

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.

network: Pseudo attribute; read/write access; type: Object or Nil.
Obsolete attribute. Use link instead.

packet_page_ptr: Optional attribute; read/write access; type: unknown type.
Packet page pointer

receive_buffer: Optional attribute; read/write access; type: unknown type.
The receive buffer for incoming ethernet packets

receive_data_port0_ptr: Optional attribute; read/write access; type: unknown type.
Current location when reading the receive buffer

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

transmit_buffer: Optional attribute; read/write access; type: Data.
The transmit buffer for outgoing ethernet packets

transmit_data_port0_ptr: Optional attribute; read/write access; type: unknown type.
Current location when reading the transmit buffer

txlength: Optional attribute; read/write access; type: unknown type.
Register, length of package to send

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
status	print status of the device

<CS8900A>.connect
Synopsis: <CS8900A>.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: <CS8900A>.disconnect

<CS8900A>.info
Synopsis: <CS8900A>.info
Description: Print detailed information about the configuration of the device.

<CS8900A>.status
Synopsis: <CS8900A>.status
Description: Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL Previous - Up - Next