Changeset 33bbd74 in rtems


Ignore:
Timestamp:
11/11/99 02:51:31 (24 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
f9078d1
Parents:
d102810e
Message:

Added information about the NTP servier field and included a copy
of the C definition of the configuration structure.

Location:
doc/networking
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/networking/Makefile

    rd102810e r33bbd74  
    6969
    7070testing.texi: testing.t Makefile
    71         $(BMENU) -p "Socket Options" \
     71        $(BMENU) -p "Time Synchronization Using NTP" \
    7272           -u "Top" \
    7373           -n "Network Servers" ${*}.t
  • doc/networking/networkapp.t

    rd102810e r33bbd74  
    6363@end example
    6464
    65 @subsection Network configuration
     65@subsection Network Configuration
    6666The network configuration is specified by declaring
    67 and initializing the @code{rtems_bsdnet_configuration}
     67and initializing the @code{rtems_bsdnet_config}
    6868structure.
     69
     70@example
     71@group
     72struct rtems_bsdnet_config @{
     73  /*
     74   * This entry points to the head of the ifconfig chain.
     75   */
     76  struct rtems_bsdnet_ifconfig *ifconfig;
     77
     78  /*
     79   * This entry should be rtems_bsdnet_do_bootp if BOOTP
     80   * is being used to configure the network, and NULL
     81   * if BOOTP is not being used.
     82   */
     83  void                    (*bootp)(void);
     84
     85  /*
     86   * The remaining items can be initialized to 0, in
     87   * which case the default value will be used.
     88   */
     89  rtems_task_priority  network_task_priority;  /* 100        */
     90  unsigned long        mbuf_bytecount;         /* 64 kbytes  */
     91  unsigned long        mbuf_cluster_bytecount; /* 128 kbytes */
     92  char                *hostname;               /* BOOTP      */
     93  char                *domainname;             /* BOOTP      */
     94  char                *gateway;                /* BOOTP      */
     95  char                *log_host;               /* BOOTP      */
     96  char                *name_server[3];         /* BOOTP      */
     97  char                *ntp_server[3];          /* BOOTP      */
     98@};
     99@end group
     100@end example
    69101
    70102The structure entries are described in the following table.
     
    121153The Internet host numbers of up to three machines to be used as
    122154Internet Domain Name Servers.
     155
     156@item char *name_server[3]
     157The Internet host numbers of up to three machines to be used as
     158Network Time Protocol (NTP) Servers.
     159
     160@end table
     161
     162In addition, the following fields in the @code{rtems_bsdnet_ifconfig}
     163are of interest.
     164
     165@table @b
    123166
    124167@item int port
     
    370413sockets.
    371414
    372 
     415@subsection Time Synchronization Using NTP
     416
     417@example
     418int rtems_bsdnet_synchronize_ntp (int interval, rtems_task_priority priority);
     419@end example
     420
     421If the interval argument is 0 the routine synchronizes the RTEMS time-of-day
     422clock with the first NTP server in the rtems_bsdnet_ntpserve array and
     423returns.  The priority argument is ignored.
     424
     425If the interval argument is greater than 0, the routine also starts an
     426RTEMS task at the specified priority and polls the NTP server every
     427`interval' seconds.  NOTE: This mode of operation has not yet been
     428implemented.
     429
     430On successful synchronization of the RTEMS time-of-day clock the routine
     431returns 0.  If an error occurs a message is printed and the routine returns -1
     432with an error code in errno.
     433There is no timeout -- if there is no response from an NTP server the
     434routine will wait forever.
     435
     436
     437
     438
Note: See TracChangeset for help on using the changeset viewer.