OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [ecos-3.0/] [packages/] [net/] [athttpd/] [current/] [cdl/] [httpd.cdl] - Blame information for rev 867

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 786 skrzyp
# ====================================================================
2
#
3
#      httpd.cdl
4
#
5
#      HTTP server configuration data
6
#
7
# ====================================================================
8
## ####ECOSGPLCOPYRIGHTBEGIN####
9
## -------------------------------------------
10
## This file is part of eCos, the Embedded Configurable Operating System.
11
## Copyright (C) 2005 Free Software Foundation, Inc.
12
##
13
## eCos is free software; you can redistribute it and/or modify it under
14
## the terms of the GNU General Public License as published by the Free
15
## Software Foundation; either version 2 or (at your option) any later
16
## version.
17
##
18
## eCos is distributed in the hope that it will be useful, but WITHOUT
19
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
## FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
21
## for more details.
22
##
23
## You should have received a copy of the GNU General Public License
24
## along with eCos; if not, write to the Free Software Foundation, Inc.,
25
## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
26
##
27
## As a special exception, if other files instantiate templates or use
28
## macros or inline functions from this file, or you compile this file
29
## and link it with other works to produce a work based on this file,
30
## this file does not by itself cause the resulting work to be covered by
31
## the GNU General Public License. However the source code for this file
32
## must still be made available in accordance with section (3) of the GNU
33
## General Public License v2.
34
##
35
## This exception does not invalidate any other reasons why a work based
36
## on this file might be covered by the GNU General Public License.
37
## -------------------------------------------
38
## ####ECOSGPLCOPYRIGHTEND####
39
# ====================================================================
40
######DESCRIPTIONBEGIN####
41
#
42
# Author(s):      Anthony Tonizzo (atonizzo@gmail.com)
43
# Contributors:   Lars Povlsen    (lpovlsen@vitesse.com)
44
# Date:           2006-06-09
45
#
46
#####DESCRIPTIONEND####
47
#
48
# ====================================================================
49
 
