VIRTUTECH CONFIDENTIAL    Previous - Up - Next

mii-transceiver

Provided by
mii-transceiver
Class Hierarchy
conf-objectlog-objectmii-transceiver
Interfaces Implemented
log_object, event_poster, ieee_802_3_phy, ethernet_device
Ports
MDIO (signal), MDC (signal)
Description
mii-transceiver is an IEEE 802.3 physical layer device with MII interface

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
Optional attribute; read/write access; type: Integer.

Address on the MII management bus.

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.

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

Set to 1 for full duplex (0 for half duplex).

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.

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.

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

The link speed (usually 10 or 100 Mbit/s).

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

The status of the link - 0 when completely unconnected, 1 when connected but down, and 2 when connected and up.

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

Set to a media access controller (MAC) object, implementing the ieee_802_3_mac_interface_t.

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

Ethernet (MAC) address of the network interface.

mdio_target
Optional attribute; read/write access; type: n|o|[os].

Describes where the outgoing MDIO signal should be connected

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.

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

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

registers
Optional attribute; read/write access; type: [i{32}].

The MII management register set as described in IEEE 802.3.

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

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.

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_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.

Command List

Commands defined by interface log_object
log, log-group, log-level, log-size, log-type
Commands
connectconnect to a simulated Ethernet link
disconnectdisconnect from simulated link
infoprint information about the device
statusprint status of the device

Command Descriptions

<mii-transceiver>.connect
Synopsis
<mii-transceiver>.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
<mii-transceiver>.disconnect
<mii-transceiver>.disconnect
Synopsis
<mii-transceiver>.disconnect
Description
Disconnect the device from a simulated Ethernet link.
See Also
<mii-transceiver>.connect
<mii-transceiver>.info
Synopsis
<mii-transceiver>.info
Description
Print detailed information about the configuration of the device.
<mii-transceiver>.status
Synopsis
<mii-transceiver>.status
Description
Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL    Previous - Up - Next