MCHPStack2.20/Source/ARPTsk.h

/*********************************************************************
 *
 *                  ARP Server Defs for Microchip TCP/IP Stack
 *
 *********************************************************************
 * FileName:        ARPTsk.h
 * Dependencies:    StackTsk.h
 *                  MAC.h
 * Processor:       PIC18
 * Complier:        MCC18 v1.00.50 or higher
 *                  HITECH PICC-18 V8.10PL1 or higher
 * Company:         Microchip Technology, Inc.
 *
 * Software License Agreement
 *
 * The software supplied herewith by Microchip Technology Incorporated
 * (the “Company”) for its PICmicro® Microcontroller is intended and
 * supplied to you, the Company’s customer, for use solely and
 * exclusively on Microchip PICmicro Microcontroller products. The
 * software is owned by the Company and/or its supplier, and is
 * protected under applicable copyright laws. All rights are reserved.
 * Any use in violation of the foregoing restrictions may subject the
 * user to criminal sanctions under applicable laws, as well as to
 * civil liability for the breach of the terms and conditions of this
 * license.
 *
 * THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. NO WARRANTIES,
 * WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED
 * TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,
 * IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 * Author               Date    Comment
 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * Nilesh Rajbharti     8/20/01 Original        (Rev 1.0)
 * Nilesh Rajbharti     2/9/02  Cleanup
 * Nilesh Rajbharti     5/22/02 Rev 2.0 (See version.log for detail)
 ********************************************************************/

#ifndef ARP_TSK_H
#define ARP_TSK_H

#include "stacktsk.h"
#include "mac.h"


/*********************************************************************
 * Function:        void ARPInit(void)
 *
 * PreCondition:    None
 *
 * Input:           None
 *
 * Output:          ARP Cache is initialized.
 *
 * Side Effects:    None
 *
 * Overview:        None
 *
 * Note:            None
 ********************************************************************/
void ARPInit(void);


/*********************************************************************
 * Function:        BOOL ARPProcess(void)
 *
 * PreCondition:    ARP packet is ready in MAC buffer.
 *
 * Input:           None
 *
 * Output:          ARP FSM is executed.
 *
 * Side Effects:    None
 *
 * Overview:        None
 *
 * Note:            None
 ********************************************************************/
BOOL ARPProcess(void);


/*********************************************************************
 * Function:        void ARPResolve(IP_ADDR* IPAddr)
 *
 * PreCondition:    None
 *
 * Input:           IPAddr  - IP Address to be resolved.
 *
 * Output:          None
 *
 * Side Effects:    None
 *
 * Overview:        An ARP request is sent.
 *
 * Note:
 ********************************************************************/
void ARPResolve(IP_ADDR *IPAddr);


/*********************************************************************
 * Function:        BOOL ARPIsResolved(IP_ADDR* IPAddr,
 *                                      MAC_ADDR *MACAddr)
 *
 * PreCondition:    None
 *
 * Input:           IPAddr      - IPAddress to be resolved.
 *                  MACAddr     - Buffer to hold corresponding
 *                                MAC Address.
 *
 * Output:          TRUE if given IP Address has been resolved.
 *                  FALSE otherwise.
 *
 * Side Effects:    None
 *
 * Overview:        None
 *
 * Note:            This function is available only when
 *                  STACK_CLIENT_MODE is defined.
 ********************************************************************/
BOOL ARPIsResolved(IP_ADDR *IPAddr, MAC_ADDR *MACAddr);


#endif
1	hedin	62	/*********************************************************************
2			*
3			* ARP Server Defs for Microchip TCP/IP Stack
4			*
5			*********************************************************************
6			* FileName: ARPTsk.h
7			* Dependencies: StackTsk.h
8			* MAC.h
9			* Processor: PIC18
10			* Complier: MCC18 v1.00.50 or higher
11			* HITECH PICC-18 V8.10PL1 or higher
12			* Company: Microchip Technology, Inc.
13			*
14			* Software License Agreement
15			*
16			* The software supplied herewith by Microchip Technology Incorporated
17			* (the “Company”) for its PICmicro® Microcontroller is intended and
18			* supplied to you, the Company’s customer, for use solely and
19			* exclusively on Microchip PICmicro Microcontroller products. The
20			* software is owned by the Company and/or its supplier, and is
21			* protected under applicable copyright laws. All rights are reserved.
22			* Any use in violation of the foregoing restrictions may subject the
23			* user to criminal sanctions under applicable laws, as well as to
24			* civil liability for the breach of the terms and conditions of this
25			* license.
26			*
27			* THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. NO WARRANTIES,
28			* WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED
29			* TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
30			* PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,
31			* IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
32			* CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
33			*
34			* Author Date Comment
35			*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36			* Nilesh Rajbharti 8/20/01 Original (Rev 1.0)
37			* Nilesh Rajbharti 2/9/02 Cleanup
38			* Nilesh Rajbharti 5/22/02 Rev 2.0 (See version.log for detail)
39			********************************************************************/
40
41			#ifndef ARP_TSK_H
42			#define ARP_TSK_H
43
44			#include "stacktsk.h"
45			#include "mac.h"
46
47
48			/*********************************************************************
49			* Function: void ARPInit(void)
50			*
51			* PreCondition: None
52			*
53			* Input: None
54			*
55			* Output: ARP Cache is initialized.
56			*
57			* Side Effects: None
58			*
59			* Overview: None
60			*
61			* Note: None
62			********************************************************************/
63			void ARPInit(void);
64
65
66			/*********************************************************************
67			* Function: BOOL ARPProcess(void)
68			*
69			* PreCondition: ARP packet is ready in MAC buffer.
70			*
71			* Input: None
72			*
73			* Output: ARP FSM is executed.
74			*
75			* Side Effects: None
76			*
77			* Overview: None
78			*
79			* Note: None
80			********************************************************************/
81			BOOL ARPProcess(void);
82
83
84			/*********************************************************************
85			* Function: void ARPResolve(IP_ADDR* IPAddr)
86			*
87			* PreCondition: None
88			*
89			* Input: IPAddr - IP Address to be resolved.
90			*
91			* Output: None
92			*
93			* Side Effects: None
94			*
95			* Overview: An ARP request is sent.
96			*
97			* Note:
98			********************************************************************/
99			void ARPResolve(IP_ADDR *IPAddr);
100
101
102			/*********************************************************************
103			* Function: BOOL ARPIsResolved(IP_ADDR* IPAddr,
104			* MAC_ADDR *MACAddr)
105			*
106			* PreCondition: None
107			*
108			* Input: IPAddr - IPAddress to be resolved.
109			* MACAddr - Buffer to hold corresponding
110			* MAC Address.
111			*
112			* Output: TRUE if given IP Address has been resolved.
113			* FALSE otherwise.
114			*
115			* Side Effects: None
116			*
117			* Overview: None
118			*
119			* Note: This function is available only when
120			* STACK_CLIENT_MODE is defined.
121			********************************************************************/
122			BOOL ARPIsResolved(IP_ADDR IPAddr, MAC_ADDR MACAddr);
123
124
125
126			#endif