Porting the ARM Webserver Programmer’s Guide

Version 1.6


Table of Contents

Preface
About this book
Intended audience
Organization
Typographical conventions
Further reading
Feedback
Feedback on the ARM Webserver software
Feedback on this book
1. Introduction
1.1. About the ARM Webserver
1.1.1. Terms
1.2. Demonstration program
2. About the ARM Webserver
2.1. Server architecture
2.1.1. HTTP engine
2.1.2. Virtual File System
2.1.3. Common Gateway Interface
2.1.4. System interfaces
2.2. Embedded data and executable files in the Virtual File System
2.2.1. File compression
2.2.2. Layering VFS on a pre-existing file system
2.3. Users, authentication, and security
2.3.1. Background information
2.3.2. Higher levels of security
2.3.3. Requirements for embedded applications
2.4. System requirements
2.4.1. TCP/IP and sockets
2.4.2. Static memory
2.4.3. Dynamic memory
2.4.4. Clock tick
3. Porting Step-by-Step
3.1. Setting up your source tree
3.1.1. Source and include files
3.1.2. Port files
3.1.3. HTML compression tags table
3.1.4. HTML compiler output
3.2. Start with HTML sources
3.2.1. Index.htm
3.3. HTML Compiler
3.3.1. Building the HTML Compiler
3.3.2. Running the HTML Compiler
3.4. Provide the system routines
3.4.1. Dynamic memory
3.4.2. TCP/IP and sockets
3.4.3. String library
3.4.4. Timer tick routine
3.5. Initialization routine
3.6. User and password lookup routine
3.7. SSI routines
3.7.1. Including other files within a page
3.7.2. Dynamic page content
3.7.3. SSI exec routine
3.7.4. html_exec
3.7.5. SSI include routines
3.7.6. Displaying C variables using #include
3.8. CGI routines
3.8.1. CGI routine inputs
3.8.2. CGI routine return values
3.8.3. Using the HTML Compiler to automatically generate CGI functions
4. Using the HTML Compiler
4.1. About the HTML Compiler
4.2. Usage
4.2.1. Command lines
4.2.2. Input lines
4.3. Sample input file
4.3.1. Code sample
4.3.2. The -a option
4.3.3. The -o option
4.3.4. The -s option
4.3.5. Embedding C variables in a web page (-cvar option)
4.3.6. The -x, -form and -endform options
4.3.7. The setip.cgi option
4.3.8. Generating stub routines
A. Building the Demonstration Program
A.1. Requirements
A.1.1. FPGA product information
A.2. Installation procedure
A.3. Building using ADS for Windows
A.3.1. Build the HTML Compiler
A.3.2. Compile the sample HTML files
A.3.3. Build the Widget application
A.3.4. Run the Widget application
A.4. Building using ADS from the command line
Glossary

List of Figures

2.1. Server components

Proprietary Notice

ARM, the ARM Powered logo, Thumb, and StrongARM are registered trademarks of ARM Limited.

The ARM logo, AMBA, PrimeCell, Angel, ARMulator, EmbeddedICE, ModelGen, MultiICE, ARM7TDMI, ARM7TDMI-S, ARM9TDMI, TDMI, and STRONG are trademarks of ARM Limited.

Portions of source code are provided under the copyright of the respective owners, and are acknowledged in the appropriate source files:

Copyright © 1998-1999 InterNiche Technologies Inc.

Copyright © 1984, 1985, 1986 by the Massachusetts Institute of Technology.Copyright © 1982, 1985, 1986 by the Regents of the University of California. All Rights Reserved. Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission.Copyright © 1988, 1989 by Carnegie Mellon University. All Rights Reserved. Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of CMU not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.

All other products or services mentioned herein may be trademarks of their respective owners.

Neither the whole or any part of the information contained in, or the product described in, this document may be adapted or reproduced in any material form except with prior written permission of the copyright holder. The product described in this document is subject to continuous development and improvements. All particulars of the product and its use contained in this document are given by ARM in good faith. However, all warranties implied or expressed, including but not limited to implied warranties of merchantability, or fitness for purpose, are excluded. This document is intended only to assist the reader in the use of the product. ARM Ltd shall not be liable for any loss or damage arising from the use of any information in this document, or any error or omission in such information, or any incorrect use of the product.

Revision History
Revision AJan 1999First release
Revision BFeb 1999Second release, minor changes
Revision CSept 2000Third release
Revision DJune 2001Fourth release
Copyright © 1999-2001 ARM Limited. All rights reserved.ARM DUI 0075D
Non-Confidential