u-boot/httpd/fs.h

   1 /**
   2  * \addtogroup httpd
   3  * @{
   4  */
   5
   6 /**
   7  * \file
   8  * HTTP server read-only file system header file.
   9  * \author Adam Dunkels <adam@dunkels.com>
  10  */
  11
  12 /*
  13  * Copyright (c) 2001, Swedish Institute of Computer Science.
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  * 3. Neither the name of the Institute nor the names of its contributors
  25  *    may be used to endorse or promote products derived from this software
  26  *    without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  *
  40  * This file is part of the lwIP TCP/IP stack.
  41  *
  42  * Author: Adam Dunkels <adam@sics.se>
  43  *
  44  * $Id: fs.h,v 1.6.2.3 2003/10/07 13:22:27 adam Exp $
  45  */
  46 #ifndef __FS_H__
  47 #define __FS_H__
  48
  49 #include "uip.h"
  50
  51 /**
  52  * An open file in the read-only file system.
  53  */
  54 struct fs_file {
  55   char *data;  /**< The actual file data. */
  56   int len;     /**< The length of the file data. */
  57 };
  58
  59 /**
  60  * Open a file in the read-only file system.
  61  *
  62  * \param name The name of the file.
  63  *
  64  * \param file The file pointer, which must be allocated by caller and
  65  * will be filled in by the function.
  66  */
  67 int fs_open(const char *name, struct fs_file *file);
  68
  69 #ifdef FS_STATISTICS
  70 #if FS_STATISTICS == 1
  71 u16_t fs_count(char *name);
  72 #endif /* FS_STATISTICS */
  73 #endif /* FS_STATISTICS */
  74
  75 /**
  76  * Initialize the read-only file system.
  77  */
  78 void fs_init(void);
  79
  80 #endif /* __FS_H__ */