X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Modules%2FIPStack%2Fipstack.h;h=db93328dfa138f7681a467a06cbea1a948009c71;hb=94ecc5441605ad5151e625457531e7f90470db31;hp=885e048dd2d1150e95695c99de4cd0ffe9351ec3;hpb=2904567b1901a524d44a136f06f2e6d7b5ce7db5;p=tpg%2Facess2.git

diff --git a/Modules/IPStack/ipstack.h b/Modules/IPStack/ipstack.h
index 885e048d..db93328d 100644
--- a/Modules/IPStack/ipstack.h
+++ b/Modules/IPStack/ipstack.h
@@ -39,41 +39,48 @@ struct sMacAddr {
 } __attribute__((packed));
 
 struct sInterface {
-	struct sInterface	*Next;
-	tVFS_Node	Node;
-	tAdapter	*Adapter;
-	 int	TimeoutDelay;	// Time in miliseconds before a packet times out
-	 int	Type;	// 0 for disabled, 4 for IPv4 and 6 for IPv6
+	struct sInterface	*Next;	//!< Next interface in list
 	
-	//TODO: Remove explicit mentions of IPv4/IPv6 and make more general
-	union {
-		struct	{
-			tIPv6	Address;
-			 int	SubnetBits;	//Should this be outside the union?
-		}	IP6;
-		
-		struct {
-			tIPv4	Address;
-			tIPv4	Gateway;
-			 int	SubnetBits;
-		}	IP4;
-	};
+	tVFS_Node	Node;	//!< Node to use the interface
+	
+	tAdapter	*Adapter;	//!< Adapter the interface is associated with
+	 int	TimeoutDelay;	//!< Time in miliseconds before a packet times out
+	 int	Type;	//!< Interface type, see ::eInterfaceTypes
+	
+	void	*Address;	//!< IP address (stored after the Name)
+	 int	SubnetBits;	//!< Number of bits that denote the address network
 	
 	char	Name[];
 };
 
+/**
+ * \brief Route definition structure
+ */
+typedef struct sRoute {
+	struct sRoute	*Next;
+	
+	tVFS_Node	Node;	//!< Node for route manipulation
+	
+	tInterface	*Interface;	//!< Interface for this route
+	 int	AddressType;	//!< 0: Invalid, 4: IPv4, 6: IPv4
+	void	*Network;	//!< Network - Pointer to tIPv4/tIPv6/... at end of structure
+	 int	SubnetBits;	//!< Number of bits in \a Network that are valid
+	void	*NextHop;	//!< Next Hop address - Pointer to tIPv4/tIPv6/... at end of structure
+	 int	Metric;	//!< Route priority
+}	tRoute;
+
 /**
  * \brief Represents a network adapter
  */
 struct sAdapter {
 	struct sAdapter	*Next;
 	
-	 int	DeviceFD;
-	 int	NRef;
+	 int	DeviceFD;	//!< File descriptor of the device
+	 int	NRef;	//!< Number of times it's been referenced
 	
-	tMacAddr	MacAddr;
-	 int	DeviceLen;
-	char	Device[];
+	tMacAddr	MacAddr;	//!< Physical address of the adapter
+	 int	DeviceLen;	//!< Device name length
+	char	Device[];	//!< Device name
 };
 
 /**