rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-22 19:55:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clean up and review of Networking User Guide.

Browse Source
This commit is contained in:
Chris Johns 2016-04-11 13:53:58 +10:00 committed by Amar Takhar
parent ea0777e4ee
commit b41203897a
9 changed files with 1112 additions and 1183 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
networking/conf.py
View File

@ -3,10 +3,11 @@ sys.path.append(os.path.abspath('../common/'))
from conf import *
version = '1.0'
release = '5.0'
version = '4.11.0'
release = '4.11.0'
project = "RTEMS Networking User Manual"
latex_documents = [
('index', 'networking.tex', u'RTEMS Networking Documentation', u'RTEMS Documentation Project', 'manual'),
('index', 'networking.tex', u'RTEMS Networking User Documentation', u'RTEMS Documentation Project', 'manual'),
]

172
networking/dec_21140.rst
View File

@ -6,20 +6,19 @@ DEC 21240 Driver Introduction
.. COMMENT: XXX add back in cross reference to list of boards.
One aim of our project is to port RTEMS on a standard PowerPC platform.
To achieve it, we have chosen a Motorola MCP750 board. This board includes
an Ethernet controller based on a DEC21140 chip. Because RTEMS has a
TCP/IP stack, we will
have to develop the DEC21140 related ethernet driver for the PowerPC port of
RTEMS. As this controller is able to support 100Mbps network and as there is
a lot of PCI card using this DEC chip, we have decided to first
One aim of our project is to port RTEMS on a standard PowerPC platform. To
achieve it, we have chosen a Motorola MCP750 board. This board includes an
Ethernet controller based on a DEC21140 chip. Because RTEMS has a TCP/IP stack,
we will have to develop the DEC21140 related ethernet driver for the PowerPC
port of RTEMS. As this controller is able to support 100Mbps network and as
there is a lot of PCI card using this DEC chip, we have decided to first
implement this driver on an Intel PC386 target to provide a solution for using
RTEMS on PC with the 100Mbps network and then to port this code on PowerPC in
a second phase.
RTEMS on PC with the 100Mbps network and then to port this code on PowerPC in a
second phase.
The aim of this document is to give some PCI board generalities and
to explain the software architecture of the RTEMS driver. Finally, we will see
what will be done for ChorusOs and Netboot environment .
The aim of this document is to give some PCI board generalities and to explain
the software architecture of the RTEMS driver. Finally, we will see what will
be done for ChorusOs and Netboot environment .
Document Revision History
=========================
@ -47,15 +46,15 @@ This chapter describes rapidely the PCI interface of this Ethernet controller.
The board we have chosen for our PC386 implementation is a D-Link DFE-500TX.
This is a dual-speed 10/100Mbps Ethernet PCI adapter with a DEC21140AF chip.
Like other PCI devices, this board has a PCI device's header containing some
required configuration registers, as shown in the PCI Register Figure.
By reading
or writing these registers, a driver can obtain information about the type of
the board, the interrupt it uses, the mapping of the chip specific registers, ...
required configuration registers, as shown in the PCI Register Figure. By
reading or writing these registers, a driver can obtain information about the
type of the board, the interrupt it uses, the mapping of the chip specific
registers, ...
On Intel target, the chip specific registers can be accessed via 2
methods : I/O port access or PCI address mapped access. We have chosen to implement
the PCI address access to obtain compatible source code to the port the driver
on a PowerPC target.
On Intel target, the chip specific registers can be accessed via 2 methods :
I/O port access or PCI address mapped access. We have chosen to implement the
PCI address access to obtain compatible source code to the port the driver on a
PowerPC target.
.. COMMENT: PCI Device's Configuration Header Space Format
@ -65,17 +64,16 @@ on a PowerPC target.
.. COMMENT: XXX add crossreference to PCI Register Figure
On RTEMS, a PCI API exists. We have used it to configure the board. After initializing
this PCI module via the ``pci_initialize()`` function, we try to detect
the DEC21140 based ethernet board. This board is characterized by its Vendor
ID (0x1011) and its Device ID (0x0009). We give these arguments to the``pcib_find_by_deviceid``
function which returns , if the device is present, a pointer to the configuration
header space (see PCI Registers Fgure). Once this operation performed,
the driver
is able to extract the information it needs to configure the board internal
registers, like the interrupt line, the base address,... The board internal
registers will not be detailled here. You can find them in *DIGITAL
Semiconductor 21140A PCI Fast Ethernet LAN Controller
On RTEMS, a PCI API exists. We have used it to configure the board. After
initializing this PCI module via the ``pci_initialize()`` function, we try to
detect the DEC21140 based ethernet board. This board is characterized by its
Vendor ID (0x1011) and its Device ID (0x0009). We give these arguments to
the``pcib_find_by_deviceid`` function which returns , if the device is present,
a pointer to the configuration header space (see PCI Registers Fgure). Once
this operation performed, the driver is able to extract the information it
needs to configure the board internal registers, like the interrupt line, the
base address,... The board internal registers will not be detailled here. You
can find them in *DIGITAL Semiconductor 21140A PCI Fast Ethernet LAN Controller
- Hardware Reference Manual*.
.. COMMENT: fix citation
@ -89,16 +87,17 @@ host memory and the 2 threads launched at the initialization time.
Initialization phase
--------------------
The DEC21140 Ethernet driver keeps the same software architecture than the other
RTEMS ethernet drivers. The only API the programmer can use is the ``rtems_dec21140_driver_attach````(struct rtems_bsdnet_ifconfig \*config)`` function which
detects the board and initializes the associated data structure (with registers
base address, entry points to low-level initialization function,...), if the
board is found.
The DEC21140 Ethernet driver keeps the same software architecture than the
other RTEMS ethernet drivers. The only API the programmer can use is the
``rtems_dec21140_driver_attach(struct rtems_bsdnet_ifconfig *config)``
function which detects the board and initializes the associated data structure
(with registers base address, entry points to low-level initialization
function,...), if the board is found.
Once the attach function executed, the driver initializes the DEC
chip. Then the driver connects an interrupt handler to the interrupt line driven
by the Ethernet controller (the only interrupt which will be treated is the
receive interrupt) and launches 2 threads : a receiver thread and a transmitter
Once the attach function executed, the driver initializes the DEC chip. Then
the driver connects an interrupt handler to the interrupt line driven by the
Ethernet controller (the only interrupt which will be treated is the receive
interrupt) and launches 2 threads : a receiver thread and a transmitter
thread. Then the driver waits for incoming frame to give to the protocol stack
or outcoming frame to send on the physical link.
@ -108,19 +107,18 @@ Memory Buffer
.. COMMENT: XXX add cross reference to Problem
This DEC chip uses the host memory to store the incoming Ethernet frames and
the descriptor of these frames. We have chosen to use 7 receive buffers and
1 transmit buffer to optimize memory allocation due to cache and paging problem
the descriptor of these frames. We have chosen to use 7 receive buffers and 1
transmit buffer to optimize memory allocation due to cache and paging problem
that will be explained in the section *Encountered Problems*.
To reference these buffers to the DEC chip we use a buffer descriptors
ring. The descriptor structure is defined in the Buffer Descriptor Figure.
Each descriptor
can reference one or two memory buffers. We choose to use only one buffer of
1520 bytes per descriptor.
Each descriptor can reference one or two memory buffers. We choose to use only
one buffer of 1520 bytes per descriptor.
The difference between a receive and a transmit buffer descriptor
is located in the status and control bits fields. We do not give details here,
please refer to the \[DEC21140 Hardware Manual].
The difference between a receive and a transmit buffer descriptor is located in
the status and control bits fields. We do not give details here, please refer
to the DEC21140 Hardware Manual.
.. COMMENT: Buffer Descriptor
@ -132,12 +130,12 @@ Receiver Thread
---------------
This thread is event driven. Each time a DEC PCI board interrupt occurs, the
handler checks if this is a receive interrupt and send an event "reception"
to the receiver thread which looks into the entire buffer descriptors ring the
ones that contain a valid incoming frame (bit OWN=0 means descriptor belongs
to host processor). Each valid incoming ethernet frame is sent to the protocol
stack and the buffer descriptor is given back to the DEC board (the host processor
reset bit OWN, which means descriptor belongs to 21140).
handler checks if this is a receive interrupt and send an event "reception" to
the receiver thread which looks into the entire buffer descriptors ring the
ones that contain a valid incoming frame (bit OWN=0 means descriptor belongs to
host processor). Each valid incoming ethernet frame is sent to the protocol
stack and the buffer descriptor is given back to the DEC board (the host
processor reset bit OWN, which means descriptor belongs to 21140).
Transmitter Thread
------------------
@ -151,47 +149,37 @@ Encountered Problems
====================
On Intel PC386 target, we were faced with a problem of memory cache management.
Because the DEC chip uses the host memory to store the incoming frame and because
the DEC21140 configuration registers are mapped into the PCI address space,
we must ensure that the data read (or written) by the host processor are the
ones written (or read) by the DEC21140 device in the host memory and not old
data stored in the cache memory. Therefore, we had to provide a way to manage
the cache. This module is described in the document *RTEMS
Cache Management For Intel*. On Intel, the
memory region cache management is available only if the paging unit is enabled.
We have used this paging mechanism, with 4Kb page. All the buffers allocated
to store the incoming or outcoming frames, buffer descriptor and also the PCI
address space of the DEC board are located in a memory space with cache disable.
Because the DEC chip uses the host memory to store the incoming frame and
because the DEC21140 configuration registers are mapped into the PCI address
space, we must ensure that the data read (or written) by the host processor are
the ones written (or read) by the DEC21140 device in the host memory and not
old data stored in the cache memory. Therefore, we had to provide a way to
manage the cache. This module is described in the document *RTEMS Cache
Management For Intel*. On Intel, the memory region cache management is
available only if the paging unit is enabled. We have used this paging
mechanism, with 4Kb page. All the buffers allocated to store the incoming or
outcoming frames, buffer descriptor and also the PCI address space of the DEC
board are located in a memory space with cache disable.
Concerning the buffers and their descriptors, we have tried to optimize
the memory space in term of allocated page. One buffer has 1520 bytes, one descriptor
has 16 bytes. We have 7 receive buffers and 1 transmit buffer, and for each,
1 descriptor : (7+1)*(1520+16) = 12288 bytes = 12Kb = 3 entire pages. This
allows not to lose too much memory or not to disable cache memory for a page
which contains other data than buffer, which could decrease performance.
ChorusOs DEC Driver
===================
Because ChorusOs is used in several Canon CRF projects, we must provide such
a driver on this OS to ensure compatibility between the RTEMS and ChorusOs developments.
On ChorusOs, a DEC driver source code already exists but only for a PowerPC
target. We plan to port this code (which uses ChorusOs API) on Intel target.
This will allow us to have homogeneous developments. Moreover, the port of the
development performed with ChorusOs environment to RTEMS environment will be
easier for the developers.
Concerning the buffers and their descriptors, we have tried to optimize the
memory space in term of allocated page. One buffer has 1520 bytes, one
descriptor has 16 bytes. We have 7 receive buffers and 1 transmit buffer, and
for each, 1 descriptor : (7+1)*(1520+16) = 12288 bytes = 12Kb = 3 entire
pages. This allows not to lose too much memory or not to disable cache memory
for a page which contains other data than buffer, which could decrease
performance.
Netboot DEC driver
==================
We use Netboot tool to load our development from a server to the target via
an ethernet network. Currently, this tool does not support the DEC board. We
plan to port the DEC driver for the Netboot tool.
We use Netboot tool to load our development from a server to the target via an
ethernet network. Currently, this tool does not support the DEC board. We plan
to port the DEC driver for the Netboot tool.
But concerning the port of the DEC driver into Netboot, we are faced
with a problem : in RTEMS environment, the DEC driver is interrupt or event
driven, in Netboot environment, it must be used in polling mode. It means that
we will have to re-write some mechanisms of this driver.
But concerning the port of the DEC driver into Netboot, we are faced with a
problem: in RTEMS environment, the DEC driver is interrupt or event driven, in
Netboot environment, it must be used in polling mode. It means that we will
have to re-write some mechanisms of this driver.
List of Ethernet cards using the DEC chip
=========================================
@ -238,9 +226,7 @@ of adapters which support this driver :
Our DEC driver has not been tested with all these cards, only with the D-Link
DFE500-TX.
- *[DEC21140 Hardware Manual] DIGITAL, *DIGITAL
Semiconductor 21140A PCI Fast Ethernet LAN Controller - Hardware
Reference Manual**.
- DEC21140 Hardware Manual DIGITAL, DIGITAL Semiconductor 21140A PCI Fast
Ethernet LAN Controller - Hardware Reference Manual**.
- *[99.TA.0021.M.ER]Emmanuel Raguet,*RTEMS Cache Management For Intel**.

