3 Copyright (C) Dean Camera, 2014.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
21 The author disclaims all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
33 * Simple webserver application for demonstrating the RNDIS demo and TCP/IP stack. This
34 * application will serve up a static HTTP web page when requested by the host.
37 #include "Webserver.h"
39 /** HTTP server response header, for transmission before the page contents. This indicates to the host that a page exists at the
40 * given location, and gives extra connection information.
42 const char HTTP200Header[] PROGMEM = "HTTP/1.1 200 OK\r\n"
43 "Server: LUFA RNDIS\r\n"
44 "Content-type: text/html\r\n"
45 "Connection: close\r\n\r\n";
47 /** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given
48 * given URL is invalid, and gives extra error information.
50 const char HTTP404Header[] PROGMEM = "HTTP/1.1 404 Not Found\r\n"
51 "Server: LUFA RNDIS\r\n"
52 "Connection: close\r\n\r\n";
54 /** HTTP page to serve to the host when a HTTP request is made. This page is too long for a single response, thus it is automatically
55 * broken up into smaller blocks and sent as a series of packets each time the webserver application callback is run.
57 const char HTTPPage[] PROGMEM =
61 " LUFA Webserver Demo"
65 " <h1>Hello from your USB AVR!</h1>"
67 " Hello! Welcome to the LUFA RNDIS Demo Webserver test page, running on your USB AVR via the LUFA library. This demonstrates the HTTP webserver, TCP/IP stack and RNDIS demo all running atop the LUFA USB stack."
69 " <small>Project Information: <a href=\"http://www.lufa-lib.org\">http://www.lufa-lib.org</a>.</small>"
71 " <i>LUFA Version: </i>" LUFA_VERSION_STRING
77 /** Initializes the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
78 * callback routine for packets sent to the HTTP protocol port.
80 void Webserver_Init(void)
82 /* Open the HTTP port in the TCP protocol so that HTTP connections to the device can be established */
83 TCP_SetPortState(TCP_PORT_HTTP, TCP_Port_Open, Webserver_ApplicationCallback);
86 /** Indicates if a given request equals the given HTTP command.
88 * \param[in] RequestHeader HTTP request made by the host
89 * \param[in] Command HTTP command to compare the request to
91 * \return Boolean \c true if the command matches the request, \c false otherwise
93 static bool IsHTTPCommand(uint8_t* RequestHeader,
96 /* Returns true if the non null terminated string in RequestHeader matches the null terminated string Command */
97 return (strncmp((char*)RequestHeader, Command, strlen(Command)) == 0);
100 /** Application callback routine, executed each time the TCP processing task runs. This callback determines what request
101 * has been made (if any), and serves up appropriate responses.
103 * \param[in] ConnectionState Pointer to a TCP Connection State structure giving connection information
104 * \param[in,out] Buffer Pointer to the application's send/receive packet buffer
106 void Webserver_ApplicationCallback(TCP_ConnectionState_t* const ConnectionState,
107 TCP_ConnectionBuffer_t* const Buffer)
109 char* BufferDataStr = (char*)Buffer->Data;
110 static uint8_t PageBlock = 0;
112 /* Check to see if a packet has been received on the HTTP port from a remote host */
113 if (TCP_APP_HAS_RECEIVED_PACKET(Buffer))
115 if (IsHTTPCommand(Buffer->Data, "GET"))
117 if (IsHTTPCommand(Buffer->Data, "GET / "))
121 /* Copy the HTTP 200 response header into the packet buffer */
122 strcpy_P(BufferDataStr, HTTP200Header);
124 /* Send the buffer contents to the host */
125 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
127 /* Lock the buffer to Device->Host transmissions only while we send the page contents */
128 TCP_APP_CAPTURE_BUFFER(Buffer);
132 /* Copy the HTTP 404 response header into the packet buffer */
133 strcpy_P(BufferDataStr, HTTP404Header);
135 /* Send the buffer contents to the host */
136 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
138 /* All data sent, close the connection */
139 TCP_APP_CLOSECONNECTION(ConnectionState);
142 else if (IsHTTPCommand(Buffer->Data, "HEAD"))
144 if (IsHTTPCommand(Buffer->Data, "HEAD / "))
146 /* Copy the HTTP response header into the packet buffer */
147 strcpy_P(BufferDataStr, HTTP200Header);
149 /* Send the buffer contents to the host */
150 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
154 /* Copy the HTTP response header into the packet buffer */
155 strcpy_P(BufferDataStr, HTTP404Header);
157 /* Send the buffer contents to the host */
158 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
161 /* All data sent, close the connection */
162 TCP_APP_CLOSECONNECTION(ConnectionState);
164 else if (IsHTTPCommand(Buffer->Data, "TRACE"))
166 /* Echo the host's query back to the host */
167 TCP_APP_SEND_BUFFER(Buffer, Buffer->Length);
169 /* All data sent, close the connection */
170 TCP_APP_CLOSECONNECTION(ConnectionState);
174 /* Unknown request, just clear the buffer (drop the packet) */
175 TCP_APP_CLEAR_BUFFER(Buffer);
178 else if (TCP_APP_HAVE_CAPTURED_BUFFER(Buffer))
180 uint16_t RemLength = strlen_P(&HTTPPage[PageBlock * HTTP_REPLY_BLOCK_SIZE]);
183 /* Determine the length of the loaded block */
184 Length = ((RemLength > HTTP_REPLY_BLOCK_SIZE) ? HTTP_REPLY_BLOCK_SIZE : RemLength);
186 /* Copy the next buffer sized block of the page to the packet buffer */
187 strncpy_P(BufferDataStr, &HTTPPage[PageBlock * HTTP_REPLY_BLOCK_SIZE], Length);
189 /* Send the buffer contents to the host */
190 TCP_APP_SEND_BUFFER(Buffer, Length);
192 /* Check to see if the entire page has been sent */
193 if (PageBlock++ == (sizeof(HTTPPage) / HTTP_REPLY_BLOCK_SIZE))
195 /* Unlock the buffer so that the host can fill it with future packets */
196 TCP_APP_RELEASE_BUFFER(Buffer);
198 /* Close the connection to the host */
199 TCP_APP_CLOSECONNECTION(ConnectionState);