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
/*
             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.
 */
36

37
#include "DHCPClientApp.h"
38

39
#if defined(ENABLE_DHCP_CLIENT) || defined(__DOXYGEN__)
40
41

/** Initialization function for the DHCP client. */
42
void DHCPClientApp_Init(void)
43
{
44
	/* Create a new UDP connection to the DHCP server port for the DHCP solicitation */
Dean Camera's avatar
Dean Camera committed
45
	struct uip_udp_conn* Connection = uip_udp_new(&uip_broadcast_addr, HTONS(DHCPC_SERVER_PORT));
46
	
47
	/* If the connection was successfully created, bind it to the local DHCP client port */
48
	if (Connection != NULL)
49
	{
50
51
		uip_udp_appstate_t* const AppState = &Connection->appstate;
		uip_udp_bind(Connection, HTONS(DHCPC_CLIENT_PORT));
52
53
		
		/* Set the initial client state */
54
		AppState->DHCPClient.CurrentState = DHCP_STATE_SendDiscover;
55

56
57
58
		/* Set timeout period to half a second for a DHCP server to respond */
		timer_set(&AppState->DHCPClient.Timeout, CLOCK_SECOND / 2);
	}
59
60
61
62
63
}
 
/** 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.
 */
64
void DHCPClientApp_Callback(void)
65
66
67
68
69
{
	uip_udp_appstate_t* const AppState    = &uip_udp_conn->appstate;
	DHCP_Header_t*      const AppData     = (DHCP_Header_t*)uip_appdata;
	uint16_t                  AppDataSize = 0;
	
70
	switch (AppState->DHCPClient.CurrentState)
71
72
73
	{
		case DHCP_STATE_SendDiscover:
			/* Clear all DHCP settings, reset client IP address */
74
75
			memset(&AppState->DHCPClient.DHCPOffer_Data, 0x00, sizeof(AppState->DHCPClient.DHCPOffer_Data));
			uip_sethostaddr((uip_ipaddr_t*)&AppState->DHCPClient.DHCPOffer_Data.AllocatedIP);
76
77

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

			/* Reset the timeout timer, progress to next state */
89
			timer_reset(&AppState->DHCPClient.Timeout);
90
			AppState->DHCPClient.CurrentState = DHCP_STATE_WaitForOffer;			
91
92
			
			break;
93
		case DHCP_STATE_WaitForOffer:
94
95
96
			if (!(uip_newdata()))
			{
				/* Check if the DHCP timeout period has expired while waiting for a response */
97
				if (timer_expired(&AppState->DHCPClient.Timeout))
98
				  AppState->DHCPClient.CurrentState = DHCP_STATE_SendDiscover;
99
100
101
102
103
104
				
				break;
			}
			  
			uint8_t OfferResponse_MessageType;
			if ((AppData->TransactionID == DHCP_TRANSACTION_ID) &&
105
			    DHCPClientApp_GetOption(AppData->Options, DHCP_OPTION_MSG_TYPE, &OfferResponse_MessageType) &&
106
107
108
			    (OfferResponse_MessageType == DHCP_OFFER))
			{
				/* Received a DHCP offer for an IP address, copy over values for later request */
109
110
111
112
				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);
113
				
114
				timer_reset(&AppState->DHCPClient.Timeout);
115
				AppState->DHCPClient.CurrentState = DHCP_STATE_SendRequest;
116
117
118
119
120
			}

			break;
		case DHCP_STATE_SendRequest:
			/* Fill out the DHCP response header */
121
			AppDataSize += DHCPClientApp_FillDHCPHeader(AppData, DHCP_REQUEST, AppState);
122
123

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

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

			/* Send the DHCP REQUEST packet */
132
			uip_udp_send(AppDataSize);
133
134
			
			/* Reset the timeout timer, progress to next state */
135
			timer_reset(&AppState->DHCPClient.Timeout);
136
			AppState->DHCPClient.CurrentState = DHCP_STATE_WaitForACK;
137
138
139
140
141
142

			break;
		case DHCP_STATE_WaitForACK:
			if (!(uip_newdata()))
			{
				/* Check if the DHCP timeout period has expired while waiting for a response */
143
				if (timer_expired(&AppState->DHCPClient.Timeout))
144
				  AppState->DHCPClient.CurrentState = DHCP_STATE_SendDiscover;
145
146
147
148
149
150
				
				break;
			}
			
			uint8_t RequestResponse_MessageType;
			if ((AppData->TransactionID == DHCP_TRANSACTION_ID) &&
151
			    DHCPClientApp_GetOption(AppData->Options, DHCP_OPTION_MSG_TYPE, &RequestResponse_MessageType) &&
152
153
154
			    (RequestResponse_MessageType == DHCP_ACK))
			{
				/* Set the new network parameters from the DHCP server */
155
156
157
				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);
158
			
159
160
161
162
				/* Indicate to the user that we now have a valid IP configuration */
				HaveIPConfiguration = true;

				AppState->DHCPClient.CurrentState = DHCP_STATE_AddressLeased;				
163
164
165
166
167
168
			}
			
			break;
	}
}

169
170
171
172
173
174
175
176
177
/** 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
 */
178
uint16_t DHCPClientApp_FillDHCPHeader(DHCP_Header_t* DHCPHeader, uint8_t DHCPMessageType, uip_udp_appstate_t* AppState)
179
180
181
182
183
184
185
186
187
188
189
190
{
	/* 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);
191
192
193
	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));
194
195
196
	memcpy(&DHCPHeader->ClientHardwareAddress, &MACAddress, sizeof(struct uip_eth_addr));
	DHCPHeader->Cookie                = DHCP_MAGIC_COOKIE;
	
197
	/* Add a DHCP message type and terminator options to the start of the DHCP options field */
198
199
200
201
202
203
204
205
206
	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);
}

207
208
209
210
211
212
213
214
215
216
/** 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
 */
217
uint8_t DHCPClientApp_SetOption(uint8_t* DHCPOptionList, uint8_t Option, uint8_t DataLen, void* OptionData)
218
219
220
221
222
223
224
225
{
	/* 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;
226
	memcpy(&DHCPOptionList[2], OptionData, DataLen);
227
228
229
230
231
232
	DHCPOptionList[2 + DataLen] = DHCP_OPTION_END;
	
	/* Calculate the total number of bytes added to the outgoing packet */
	return (2 + DataLen);
}

233
234
235
236
237
238
239
240
/** 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
 */
241
bool DHCPClientApp_GetOption(uint8_t* DHCPOptionList, uint8_t Option, void* Destination)
242
{
243
	/* Look through the incoming DHCP packet's options list for the requested option */
244
245
246
247
248
249
250
251
	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]);
			
252
			/* Indicate that the requested option data was successfully retrieved */
253
254
255
256
257
258
259
			return true;
		}
		
		/* Skip to next DHCP option in the options list */
		DHCPOptionList += (DHCPOptionList[1] + 2);
	}
	
260
	/* Requested option not found in the incoming packet's DHCP options list */
261
262
263
	return false;
}
#endif