DHCPClientApp.c 11.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  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 
  software without specific, written prior permission.

  The author disclaim 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
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  DHCP Client Application. When connected to the uIP stack, this will retrieve IP configuration settings from the
 *  DHCP server on the network.
 */
 
37
#include "DHCPClientApp.h"
38

39
#if defined(ENABLE_DHCP_CLIENT) || defined(__DOXYGEN__)
40
41
42
43
/** Timer for managing the timeout period for a DHCP server to respond */
struct timer DHCPTimer;

/** Initialization function for the DHCP client. */
44
void DHCPClientApp_Init(void)
45
{
46
	/* Create an IP address to the broadcast network address */
47
48
	uip_ipaddr_t DHCPServerIPAddress;
	uip_ipaddr(&DHCPServerIPAddress, 255, 255, 255, 255);
49
50
51

	/* Create a new UDP connection to the DHCP server port for the DHCP solicitation */
	struct uip_udp_conn* Connection = uip_udp_new(&DHCPServerIPAddress, HTONS(DHCPC_SERVER_PORT));
52
	
53
	/* If the connection was successfully created, bind it to the local DHCP client port */
54
	if (Connection != NULL)
55
	{
56
57
58
		uip_udp_appstate_t* const AppState = &Connection->appstate;

		uip_udp_bind(Connection, HTONS(DHCPC_CLIENT_PORT));
59
		AppState->DHCPClient.CurrentState = DHCP_STATE_SendDiscover;
60
61
62
63
64
65
66
67
68
	}

	/* Set timeout period to half a second for a DHCP server to respond */
	timer_set(&DHCPTimer, CLOCK_SECOND / 2);
}
 
/** uIP stack application callback for the DHCP client. This function must be called each time the TCP/IP stack 
 *  needs a UDP packet to be processed.
 */
