MCHPStack2.20/Source/DHCP.h

/*********************************************************************
 *
 *                  DHCP Defs for Microchip TCP/IP Stack
 *
 *********************************************************************
 * FileName:        DHCP.h
 * Dependencies:    StackTsk.h
 *                  UDP.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     3/21/01  Original        (Rev 1.0)
 ********************************************************************/
#ifndef DHCP_H
#define DHCP_H

#include "stacktsk.h"


typedef enum _SM_DHCP
{
    SM_DHCP_INIT,
    SM_DHCP_RESET_WAIT,
    SM_DHCP_BROADCAST,
    SM_DHCP_DISCOVER,
    SM_DHCP_REQUEST,
    SM_DHCP_BIND,
    SM_DHCP_BOUND,
    SM_DHCP_DISABLED,
    SM_DHCP_ABORTED
} SM_DHCP;

#if !defined(THIS_IS_DHCP)
    extern SM_DHCP smDHCPState;
#endif

/*********************************************************************
 * Macro:           void DHCPDisable(void)
 *
 * PreCondition:    None
 *
 * Input:           None
 *
 * Output:          None
 *
 * Side Effects:    None
 *
 * Overview:        Puts DHCPTask into unhandled state "SM_DHCP_DISABLED"
 *                  and hence DHCP is effictively disabled.
 *
 * Note:            This macro should be called before DHCPTask is called
 *                  or else a UDP port will be kept open and there will
 *                  be no task to process it.
 ********************************************************************/
#define DHCPDisable()       (smDHCPState = SM_DHCP_DISABLED)


/*********************************************************************
 * Function:        void DHCPTask(void)
 *
 * PreCondition:    DHCPInit() is already called AND
 *                  IPGetHeader() is called with
 *                  IPFrameType == IP_PROT_UDP
 *
 * Input:           None
 *
 * Output:          None
 *
 * Side Effects:    None
 *
 * Overview:        Fetches pending UDP packet from MAC receive buffer
 *                  and dispatches it appropriate UDP socket.
 *                  If not UDP socket is matched, UDP packet is
 *                  silently discarded.
 *
 * Note:            Caller must make sure that MAC receive buffer
 *                  access pointer is set to begining of UDP packet.
 *                  Required steps before calling this function is:
 *
 *                  If ( MACIsRxReady() )
 *                  {
 *                      MACGetHeader()
 *                      If MACFrameType == IP
 *                          IPGetHeader()
 *                          if ( IPFrameType == IP_PROT_UDP )
 *                              Call DHCPTask()
 *                  ...
 ********************************************************************/
void DHCPTask(void);


/*********************************************************************
 * Function:        void DHCPAbort(void)
 *
 * PreCondition:    DHCPTask() must have been called at least once.
 *
 * Input:           None
 *
 * Output:          None
 *
 * Side Effects:    None
 *
 * Overview:        Forgets about any previous DHCP attempts and
 *                  closes DHCPSocket.
 *
 * Note:
 ********************************************************************/
void DHCPAbort(void);


/*********************************************************************
 * Macro:           BOOL DHCPIsBound(void)
 *
 * PreCondition:    None
 *
 * Input:           None
 *
 * Output:          TRUE if DHCP is bound to given configuration
 *                  FALSE if DHCP has yet to be bound.
 *
 * Side Effects:    None
 *
 * Overview:        None
 *
 * Note:
 ********************************************************************/
#define DHCPIsBound()       (DHCPState.bits.bIsBound)

typedef union _DHCP_STATE
{
    struct
    {
        unsigned int bIsBound : 1;
    } bits;
    BYTE Val;
} DHCP_STATE;

#if !defined(THIS_IS_DHCP)
    extern DHCP_STATE DHCPState;
#endif

/*********************************************************************
 * Macro:           void DHCPReset(void)
 *
 * PreCondition:    None
 *
 * Input:           None
 *
 * Output:          None
 *
 * Side Effects:    None
 *
 * Overview:        Closes any previously opened DHCP socket
 *                  and resets DHCP state machine so that on next
 *                  call to DHCPTask will result in new DHCP request.
 *
 * Note:            None
 ********************************************************************/
void DHCPReset(void);


