Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Demos / Device / ClassDriver / RNDISEthernet / Lib / IP.h
index 82f28e8..1891ef4 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
  *
  *  Header file for IP.c.
  */
+
 #ifndef _IP_H_
 #define _IP_H_
 
        /* Includes: */
                #include <avr/io.h>
                #include <string.h>
-               
+
                #include "EthernetProtocols.h"
                #include "Ethernet.h"
                #include "ProtocolDecoders.h"
-       
+
        /* Macros: */
-               /** Protocol IP address of the host (client) machine, once assigned by DHCP */
+               /** Protocol IP address of the host (client) machine, once assigned by DHCP. */
                #define CLIENT_IP_ADDRESS                { 10,     0,    0,    1}
 
-               /** Protocol IP address of the virtual server machine */
+               /** Protocol IP address of the virtual server machine. */
                #define SERVER_IP_ADDRESS                { 10,     0,    0,    2}
 
-               /** Protocol IP address of the broadcast address */
+               /** Protocol IP address of the broadcast address. */
                #define BROADCAST_IP_ADDRESS             {0xFF, 0xFF, 0xFF, 0xFF}
 
-               /** Default Time To Live (TTL) value for sent packets, indicating the maximum allowable hops until their destination is reached */
+               /** Default Time To Live (TTL) value for sent packets, indicating the maximum allowable hops until their destination
+                *  is reached.
+                */
                #define DEFAULT_TTL                      128
-               
+
                /** Performs a comparison between two IP addresses, indicating if they are identical.
-                *  
+                *
                 *  \param[in] IP1  First IP address
                 *  \param[in] IP2  Second IP address
                 *
                 *  \return True if the addresses match, false otherwise
                 */
                #define IP_COMPARE(IP1, IP2)             (memcmp(IP1, IP2, sizeof(IP_Address_t)) == 0)
-               
+
        /* Type Defines: */
                /** Type define of an IP packet header. */
                typedef struct
                {
-                       unsigned char  HeaderLength   : 4; /**< Total length of the packet header, in 4-byte blocks */
-                       unsigned char  Version        : 4; /**< IP protocol version */
-                       uint8_t        TypeOfService; /**< Special service type identifier, indicating delay/throughput/reliability levels */
-                       uint16_t       TotalLength; /**< Total length of the IP packet, in bytes */
-
-                       uint16_t       Identification; /**< Identification value for identifying fragmented packets */
-                       unsigned int   FragmentOffset : 13; /**< Offset of this IP fragment */
-                       unsigned int   Flags          : 3; /**< Fragment flags, to indicate if a packet is fragmented */
-
-                       uint8_t        TTL; /**< Maximum allowable number of hops to reach the packet destination */
-                       uint8_t        Protocol; /**< Encapsulated protocol type */
-                       uint16_t       HeaderChecksum; /**< Ethernet checksum of the IP header */
-                       
-                       IP_Address_t  SourceAddress; /**< Source protocol IP address of the packet */
-                       IP_Address_t  DestinationAddress; /**< Destination protocol IP address of the packet */
+                       unsigned     HeaderLength   : 4; /**< Total length of the packet header, in 4-byte blocks */
+                       unsigned     Version        : 4; /**< IP protocol version */
+                       uint8_t      TypeOfService; /**< Special service type identifier, indicating delay/throughput/reliability levels */
+                       uint16_t     TotalLength; /**< Total length of the IP packet, in bytes */
+
+                       uint16_t     Identification; /**< Identification value for identifying fragmented packets */
+                       unsigned     FragmentOffset : 13; /**< Offset of this IP fragment */
+                       unsigned     Flags          : 3; /**< Fragment flags, to indicate if a packet is fragmented */
+
+                       uint8_t      TTL; /**< Maximum allowable number of hops to reach the packet destination */
+                       uint8_t      Protocol; /**< Encapsulated protocol type */
+                       uint16_t     HeaderChecksum; /**< Ethernet checksum of the IP header */
+
+                       IP_Address_t SourceAddress; /**< Source protocol IP address of the packet */
+                       IP_Address_t DestinationAddress; /**< Destination protocol IP address of the packet */
                } IP_Header_t;
-               
+
        /* Function Prototypes: */
-               int16_t IP_ProcessIPPacket(Ethernet_Frame_Info_t* FrameIN, void* InDataStart, void* OutDataStart);
+               int16_t IP_ProcessIPPacket(Ethernet_Frame_Info_t* const FrameIN,
+                                          void* InDataStart,
+                                          void* OutDataStart);
 
 #endif
+