69
void DHCPClientApp_Callback(void)
70
71
72
73
74
{
	uip_udp_appstate_t* const AppState    = &uip_udp_conn->appstate;
	DHCP_Header_t*      const AppData     = (DHCP_Header_t*)uip_appdata;
	uint16_t                  AppDataSize = 0;
	
75
	switch (AppState->DHCPClient.CurrentState)
76
77
78
	{
		case DHCP_STATE_SendDiscover:
			/* Clear all DHCP settings, reset client IP address */
79
80
			memset(&AppState->DHCPClient.DHCPOffer_Data, 0x00, sizeof(AppState->DHCPClient.DHCPOffer_Data));
			uip_sethostaddr((uip_ipaddr_t*)&AppState->DHCPClient.DHCPOffer_Data.AllocatedIP);
81
82

			/* Fill out the DHCP response header */
83
			AppDataSize += DHCPClientApp_FillDHCPHeader(AppData, DHCP_DISCOVER, AppState);
84
85
86
			
			/* Add the required DHCP options list to the packet */
			uint8_t RequiredOptionList[] = {DHCP_OPTION_SUBNET_MASK, DHCP_OPTION_ROUTER, DHCP_OPTION_DNS_SERVER};
87
88
			AppDataSize += DHCPClientApp_SetOption(AppData->Options, DHCP_OPTION_REQ_LIST, sizeof(RequiredOptionList),
			                                       RequiredOptionList);			
89
90
			
			/* Send the DHCP DISCOVER packet */
91
			uip_udp_send(AppDataSize);
92
93
94

			/* Reset the timeout timer, progress to next state */
			timer_reset(&DHCPTimer);
95
			AppState->DHCPClient.CurrentState = DHCP_STATE_WaitForOffer;			
96
97
			
			break;
98
		case DHCP_STATE_WaitForOffer:
99
100
101
102
			if (!(uip_newdata()))
			{
				/* Check if the DHCP timeout period has expired while waiting for a response */
				if (timer_expired(&DHCPTimer))
103
				  AppState->DHCPClient.CurrentState = DHCP_STATE_SendDiscover;
104
105
106
107
108
109
				
				break;
			}
			  
			uint8_t OfferResponse_MessageType;
			if ((AppData->TransactionID == DHCP_TRANSACTION_ID) &&
110
			    DHCPClientApp_GetOption(AppData->Options, DHCP_OPTION_MSG_TYPE, &OfferResponse_MessageType) &&
111
112
113
			    (OfferResponse_MessageType == DHCP_OFFER))
			{
				/* Received a DHCP offer for an IP address, copy over values for later request */
114
115
116
117
				memcpy(&AppState->DHCPClient.DHCPOffer_Data.AllocatedIP, &AppData->YourIP, sizeof(uip_ipaddr_t));
				DHCPClientApp_GetOption(AppData->Options, DHCP_OPTION_SUBNET_MASK, &AppState->DHCPClient.DHCPOffer_Data.Netmask);
				DHCPClientApp_GetOption(AppData->Options, DHCP_OPTION_ROUTER,      &AppState->DHCPClient.DHCPOffer_Data.GatewayIP);
				DHCPClientApp_GetOption(AppData->Options, DHCP_OPTION_SERVER_ID,   &AppState->DHCPClient.DHCPOffer_Data.ServerIP);
118
119
				
				timer_reset(&DHCPTimer);
120
				AppState->DHCPClient.CurrentState = DHCP_STATE_SendRequest;
121
122
123
124
125
			}

			break;
		case DHCP_STATE_SendRequest:
			/* Fill out the DHCP response header */
126
			AppDataSize += DHCPClientApp_FillDHCPHeader(AppData, DHCP_REQUEST, AppState);
127
128

			/* Add the DHCP REQUESTED IP ADDRESS option to the packet */
129
130
			AppDataSize += DHCPClientApp_SetOption(AppData->Options, DHCP_OPTION_REQ_IPADDR, sizeof(uip_ipaddr_t),
			                                       &AppState->DHCPClient.DHCPOffer_Data.AllocatedIP);
131
132

			/* Add the DHCP SERVER IP ADDRESS option to the packet */
133
134
			AppDataSize += DHCPClientApp_SetOption(AppData->Options, DHCP_OPTION_SERVER_ID, sizeof(uip_ipaddr_t),
			                                       &AppState->DHCPClient.DHCPOffer_Data.ServerIP);
135
136

			/* Send the DHCP REQUEST packet */
137
			uip_udp_send(AppDataSize);
138
139
140
			
			/* Reset the timeout timer, progress to next state */
			timer_reset(&DHCPTimer);
141
			AppState->DHCPClient.CurrentState = DHCP_STATE_WaitForACK;
142
143
144
145
146
147
148

			break;
		case DHCP_STATE_WaitForACK:
			if (!(uip_newdata()))
			{
				/* Check if the DHCP timeout period has expired while waiting for a response */
				if (timer_expired(&DHCPTimer))
149
				  AppState->DHCPClient.CurrentState = DHCP_STATE_SendDiscover;
150
151
152
153
154
155
				
				break;
			}
			
			uint8_t RequestResponse_MessageType;
			if ((AppData->TransactionID == DHCP_TRANSACTION_ID) &&
156
			    DHCPClientApp_GetOption(AppData->Options, DHCP_OPTION_MSG_TYPE, &RequestResponse_MessageType) &&
157
158
159
			    (RequestResponse_MessageType == DHCP_ACK))
			{
				/* Set the new network parameters from the DHCP server */
160
161
162
				uip_sethostaddr((uip_ipaddr_t*)&AppState->DHCPClient.DHCPOffer_Data.AllocatedIP);
				uip_setnetmask((uip_ipaddr_t*)&AppState->DHCPClient.DHCPOffer_Data.Netmask);
				uip_setdraddr((uip_ipaddr_t*)&AppState->DHCPClient.DHCPOffer_Data.GatewayIP);
163
			
164
				AppState->DHCPClient.CurrentState = DHCP_STATE_AddressLeased;
165
166
167
168
169
170
			}
			
			break;
	}
}

171
172
173
174
175
176
177
178
179
/** Fills the DHCP packet response with the appropriate BOOTP header for DHCP. This fills out all the required
 *  fields, leaving only the additional DHCP options to be added to the packet before it is sent to the DHCP server.
 *
 *  \param[out] DHCPHeader  Location in the packet buffer where the BOOTP header should be written to
 *  \param[in]  DHCPMessageType  DHCP Message type, such as DHCP_DISCOVER
 *  \param[in]  AppState    Application state of the current UDP connection
 *
 *  \return Size in bytes of the created DHCP packet
 */
