Minor code style fixes, documentation improvements.

[pub/USBasp.git] / Demos / Device / LowLevel / RNDISEthernet / Lib / Ethernet.h

diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h b/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h
index 4bae3c4..93d5c47 100644 (file)
--- a/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h
+++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h
@@ -1,24 +1,24 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2014.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  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
   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
   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.
 
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -32,7 +32,7 @@
  *
  *  Header file for Ethernet.c.
  */
  *
  *  Header file for Ethernet.c.
  */

- 
+

 #ifndef _ETHERNET_H_
 #define _ETHERNET_H_
 
 #ifndef _ETHERNET_H_
 #define _ETHERNET_H_
 


@@ -40,6 +40,8 @@
                #include <avr/io.h>
                #include <string.h>
 
                #include <avr/io.h>
                #include <string.h>
 

+               #include "Config/AppConfig.h"
+

                #include "EthernetProtocols.h"
                #include "ProtocolDecoders.h"
                #include "ICMP.h"
                #include "EthernetProtocols.h"
                #include "ProtocolDecoders.h"
                #include "ICMP.h"


@@ -48,60 +50,48 @@
                #include "DHCP.h"
                #include "ARP.h"
                #include "IP.h"
                #include "DHCP.h"
                #include "ARP.h"
                #include "IP.h"

-               
-       /* Macros: */
-               /** Physical MAC address of the USB RNDIS network adapter */
-               #define ADAPTER_MAC_ADDRESS              {0x02, 0x00, 0x02, 0x00, 0x02, 0x00}
-       
-               /** Physical MAC address of the virtual server on the network */
-               #define SERVER_MAC_ADDRESS               {0x00, 0x01, 0x00, 0x01, 0x00, 0x01}           

 
 

-               /** Physical MAC address of the network broadcast address */
+       /* Macros: */
+               /** Physical MAC address of the network broadcast address. */

                #define BROADCAST_MAC_ADDRESS            {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}
                #define BROADCAST_MAC_ADDRESS            {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}

-       
+

                /** Performs a comparison between two MAC addresses, indicating if they are identical.
                /** Performs a comparison between two MAC addresses, indicating if they are identical.

-                *  
+                *

                 *  \param[in] MAC1  First MAC address
                 *  \param[in] MAC2  Second MAC address
                 *
                 *  \param[in] MAC1  First MAC address
                 *  \param[in] MAC2  Second MAC address
                 *

-                *  \return True if the addresses match, false otherwise
+                *  \return True if the addresses match, \c false otherwise

                 */
                #define MAC_COMPARE(MAC1, MAC2)          (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0)
 
                 */
                #define MAC_COMPARE(MAC1, MAC2)          (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0)
 

-               /** Maximum size of an incoming or outgoing Ethernet frame in bytes */
+               /** Maximum size of an incoming or outgoing Ethernet frame in bytes. */

                #define ETHERNET_FRAME_SIZE_MAX          1500
                #define ETHERNET_FRAME_SIZE_MAX          1500

-               
-               /** Minimum size of an Ethernet packet in bytes, to conform to the Ethernet V2 packet standard */
+
+               /** Minimum size of an Ethernet packet in bytes, to conform to the Ethernet V2 packet standard. */

                #define ETHERNET_VER2_MINSIZE            0x0600
                #define ETHERNET_VER2_MINSIZE            0x0600

-               
-               /** Return value for all sub protocol handling routines, indicating that no response packet has been generated */
-               #define NO_RESPONSE                      0              

 
 

-               /** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled */
+               /** Return value for all sub protocol handling routines, indicating that no response packet has been generated. */
+               #define NO_RESPONSE                      0
+
+               /** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled. */

                #define NO_PROCESS                       -1
 
        /* Type Defines: */
                #define NO_PROCESS                       -1
 
        /* Type Defines: */

-               /** Type define for an Ethernet frame buffer. */
+               /** Type define for an Ethernet frame buffer data and information structure. */

                typedef struct
                {
                typedef struct
                {

-                       uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */
-                       uint16_t      FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer */
-                       bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */
+                       uint8_t  FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents. */
+                       uint16_t FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer. */

                } Ethernet_Frame_Info_t;
 
                } Ethernet_Frame_Info_t;
 

-               /** Type define for an Ethernet frame header */
+               /** Type define for an Ethernet frame header. */

                typedef struct
                {
                        MAC_Address_t Destination; /**< Physical MAC address of the packet recipient */
                        MAC_Address_t Source; /**< Physics MAC address of the packet source */
                typedef struct
                {
                        MAC_Address_t Destination; /**< Physical MAC address of the packet recipient */
                        MAC_Address_t Source; /**< Physics MAC address of the packet source */

-                       
-                       union
-                       {
-                               uint16_t  EtherType; /**< Ethernet packet sub-protocol type, for Ethernet V2 packets */
-                               uint16_t  Length; /**< Ethernet frame length, for Ethernet V1 packets */
-                       };
+                       uint16_t      EtherType; /**< Ethernet packet sub-protocol type, for Ethernet V2 packets */

                } Ethernet_Frame_Header_t;
                } Ethernet_Frame_Header_t;

-               
+

        /* External Variables: */
                extern Ethernet_Frame_Info_t FrameIN;
                extern Ethernet_Frame_Info_t FrameOUT;
        /* External Variables: */
                extern Ethernet_Frame_Info_t FrameIN;
                extern Ethernet_Frame_Info_t FrameOUT;


@@ -111,9 +101,11 @@
                extern const MAC_Address_t BroadcastMACAddress;
                extern const IP_Address_t  BroadcastIPAddress;
                extern const IP_Address_t  ClientIPAddress;
                extern const MAC_Address_t BroadcastMACAddress;
                extern const IP_Address_t  BroadcastIPAddress;
                extern const IP_Address_t  ClientIPAddress;

-               
+

        /* Function Prototypes: */
                void     Ethernet_ProcessPacket(void);
        /* Function Prototypes: */
                void     Ethernet_ProcessPacket(void);

-               uint16_t Ethernet_Checksum16(void* Data, uint16_t Bytes);
-               
+               uint16_t Ethernet_Checksum16(void* Data,
+                                            uint16_t Bytes);
+

 #endif
 #endif

+