VIRTUTECH CONFIDENTIAL Previous - Up - Next
cheerio-hme
- Provided by
-
cheerio-hme
- Class Hierarchy
-
conf-object → log-object → conf-object → log-object → cheerio-hme
- Interfaces Implemented
-
log_object, io_memory, pci_device, ethernet_device, event_poster
- Description
-
The cheerio-hme Network Adapter.
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
- 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.
- align_error_counter
- 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
- Optional attribute; read/write access; type: unknown type.
Internal Register
- bmcr
- Optional attribute; read/write access; type: unknown type.
Internal Register
- bmsr
- Optional attribute; read/write access; type: unknown type.
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.
- 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.
- defer_timer
- Optional attribute; read/write access; type: unknown type.
Internal Register
- exc_collision
- Optional attribute; read/write access; type: unknown type.
Internal Register
- expansion_rom
- Optional attribute; read/write access; type: [oii].
ROM object, map size, and map function number for the Expansion ROM.
- fcs_error_counter
- Optional attribute; read/write access; type: Integer.
Internal Register
- first_collision
- Optional attribute; read/write access; type: unknown type.
Internal Register
- glob_conf
- Optional attribute; read/write access; type: unknown type.
Internal Register
- glob_stat
- Optional attribute; read/write access; type: unknown type.
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.
- interrupt_pin
- Optional attribute; read/write access; type: [iiii].
State of the interrupt pin.
- ipg1
- Optional attribute; read/write access; type: unknown type.
Internal Register
- ipg2
- Optional attribute; read/write access; type: unknown type.
Internal Register
- irq_mask
- Optional attribute; read/write access; type: unknown type.
Internal Register
- jam_size
- Optional attribute; read/write access; type: unknown type.
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.
- last_rx_descriptor
- Optional attribute; read/write access; type: unknown type.
Internal Register
- last_tx_descriptor
- Optional attribute; read/write access; type: unknown type.
Internal Register
- late_collision
- Optional attribute; read/write access; type: unknown type.
Internal Register
- len_error_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.
- mappings
- Optional attribute; read/write access; type: [[i{5:8}]|[iiiiiiiio|nii]*].
List of all current PCI IO and memory mappings.
- mif_config
- Optional attribute; read/write access; type: unknown type.
Internal Register
- mif_mask
- Optional attribute; read/write access; type: unknown type.
Internal Register
- mif_status
- Optional attribute; read/write access; type: unknown type.
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.
- network
- Pseudo attribute; read/write access; type: Object or Nil.
Obsolete attribute. Use link instead.
- next_mii_val
- Optional attribute; read/write access; type: unknown type.
Internal Register
- normal_collision
- Optional attribute; read/write access; type: unknown type.
Internal Register
- pa_pattern
- Optional attribute; read/write access; type: unknown type.
Internal Register
- pa_size
- Optional attribute; read/write access; type: unknown type.
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.
- pkt_rec
- Session attribute; read/write access; type: unknown type.
Number of packets received
- pkt_snt
- Session attribute; read/write access; type: unknown type.
Number of packets sent
- poll_reg
- Optional attribute; read/write access; type: unknown type.
Internal Register
- random_seed
- Optional attribute; read/write access; type: unknown type.
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_byte_offset
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_checksum_offset
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_desc_base
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_desc_disp
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_dma_enable
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_frame_counter
- Optional attribute; read/write access; type: Integer.
Internal Register
- rx_mac_config
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_max_frame
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_min_frame
- Optional attribute; read/write access; type: unknown type.
Internal Register
- rx_ring_size_idx
- Optional attribute; read/write access; type: unknown type.
Internal Register
- serial_clock
- Optional attribute; read/write access; type: Integer.
MII Management Interface serial communication state.
- serial_data_in
- Optional attribute; read/write access; type: Integer.
MII Management Interface serial communication state.
- serial_data_out
- Optional attribute; read/write access; type: Integer.
MII Management Interface serial communication state.
- serial_num_cycles
- Optional attribute; read/write access; type: Integer.
MII Management Interface serial communication state.
- serial_port_status
- Optional attribute; read/write access; type: Integer.
MII Management Interface serial communication state.
- sfd_pattern
- Optional attribute; read/write access; type: unknown type.
Internal Register
- slot_time
- Optional attribute; read/write access; type: unknown type.
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_config
- Optional attribute; read/write access; type: unknown type.
Internal Register
- tx_desc_base
- Optional attribute; read/write access; type: unknown type.
Internal Register
- tx_desc_disp
- Optional attribute; read/write access; type: unknown type.
Internal Register
- tx_mac_config
- Optional attribute; read/write access; type: unknown type.
Internal Register
- tx_max_frame
- Optional attribute; read/write access; type: unknown type.
Internal Register
- tx_min_frame
- Optional attribute; read/write access; type: unknown type.
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_ring_size
- Optional attribute; read/write access; type: unknown type.
Internal Register
- 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_config
- Optional attribute; read/write access; type: unknown type.
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
-
<cheerio-hme>.connect
- Synopsis
-
<cheerio-hme>.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
-
<cheerio-hme>.disconnect
-
<cheerio-hme>.disconnect
- Synopsis
-
<cheerio-hme>.disconnect
- Description
-
Disconnect the device from a simulated Ethernet link.
- See Also
-
<cheerio-hme>.connect
-
<cheerio-hme>.info
- Synopsis
-
<cheerio-hme>.info
- Description
-
Print detailed information about the configuration of the device.
-
<cheerio-hme>.pci-header
- Synopsis
-
<cheerio-hme>.pci-header
- Description
-
Print the PCI header, i.e the configuration registers.
-
<cheerio-hme>.status
- Synopsis
-
<cheerio-hme>.status
- Description
-
Print detailed information about the current status of the device.
VIRTUTECH CONFIDENTIAL Previous - Up - Next