git.sur5r.net Git - freertos/blob

   1 /*
   2  * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without modification,
   6  * are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25  * OF SUCH DAMAGE.
  26  *
  27  * This file is part of the lwIP TCP/IP stack.
  28  *
  29  * Author: Adam Dunkels <adam@sics.se>
  30  *
  31  */
  32 #ifndef __FS_H__
  33 #define __FS_H__
  34
  35 #include "lwip/opt.h"
  36
  37 /** Set this to 1 and provide the functions:
  38  * - "int fs_open_custom(struct fs_file *file, const char *name)"
  39  *    Called first for every opened file to allow opening files
  40  *    that are not included in fsdata(_custom).c
  41  * - "void fs_close_custom(struct fs_file *file)"
  42  *    Called to free resources allocated by fs_open_custom().
  43  */
  44 #ifndef LWIP_HTTPD_CUSTOM_FILES
  45 #define LWIP_HTTPD_CUSTOM_FILES       0
  46 #endif
  47
  48 /** Set this to 1 to include an application state argument per file
  49  * that is opened. This allows to keep a state per connection/file.
  50  */
  51 #ifndef LWIP_HTTPD_FILE_STATE
  52 #define LWIP_HTTPD_FILE_STATE         0
  53 #endif
  54
  55 /** HTTPD_PRECALCULATED_CHECKSUM==1: include precompiled checksums for
  56  * predefined (MSS-sized) chunks of the files to prevent having to calculate
  57  * the checksums at runtime. */
  58 #ifndef HTTPD_PRECALCULATED_CHECKSUM
  59 #define HTTPD_PRECALCULATED_CHECKSUM  0
  60 #endif
  61
  62 #if HTTPD_PRECALCULATED_CHECKSUM
  63 struct fsdata_chksum {
  64   u32_t offset;
  65   u16_t chksum;
  66   u16_t len;
  67 };
  68 #endif /* HTTPD_PRECALCULATED_CHECKSUM */
  69
  70 struct fs_file {
  71   const char *data;
  72   int len;
  73   int index;
  74   void *pextension;
  75 #if HTTPD_PRECALCULATED_CHECKSUM
  76   const struct fsdata_chksum *chksum;
  77   u16_t chksum_count;
  78 #endif /* HTTPD_PRECALCULATED_CHECKSUM */
  79   u8_t http_header_included;
  80 #if LWIP_HTTPD_CUSTOM_FILES
  81   u8_t is_custom_file;
  82 #endif /* LWIP_HTTPD_CUSTOM_FILES */
  83 #if LWIP_HTTPD_FILE_STATE
  84   void *state;
  85 #endif /* LWIP_HTTPD_FILE_STATE */
  86 };
  87
  88 struct fs_file *fs_open(const char *name);
  89 void fs_close(struct fs_file *file);
  90 int fs_read(struct fs_file *file, char *buffer, int count);
  91 int fs_bytes_left(struct fs_file *file);
  92
  93 #if LWIP_HTTPD_FILE_STATE
  94 /** This user-defined function is called when a file is opened. */
  95 void *fs_state_init(struct fs_file *file, const char *name);
  96 /** This user-defined function is called when a file is closed. */
  97 void fs_state_free(struct fs_file *file, void *state);
  98 #endif /* #if LWIP_HTTPD_FILE_STATE */
  99
 100 #endif /* __FS_H__ */