180
uint16_t DHCPClientApp_FillDHCPHeader(DHCP_Header_t* DHCPHeader, uint8_t DHCPMessageType, uip_udp_appstate_t* AppState)
181
182
183
184
185
186
187
188
189
190
191
192
{
	/* Erase existing packet data so that we start will all 0x00 DHCP header data */
 	memset(DHCPHeader, 0, sizeof(DHCP_Header_t));

	/* Fill out the DHCP packet header */
	DHCPHeader->Operation             = DHCP_OP_BOOTREQUEST;
	DHCPHeader->HardwareType          = DHCP_HTYPE_ETHERNET;
	DHCPHeader->HardwareAddressLength = sizeof(MACAddress);
	DHCPHeader->Hops                  = 0;
	DHCPHeader->TransactionID         = DHCP_TRANSACTION_ID;
	DHCPHeader->ElapsedSeconds        = 0;
	DHCPHeader->Flags                 = HTONS(BOOTP_BROADCAST);
193
194
195
	memcpy(&DHCPHeader->ClientIP,     &uip_hostaddr,        sizeof(uip_ipaddr_t));
	memcpy(&DHCPHeader->YourIP,       &AppState->DHCPClient.DHCPOffer_Data.AllocatedIP, sizeof(uip_ipaddr_t));
	memcpy(&DHCPHeader->NextServerIP, &AppState->DHCPClient.DHCPOffer_Data.ServerIP,    sizeof(uip_ipaddr_t));
196
197
198
	memcpy(&DHCPHeader->ClientHardwareAddress, &MACAddress, sizeof(struct uip_eth_addr));
	DHCPHeader->Cookie                = DHCP_MAGIC_COOKIE;
	
199
	/* Add a DHCP message type and terminator options to the start of the DHCP options field */
200
201
202
203
204
205
206
207
208
	DHCPHeader->Options[0]            = DHCP_OPTION_MSG_TYPE;
	DHCPHeader->Options[1]            = 1;
	DHCPHeader->Options[2]            = DHCPMessageType;
	DHCPHeader->Options[3]            = DHCP_OPTION_END;
	
	/* Calculate the total number of bytes added to the outgoing packet */
	return (sizeof(DHCP_Header_t) + 4);
}

209
210
211
212
213
214
215
216
217
218
/** Sets the given DHCP option in the DHCP packet's option list. This automatically moves the
 *  end of options terminator past the new option in the options list.
 *
 *  \param[in,out] DHCPOptionList  Pointer to the start of the DHCP packet's options list
 *  \param[in]     Option          DHCP option to add to the list
 *  \param[in]     DataLen         Size in bytes of the option data to add
 *  \param[in]     OptionData      Buffer where the option's data is to be sourced from
 *
 *  \return Number of bytes added to the DHCP packet
 */
219
uint8_t DHCPClientApp_SetOption(uint8_t* DHCPOptionList, uint8_t Option, uint8_t DataLen, void* OptionData)
220
221
222
223
224
225
226
227
{
	/* Skip through the DHCP options list until the terminator option is found */
	while (*DHCPOptionList != DHCP_OPTION_END)
	  DHCPOptionList += (DHCPOptionList[1] + 2);

	/* Overwrite the existing terminator with the new option, add a new terminator at the end of the list */
	DHCPOptionList[0] = Option;
	DHCPOptionList[1] = DataLen;
228
	memcpy(&DHCPOptionList[2], OptionData, DataLen);
229
230
231
232
233
234
	DHCPOptionList[2 + DataLen] = DHCP_OPTION_END;
	
	/* Calculate the total number of bytes added to the outgoing packet */
	return (2 + DataLen);
}

235
236
237
238
239
240
241
242
/** Retrieves the given option's data (if present) from the DHCP packet's options list.
 *
 *  \param[in,out] DHCPOptionList  Pointer to the start of the DHCP packet's options list
 *  \param[in]     Option          DHCP option to retrieve to the list
 *  \param[out]    Destination     Buffer where the option's data is to be written to if found
 *
 *  \return Boolean true if the option was found in the DHCP packet's options list, false otherwise
 */
243
bool DHCPClientApp_GetOption(uint8_t* DHCPOptionList, uint8_t Option, void* Destination)
244
{
245
	/* Look through the incoming DHCP packet's options list for the requested option */
246
247
248
249
250
251
252
253
	while (*DHCPOptionList != DHCP_OPTION_END)
	{
		/* Check if the current DHCP option in the packet is the one requested */
		if (DHCPOptionList[0] == Option)
		{
			/* Copy request option's data to the destination buffer */
			memcpy(Destination, &DHCPOptionList[2], DHCPOptionList[1]);
			
254
			/* Indicate that the requested option data was successfully retrieved */
255
256
257
258
259
260
261
			return true;
		}
		
		/* Skip to next DHCP option in the options list */
		DHCPOptionList += (DHCPOptionList[1] + 2);
	}
	
262
	/* Requested option not found in the incoming packet's DHCP options list */
263
264
265
	return false;
}
#endif