Changeset d01dead in rtems-docs


Ignore:
Timestamp:
Jan 16, 2016, 11:24:08 PM (3 years ago)
Author:
Amar Takhar <verm@…>
Branches:
4.11, master
Children:
ca49bfd
Parents:
75a59fd
git-author:
Amar Takhar <verm@…> (01/16/16 23:24:08)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:23)
Message:

Fix markup

File:
1 edited

Legend:

Unmodified
Added
Removed
  • networking/networking.rst

    r75a59fd rd01dead  
    286286This is equivalent to the following list of definitions.  Early versions
    287287of the RTEMS BSD network stack required that all of these be defined.
     288
    288289.. code:: c
    289290
     
    460461
    461462``SIOCSIFADDR``
     463
    462464    If the device is an Ethernet interface these
    463465    commands should be passed on to ``ether_ioctl``.
    464466
    465467``SIOCSIFFLAGS``
     468
    466469    This command should be used to start or stop the device,
    467470    depending on the state of the interface ``IFF_UP`` and``IFF_RUNNING`` bits in ``if_flags``:
     471
    468472    ``IFF_RUNNING``
     473
    469474        Stop the device.
     475
    470476    ``IFF_UP``
     477
    471478        Start the device.
     479
    472480    ``IFF_UP|IFF_RUNNING``
     481
    473482        Stop then start the device.
     483
    474484    ``0``
     485
    475486        Do nothing.
    476487
     
    604615
    605616``struct rtems_bsdnet_ifconfig \*ifconfig``
     617
    606618    A pointer to the first configuration structure of the first network
    607619    device.  This structure is described in the following section.
     
    609621
    610622``void (\*bootp)(void)``
     623
    611624    This entry should be set to ``rtems_bsdnet_do_bootp`` if your
    612625    application by default uses the BOOTP/DHCP client protocol to obtain
     
    687700
    688701``unsigned long udp_tx_buf_size``
     702
    689703    This configuration parameter specifies the maximum amount of
    690704    buffer memory which may be used for UDP sockets to transmit
     
    693707
    694708``unsigned long udp_rx_buf_size``
     709
    695710    This configuration parameter specifies the maximum amount of
    696711    buffer memory which may be used for UDP sockets to receive
    697712    into.  The default size is the following length in bytes:
     713
    698714    .. code:: c
     715
    699716        40 * (1024 + sizeof(struct sockaddr_in)
    700717
    701718``unsigned long tcp_tx_buf_size``
     719
    702720    This configuration parameter specifies the maximum amount of
    703721    buffer memory which may be used for TCP sockets to transmit
     
    705723
    706724``unsigned long tcp_rx_buf_size``
     725
    707726    This configuration parameter specifies the maximum amount of
    708727    buffer memory which may be used for TCP sockets to receive
     
    710729
    711730``const cpu_set_t \*network_task_cpuset``
     731
    712732    This configuration parameter specifies the CPU affinity of the
    713733    network task. If set to ``0`` the network task can be scheduled on
     
    715735
    716736``size_t network_task_cpuset_size``
     737
    717738    This configuration parameter specifies the size of the``network_task_cpuset`` used. Only available in SMP configurations.
    718739
     
    847868  For example the following functions return a pointer to a static
    848869  buffer which remains valid only until the next call:
     870
    849871  ``gethostbyaddr``
     872
    850873  ``gethostbyname``
     874
    851875  ``inet_ntoa``
     876
    852877      (``inet_ntop`` is thread-safe, though).
    853878
     
    14091434  This command shows the current routing information for the TCP/IP stack. Following is an
    14101435  example showing the output of this command.
     1436
    14111437  .. code:: c
     1438
    14121439      Destination     Gateway/Mask/Hw    Flags     Refs     Use Expire Interface
    14131440      10.0.0.0        255.0.0.0          U           0        0     17 smc1
    14141441      127.0.0.1       127.0.0.1          UH          0        0      0 lo0
     1442
    14151443  In this example, there is only one network interface with an IP address of 10.8.1.1.  This
    14161444  link is currently not up.
     
    14211449  URL: (http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-routing.html)
    14221450  For a quick reference to the flags, see the table below:
     1451
    14231452  ‘``U``’
    14241453      Up: The route is active.
     1454
    14251455  ‘``H``’
    14261456      Host: The route destination is a single host.
     1457
    14271458  ‘``G``’
    14281459      Gateway: Send anything for this destination on to this remote system, which
    14291460      will figure out from there where to send it.
     1461
    14301462  ‘``S``’
    14311463      Static: This route was configured manually, not automatically generated by the
    14321464      system.
     1465
    14331466  ‘``C``’
    14341467      Clone: Generates a new route based upon this route for machines we connect
    14351468      to. This type of route is normally used for local networks.
     1469
    14361470  ‘``W``’
    14371471      WasCloned: Indicated a route that was auto-configured based upon a local area
    14381472      network (Clone) route.
     1473
    14391474  ‘``L``’
    14401475      Link: Route involves references to Ethernet hardware.
    14411476
    14421477- ``mbuf``
     1478
    14431479  This command shows the current MBUF statistics.  An example of the command is shown below:
     1480
    14441481  .. code:: c
     1482
    14451483      ************ MBUF STATISTICS \************
    14461484      mbufs:4096    clusters: 256    free: 241
     
    14521490
    14531491- ``if``
     1492
    14541493  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:
     1494
    14551495  .. code:: c
     1496
    14561497      ************ INTERFACE STATISTICS \************
    14571498      \***** smc1 \*****
     
    15681609- Display the driver statistics (Console ‘``s``’ command or telnet
    15691610  ‘control-G’ character) and verify that:
     1611
    15701612  # The number of transmit interrupts is non-zero.
    15711613    This indicates that all transmit descriptors have been in use at some time.
     1614
    15721615  # The number of missed packets is non-zero.
    15731616    This indicates that all receive descriptors have been in use at some time.
     
    16051648  found in the ``ttcp_orig`` subdirectory.
    16061649
    1607 # On the host run ``ttcp -s -t <<insert the hostname or IP address of
    1608   the Target here>>``
     1650# On the host run ``ttcp -s -t <<insert the hostname or IP address of  the Target here>>``
    16091651
    16101652The procedure for testing throughput from an RTEMS target
     
    16151657# Download and start the ttcp program on the Target.
    16161658
    1617 # In response to the ``ttcp`` prompt, enter ``-s -t <<insert
    1618   the hostname or IP address of the Target here>>``.  You need to type the
     1659# In response to the ``ttcp`` prompt, enter ``-s -t <<insert  the hostname or IP address of the Target here>>``.  You need to type the
    16191660  IP address of the host unless your Target is talking to your Domain Name
    16201661  Server.
     
    19812022DFE500-TX.
    19822023
    1983 - ```` *[DEC21140 Hardware Manual] DIGITAL, *DIGITAL
     2024- *[DEC21140 Hardware Manual] DIGITAL, *DIGITAL
    19842025  Semiconductor 21140A PCI Fast Ethernet LAN Controller - Hardware
    19852026  Reference Manual**.
    19862027
    1987 - ```` *[99.TA.0021.M.ER]Emmanuel Raguet,*RTEMS Cache Management For Intel**.
     2028- *[99.TA.0021.M.ER]Emmanuel Raguet,*RTEMS Cache Management For Intel**.
    19882029
    19892030Command and Variable Index
Note: See TracChangeset for help on using the changeset viewer.