Changeset d389819 in rtems-docs for networking

Timestamp:

01/18/16 05:37:40 (7 years ago)

Author:

Amar Takhar <amar@…>

Branches:

4.11, 5, am, master

Children:

f916fca

Parents:

11e1a6f

git-author:

Amar Takhar <amar@…> (01/18/16 05:37:40)

git-committer:

Amar Takhar <verm@…> (05/03/16 00:51:24)

Message:

Convert all Unicode to ASCII(128)

Location:

networking

Files:

• dec_21140.rst (modified) (2 diffs)
• index.rst (modified) (1 diff)
• network_servers.rst (modified) (1 diff)
• network_task_structure.rst (modified) (1 diff)
• networking_driver.rst (modified) (6 diffs)
• preface.rst (modified) (1 diff)
• testing_the_driver.rst (modified) (9 diffs)
• using_networking_rtems_app.rst (modified) (7 diffs)

networking/dec_21140.rst

@@ -47 +47 @@
 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
+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
@@ -133 +133 @@
 
 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”
+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

networking/index.rst

@@ -2 +2 @@
 RTEMS Network Supplement
 ========================
-COPYRIGHT © 1988 - 2015.
+COPYRIGHT (c) 1988 - 2015.
 
 On-Line Applications Research Corporation (OAR).

networking/network_servers.rst

@@ -7 +7 @@
 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”
+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

networking/network_task_structure.rst

@@ -24 +24 @@
 aging and removing routing table entries.
 
-The ‘Network code’ contains routines which may run in the context of
+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

networking/networking_driver.rst

@@ -7 +7 @@
 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
+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
@@ -16 +16 @@
 
 Before starting to write the network driver become completely
-familiar with the programmer’s view of the device.
+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.
@@ -71 +71 @@
 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.
+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.
@@ -161 +161 @@
 ``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.
+    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``
@@ -212 +212 @@
 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.
+device's ``ifnet`` structure as their only argument.
 
 The attach function should return a non-zero value to indicate that
@@ -222 +222 @@
 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.
+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

networking/preface.rst

@@ -12 +12 @@
 to understand Ethernet:
 
-- *Charles Spurgeon’s Ethernet Web Site*
+- *Charles Spurgeon's Ethernet Web Site*
   "This site provides extensive information about Ethernet
   (IEEE 802.3) local area network (LAN) technology. Including

networking/testing_the_driver.rst

@@ -12 +12 @@
 
 - An Ethernet network analyzer or a workstation with an
-  ‘Ethernet snoop’ program such as ``ethersnoop`` or``tcpdump``.
+  'Ethernet snoop' program such as ``ethersnoop`` or``tcpdump``.
 
 - A workstation.
@@ -40 +40 @@
 - 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
+  these lines results in output when mbuf's are allocated
   and freed.  This is very useful for finding memory leaks.
 
@@ -92 +92 @@
   For a quick reference to the flags, see the table below:
 
-  ‘``U``’
+  '``U``'
       Up: The route is active.
 
-  ‘``H``’
+  '``H``'
       Host: The route destination is a single host.
 
-  ‘``G``’
+  '``G``'
       Gateway: Send anything for this destination on to this remote system, which
       will figure out from there where to send it.
 
-  ‘``S``’
+  '``S``'
       Static: This route was configured manually, not automatically generated by the
       system.
 
-  ‘``C``’
+  '``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.
 
-  ‘``W``’
+  '``W``'
       WasCloned: Indicated a route that was auto-configured based upon a local area
       network (Clone) route.
 
-  ‘``L``’
+  '``L``'
       Link: Route involves references to Ethernet hardware.
 
@@ -183 +183 @@
   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.
+- 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.
+- Issue a '``s``' command to print the network and driver statistics.
 
 - On a workstation, add a static route to the target system.
 
-- On that same workstation try to ‘ping’ the target system.
+- On that same workstation try to 'ping' the target system.
   Verify that the ICMP echo request and reply packets appear on the net.
 
@@ -197 +197 @@
   Modify ``networkconfig.h`` to attach the driver
   with reception of broadcast packets enabled.
-  Try to ‘ping’ the target system again.
+  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.
+- 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.
+- Issue a '``s``' command to print the network and driver statistics.
 
 - Verify that you can telnet to ports 24742
@@ -233 +233 @@
   a smaller value, say 514.
 
-- ‘Ping’ the driver from another workstation and verify
+- 'Ping' the driver from another workstation and verify
   that frames larger than 514 bytes are correctly rejected.
 
@@ -249 +249 @@
   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.
@@ -263 +263 @@
 - Run the ``netdemo`` program.
 
-- Issue a ‘``u``’ console command to make the target machine transmit
+- Issue a '``u``' console command to make the target machine transmit
   a bunch of UDP packets.
 
@@ -278 +278 @@
 
 Run the ``ttcp`` network benchmark program.
-Transfer large amounts of data (100’s of megabytes) to and from the target
+Transfer large amounts of data (100's of megabytes) to and from the target
 system.
 

networking/using_networking_rtems_app.rst

@@ -127 +127 @@
     standard files created with the information return by the BOOTP/DHCP
     protocol. The IP address is added to :file:`/etc/hosts` with the host
-    name and domain returned. If no host name or domain is returned``me.mydomain`` is used. The BOOTP/DHCP server’s address is also
+    name and domain returned. If no host name or domain is returned``me.mydomain`` is used. The BOOTP/DHCP server's address is also
     added to :file:`/etc/hosts`. The domain name server listed in the
     BOOTP/DHCP information are added to :file:`/etc/resolv.conf`. A``search`` record is also added if a domain is returned. The files
@@ -163 +163 @@
 ``char \*gateway``
     The Internet host number of the network gateway machine,
-    specified in ’dotted decimal’ (``129.128.4.1``) form.
+    specified in 'dotted decimal' (``129.128.4.1``) form.
 
 ``char \*log_host``
@@ -280 +280 @@
 ``char \*ip_address``
     The Internet address of the device,
-    specified in ‘dotted decimal’ (``129.128.4.2``) form, or ``NULL``
+    specified in 'dotted decimal' (``129.128.4.2``) form, or ``NULL``
     if the device configuration information is being obtained from a
     BOOTP/DHCP server.
@@ -286 +286 @@
 ``char \*ip_netmask``
     The Internet inetwork mask of the device,
-    specified in ‘dotted decimal’ (``255.255.255.0``) form, or ``NULL``
+    specified in 'dotted decimal' (``255.255.255.0``) form, or ``NULL``
     if the device configuration information is being obtained from a
     BOOTP/DHCP server.
@@ -497 +497 @@
 For sending, when the socket is connected and the free space becomes at
 or above the "low water mark" for the send buffer (default 4096 bytes)
-you will receive a writable callback. You don’t get continuous callbacks
-if you don’t write anything. Using a non-blocking write socket, you can
+you will receive a writable callback. You don't get continuous callbacks
+if you don't write anything. Using a non-blocking write socket, you can
 then call write until it returns a value less than the amount of data
 requested to be sent or it produces error EWOULDBLOCK (indicating buffer
@@ -838 +838 @@
 If the interval argument is greater than 0, the routine also starts an
 RTEMS task at the specified priority and polls the NTP server every
-‘interval’ seconds.  NOTE: This mode of operation has not yet been
+'interval' seconds.  NOTE: This mode of operation has not yet been
 implemented.
 
@@ -844 +844 @@
 returns 0.  If an error occurs a message is printed and the routine returns -1
 with an error code in errno.
-There is no timeout – if there is no response from an NTP server the
+There is no timeout - if there is no response from an NTP server the
 routine will wait forever.