net/arp.h File Reference

ARP Module for Modtronix TCP/IP Stack. More...

#include "net\ip.h"

Defines
#define	ARP_REPLY   (0x00ul)
#define	ARP_REQUEST   (0x01ul)
#define	ARP_UNKNOWN   (0x02ul)
#define	ARPIsTxReady()   MACIsTxReady(TRUE)
Functions
BOOL	ARPGet (NODE_INFO *remote, BYTE *opCode)
BOOL	ARPPut (NODE_INFO *remote, BYTE opCode)

---

Detailed Description

ARP Module for Modtronix TCP/IP Stack.

Author:

Modtronix Engineering

Dependencies:

stacktsk.h, mac.h

Compiler:

MPLAB C18 v2.10 or higher
HITECH PICC-18 V8.35PL3 or higher

Description

This module contains the ARP code.
For a detailed description, see the ARP section of this document - in [Modules] [TCP/IP Stack] [TCP/IP Base Protocols].

---

Define Documentation

#define ARP_REPLY   (0x00ul)

#define ARP_REQUEST   (0x01ul)

#define ARP_UNKNOWN   (0x02ul)

 

#define ARPIsTxReady

(

)

MACIsTxReady(TRUE)

Returns:

TRUE if ARP receive buffer is full.
FALSE otherwise.

Examples:

ex_tcp_client.c, ex_udp_client.c, and ex_udp_client2.c.

---

Function Documentation

BOOL ARPGet	(	NODE_INFO *	remote,
		BYTE *	opCode
	)

If a valid ARP packet addressed to us was received, true is returned and opcode (ARP_REPLY or ARP_REQUEST) is writen to given opCode buffer.

Pre-Condition:

ARP packet is ready in MAC buffer.

Parameters:

	remote	Remote node info
	opCode	Buffer to hold ARP op code.

Returns:

TRUE if a valid ARP packet was received, and addressed to us.
FALSE otherwise.

BOOL ARPPut	(	NODE_INFO *	remote,
		BYTE	opCode
	)

Send an ARP message.

Parameters:

	remote	- Remote node info
	opCode	- ARP op code to send

Returns:

TRUE - The ARP packet was generated properly FALSE - Unable to allocate a TX buffer