50
cdl_package CYGPKG_ATHTTPD {
51
    display       "Another Tiny HTTP server"
52
    description   "This package provides a small footprint web server for eCos
53
                   with configurable features."
54
    include_dir   cyg/athttpd
55
    include_files auth.h digcalc.h forms.h global.h handler.h http.h md5.h socket.h cgi.h jim.h
56
    compile       forms.c handler.c http.c socket.c cgi.c
57
    requires      CYGPKG_NET
58
    requires      CYGPKG_NET_STACK_INET
59
    requires      !CYGPKG_HTTPD
60
    requires      CYGINT_ISO_STDIO_STREAMS
61
    requires      CYGINT_ISO_STDIO_FILEACCESS
62
    requires      CYGINT_ISO_STDIO_FORMATTED_IO
63
    requires      CYGINT_ISO_STRING_MEMFUNCS
64
    requires      CYGINT_ISO_STRING_STRFUNCS
65
    requires      CYGINT_ISO_STRING_BSD_FUNCS
66
    requires      CYGINT_ISO_C_CLOCK_FUNCS
67
    requires      CYGINT_ISO_MALLOC
68
    requires      CYGINT_ISO_CTYPE
69
 
70
# ====================================================================
71
 
72
    cdl_component CYGPKG_NET_ATHTTPD_THREADOPT {
73
        display "Thread settings"
74
        flavor  none
75
        no_define
76
        description   "Options to change certain thread values."
77
 
78
      cdl_option CYGNUM_NET_ATHTTPD_THREADOPT_PRIORITY {
79
          display "Thread priority"
80
          flavor data
81
          default_value { CYGNUM_KERNEL_SCHED_PRIORITIES/2 }
82
          legal_values 0 to CYGNUM_KERNEL_SCHED_PRIORITIES
83
          description "The HTTP server threads can be run at any
84
                       priority.  The exact priority depends on the
85
                       importance of the server relative to the rest
86
                       of the system. The default is to put it in the
87
                       middle of the priority range to provide
88
                       reasonable response without impacting genuine
89
                       high priority threads."
90
      }
91
 
92
      cdl_option CYGNUM_NET_ATHTTPD_THREADOPT_STACKSIZE {
93
          display "Thread stack size"
94
          flavor data
95
          default_value 4096
96
          description "This is the amount of extra stack to be
97
                       allocated for the HTTPD thread. This value is
98
                       added to CYGNUM_HAL_STACK_SIZE_MINIMUM to
99
                       determine the final size of the stack for the
100
                       server."
101
      }
102
    }
103
 
104
    cdl_component CYGOPT_NET_ATHTTPD_SERVEROPT {
105
        display "Server settings"
106
        flavor  none
107
        no_define
108
        description   "Options to change certain server options."
109
 
110
      cdl_option CYGNUM_NET_ATHTTPD_SERVEROPT_PORT {
111
          display "Server Port"
112
          flavor data
113
          default_value 80
114
          description "This is the port on which the server will be listening
115
                      for requests. Unless overridden in the request by the
116
                      client, the well known port for HTTP is 80."
117
      }
118
 
119
      cdl_option CYGDAT_NET_ATHTTPD_SERVEROPT_SERVERID {
120
          display "Server ID string"
121
          flavor data
122
          default_value {"\"eCos Embedded Web Server\""}
123
          description "This is the string sent out in the 'Server:'
124
                       header line."
125
      }
126
 
127
      cdl_option CYGNUM_ATHTTPD_SERVER_BUFFER_SIZE {
128
          display "IO buffer size"
129
          flavor data
130
          default_value 2048
131
          description "This option defines the size of the buffers used to
132
                       receive and transmit transmit data to and from the
133
                       TCP/IP stack."
134
      }
135
 
136
      cdl_option CYGNUM_ATHTTPD_SERVER_MAX_POST {
137
          display "Maximum data received upon POST"
138
          flavor data
139
          default_value 2048
140
          description "This option defines the size of maximum amount of data
141
                       the web server will accept from POST'ed forms."
142
      }
143
 
144
      cdl_option CYGDAT_NET_ATHTTPD_SERVEROPT_ROOTDIR {
145
          display "HTTPD root directory"
146
          flavor data
147
          default_value {"\"/\""}
148
          description "This is the absolute path in the eCos file
149
                       system to the HTML documents, including cgi-bin
150
                       files and error files and it is generally where
151
                       the web server will look for the index
152
                       file. Include a trailing slash."
153
      }
154
 
155
      cdl_option CYGDAT_NET_ATHTTPD_SERVEROPT_CGIDIR {
156
          display "cgi-bin directory"
157
          active_if    { 0 != CYGOPT_NET_ATHTTPD_USE_CGIBIN_OBJLOADER ||
158
 
159
          flavor data
160
          default_value {"\"cgi-bin/\""}
161
          description "This is the path, relative to
162
                       CYGDAT_NET_ATHTTPD_SERVEROPT_ROOTDIR, where the
163
                       cgi-bin files are stored. Based on the
164
                       extension of the cgi-bin file requested, the
165
                       appropriate interpreter will be used. Include a
166
                       trailing slash."
167
      }
168
 
169
      cdl_option CYGDAT_NET_ATHTTPD_SERVEROPT_ERRORDIR {
170
          display "Error files directory"
171
          flavor data
172
          default_value {"\"errors/\""}
173
          description "This is the path, relative to the
174
                       CYGDAT_NET_ATHTTPD_SERVEROPT_ROOTDIR, that
175
                       contains the user-defined files that are sent
176
                       out by the server in case of error. The files
177
                       are named error_XXX.html where XXX is the 3
178
                       digit HTML code.  For example, for a 404 error
179
                       the server file will be named
180
                       error_404.html. Upon a 404 error, the server
181
                       will check the existence of such a file in this
182
                       directory and if found, it will send it
183
                       out. Missing that file, a standard simple
184
                       message will be sent instead. Include a
185
                       trailing slash."
186
      }
187
 
188
      cdl_option CYGDAT_NET_ATHTTPD_DEFAULT_MIME_TYPE {
189
          display "Default MIME type"
190
          flavor data
191
          default_value {"\"text/plain\""}
192
          description "When accessing internal resources or a file
193
                       system, the MIME type is determined by first
194
                       finding the extension of the file itself and
195
                       then by looking up the extension in the MIME
196
                       table. In case no extension is found the user
197
                       can define the default MIME type to use. Notice
198
                       that this is the full MIME type and not the
199
                       extension.  A list of standard MIME types
200
                       sorted by extension can be found in the
201
                       current/doc directory"
202
      }
203
 
204
      cdl_option CYGDAT_NET_ATHTTPD_ALTERNATE_HOME {
205
          display "User defined Home Page"
206
          flavor booldata
207
          default_value {"\"/index.html\""}
208
          description "This file name defines the name of a custom index file
209
                       and is used in case none of the default index files are
210
                       found in a directory. Notice that this file name is
211
                       only appended to GET requests for \"/\""
212
      }
213
    }
214
 
215
    cdl_option CYGOPT_NET_ATHTTPD_USE_FS {
216
        display       "Support for file system access"
217
        flavor        bool
218
        default_value 1
219
        active_if     CYGPKG_IO_FILEIO
220
        description   "
221
            This option enables the use of a file system to access the pages
222
             to be served. It is the responsibility of the user to properly
223
             mount the file system(s) required by the web server. If this
224
             option is not selected each URL requested must be serviced using
225
             either c language callbacks or internal resources."
226
    }
227
 
228
    cdl_option CYGOPT_NET_ATHTTPD_USE_AUTH {
229
        display       "Support for basic and digest authentication"
230
        flavor        bool
231
        default_value 0
232
        description   "
233
            This option enables the use basic authentication in web pages.
234
            Not all clients have been tested."
235
       compile md5c.c
236
       compile auth.c
237
    }
238
 
239
    cdl_option CYGOPT_NET_ATHTTPD_CLOSE_CHUNKED_CONNECTIONS {
240
        display       "Close connections used for chunked transfers"
241
        flavor        bool
242
        default_value 1
243
        description   "
244
            This option causes connections used for chunked transfer
245
            to be closed after use. Persisting the connection will use
246
            less network resources and will improve latency, but may
247
            do so at the risk of compatibility with older browsers."
248
    }
249
 
250
    cdl_option CYGOPT_NET_ATHTTPD_DOCUMENT_EXPIRATION_TIME {
251
        display          "Maximum lifetime of a document in seconds"
252
        flavor           data
253
        default_value    0
254
        description      "
255
            This options causes documents to 'expire' after a set number
256
            of seconds. If certain pages are updated frequently, it might be a
257
            good idea to assign them an expitation time in seconds. If the
258
            client needs to reload a page that has expired, it will request
259
            it again, otherwise it will use the copy in the cache. A value
260
            of 0 means that this option is disabled. Any other value
261
            represents the number of seconds (after the last modification to
262
            the document) after which the page becomes stale. This option
263
            applies to all the pages (including those that reside in ROM
264
            and thus, by definition, won't change) and thus is it preferable
265
            to use the CYG_HTTPD_MODE_NO_CACHE mode for pages that need to be
266
            refreshed frequently."
267
    }
268
 
269
    cdl_option CYGOPT_NET_ATHTTPD_USE_DIRLIST {
270
        display       "Support for directory listing"
271
        flavor        bool
272
        default_value 0
273
        active_if     CYGPKG_IO_FILEIO
274
        active_if     CYGOPT_NET_ATHTTPD_USE_FS
275
        description   "
276
            When a client issues a request that ends in '/' the server will
277
            try to locate anyone of a number of index files. Failing to find
278
            one, it will list the directory contents."
279
    }
280
 
281
    cdl_component CYGOPT_NET_ATHTTPD_CGIBIN {
282
        display "Supported CGI Types"
283
        flavor  none
284
        no_define
285
        description   "Options to select which CGI types are supported."
286
 
287
      cdl_option CYGOPT_NET_ATHTTPD_USE_CGIBIN_OBJLOADER {
288
          display       "Support cgi via the OBJLOADER package"
289
          flavor        bool
290
          default_value 0
291
          active_if     CYGPKG_OBJLOADER
292
          description   "This option enables the use of the object loader
293
                         package as a means of providing on-demand loading and
294
                         execution of code, thus providing a simple cgi
295
                         capability that does not involve scripting."
296
      }
297
 
298
      cdl_option CYGOPT_NET_ATHTTPD_USE_CGIBIN_TCL {
299
          display       "Support cgi via the a simple tcl interpreter (jim)"
300
          flavor        bool
301
          default_value 0
302
          description   "This option enables the use of a small tcl
303
                         interpreter as a means of providing a simple cgi
304
                         capability. Checking this option increases
305
                         considerably the size of the executable."
306
          compile       jim.c jim-aio.c
307
          define        JIM_ANSIC
308
          define        JIM_STATICEXT
309
      }
310
    }
311
 
312
    cdl_option CYGOPT_NET_ATHTTPD_DEBUG_LEVEL {
313
        display          "Verbosity of debug output"
314
        flavor           data
315
        legal_values     0 1 2
316
        default_value    0
317
        description      "This option allows controls over the verbosity of
318
                         the debug output. 1 mostly reports opening and
319
                         closing of socket descriptors, 2 is very
320
                         verbose, including the name of all files sent
321
                         out, including internal resources."
322
    }
323
    cdl_component CYGPKG_ATHTTPD_OPTIONS {
324
        display "AT HTTP server build options"
325
        flavor  none
326
        no_define
327
 
328
        cdl_option CYGPKG_ATHTTPD_CFLAGS_ADD {
329
            display "Additional compiler flags"
330
            flavor  data
331
            no_define
332
            default_value { "-D__ECOS" }
333
            description   "
334
                This option modifies the set of compiler flags for
335
                building the HTTP server package.
336
                These flags are used in addition
337
                to the set of global flags."
338
        }
339
 
340
        cdl_option CYGPKG_ATHTTPD_CFLAGS_REMOVE {
341
            display "Suppressed compiler flags"
342
            flavor  data
343
            no_define
344
            default_value { "" }
345
            description   "
346
                This option modifies the set of compiler flags for
347
                building the HTTP server package. These flags are removed from
348
                the set of global flags if present."
349
        }
350
    }
351
}
352
 
353
# ====================================================================
354
# EOF httpd.cdl

powered by: WebSVN 2.1.0

© copyright 1999-2025 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.