55
networking/index.rst
View File

@ -1,36 +1,35 @@
========================
RTEMS Network Supplement
========================
COPYRIGHT (c) 1988 - 2015.
.. highlight:: c
On-Line Applications Research Corporation (OAR).
===================================
RTEMS |version| Network User Manual
===================================
The authors have used their best efforts in preparing
this material. These efforts include the development, research,
and testing of the theories and programs to determine their
effectiveness. No warranty of any kind, expressed or implied,
with regard to the software or the material contained in this
document is provided. No liability arising out of the
application or use of any product described in this document is
assumed. The authors reserve the right to revise this material
and to make changes from time to time in the content hereof
without obligation to notify anyone of such revision or changes.
| COPYRIGHT (c) 1988 - 2015.
| On-Line Applications Research Corporation (OAR).
The RTEMS Project is hosted at http://www.rtems.org. Any
inquiries concerning RTEMS, its related support components, or its
documentation should be directed to the Community Project hosted athttp://www.rtems.org.
The authors have used their best efforts in preparing this material. These
efforts include the development, research, and testing of the theories and
programs to determine their effectiveness. No warranty of any kind, expressed
or implied, with regard to the software or the material contained in this
document is provided. No liability arising out of the application or use of
any product described in this document is assumed. The authors reserve the
right to revise this material and to make changes from time to time in the
content hereof without obligation to notify anyone of such revision or changes.
Any inquiries for commercial services including training, support, custom
development, application development assistance should be directed tohttp://www.rtems.com.
The RTEMS Project is hosted at http://www.rtems.org/. Any inquiries concerning
RTEMS, its related support components, or its documentation should be directed
to the Community Project hosted at http://www.rtems.org/.
.. topic:: RTEMS Online Resources
Table of Contents
-----------------
.. toctree::
preface
================ =============================
Home https://www.rtems.org/
Developers https://devel.rtems.org/
Documentation https://docs.rtems.org/
Bug Reporting https://devel.rtems.org/query
Mailing Lists https://lists.rtems.org/
Git Repositories https://git.rtems.org/
================ =============================
.. toctree::
:maxdepth: 3
@ -45,7 +44,5 @@ Table of Contents
dec_21140
command
* :ref:`genindex`
* :ref:`search`

