5.4.4. TelnetTerminal component

The TelnetTerminal component is a virtual component that permits UART data to be transferred between a SerialData port and a TCP/IP socket on the host.

When the simulation is started and the TelnetTerminal component is enabled, the component opens a server (listening) socket on a TCP/IP port. This is port 5000 by default.

Data written to the SerialData port is transmitted over the network socket.When data becomes available on the network socket, the TelnetTerminal component buffers the data. The data can then be read from SerialData.

If there is no connection to the network socket when the first data access is made, a host telnet session is automatically started. Prior to this first access, you can connect a client of your choice to the network socket. If the connection between the TelnetTerminal component and the client is broken at any time, the port is re-opened, permitting you to make another client connection.

Further information on how to use the TelnetTerminal component is provided later in this book. See Terminal.

Figure 5.25 shows a view of the component in System Canvas.

Figure 5.25. TelnetTerminal in System Canvas

TelnetTerminal in System Canvas

This component is written in C++.

Ports

Table 5.36 provides a brief description of the TelnetTerminal component ports.

Table 5.36. TelnetTerminal ports

NamePort protocolTypeDescription
serialSerialDataSlaveSlave port for connecting to a SerialData master.

Additional protocols

The TelnetTerminal component has no additional protocols.

Parameters

Table 5.37 lists the parameters used by the TelnetTerminal component.

Table 5.37. TelnetTerminal configuration parameters

Parameter nameDescriptionTypeAllowed valueDefault value
modeTerminal operation mode.Stringtelnet[a], raw[b]telnet
start_telnetEnable terminal when the system starts.Booleantrue/falsetrue
start_portPort used for the terminal when the system starts. If the specified port is not free, the port value is incremented by 1 until a free port is found.Integervalid port number5000

[a] In telnet mode, the TelnetTerminal component supports a subset of the telnet protocol defined in RFC 854.

[b] In raw mode, the TelnetTerminal component does not interpret or modify the byte stream contents. This permits you to make a debugger connection, for example, to connect a gdb client to a gdbserver running on the target operating system.


Registers

The TelnetTerminal component has no registers.

Debug features

The TelnetTerminal component has no debug features.

Verification and testing

The TelnetTerminal component has been tested as part of the VE example system using VE test suites and by booting operating systems.

Performance

The TelnetTerminal component is not expected to significantly affect the performance of a PV system.

Library dependencies

The performance of the TelnetTerminal component depends on the host terminal.

Copyright © 2008-2013 ARM. All rights reserved.ARM DUI 0423O
Non-ConfidentialID060613