Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Projects / Webserver / Lib / uip / uip.h
index a10699d..7b87a2c 100644 (file)
  */
 #if UIP_CONF_IPV6
 typedef union uip_ip6addr_t {
  */
 #if UIP_CONF_IPV6
 typedef union uip_ip6addr_t {
-  u8_t  u8[16];                        /* Initializer, must come first!!! */
+  u8_t  u8[16];                        /* Initialiser, must come first!!! */
   u16_t u16[8];
 } uip_ip6addr_t;
 
 typedef uip_ip6addr_t uip_ipaddr_t;
 #else /* UIP_CONF_IPV6 */
 typedef union uip_ip4addr_t {
   u16_t u16[8];
 } uip_ip6addr_t;
 
 typedef uip_ip6addr_t uip_ipaddr_t;
 #else /* UIP_CONF_IPV6 */
 typedef union uip_ip4addr_t {
-  u8_t  u8[4];                 /* Initializer, must come first!!! */
+  u8_t  u8[4];                 /* Initialiser, must come first!!! */
   u16_t u16[2];
 #if 0
   u32_t u32;
   u16_t u16[2];
 #if 0
   u32_t u32;
@@ -145,7 +145,7 @@ typedef struct uip_eth_addr uip_lladdr_t;
 
  uip_ipaddr(&addr, 192,168,1,2);
  uip_sethostaddr(&addr);
 
  uip_ipaddr(&addr, 192,168,1,2);
  uip_sethostaddr(&addr);
+
  \endcode
  * \param addr A pointer to an IP address of type uip_ipaddr_t;
  *
  \endcode
  * \param addr A pointer to an IP address of type uip_ipaddr_t;
  *
@@ -232,7 +232,7 @@ typedef struct uip_eth_addr uip_lladdr_t;
 /**
  * uIP initialization function.
  *
 /**
  * uIP initialization function.
  *
- * This function should be called at boot up to initilize the uIP
+ * This function should be called at boot up to initialize the uIP
  * TCP/IP stack.
  */
 void uip_init(void);
  * TCP/IP stack.
  */
 void uip_init(void);
@@ -311,7 +311,7 @@ void uip_setipid(u16_t id);
  * Periodic processing for a connection identified by its number.
  *
  * This function does the necessary periodic processing (timers,
  * Periodic processing for a connection identified by its number.
  *
  * This function does the necessary periodic processing (timers,
- * polling) for a uIP TCP conneciton, and should be called when the
+ * polling) for a uIP TCP connection, and should be called when the
  * periodic uIP timer goes off. It should be called for every
  * connection, regardless of whether they are open of closed.
  *
  * periodic uIP timer goes off. It should be called for every
  * connection, regardless of whether they are open of closed.
  *
@@ -805,7 +805,7 @@ void uip_send(const void *data, int len);
  \code
  uip_ipaddr_t addr;
  struct uip_udp_conn *c;
  \code
  uip_ipaddr_t addr;
  struct uip_udp_conn *c;
+
  uip_ipaddr(&addr, 192,168,2,1);
  c = uip_udp_new(&addr, HTONS(12345));
  if(c != NULL) {
  uip_ipaddr(&addr, 192,168,2,1);
  c = uip_udp_new(&addr, HTONS(12345));
  if(c != NULL) {
@@ -866,7 +866,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
  * These functions can be used for converting between different data
  * formats used by uIP.
  */
  * These functions can be used for converting between different data
  * formats used by uIP.
  */
+
 /**
  * Convert an IP address to four bytes separated by commas.
  *
 /**
  * Convert an IP address to four bytes separated by commas.
  *
@@ -892,7 +892,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
  \code
  uip_ipaddr_t ipaddr;
  struct uip_conn *c;
  \code
  uip_ipaddr_t ipaddr;
  struct uip_conn *c;
+
  uip_ipaddr(&ipaddr, 192,168,1,2);
  c = uip_connect(&ipaddr, HTONS(80));
  \endcode
  uip_ipaddr(&ipaddr, 192,168,1,2);
  c = uip_connect(&ipaddr, HTONS(80));
  \endcode
@@ -933,7 +933,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
   } while(0)
 
 /**
   } while(0)
 
 /**
- * Construct an IPv6 address from eight 8-bit words.
+ * Construct an IPv6 address from sixteen 8-bit words.
  *
  * This function constructs an IPv6 address.
  *
  *
  * This function constructs an IPv6 address.
  *
@@ -1281,11 +1281,11 @@ extern u16_t uip_urglen, uip_surglen;
  */
 struct uip_conn {
   uip_ipaddr_t ripaddr;   /**< The IP address of the remote host. */
  */
 struct uip_conn {
   uip_ipaddr_t ripaddr;   /**< The IP address of the remote host. */
-  
+
   u16_t lport;        /**< The local TCP port, in network byte order. */
   u16_t rport;        /**< The local remote TCP port, in network byte
                         order. */
   u16_t lport;        /**< The local TCP port, in network byte order. */
   u16_t rport;        /**< The local remote TCP port, in network byte
                         order. */
-  
+
   u8_t rcv_nxt[4];    /**< The sequence number that we expect to
                         receive next. */
   u8_t snd_nxt[4];    /**< The sequence number that was last sent by
   u8_t rcv_nxt[4];    /**< The sequence number that we expect to
                         receive next. */
   u8_t snd_nxt[4];    /**< The sequence number that was last sent by
@@ -1398,7 +1398,7 @@ struct uip_stats {
                             layer. */
     uip_stats_t sent;     /**< Number of sent packets at the IP
                             layer. */
                             layer. */
     uip_stats_t sent;     /**< Number of sent packets at the IP
                             layer. */
-    uip_stats_t forwarded;/**< Number of forwarded packets at the IP 
+    uip_stats_t forwarded;/**< Number of forwarded packets at the IP
                             layer. */
     uip_stats_t drop;     /**< Number of dropped packets at the IP
                             layer. */
                             layer. */
     uip_stats_t drop;     /**< Number of dropped packets at the IP
                             layer. */
@@ -1426,17 +1426,17 @@ struct uip_stats {
   } icmp;                 /**< ICMP statistics. */
 #if UIP_TCP
   struct {
   } icmp;                 /**< ICMP statistics. */
 #if UIP_TCP
   struct {
-    uip_stats_t recv;     /**< Number of recived TCP segments. */
+    uip_stats_t recv;     /**< Number of received TCP segments. */
     uip_stats_t sent;     /**< Number of sent TCP segments. */
     uip_stats_t drop;     /**< Number of dropped TCP segments. */
     uip_stats_t chkerr;   /**< Number of TCP segments with a bad
                             checksum. */
     uip_stats_t ackerr;   /**< Number of TCP segments with a bad ACK
                             number. */
     uip_stats_t sent;     /**< Number of sent TCP segments. */
     uip_stats_t drop;     /**< Number of dropped TCP segments. */
     uip_stats_t chkerr;   /**< Number of TCP segments with a bad
                             checksum. */
     uip_stats_t ackerr;   /**< Number of TCP segments with a bad ACK
                             number. */
-    uip_stats_t rst;      /**< Number of recevied TCP RST (reset) segments. */
+    uip_stats_t rst;      /**< Number of received TCP RST (reset) segments. */
     uip_stats_t rexmit;   /**< Number of retransmitted TCP segments. */
     uip_stats_t syndrop;  /**< Number of dropped SYNs due to too few
     uip_stats_t rexmit;   /**< Number of retransmitted TCP segments. */
     uip_stats_t syndrop;  /**< Number of dropped SYNs due to too few
-                            connections was avaliable. */
+                            connections was available. */
     uip_stats_t synrst;   /**< Number of SYNs for closed ports,
                             triggering a RST. */
   } tcp;                  /**< TCP statistics. */
     uip_stats_t synrst;   /**< Number of SYNs for closed ports,
                             triggering a RST. */
   } tcp;                  /**< TCP statistics. */
@@ -1444,7 +1444,7 @@ struct uip_stats {
 #if UIP_UDP
   struct {
     uip_stats_t drop;     /**< Number of dropped UDP segments. */
 #if UIP_UDP
   struct {
     uip_stats_t drop;     /**< Number of dropped UDP segments. */
-    uip_stats_t recv;     /**< Number of recived UDP segments. */
+    uip_stats_t recv;     /**< Number of received UDP segments. */
     uip_stats_t sent;     /**< Number of sent UDP segments. */
     uip_stats_t chkerr;   /**< Number of UDP segments with a bad
                             checksum. */
     uip_stats_t sent;     /**< Number of sent UDP segments. */
     uip_stats_t chkerr;   /**< Number of UDP segments with a bad
                             checksum. */
@@ -1453,7 +1453,7 @@ struct uip_stats {
 #if UIP_CONF_IPV6
   struct {
     uip_stats_t drop;     /**< Number of dropped ND6 packets. */
 #if UIP_CONF_IPV6
   struct {
     uip_stats_t drop;     /**< Number of dropped ND6 packets. */
-    uip_stats_t recv;     /**< Number of recived ND6 packets */
+    uip_stats_t recv;     /**< Number of received ND6 packets */
     uip_stats_t sent;     /**< Number of sent ND6 packets */
   } nd6;
 #endif /*UIP_CONF_IPV6*/
     uip_stats_t sent;     /**< Number of sent ND6 packets */
   } nd6;
 #endif /*UIP_CONF_IPV6*/
@@ -1527,14 +1527,14 @@ uip_ext_hdr_options_process(); */
  * The actual uIP function which does all the work.
  */
 void uip_process(u8_t flag);
  * The actual uIP function which does all the work.
  */
 void uip_process(u8_t flag);
-  
+
   /* The following flags are passed as an argument to the uip_process()
    function. They are used to distinguish between the two cases where
    uip_process() is called. It can be called either because we have
    incoming data that should be processed, or because the periodic
    timer has fired. These values are never used directly, but only in
    the macros defined in this file. */
   /* The following flags are passed as an argument to the uip_process()
    function. They are used to distinguish between the two cases where
    uip_process() is called. It can be called either because we have
    incoming data that should be processed, or because the periodic
    timer has fired. These values are never used directly, but only in
    the macros defined in this file. */
+
 #define UIP_DATA          1     /* Tells uIP that there is incoming
                                   data in the uip_buf buffer. The
                                   length of the data is stored in the
 #define UIP_DATA          1     /* Tells uIP that there is incoming
                                   data in the uip_buf buffer. The
                                   length of the data is stored in the
@@ -1561,7 +1561,7 @@ void uip_process(u8_t flag);
 #define UIP_TIME_WAIT   7
 #define UIP_LAST_ACK    8
 #define UIP_TS_MASK     15
 #define UIP_TIME_WAIT   7
 #define UIP_LAST_ACK    8
 #define UIP_TS_MASK     15
-  
+
 #define UIP_STOPPED      16
 
 /* The TCP and IP headers. */
 #define UIP_STOPPED      16
 
 /* The TCP and IP headers. */
@@ -1586,7 +1586,7 @@ struct uip_tcpip_hdr {
   u16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
   u16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
-  
+
   /* TCP header. */
   u16_t srcport,
     destport;
   /* TCP header. */
   u16_t srcport,
     destport;
@@ -1622,7 +1622,7 @@ struct uip_icmpip_hdr {
   u16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
   u16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
-  
+
   /* ICMP header. */
   u8_t type, icode;
   u16_t icmpchksum;
   /* ICMP header. */
   u8_t type, icode;
   u16_t icmpchksum;
@@ -1655,7 +1655,7 @@ struct uip_udpip_hdr {
   u16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
   u16_t ipchksum;
   uip_ipaddr_t srcipaddr, destipaddr;
 #endif /* UIP_CONF_IPV6 */
-  
+
   /* UDP header. */
   u16_t srcport,
     destport;
   /* UDP header. */
   u16_t srcport,
     destport;
@@ -2023,7 +2023,7 @@ extern uip_lladdr_t uip_lladdr;
    (((a)->u8[13]) == (m)->addr[3]) &&            \
    (((a)->u8[14]) == (m)->addr[4]) &&            \
    (((a)->u8[15]) == (m)->addr[5]))
    (((a)->u8[13]) == (m)->addr[3]) &&            \
    (((a)->u8[14]) == (m)->addr[4]) &&            \
    (((a)->u8[15]) == (m)->addr[5]))
-   
+
 #endif /*UIP_CONF_LL_802154*/
 
 /**
 #endif /*UIP_CONF_LL_802154*/
 
 /**
@@ -2127,3 +2127,4 @@ u16_t uip_icmp6chksum(void);
 
 
 /** @} */
 
 
 /** @} */
+