91
networking/network_servers.rst
View File

@ -1,16 +1,18 @@
.. COMMENT: RTEMS Remote Debugger Server Specifications
.. COMMENT: Written by: Emmanuel Raguet <raguet@crf.canon.fr>
Network Servers
###############
RTEMS FTP Daemon
================
The RTEMS FTPD is a complete file transfer protocol (FTP) daemon
which can store, retrieve, and manipulate files on the local
filesystem. In addition, the RTEMS FTPD provides "hooks"
which are actions performed on received data. Hooks are useful
in situations where a destination file is not necessarily
appropriate or in cases when a formal device driver has not yet
been implemented.
The RTEMS FTPD is a complete file transfer protocol (FTP) daemon which can
store, retrieve, and manipulate files on the local filesystem. In addition,
the RTEMS FTPD provides "hooks" which are actions performed on received data.
Hooks are useful in situations where a destination file is not necessarily
appropriate or in cases when a formal device driver has not yet been
implemented.
This server was implemented and documented by Jake Janovetz
(janovetz@tempest.ece.uiuc.edu).
@ -19,61 +21,63 @@ Configuration Parameters
------------------------
The configuration structure for FTPD is as follows:
.. code:: c
.. code-block:: c
struct rtems_ftpd_configuration
{
rtems_task_priority priority; /* FTPD task priority \*/
unsigned long max_hook_filesize; /* Maximum buffersize \*/
/* for hooks \*/
int port; /* Well-known port \*/
struct rtems_ftpd_hook \*hooks; /* List of hooks \*/
rtems_task_priority priority; /* FTPD task priority */
unsigned long max_hook_filesize; /* Maximum buffersize */
/* for hooks */
int port; /* Well-known port */
struct rtems_ftpd_hook *hooks; /* List of hooks */
};
The FTPD task priority is specified with ``priority``. Because
hooks are not saved as files, the received data is placed in an
allocated buffer. ``max_hook_filesize`` specifies the maximum
size of this buffer. Finally, ``hooks`` is a pointer to the
configured hooks structure.
The FTPD task priority is specified with ``priority``. Because hooks are not
saved as files, the received data is placed in an allocated buffer.
``max_hook_filesize`` specifies the maximum size of this buffer. Finally,
``hooks`` is a pointer to the configured hooks structure.
Initializing FTPD (Starting the daemon)
---------------------------------------
Starting FTPD is done with a call to ``rtems_initialize_ftpd()``.
The configuration structure must be provided in the application
source code. Example hooks structure and configuration structure
folllow.
.. code:: c
Starting FTPD is done with a call to ``rtems_initialize_ftpd()``. The
configuration structure must be provided in the application source code.
Example hooks structure and configuration structure folllow.
.. code-block:: c
struct rtems_ftpd_hook ftp_hooks[] =
{
{"untar", Untar_FromMemory},
{NULL, NULL}
};
struct rtems_ftpd_configuration rtems_ftpd_configuration =
{
40, /* FTPD task priority \*/
512*1024, /* Maximum hook 'file' size \*/
0, /* Use default port \*/
ftp_hooks /* Local ftp hooks \*/
{"untar", Untar_FromMemory},
{NULL, NULL}
};
Specifying 0 for the well-known port causes FTPD to use the
UNIX standard FTPD port (21).
struct rtems_ftpd_configuration rtems_ftpd_configuration =
{
40, /* FTPD task priority */
512*1024, /* Maximum hook 'file' size */
0, /* Use default port */
ftp_hooks /* Local ftp hooks */
};
Specifying 0 for the well-known port causes FTPD to use the UNIX standard FTPD
port (21).
Using Hooks
-----------
In the example above, one hook was installed. The hook causes
FTPD to call the function ``Untar_FromMemory`` when the
user sends data to the file ``untar``. The prototype for
the ``untar`` hook (and hooks, in general) is:
.. code:: c
In the example above, one hook was installed. The hook causes FTPD to call the
function ``Untar_FromMemory`` when the user sends data to the file ``untar``.
The prototype for the ``untar`` hook (and hooks, in general) is:
int Untar_FromMemory(unsigned char \*tar_buf, unsigned long size);
.. code-block:: c
int Untar_FromMemory(unsigned char *tar_buf, unsigned long size);
An example FTP transcript which exercises this hook is:
.. code:: c
.. code-block:: shell
220 RTEMS FTP server (Version 1.0-JWJ) ready.
Name (dcomm0:janovetz): John Galt
@ -102,8 +106,3 @@ An example FTP transcript which exercises this hook is:
226 Transfer complete.
ftp> quit
221 Goodbye.
.. COMMENT: RTEMS Remote Debugger Server Specifications
.. COMMENT: Written by: Emmanuel Raguet <raguet@crf.canon.fr>

50
networking/network_task_structure.rst
View File

@ -1,38 +1,32 @@
.. COMMENT: Written by Eric Norum
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
Network Task Structure and Data Flow
####################################
A schematic diagram of the tasks and message *mbuf* queues in a
simple RTEMS networking application is shown in the following
figure:
A schematic diagram of the tasks and message *mbuf* queues in a simple RTEMS
networking application is shown in the following figure:
.. image:: images/networkflow.jpg
The transmit task for each network interface is normally blocked waiting
for a packet to arrive in the transmit queue. Once a packet arrives, the
transmit task may block waiting for an event from the transmit interrupt
handler. The transmit interrupt handler sends an RTEMS event to the transmit
task to indicate that transmit hardware resources have become available.
The transmit task for each network interface is normally blocked waiting for a
packet to arrive in the transmit queue. Once a packet arrives, the transmit
task may block waiting for an event from the transmit interrupt handler. The
transmit interrupt handler sends an RTEMS event to the transmit task to
indicate that transmit hardware resources have become available.
The receive task for each network interface is normally blocked waiting
for an event from the receive interrupt handler. When this event is received
the receive task reads the packet and forwards it to the network stack
for subsequent processing by the network task.
The receive task for each network interface is normally blocked waiting for an
event from the receive interrupt handler. When this event is received the
receive task reads the packet and forwards it to the network stack for
subsequent processing by the network task.
The network task processes incoming packets and takes care of
timed operations such as handling TCP timeouts and
aging and removing routing table entries.
The 'Network code' contains routines which may run in the context of
the user application tasks, the interface receive task or the network task.
A network semaphore ensures that
the data structures manipulated by the network code remain consistent.
.. COMMENT: Written by Eric Norum
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
The network task processes incoming packets and takes care of timed operations
such as handling TCP timeouts and aging and removing routing table entries.
The 'Network code' contains routines which may run in the context of the user
application tasks, the interface receive task or the network task. A network
semaphore ensures that the data structures manipulated by the network code
remain consistent.

364
networking/networking_driver.rst
View File