#endif
1	hedin	62	/*********************************************************************
2			*
3			* DHCP Defs for Microchip TCP/IP Stack
4			*
5			*********************************************************************
6			* FileName: DHCP.h
7			* Dependencies: StackTsk.h
8			* UDP.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 3/21/01 Original (Rev 1.0)
37			********************************************************************/
38			#ifndef DHCP_H
39			#define DHCP_H
40
41			#include "stacktsk.h"
42
43
44			typedef enum _SM_DHCP
45			{
46			SM_DHCP_INIT,
47			SM_DHCP_RESET_WAIT,
48			SM_DHCP_BROADCAST,
49			SM_DHCP_DISCOVER,
50			SM_DHCP_REQUEST,
51			SM_DHCP_BIND,
52			SM_DHCP_BOUND,
53			SM_DHCP_DISABLED,
54			SM_DHCP_ABORTED
55			} SM_DHCP;
56
57			#if !defined(THIS_IS_DHCP)
58			extern SM_DHCP smDHCPState;
59			#endif
60
61			/*********************************************************************
62			* Macro: void DHCPDisable(void)
63			*
64			* PreCondition: None
65			*
66			* Input: None
67			*
68			* Output: None
69			*
70			* Side Effects: None
71			*
72			* Overview: Puts DHCPTask into unhandled state "SM_DHCP_DISABLED"
73			* and hence DHCP is effictively disabled.
74			*
75			* Note: This macro should be called before DHCPTask is called
76			* or else a UDP port will be kept open and there will
77			* be no task to process it.
78			********************************************************************/
79			#define DHCPDisable() (smDHCPState = SM_DHCP_DISABLED)
80
81
82			/*********************************************************************
83			* Function: void DHCPTask(void)
84			*
85			* PreCondition: DHCPInit() is already called AND
86			* IPGetHeader() is called with
87			* IPFrameType == IP_PROT_UDP
88			*
89			* Input: None
90			*
91			* Output: None
92			*
93			* Side Effects: None
94			*
95			* Overview: Fetches pending UDP packet from MAC receive buffer
96			* and dispatches it appropriate UDP socket.
97			* If not UDP socket is matched, UDP packet is
98			* silently discarded.
99			*
100			* Note: Caller must make sure that MAC receive buffer
101			* access pointer is set to begining of UDP packet.
102			* Required steps before calling this function is:
103			*
104			* If ( MACIsRxReady() )
105			* {
106			* MACGetHeader()
107			* If MACFrameType == IP
108			* IPGetHeader()
109			* if ( IPFrameType == IP_PROT_UDP )
110			* Call DHCPTask()
111			* ...
112			********************************************************************/
113			void DHCPTask(void);
114
115
116			/*********************************************************************
117			* Function: void DHCPAbort(void)
118			*
119			* PreCondition: DHCPTask() must have been called at least once.
120			*
121			* Input: None
122			*
123			* Output: None
124			*
125			* Side Effects: None
126			*
127			* Overview: Forgets about any previous DHCP attempts and
128			* closes DHCPSocket.
129			*
130			* Note:
131			********************************************************************/
132			void DHCPAbort(void);
133
134
135
136			/*********************************************************************
137			* Macro: BOOL DHCPIsBound(void)
138			*
139			* PreCondition: None
140			*
141			* Input: None
142			*
143			* Output: TRUE if DHCP is bound to given configuration
144			* FALSE if DHCP has yet to be bound.
145			*
146			* Side Effects: None
147			*
148			* Overview: None
149			*
150			* Note:
151			********************************************************************/
152			#define DHCPIsBound() (DHCPState.bits.bIsBound)
153
154			typedef union _DHCP_STATE
155			{
156			struct
157			{
158			unsigned int bIsBound : 1;
159			} bits;
160			BYTE Val;
161			} DHCP_STATE;
162
163			#if !defined(THIS_IS_DHCP)
164			extern DHCP_STATE DHCPState;
165			#endif
166
167			/*********************************************************************
168			* Macro: void DHCPReset(void)
169			*
170			* PreCondition: None
171			*
172			* Input: None
173			*
174			* Output: None
175			*
176			* Side Effects: None
177			*
178			* Overview: Closes any previously opened DHCP socket
179			* and resets DHCP state machine so that on next
180			* call to DHCPTask will result in new DHCP request.
181			*
182			* Note: None
183			********************************************************************/
184			void DHCPReset(void);
185
186
187
188
189			#endif