Add comments.bertos/net/http.c
[bertos.git] / boards / sam3x-ek / examples / sam3x-ek_http_server / main.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2011 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \author Andrea Righi <arighi@develer.com>
34  * \author Daniele Basile <asterix@develer.com>
35  *
36  * \brief Simple Http server.
37  *
38  * This simple web server read the site's pages from SD card, and manage
39  * the cases where SD is not present or page not found, using embedded pages.
40  * Quering from browser some cgi page, the server return a json dictionary.
41  */
42
43
44 #include "hw/hw_http.h"
45 #include "hw/hw_sd.h"
46 #include "hw/hw_adc.h"
47 #include "hw/hw_sdram.h"
48
49 // Define logging setting (for cfg/log.h module).
50 #define LOG_LEVEL         3
51 #define LOG_VERBOSITY     0
52 #include <cfg/log.h>
53 #include <cfg/debug.h>
54
55 #include <cpu/irq.h>
56 #include <cpu/power.h>
57
58 #include <drv/timer.h>
59 #include <drv/ser.h>
60 #include <drv/sd.h>
61 #include <drv/dmac_sam3.h>
62 #include <drv/adc.h>
63
64 #include <kern/proc.h>
65 #include <kern/monitor.h>
66
67 #include <net/http.h>
68
69 #include <netif/ethernetif.h>
70
71 #include <lwip/ip.h>
72 #include <lwip/ip_addr.h>
73 #include <lwip/netif.h>
74 #include <lwip/tcpip.h>
75 #include <lwip/dhcp.h>
76
77 #include <fs/fat.h>
78
79 #include <icons/bertos.h>
80
81 #include <stdio.h>
82 #include <string.h>
83
84 /* Network interface global variables */
85 static struct ip_addr ipaddr, netmask, gw;
86 static struct netif netif;
87
88 typedef struct BoardStatus
89 {
90         char local_ip[sizeof("123.123.123.123")];
91         char last_connected_ip[sizeof("123.123.123.123")];
92         uint16_t internal_temp;
93         ticks_t up_time;
94         size_t tot_req;
95 } BoardStatus;
96
97 static BoardStatus status;
98
99
100 static void init(void)
101 {
102         /* Enable all the interrupts */
103         IRQ_ENABLE;
104
105         /* Initialize debugging module (allow kprintf(), etc.) */
106         kdbg_init();
107         /* Initialize system timer */
108         timer_init();
109
110         /*
111          * Kernel initialization: processes (allow to create and dispatch
112          * processes using proc_new()).
113          */
114         proc_init();
115         sdram_init();
116
117         /* Initialize TCP/IP stack */
118         tcpip_init(NULL, NULL);
119
120         /* Bring up the network interface */
121         netif_add(&netif, &ipaddr, &netmask, &gw, NULL, ethernetif_init, tcpip_input);
122         netif_set_default(&netif);
123         netif_set_up(&netif);
124
125         dmac_init();
126
127         adc_init();
128         /* Enable the adc to read internal temperature sensor */
129         hw_enableTempRead();
130 }
131
132 static NORETURN void status_process(void)
133 {
134         while (1)
135         {
136                 status.internal_temp = hw_convertToDegree(adc_read(ADC_TEMPERATURE_CH));
137                 status.up_time++;
138                 timer_delay(1000);
139         }
140 }
141
142 /* Macro to unpack the ip addres from lwip format */
143 #define IP_ADDR_TO_INT_TUPLE(addr) \
144                 (int)((addr) >>  0 & 0xff), \
145                 (int)((addr) >>  8 & 0xff), \
146                 (int)((addr) >> 16 & 0xff), \
147                 (int)((addr) >> 24 & 0xff)
148
149
150 static uint8_t tx_buf[2048];
151
152 /*
153  * Return a JSON string of board status.
154  */
155 static int cgi_status(struct netconn *client, const char *name, char *revc_buf, size_t revc_len)
156 {
157         (void)revc_buf;
158         (void)revc_len;
159         (void)name;
160
161         //Update board status.
162         sprintf(status.last_connected_ip, "%d.%d.%d.%d", IP_ADDR_TO_INT_TUPLE(client->pcb.ip->remote_ip.addr));
163         sprintf(status.local_ip, "%d.%d.%d.%d", IP_ADDR_TO_INT_TUPLE(client->pcb.ip->local_ip.addr));
164         sprintf((char *)tx_buf, "[ %s, %s, %d.%d, %ld, %d ]", status.local_ip, status.last_connected_ip,
165                                                                                                                         status.internal_temp / 10, status.internal_temp % 10,
166                                                                                                                         status.up_time, status.tot_req);
167
168         status.tot_req++;
169
170         http_sendOk(client);
171         netconn_write(client, tx_buf, strlen((char *)tx_buf), NETCONN_COPY);
172         return 0;
173 }
174
175 static int cgi_logo(struct netconn *client, const char *name, char *revc_buf, size_t revc_len)
176 {
177         (void)revc_buf;
178         (void)revc_len;
179         (void)name;
180
181         http_sendOk(client);
182         netconn_write(client, bertos_logo_jpg, bertos_logo_jpg_len, NETCONN_NOCOPY);
183         return 0;
184 }
185
186 /*
187  * Return the internal micro temperature string.
188  */
189 static int cgi_temp(struct netconn *client, const char *name, char *revc_buf, size_t revc_len)
190 {
191         (void)revc_buf;
192         (void)revc_len;
193         (void)name;
194
195         sprintf((char *)tx_buf, "[ %d.%d ]", status.internal_temp / 10, status.internal_temp % 10);
196
197         http_sendOk(client);
198         netconn_write(client, tx_buf, strlen((char *)tx_buf), NETCONN_COPY);
199         return 0;
200 }
201
202 /*
203  * Reply to client the request string.
204  */
205 static int cgi_echo(struct netconn *client, const char *name, char *revc_buf, size_t revc_len)
206 {
207         (void)name;
208
209         http_sendOk(client);
210         netconn_write(client, revc_buf, revc_len, NETCONN_COPY);
211         return 0;
212 }
213
214
215 /*
216  * Default function that http server call every client request, if it doesn't match a cgi table.
217  * In this implementation all client request are associate to real file stored on FAT file
218  * sistem on SD card. If the file there is not on SD card the server reply to client the
219  * error File not found, and send an harcoded page. In the same way, the server reply
220  * error page if the SD card is not present.
221  *
222  */
223 static int http_htmPageLoad(struct netconn *client, const char *name, char *revc_buf, size_t revc_len)
224 {
225         (void)revc_buf;
226         (void)revc_len;
227
228         if (SD_CARD_PRESENT())
229         {
230
231                 // SD fat filesystem context
232                 Sd sd;
233                 FATFS fs;
234                 FatFile in_file;
235                 FRESULT result;
236
237                 bool sd_ok = sd_init(&sd, NULL, 0);
238                 if (sd_ok)
239                 {
240                         LOG_INFO("Mount FAT filesystem.\n");
241                         result = f_mount(0, &fs);
242                         if (result != FR_OK)
243                         {
244                                 LOG_ERR("Mounting FAT volumes error[%d]\n", result);
245                                 sd_ok = false;
246                                 f_mount(0, NULL);
247                         }
248
249                         if (sd_ok)
250                         {
251                                 result = fatfile_open(&in_file, name,  FA_OPEN_EXISTING | FA_READ);
252
253                                 size_t count = 0;
254                                 if (result == FR_OK)
255                                 {
256                                         LOG_INFO("Opened file '%s' size %ld\n", name, in_file.fat_file.fsize);
257
258                                         http_sendOk(client);
259
260                                         while (count < in_file.fat_file.fsize)
261                                         {
262                                                 int len = kfile_read(&in_file.fd, tx_buf, sizeof(tx_buf));
263                                                 netconn_write(client, tx_buf, len, NETCONN_COPY);
264                                                 count += len;
265                                         }
266
267                                         kfile_flush(&in_file.fd);
268                                         kfile_close(&in_file.fd);
269
270                                         LOG_INFO("Sent: %d\n", count);
271                                 }
272                                 else
273                                 {
274                                         LOG_ERR("Unable to open file: '%s' error[%d]\n",  name, result);
275                                         http_sendFileNotFound(client);
276                                         netconn_write(client, http_file_not_found, http_file_not_found_len - 1, NETCONN_NOCOPY);
277                                 }
278                         }
279                 }
280                 f_mount(0, NULL);
281                 LOG_INFO("Umount FAT filesystem.\n");
282         }
283         else
284         {
285                 http_sendFileNotFound(client);
286                 netconn_write(client, http_sd_not_present, http_sd_not_present_len, NETCONN_NOCOPY);
287         }
288
289         return 0;
290 }
291
292 /*
293  * Return to client a string that display the CHIP ID information.
294  * See datasheet for more detail.
295  */
296 static int cgi_chipInfo(struct netconn *client, const char *name, char *revc_buf, size_t revc_len)
297 {
298         (void)revc_buf;
299         (void)revc_len;
300         (void)name;
301
302         sprintf((char *)tx_buf, "[ %s, %s, %s, %s, %s ]",
303         chipid_eproc_name(CHIPID_EPRCOC()),
304         chipid_archnames(CHIPID_ARCH()),
305         chipid_sramsize(CHIPID_SRAMSIZ()),
306         chipid_nvpsize(CHIPID_NVPSIZ()),
307         chipid_nvptype(CHIPID_NVTYP()));
308
309         http_sendOk(client);
310         netconn_write(client, tx_buf, strlen((char *)tx_buf), NETCONN_COPY);
311
312         return 0;
313 }
314
315 static int cgi_error(struct netconn *client, const char *name, char *revc_buf, size_t revc_len)
316 {
317         (void)revc_buf;
318         (void)revc_len;
319         (void)name;
320         (void)client;
321
322         return -1;
323 }
324
325 /*
326  * Static cgi table where we associate callback to page.
327  */
328 static HttpCGI cgi_table[] =
329 {
330         { CGI_MATCH_NAME, "echo",                cgi_echo          },
331         { CGI_MATCH_NAME, "temp",                cgi_temp          },
332         { CGI_MATCH_NAME, "status",              cgi_status        },
333         { CGI_MATCH_NAME, "chipinfo",            cgi_chipInfo      },
334         { CGI_MATCH_NAME, "error_test",          cgi_error         },
335         { CGI_MATCH_NAME, "bertos_logo_jpg",     cgi_logo          },
336         { CGI_MATCH_NONE,  NULL,                 NULL              }
337 };
338
339
340 int main(void)
341 {
342         struct netconn *server;
343
344         /* Hardware initialization */
345         init();
346         http_init(http_htmPageLoad, cgi_table);
347
348         proc_new(status_process, NULL, KERN_MINSTACKSIZE * 2, NULL);
349
350         dhcp_start(&netif);
351         while (!netif.ip_addr.addr)
352                 timer_delay(DHCP_FINE_TIMER_MSECS);
353         kprintf("dhcp ok: ip = %d.%d.%d.%d\n", IP_ADDR_TO_INT_TUPLE(netif.ip_addr.addr));
354
355         server = netconn_new(NETCONN_TCP);
356         netconn_bind(server, IP_ADDR_ANY, 80);
357         netconn_listen(server);
358
359         while (1)
360         {
361                 http_poll(server);
362         }
363 }