@ -1,182 +1,177 @@
.. COMMENT: Written by Eric Norum
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
Networking Driver
#################
Introduction
============
This chapter is intended to provide an introduction to the
procedure for writing RTEMS network device drivers.
The example code is taken from the 'Generic 68360' network device
driver. The source code for this driver is located in the``c/src/lib/libbsp/m68k/gen68360/network`` directory in the RTEMS
source code distribution. Having a copy of this driver at
hand when reading the following notes will help significantly.
This chapter is intended to provide an introduction to the procedure for
writing RTEMS network device drivers. The example code is taken from the
'Generic 68360' network device driver. The source code for this driver is
located in the :file:`c/src/lib/libbsp/m68k/gen68360/network` directory in the
RTEMS source code distribution. Having a copy of this driver at hand when
reading the following notes will help significantly.
Learn about the network device
==============================
Before starting to write the network driver become completely
familiar with the programmer's view of the device.
The following points list some of the details of the
device that must be understood before a driver can be written.
Before starting to write the network driver become completely familiar with the
programmer's view of the device. The following points list some of the details
of the device that must be understood before a driver can be written.
- Does the device use DMA to transfer packets to and from
memory or does the processor have to
copy packets to and from memory on the device?
- Does the device use DMA to transfer packets to and from memory or does the
processor have to copy packets to and from memory on the device?
- If the device uses DMA, is it capable of forming a single
outgoing packet from multiple fragments scattered in separate
memory buffers?
- If the device uses DMA, is it capable of forming a single outgoing packet
from multiple fragments scattered in separate memory buffers?
- If the device uses DMA, is it capable of chaining multiple
outgoing packets, or does each outgoing packet require
intervention by the driver?
- If the device uses DMA, is it capable of chaining multiple outgoing packets,
or does each outgoing packet require intervention by the driver?
- Does the device automatically pad short frames to the minimum
64 bytes or does the driver have to supply the padding?
- Does the device automatically pad short frames to the minimum 64 bytes or
does the driver have to supply the padding?
- Does the device automatically retry a transmission on detection
of a collision?
- Does the device automatically retry a transmission on detection of a
collision?
- If the device uses DMA, is it capable of buffering multiple
packets to memory, or does the receiver have to be restarted
after the arrival of each packet?
- If the device uses DMA, is it capable of buffering multiple packets to
memory, or does the receiver have to be restarted after the arrival of each
packet?
- How are packets that are too short, too long, or received with
CRC errors handled? Does the device automatically continue
reception or does the driver have to intervene?
- How are packets that are too short, too long, or received with CRC errors
handled? Does the device automatically continue reception or does the driver
have to intervene?
- How is the device Ethernet address set? How is the device
programmed to accept or reject broadcast and multicast packets?
- How is the device Ethernet address set? How is the device programmed to
accept or reject broadcast and multicast packets?
- What interrupts does the device generate? Does it generate an
interrupt for each incoming packet, or only for packets received
without error? Does it generate an interrupt for each packet
transmitted, or only when the transmit queue is empty? What
happens when a transmit error is detected?
- What interrupts does the device generate? Does it generate an interrupt for
each incoming packet, or only for packets received without error? Does it
generate an interrupt for each packet transmitted, or only when the transmit
queue is empty? What happens when a transmit error is detected?
In addition, some controllers have specific questions regarding
board specific configuration. For example, the SONIC Ethernet
controller has a very configurable data bus interface. It can
even be configured for sixteen and thirty-two bit data buses. This
type of information should be obtained from the board vendor.
In addition, some controllers have specific questions regarding board specific
configuration. For example, the SONIC Ethernet controller has a very
configurable data bus interface. It can even be configured for sixteen and
thirty-two bit data buses. This type of information should be obtained from
the board vendor.
Understand the network scheduling conventions
=============================================
When writing code for the driver transmit and receive tasks,
take care to follow the network scheduling conventions. All tasks
which are associated with networking share various
data structures and resources. To ensure the consistency
of these structures the tasks
execute only when they hold the network semaphore (``rtems_bsdnet_semaphore``).
The transmit and receive tasks must abide by this protocol. Be very
careful to avoid 'deadly embraces' with the other network tasks.
A number of routines are provided to make it easier for the network
driver code to conform to the network task scheduling conventions.
When writing code for the driver transmit and receive tasks, take care to
follow the network scheduling conventions. All tasks which are associated with
networking share various data structures and resources. To ensure the
consistency of these structures the tasks execute only when they hold the
network semaphore (``rtems_bsdnet_semaphore``). The transmit and receive tasks
must abide by this protocol. Be very careful to avoid 'deadly embraces' with
the other network tasks. A number of routines are provided to make it easier
for the network driver code to conform to the network task scheduling
conventions.
- ``void rtems_bsdnet_semaphore_release(void)``
This function releases the network semaphore.
The network driver tasks must call this function immediately before
making any blocking RTEMS request.
This function releases the network semaphore. The network driver tasks must
call this function immediately before making any blocking RTEMS request.
- ``void rtems_bsdnet_semaphore_obtain(void)``
This function obtains the network semaphore.
If a network driver task has released the network semaphore to allow other
network-related tasks to run while the task blocks, then this function must
be called to reobtain the semaphore immediately after the return from the
blocking RTEMS request.
This function obtains the network semaphore. If a network driver task has
released the network semaphore to allow other network-related tasks to run
while the task blocks, then this function must be called to reobtain the
semaphore immediately after the return from the blocking RTEMS request.
- ``rtems_bsdnet_event_receive(rtems_event_set, rtems_option, rtems_interval, rtems_event_set \*)``
The network driver task should call this function when it wishes to wait
for an event. This function releases the network semaphore,
calls ``rtems_event_receive`` to wait for the specified event
or events and reobtains the semaphore.
The value returned is the value returned by the ``rtems_event_receive``.
- ``rtems_bsdnet_event_receive(rtems_event_set, rtems_option, rtems_interval, rtems_event_set *)``
The network driver task should call this function when it wishes to wait for
an event. This function releases the network semaphore, calls
``rtems_event_receive`` to wait for the specified event or events and
reobtains the semaphore. The value returned is the value returned by the
``rtems_event_receive``.
Network Driver Makefile
=======================
Network drivers are considered part of the BSD network package and as such
are to be compiled with the appropriate flags. This can be accomplished by
adding ``-D__INSIDE_RTEMS_BSD_TCPIP_STACK__`` to the ``command line``.
If the driver is inside the RTEMS source tree or is built using the
RTEMS application Makefiles, then adding the following line accomplishes
this:
.. code:: c
Network drivers are considered part of the BSD network package and as such are
to be compiled with the appropriate flags. This can be accomplished by adding
``-D__INSIDE_RTEMS_BSD_TCPIP_STACK__`` to the ``command line``. If the driver
is inside the RTEMS source tree or is built using the RTEMS application
Makefiles, then adding the following line accomplishes this:
.. code-block:: c
DEFINES += -D__INSIDE_RTEMS_BSD_TCPIP_STACK__
This is equivalent to the following list of definitions. Early versions
of the RTEMS BSD network stack required that all of these be defined.
This is equivalent to the following list of definitions. Early versions of the
RTEMS BSD network stack required that all of these be defined.
.. code:: c
.. code-block:: c
-D_COMPILING_BSD_KERNEL_ -DKERNEL -DINET -DNFS \\
-DDIAGNOSTIC -DBOOTP_COMPAT
-D_COMPILING_BSD_KERNEL_ -DKERNEL -DINET -DNFS \
-DDIAGNOSTIC -DBOOTP_COMPAT
Defining these macros tells the network header files that the driver
is to be compiled with extended visibility into the network stack. This
is in sharp contrast to applications that simply use the network stack.
Applications do not require this level of visibility and should stick
to the portable application level API.
Defining these macros tells the network header files that the driver is to be
compiled with extended visibility into the network stack. This is in sharp
contrast to applications that simply use the network stack. Applications do
not require this level of visibility and should stick to the portable
application level API.
As a direct result of being logically internal to the network stack,
network drivers use the BSD memory allocation routines This means,
for example, that malloc takes three arguments. See the SONIC
device driver (``c/src/lib/libchip/network/sonic.c``) for an example
of this. Because of this, network drivers should not include``<stdlib.h>``. Doing so will result in conflicting definitions
of ``malloc()``.
As a direct result of being logically internal to the network stack, network
drivers use the BSD memory allocation routines This means, for example, that
malloc takes three arguments. See the SONIC device driver
(:file:`c/src/lib/libchip/network/sonic.c`) for an example of this. Because of
this, network drivers should not include ``<stdlib.h>``. Doing so will result
in conflicting definitions of ``malloc()``.
*Application level* code including network servers such as the FTP
daemon are *not* part of the BSD kernel network code and should not be
compiled with the BSD network flags. They should include``<stdlib.h>`` and not define the network stack visibility
macros.
*Application level* code including network servers such as the FTP daemon are
*not* part of the BSD kernel network code and should not be compiled with the
BSD network flags. They should include ``<stdlib.h>`` and not define the
network stack visibility macros.
Write the Driver Attach Function
================================
The driver attach function is responsible for configuring the driver
and making the connection between the network stack
and the driver.
The driver attach function is responsible for configuring the driver and making
the connection between the network stack and the driver.
Driver attach functions take a pointer to an``rtems_bsdnet_ifconfig`` structure as their only argument.
and set the driver parameters based on the
values in this structure. If an entry in the configuration
structure is zero the attach function chooses an
appropriate default value for that parameter.
Driver attach functions take a pointer to an ``rtems_bsdnet_ifconfig``
structure as their only argument. and set the driver parameters based on the
values in this structure. If an entry in the configuration structure is zero
the attach function chooses an appropriate default value for that parameter.
The driver should then set up several fields in the ifnet structure
in the device-dependent data structure supplied and maintained by the driver:
The driver should then set up several fields in the ifnet structure in the
device-dependent data structure supplied and maintained by the driver:
``ifp->if_softc``
Pointer to the device-dependent data. The first entry
in the device-dependent data structure must be an ``arpcom``
structure.
Pointer to the device-dependent data. The first entry in the
device-dependent data structure must be an ``arpcom`` structure.
``ifp->if_name``
The name of the device. The network stack uses this string
and the device number for device name lookups. The device name should
be obtained from the ``name`` entry in the configuration structure.
The name of the device. The network stack uses this string and the device
number for device name lookups. The device name should be obtained from
the ``name`` entry in the configuration structure.
``ifp->if_unit``
The device number. The network stack uses this number and the
device name for device name lookups. For example, if``ifp->if_name`` is '``scc``' and ``ifp->if_unit`` is '``1``',
the full device name would be '``scc1``'. The unit number should be
obtained from the 'name' entry in the configuration structure.
The device number. The network stack uses this number and the device name
for device name lookups. For example, if ``ifp->if_name`` is ``scc`` and
``ifp->if_unit`` is ``1``, the full device name would be ``scc1``. The
unit number should be obtained from the 'name' entry in the configuration
structure.
``ifp->if_mtu``
The maximum transmission unit for the device. For Ethernet
devices this value should almost always be 1500.
The maximum transmission unit for the device. For Ethernet devices this
value should almost always be 1500.
``ifp->if_flags``
The device flags. Ethernet devices should set the flags
to ``IFF_BROADCAST|IFF_SIMPLEX``, indicating that the
device can broadcast packets to multiple destinations
and does not receive and transmit at the same time.
The device flags. Ethernet devices should set the flags to
``IFF_BROADCAST|IFF_SIMPLEX``, indicating that the device can broadcast
packets to multiple destinations and does not receive and transmit at the
same time.
``ifp->if_snd.ifq_maxlen``
The maximum length of the queue of packets waiting to be
sent to the driver. This is normally set to ``ifqmaxlen``.
The maximum length of the queue of packets waiting to be sent to the
driver. This is normally set to ``ifqmaxlen``.
``ifp->if_init``
The address of the driver initialization function.
@ -188,91 +183,91 @@ in the device-dependent data structure supplied and maintained by the driver:
The address of the driver ioctl function.
``ifp->if_output``
The address of the output function. Ethernet devices
should set this to ``ether_output``.
The address of the output function. Ethernet devices should set this to
``ether_output``.
RTEMS provides a function to parse the driver name in the
configuration structure into a device name and unit number.
.. code:: c
RTEMS provides a function to parse the driver name in the configuration
structure into a device name and unit number.
.. code-block:: c
int rtems_bsdnet_parse_driver_name (
const struct rtems_bsdnet_ifconfig \*config,
char \**namep
const struct rtems_bsdnet_ifconfig *config,
char **namep
);
The function takes two arguments; a pointer to the configuration
structure and a pointer to a pointer to a character. The function
parses the configuration name entry, allocates memory for the driver
name, places the driver name in this memory, sets the second argument
to point to the name and returns the unit number.
On error, a message is printed and -1 is returned.
The function takes two arguments; a pointer to the configuration structure and
a pointer to a pointer to a character. The function parses the configuration
name entry, allocates memory for the driver name, places the driver name in
this memory, sets the second argument to point to the name and returns the unit
number. On error, a message is printed and ``-1`` is returned.
Once the attach function has set up the above entries it must link the
driver data structure onto the list of devices by
calling ``if_attach``. Ethernet devices should then
call ``ether_ifattach``. Both functions take a pointer to the
device's ``ifnet`` structure as their only argument.
Once the attach function has set up the above entries it must link the driver
data structure onto the list of devices by calling ``if_attach``. Ethernet
devices should then call ``ether_ifattach``. Both functions take a pointer to
the device's ``ifnet`` structure as their only argument.
The attach function should return a non-zero value to indicate that
the driver has been successfully configured and attached.
The attach function should return a non-zero value to indicate that the driver
has been successfully configured and attached.
Write the Driver Start Function.
================================
This function is called each time the network stack wants to start the
transmitter. This occures whenever the network stack adds a packet
to a device's send queue and the ``IFF_OACTIVE`` bit in the
device's ``if_flags`` is not set.
transmitter. This occures whenever the network stack adds a packet to a
device's send queue and the ``IFF_OACTIVE`` bit in the device's ``if_flags`` is
not set.
For many devices this function need only set the ``IFF_OACTIVE`` bit in the``if_flags`` and send an event to the transmit task
indicating that a packet is in the driver transmit queue.
For many devices this function need only set the ``IFF_OACTIVE`` bit in the
``if_flags`` and send an event to the transmit task indicating that a packet is
in the driver transmit queue.
Write the Driver Initialization Function.
=========================================
This function should initialize the device, attach to interrupt handler,
and start the driver transmit and receive tasks. The function
.. code:: c
This function should initialize the device, attach to interrupt handler, and
start the driver transmit and receive tasks. The function
.. code-block:: c
rtems_id
rtems_bsdnet_newproc (char \*name,
int stacksize,
void(\*entry)(void \*),
void \*arg);
rtems_bsdnet_newproc (char *name,
int stacksize,
void(*entry)(void *),
void *arg);
should be used to start the driver tasks.
Note that the network stack may call the driver initialization function more
than once.
Make sure multiple versions of the receive and transmit tasks are not accidentally
started.
than once. Make sure multiple versions of the receive and transmit tasks are
not accidentally started.
Write the Driver Transmit Task
==============================
This task is reponsible for removing packets from the driver send queue and sending them to the device. The task should block waiting for an event from the
driver start function indicating that packets are waiting to be transmitted.
When the transmit task has drained the driver send queue the task should clear
the ``IFF_OACTIVE`` bit in ``if_flags`` and block until another outgoing
packet is queued.
This task is reponsible for removing packets from the driver send queue and
sending them to the device. The task should block waiting for an event from
the driver start function indicating that packets are waiting to be
transmitted. When the transmit task has drained the driver send queue the task
should clear the ``IFF_OACTIVE`` bit in ``if_flags`` and block until another
outgoing packet is queued.
Write the Driver Receive Task
=============================
This task should block until a packet arrives from the device. If the
device is an Ethernet interface the function ``ether_input`` should be called
to forward the packet to the network stack. The arguments to ``ether_input``
are a pointer to the interface data structure, a pointer to the ethernet
header and a pointer to an mbuf containing the packet itself.
This task should block until a packet arrives from the device. If the device
is an Ethernet interface the function ``ether_input`` should be called to
forward the packet to the network stack. The arguments to ``ether_input`` are
a pointer to the interface data structure, a pointer to the ethernet header and
a pointer to an mbuf containing the packet itself.
Write the Driver Interrupt Handler
==================================
A typical interrupt handler will do nothing more than the hardware
manipulation required to acknowledge the interrupt and send an RTEMS event
to wake up the driver receive or transmit task waiting for the event.
Network interface interrupt handlers must not make any calls to other
network routines.
A typical interrupt handler will do nothing more than the hardware manipulation
required to acknowledge the interrupt and send an RTEMS event to wake up the
driver receive or transmit task waiting for the event. Network interface
interrupt handlers must not make any calls to other network routines.
Write the Driver IOCTL Function
===============================
@ -283,43 +278,28 @@ commands which must be handled are:
``SIOCGIFADDR``
``SIOCSIFADDR``
If the device is an Ethernet interface these
commands should be passed on to ``ether_ioctl``.
If the device is an Ethernet interface these commands should be passed on
to ``ether_ioctl``.
``SIOCSIFFLAGS``
This command should be used to start or stop the device,
depending on the state of the interface ``IFF_UP`` and``IFF_RUNNING`` bits in ``if_flags``:
This command should be used to start or stop the device, depending on the
state of the interface ``IFF_UP`` and ``IFF_RUNNING`` bits in ``if_flags``:
``IFF_RUNNING``
Stop the device.
``IFF_UP``
Start the device.
``IFF_UP|IFF_RUNNING``
Stop then start the device.
``0``
Do nothing.
Write the Driver Statistic-Printing Function
============================================
This function should print the values of any statistic/diagnostic
counters the network driver may use. The driver ioctl function should call
the statistic-printing function when the ioctl command is``SIO_RTEMS_SHOW_STATS``.
.. COMMENT: Written by Eric Norum
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
This function should print the values of any statistic/diagnostic counters the
network driver may use. The driver ioctl function should call the
statistic-printing function when the ioctl command is ``SIO_RTEMS_SHOW_STATS``.

49
networking/preface.rst
View File

@ -1,45 +1,38 @@
=======
.. COMMENT: Written by Eric Norum
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
Preface
=======
#######
This document describes the RTEMS specific parts of the FreeBSD TCP/IP
stack. Much of this documentation was written by Eric Norum
(eric@skatter.usask.ca)
of the Saskatchewan Accelerator Laboratory
who also ported the FreeBSD TCP/IP stack to RTEMS.
This document describes the RTEMS specific parts of the FreeBSD TCP/IP stack.
Much of this documentation was written by Eric Norum (eric@skatter.usask.ca) of
the Saskatchewan Accelerator Laboratory who also ported the FreeBSD TCP/IP
stack to RTEMS.
The following is a list of resources which should be useful in trying
to understand Ethernet:
The following is a list of resources which should be useful in trying to
understand Ethernet:
- *Charles Spurgeon's Ethernet Web Site*
"This site provides extensive information about Ethernet
(IEEE 802.3) local area network (LAN) technology. Including
the original 10 Megabit per second (Mbps) system, the 100 Mbps
Fast Ethernet system (802.3u), and the Gigabit Ethernet system (802.3z)."
The URL is:
"This site provides extensive information about Ethernet (IEEE 802.3) local
area network (LAN) technology. Including the original 10 Megabit per second
(Mbps) system, the 100 Mbps Fast Ethernet system (802.3u), and the Gigabit
Ethernet system (802.3z)." The URL is:
(http://www.ethermanage.com/ethernet/ethernet.html)
- *TCP/IP Illustrated, Volume 1 : The Protocols* by
- *TCP/IP Illustrated, Volume 1 : The Protocols*
by W. Richard Stevens (ISBN: 0201633469)
This book provides detailed introduction to TCP/IP and includes diagnostic
programs which are publicly available.
- *TCP/IP Illustrated, Volume 2 : The Implementation* by W. Richard
Stevens and Gary Wright (ISBN: 020163354X)
- *TCP/IP Illustrated, Volume 2 : The Implementation*
by W. Richard Stevens and Gary Wright (ISBN: 020163354X)
This book focuses on implementation issues regarding TCP/IP. The
treat for RTEMS users is that the implementation covered is the BSD
stack with most of the source code described in detail.
- *UNIX Network Programming, Volume 1 : 2nd Edition* by W. Richard
Stevens (ISBN: 0-13-490012-X)
- *UNIX Network Programming, Volume 1 : 2nd Edition*
by W. Richard Stevens (ISBN: 0-13-490012-X)
This book describes how to write basic TCP/IP applications, again with primary
focus on the BSD stack.
.. COMMENT: Written by Eric Norum
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.

283
networking/testing_the_driver.rst
View File

@ -1,3 +1,8 @@
.. COMMENT: Text Written by Jake Janovetz
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
Testing the Driver
##################
@ -6,89 +11,84 @@ Preliminary Setup
The network used to test the driver should include at least:
- The hardware on which the driver is to run.
It makes testing much easier if you can run a debugger to control
the operation of the target machine.
- The hardware on which the driver is to run. It makes testing much easier if
you can run a debugger to control the operation of the target machine.
- An Ethernet network analyzer or a workstation with an
'Ethernet snoop' program such as ``ethersnoop`` or``tcpdump``.
- An Ethernet network analyzer or a workstation with an 'Ethernet snoop'
program such as ``ethersnoop`` or ``tcpdump``.
- A workstation.
During early debug, you should consider putting the target, workstation,
and snooper on a small network by themselves. This offers a few
advantages:
During early debug, you should consider putting the target, workstation, and
snooper on a small network by themselves. This offers a few advantages:
- There is less traffic to look at on the snooper and for the target
to process while bringing the driver up.
- There is less traffic to look at on the snooper and for the target to process
while bringing the driver up.
- Any serious errors will impact only your small network not a building
or campus network. You want to avoid causing any unnecessary problems.
- Any serious errors will impact only your small network not a building or
campus network. You want to avoid causing any unnecessary problems.
- Test traffic is easier to repeatably generate.
- Performance measurements are not impacted by other systems on
the network.
- Performance measurements are not impacted by other systems on the network.
Debug Output
============
There are a number of sources of debug output that can be enabled
to aid in tracing the behavior of the network stack. The following
is a list of them:
There are a number of sources of debug output that can be enabled to aid in
tracing the behavior of the network stack. The following is a list of them:
- mbuf activity
There are commented out calls to ``printf`` in the file``sys/mbuf.h`` in the network stack code. Uncommenting
these lines results in output when mbuf's are allocated
and freed. This is very useful for finding memory leaks.
There are commented out calls to ``printf`` in the file ``sys/mbuf.h`` in the
network stack code. Uncommenting these lines results in output when mbuf's
are allocated and freed. This is very useful for finding memory leaks.
- TX and RX queuing
There are commented out calls to ``printf`` in the file``net/if.h`` in the network stack code. Uncommenting
these lines results in output when packets are placed
on or removed from one of the transmit or receive packet
queues. These queues can be viewed as the boundary line
between a device driver and the network stack. If the
network stack is enqueuing packets to be transmitted that
the device driver is not dequeuing, then that is indicative
of a problem in the transmit side of the device driver.
Conversely, if the device driver is enqueueing packets
as it receives them (via a call to ``ether_input``) and
they are not being dequeued by the network stack,
then there is a problem. This situation would likely indicate
that the network server task is not running.
There are commented out calls to ``printf`` in the file ``net/if.h`` in the
network stack code. Uncommenting these lines results in output when packets
are placed on or removed from one of the transmit or receive packet queues.
These queues can be viewed as the boundary line between a device driver and
the network stack. If the network stack is enqueuing packets to be
transmitted that the device driver is not dequeuing, then that is indicative
of a problem in the transmit side of the device driver. Conversely, if the
device driver is enqueueing packets as it receives them (via a call to
``ether_input``) and they are not being dequeued by the network stack, then
there is a problem. This situation would likely indicate that the network
server task is not running.
- TCP state transitions
In the unlikely event that one would actually want to see
TCP state transitions, the ``TCPDEBUG`` macro can be defined
in the file ``opt_tcpdebug.h``. This results in the routine``tcp_trace()`` being called by the network stack and
the state transitions logged into the ``tcp_debug`` data
structure. If the variable ``tcpconsdebug`` in the file``netinet/tcp_debug.c`` is set to 1, then the state transitions
will also be printed to the console.
In the unlikely event that one would actually want to see TCP state
transitions, the ``TCPDEBUG`` macro can be defined in the file
``opt_tcpdebug.h``. This results in the routine ``tcp_trace()`` being called
by the network stack and the state transitions logged into the ``tcp_debug``
data structure. If the variable ``tcpconsdebug`` in the file
``netinet/tcp_debug.c`` is set to ``1``, then the state transitions will also
be printed to the console.
Monitor Commands
================
There are a number of command available in the shell / monitor
to aid in tracing the behavior of the network stack. The following
is a list of them:
There are a number of command available in the shell / monitor to aid in
tracing the behavior of the network stack. The following is a list of them:
- ``inet``
This command shows the current routing information for the TCP/IP stack. Following is an
example showing the output of this command.
This command shows the current routing information for the TCP/IP
stack. Following is an example showing the output of this command.
.. code:: c
.. code-block:: shell
Destination Gateway/Mask/Hw Flags Refs Use Expire Interface
10.0.0.0 255.0.0.0 U 0 0 17 smc1
127.0.0.1 127.0.0.1 UH 0 0 0 lo0
In this example, there is only one network interface with an IP address of 10.8.1.1. This
link is currently not up.
Two routes that are shown are the default routes for the Ethernet interface (10.0.0.0) and the
loopback interface (127.0.0.1).
Since the stack comes from BSD, this command is very similar to the netstat command. For more
details on the network routing please look the following
URL: (http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-routing.html)
In this example, there is only one network interface with an IP address of
10.8.1.1. This link is currently not up. Two routes that are shown are the
default routes for the Ethernet interface (10.0.0.0) and the loopback
interface (127.0.0.1). Since the stack comes from BSD, this command is very
similar to the netstat command. For more details on the network routing
please look the following URL:
(http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-routing.html)
For a quick reference to the flags, see the table below:
'``U``'
@ -98,43 +98,44 @@ is a list of them:
Host: The route destination is a single host.
'``G``'
Gateway: Send anything for this destination on to this remote system, which
will figure out from there where to send it.
Gateway: Send anything for this destination on to this remote system,
which will figure out from there where to send it.
'``S``'
Static: This route was configured manually, not automatically generated by the
system.
Static: This route was configured manually, not automatically generated
by the system.
'``C``'
Clone: Generates a new route based upon this route for machines we connect
to. This type of route is normally used for local networks.
Clone: Generates a new route based upon this route for machines we
connect to. This type of route is normally used for local networks.
'``W``'
WasCloned: Indicated a route that was auto-configured based upon a local area
network (Clone) route.
WasCloned: Indicated a route that was auto-configured based upon a local
area network (Clone) route.
'``L``'
Link: Route involves references to Ethernet hardware.
- ``mbuf``
This command shows the current MBUF statistics. An example of the command is
shown below:
This command shows the current MBUF statistics. An example of the command is shown below:
.. code:: c
.. code-block:: shell
************ MBUF STATISTICS \************
mbufs:4096 clusters: 256 free: 241
drops: 0 waits: 0 drains: 0
free:4080 data:16 header:0 socket:0
pcb:0 rtable:0 htable:0 atable:0
soname:0 soopts:0 ftable:0 rights:0
ifaddr:0 control:0 oobdata:0
pcb:0 rtable:0 htable:0 atable:0
soname:0 soopts:0 ftable:0 rights:0
ifaddr:0 control:0 oobdata:0
- ``if``
This command shows the current statistics for your Ethernet driver as long as
the ioctl hook ``SIO_RTEMS_SHOW_STATS`` has been implemented. Below is an
example:
This command shows the current statistics for your Ethernet driver as long as the ioctl hook``SIO_RTEMS_SHOW_STATS`` has been implemented. Below is an example:
.. code:: c
.. code-block:: shell
************ INTERFACE STATISTICS \************
\***** smc1 \*****
@ -144,11 +145,11 @@ is a list of them:
Send queue limit:50 length:0 Dropped:0
SMC91C111 RTEMS driver A0.01 11/03/2002 Ian Caddy (ianc@microsol.iinet.net.au)
Rx Interrupts:0 Not First:0 Not Last:0
Giant:0 Runt:0 Non-octet:0
Bad CRC:0 Overrun:0 Collision:0
Giant:0 Runt:0 Non-octet:0
Bad CRC:0 Overrun:0 Collision:0
Tx Interrupts:2 Deferred:0 Missed Hearbeat:0
No Carrier:0 Retransmit Limit:0 Late Collision:0
Underrun:0 Raw output wait:0 Coalesced:0
No Carrier:0 Retransmit Limit:0 Late Collision:0
Underrun:0 Raw output wait:0 Coalesced:0
Coalesce failed:0 Retries:0
\***** lo0 \*****
Address:127.0.0.1 Net mask:255.0.0.0
@ -176,15 +177,12 @@ The network demonstration program ``netdemo`` may be used for these tests.
- Start with ``RTEMS_USE_BOOTP`` not defined.
- Edit ``networkconfig.h`` to configure the driver
with an
explicit Ethernet and Internet address and with reception of
broadcast packets disabled:
Verify that the program continues to run once the driver has been attached.
- Edit ``networkconfig.h`` to configure the driver with an explicit Ethernet
and Internet address and with reception of broadcast packets disabled: Verify
that the program continues to run once the driver has been attached.
- Issue a '``u``' command to send UDP
packets to the 'discard' port.
Verify that the packets appear on the network.
- Issue a '``u``' command to send UDP packets to the 'discard' port. Verify
that the packets appear on the network.
- Issue a '``s``' command to print the network and driver statistics.
@ -193,124 +191,109 @@ The network demonstration program ``netdemo`` may be used for these tests.
- On that same workstation try to 'ping' the target system.
Verify that the ICMP echo request and reply packets appear on the net.
- Remove the static route to the target system.
Modify ``networkconfig.h`` to attach the driver
with reception of broadcast packets enabled.
Try to 'ping' the target system again.
Verify that ARP request/reply and ICMP echo request/reply packets appear
on the net.
- Remove the static route to the target system. Modify ``networkconfig.h`` to
attach the driver with reception of broadcast packets enabled. Try to 'ping'
the target system again. Verify that ARP request/reply and ICMP echo
request/reply packets appear on the net.
- Issue a '``t``' command to send TCP
packets to the 'discard' port.
Verify that the packets appear on the network.
- Issue a '``t``' command to send TCP packets to the 'discard' port. Verify
that the packets appear on the network.
- Issue a '``s``' command to print the network and driver statistics.
- Verify that you can telnet to ports 24742
and 24743 on the target system from one or more
workstations on your network.
- Verify that you can telnet to ports 24742 and 24743 on the target system from
one or more workstations on your network.
BOOTP/DHCP operation
====================
Set up a BOOTP/DHCP server on the network.
Set define ``RTEMS USE_BOOT`` in ``networkconfig.h``.
Run the ``netdemo`` test program.
Verify that the target system configures itself from the BOOTP/DHCP server and
that all the above tests succeed.
Set up a BOOTP/DHCP server on the network. Set define ``RTEMS USE_BOOT`` in
``networkconfig.h``. Run the ``netdemo`` test program. Verify that the target
system configures itself from the BOOTP/DHCP server and that all the above
tests succeed.
Stress Tests
============
Once the driver passes the tests described in the previous section it should
be subjected to conditions which exercise it more
thoroughly and which test its error handling routines.
Once the driver passes the tests described in the previous section it should be
subjected to conditions which exercise it more thoroughly and which test its
error handling routines.
Giant packets
-------------
- Recompile the driver with ``MAXIMUM_FRAME_SIZE`` set to
a smaller value, say 514.
- Recompile the driver with ``MAXIMUM_FRAME_SIZE`` set to a smaller value,
say 514.
- 'Ping' the driver from another workstation and verify
that frames larger than 514 bytes are correctly rejected.
- 'Ping' the driver from another workstation and verify that frames larger than
514 bytes are correctly rejected.
- Recompile the driver with ``MAXIMUM_FRAME_SIZE`` restored to 1518.
Resource Exhaustion
-------------------
- Edit ``networkconfig.h``
so that the driver is configured with just two receive and transmit descriptors.
- Edit ``networkconfig.h`` so that the driver is configured with just two
receive and transmit descriptors.
- Compile and run the ``netdemo`` program.
- Verify that the program operates properly and that you can
still telnet to both the ports.
- Verify that the program operates properly and that you can still telnet to
both the ports.
- Display the driver statistics (Console '``s``' command or telnet
'control-G' character) and verify that:
- Display the driver statistics (Console '``s``' command or telnet 'control-G'
character) and verify that:
# The number of transmit interrupts is non-zero.
This indicates that all transmit descriptors have been in use at some time.
#. The number of transmit interrupts is non-zero. This indicates that all
transmit descriptors have been in use at some time.
# The number of missed packets is non-zero.
This indicates that all receive descriptors have been in use at some time.
#. The number of missed packets is non-zero. This indicates that all receive
descriptors have been in use at some time.
Cable Faults
------------
- Run the ``netdemo`` program.
- Issue a '``u``' console command to make the target machine transmit
a bunch of UDP packets.
- Issue a '``u``' console command to make the target machine transmit a bunch
of UDP packets.
- While the packets are being transmitted, disconnect and reconnect the
network cable.
- While the packets are being transmitted, disconnect and reconnect the network
cable.
- Display the network statistics and verify that the driver has
detected the loss of carrier.
- Display the network statistics and verify that the driver has detected the
loss of carrier.
- Verify that you can still telnet to both ports on the target machine.
Throughput
----------
Run the ``ttcp`` network benchmark program.
Transfer large amounts of data (100's of megabytes) to and from the target
system.
Run the ``ttcp`` network benchmark program. Transfer large amounts of data
(100's of megabytes) to and from the target system.
The procedure for testing throughput from a host to an RTEMS target
is as follows:
The procedure for testing throughput from a host to an RTEMS target is as
follows:
# Download and start the ttcp program on the Target.
#. Download and start the ttcp program on the Target.
# In response to the ``ttcp`` prompt, enter ``-s -r``. The
meaning of these flags is described in the ``ttcp.1`` manual page
found in the ``ttcp_orig`` subdirectory.
#. In response to the ``ttcp`` prompt, enter ``-s -r``. The meaning of these
flags is described in the ``ttcp.1`` manual page found in the ``ttcp_orig``
subdirectory.
# On the host run ``ttcp -s -t <<insert the hostname or IP address of the Target here>>``
#. On the host run ``ttcp -s -t <<insert the hostname or IP address of the Target here>>``
The procedure for testing throughput from an RTEMS target
to a Host is as follows:
The procedure for testing throughput from an RTEMS target to a Host is as
follows:
# On the host run ``ttcp -s -r``.
#. On the host run ``ttcp -s -r``.
# Download and start the ttcp program on the Target.
#. Download and start the ttcp program on the Target.
# In response to the ``ttcp`` prompt, enter ``-s -t <<insert the hostname or IP address of the Target here>>``. You need to type the
IP address of the host unless your Target is talking to your Domain Name
Server.
To change the number of buffers, the buffer size, etc. you just add the
extra flags to the ``-t`` machine as specified in the ``ttcp.1``
manual page found in the ``ttcp_orig`` subdirectory.
.. COMMENT: Text Written by Jake Janovetz
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
#. In response to the ``ttcp`` prompt, enter ``-s -t <<insert the hostname or
IP address of the Target here>>``. You need to type the IP address of the
host unless your Target is talking to your Domain Name Server.
To change the number of buffers, the buffer size, etc. you just add the extra
flags to the ``-t`` machine as specified in the ``ttcp.1`` manual page found in
the ``ttcp_orig`` subdirectory.

1222
networking/using_networking_rtems_app.rst
View File

File diff suppressed because it is too large Load Diff