Use Manual Embosip

embOS/IP
CPU independent TCP/IP stack for embedded applications
User Guide
Software version 1.62 Document: UM07001 Revision: 0

Date: August 10, 2010
A product of SEGGER Microcontroller GmbH & Co. KG
www.segger.com
Disclaimer
Specifications written in this document are believed to be accurate, but are not guaranteed to be entirely free of error. The information in this manual is subject to change for functional or performance improvements without notice. Please make sure your manual is the latest edition. While the information herein is assumed to be accurate, SEGGER Microcontroller GmbH & Co. KG (the manufacturer) assumes no responsibility for any errors or omissions. The manufacturer makes and you receive no warranties or conditions, express, implied, statutory or in any communication with you. The manufacturer specifically disclaims any implied warranty of merchantability or fitness for a particular purpose.
Copyright notice
You may not extract portions of this manual or modify the PDF file in any way without the prior written permission of the manufacturer. The software described in this document is furnished under a license and may only be used or copied in accordance with the terms of such a license.
2007 - 2010 SEGGER Microcontroller GmbH & Co. KG, Hilden / Germany
Additional copyrights: Portions Copyright 2007 InterNiche Technologies Inc.
Trademarks
Names mentioned in this manual may be trademarks of their respective companies. Brand and product names are trademarks or registered trademarks of their respective holders.
Contact address
SEGGER Microcontroller GmbH & Co. KG In den Weiden 11 D-40721 Hilden Germany Tel.+49 2103-2878-0 Fax.+49 2103-2878-28 Email: support@segger.com Internet: http://www.segger.com
UM07001 - embOS/IP User Guide
2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
Manual versions
This manual describes the latest software version. If any error occurs, please inform us and we will try to assist you as soon as possible. For further information on topics or routines not yet specified, please contact us. SW version / Manual revision
1.60/00
Date
By
Explanation
Chapter "API functions" updated. * "IP_SetSupportedDuplexModes()" added. Chapter "FTP client" added. Minor updates and corrections. Chapter "SMTP client" updated. Chapter "Configuration" updated. * Section "Required buffers" updated. Minor updates and corrections. Chapter "API functions" updated. * "IP_DNSC_SetMaxTLL()" added. Chapter "Configuring embOS/IP" updated. * Macro "IP_TCP_ACCEPT_CHECKSUM_FFFF" added. Chapter "Web server (Add-on)" updated. * "IP_WEBS_Process()" updated. * "IP_WEBS_ProcessLast()" added. * "IP_WEBS_OnConnectionLimit()" updated. Chapter "API functions" updated. * IP_GetAddrMask() updated. * IP_GetGWMask() updated. * IP_GetIPMask() updated. Chapter "Web server (Add-on)" updated. * Section "Changing the file system type" added. * Section "IP_WEBS_SetFileInfoCallback" updated. Chapter "Web server (Add-on)" updated. * IP_WEBS_GetNumParas() added. * IP_WEBS_GetParaValue() added. * IP_WEBS_DecodeAndCopyStr() added. * IP_WEBS_DecodeString() added. * IP_WEBS_SetFileInfoCallback() added. * IP_WEBS_CompareFilenameExt() added. * Section "Dynamic content" added * Section "Common Gateway interface" moved into section "Dynamic content". Chapter "Socket interface" * getpeername() corrected. Chapter "Network interface drivers" updated. Chapter "UDP zero-copy" updated. Chapter "SMTP client" added. Chapter "API functions": * IP_SetTxBufferSize() added. * IP_GetIPAddr() updated. * IP_PrintIPAddr() updated. Chapter "API functions": * IP_ICMP_SetRxHook() added. * IP_SetRxHook() added. * IP_SOCKET_SetDefaultOptions() added. * IP_SOCKET_SetLimit() added. Chapter "Web server (Add-on)": * List of valid values for CGI parameter and values added. Chapter "FTP Server (Add-on)": * Section "FTP server system time" added. * pfGetTimeDate() added. Chapter "API functions": * IP_TCP_SetConnKeepaliveOpt() added. * IP_TCP_SetRetransDelayRange() added. * IP_SendPacket() added. Chapter "Socket interface": * getsockopt() updated. * setsockopt() updated. Chapter "OS integration": * IP_OS_WaitItemTimed() added.
100324
SK
1.58/00
100204
SK
1.56/00
090710
SK
1.54b/00
090603
SK
1.54a/01
090520
SK
1.54a/00
090508
SK
1.54/00 1.52/01 1.52/00
090504 090402 090223
SK SK SK
1.50/00
081210
SK
1.42/00
080821
SK
1.40/00
080731
SK
SW version / Manual revision

1.30/01 1.30/00 1.24/03 1.24/02
Date
080610 080423 080320 080222
By
SK SK SK SK
Explanation
Chapter "FTP server (Add-on)" section "Resource usage" added Chapter "Web server (Add-on)" section "Resource usage" added Chapter "FTP server (Add-on)" added. Chapter "Web server (Add-on)" updated. Chapter "Socket interface": * getpeername added. * getsockname added. Chapter "Device Driver": * NXP LPC23xx/24xx driver added. Chapter "HTTP server (Add-on)" updated. Chapter "API functions": * IP_UTIL_EncodeBase64() added. * IP_UTIL_DecodeBase64() added. Chapter "HTTP server (Add-on)" added: Chapter "API functions": * IP_AllowBackPressure() added. * IP_GetIPAddr() added. * IP_SendPing() added. * IP_SetDefaultTTL() added. Chapter "Introduction": * Section "Components of an Ethernet system" added. Chapter "API functions": * IP_IsIFaceReady() added. * IP_NI_ConfigPHYAddr() added. * IP_NI_ConfigPHYMode() added. * IP_NI_ConfigBasePtr () added. Chapter "Socket interface": * All functions: parameter description enhanced. Chapter "Device drivers" renamed to "Network interface drivers". Chapter "Network interface drivers": * Section "ATMEL AT91SAM7X" added. * Section "ATMEL AT91SAM9260"added. * Section "Davicom DM9000"added. * Section "ST STR912"added. Chapter "OS Integration": * IP_OS_Sleep() removed. * IP_OS_Wakeup() removed. * IP_OS_WaitItem added. * IP_OS_SignalItem added. Chapter "Running embOS/IP on target hardware" updated. Chapter "Socket interface": * gethostbyname() added. * Structure hostent added. Chapter "Core functions": * IP_PrintIPAddr() added. * IP_DNS_SetServer() added. Chapter "DHCP": * IP_DHCPC_Activate() updated. Chapter "Debugging": * Section "Testing stability" added. Chapter "Socket interface": * Section "Error codes" added.
1.24/01
080124
SK
1.24/00
080124
SK
1.22/04
071213
SK
1.22/03
071126
SK
1.22/02
071123
SK
1.22/01
071122
SK
SW version / Manual revision
Date
By
Explanation
Chapter "Introduction": * "Request for comments" enhanced. Chapter "API functions": * IP_AddLogFilter() added. * IP_AddWarnFilter() added. * IP_GetCurrentLinkSpeed() added. * IP_TCP_Set2MSLDelay() added. * select() added. Various function descriptions enhanced. Chapter "API functions" renamed to "core functions". Socket functions removed from chapter "API functions" Chapter "Socket interface" added. Chapter "DHCP" added. Chapter "UDP zero copy" added. Chapter "TCP zero copy" added. Chapter "Glossary" added. Chapter "Index" updated. Chapter "Introduction": * Section "Features" enhanced. * Section "Basic concepts" added. * Section "Task and interrupt usage" added. * Section "Further readings" added. Chapter "Running embOS/IP" enhanced. Chapter "API functions": * IP_Init() added. * IP_Task() added. * IP_RxTask() added. * IP_GetVersion() added. * IP_SetLogFilter() added. * IP_SetWarnFilter() added. * IP_Panic() removed. * Structure sockaddr added. * Structure sockaddr_in added. * Structure in_addr added. Chapter "Device driver". * General information updated. * Section "Writing your own driver" added. Chapter "Debugging" added. Chapter "Performance and resource usage" added. Chapter "OS integration" updated. Product name changed to "embOS/IP": Chapter "API functions": * IP_X_Prepare() renamed to IP_X_Config(). * IP_AddBuffers() added. * IP_ConfTCPSpace() added. Initial version.
1.22/00
071114
SK
1.00/02
071017
SK
1.00/01
071002
SK
1.00/00
070927
SK
Software versions
Refers to Release.html for information about the changes of the software versions.
About this document

Assumptions
This document assumes that you already have a solid knowledge of the following: The software tools used for building your application (assembler, linker, C compiler) The C programming language The target processor DOS command line.
If you feel that your knowledge of C is not sufficient, we recommend The C Programming Language by Kernighan and Richie (ISBN 0-13-1103628), which describes the standard in C-programming and, in newer editions, also covers the ANSI C standard.
How to use this manual

This manual explains all the functions and macros that embOS/IP offers. It assumes you have a working knowledge of the C language. Knowledge of assembly programming is not required.
Typographic conventions for syntax

This manual uses the following typographic conventions: Style Body Keyword Parameter
Sample Sample comment
Used for Body text. Text that you enter at the command-prompt or that appears on the display (that is system functions, file- or pathnames). Parameters in API functions. Sample code in program examples. Comments in program examples. Reference to chapters, sections, tables and figures or other documents. Buttons, dialog boxes, menu names, menu commands. Very important sections
Reference GUIElement Emphasis
Table 1.1: Typographic conventions
SEGGER Microcontroller GmbH & Co. KG develops and distributes software development tools and ANSI C software components (middleware) for embedded systems in several industries such as telecom, medical technology, consumer electronics, automotive industry and industrial automation. SEGGERs intention is to cut software developmenttime for embedded applications by offering compact flexible and easy to use middleware, allowing developers to concentrate on their application. Our most popular products are emWin, a universal graphic software package for embedded applications, and embOS, a small yet efficient real-time kernel. emWin, written entirely in ANSI C, can easily be used on any CPU and most any display. It is complemented by the available PC tools: Bitmap Converter, Font Converter, Simulator and Viewer. embOS supports most 8/16/32-bit CPUs. Its small memory footprint makes it suitable for single-chip applications. Apart from its main focus on software tools, SEGGER develops and produces programming tools for flash microcontrollers, as well as J-Link, a JTAG emulator to assist in development, debugging and production, which has rapidly become the industry standard for debug access to ARM cores.
Corporate Office: http://www.segger.com
United States Office: http://www.segger-us.com
EMBEDDED SOFTWARE (Middleware)

emWin
Graphics software and GUI emWin is designed to provide an efficient, processor- and display controller-independent graphical user interface (GUI) for any application that operates with a graphical display. Starterkits, eval- and trial-versions are available.
SEGGER TOOLS
Flasher
Flash programmer Flash Programming tool primarily for microcontrollers.
J-Link
JTAG emulator for ARM cores USB driven JTAG interface for ARM cores.
embOS
Real Time Operating System embOS is an RTOS designed to offer the benefits of a complete multitasking system for hard real time applications with minimal resources. The profiling PC tool embOSView is included.
J-Trace
JTAG emulator with trace USB driven JTAG interface for ARM cores with Trace memory. supporting the ARM ETM (Embedded Trace Macrocell).
J-Link / J-Trace Related Software

Add-on software to be used with SEGGERs industry standard JTAG emulator, this includes flash programming software and flash breakpoints.
emFile
File system emFile is an embedded file system with FAT12, FAT16 and FAT32 support. emFile has been optimized for minimum memory consumption in RAM and ROM while maintaining high speed. Various Device drivers, e.g. for NAND and NOR flashes, SD/MMC and CompactFlash cards, are available.
USB-Stack
USB device stack A USB stack designed to work on any embedded system with a USB client controller. Bulk communication and most standard device classes are supported.
Table of Contents
1 Introduction to embOS/IP...............................................................................................13
1.1 1.2 1.3 1.3.1 1.3.2 1.4 1.5 1.5.1 1.6 1.6.1 1.6.2 1.7 What is embOS/IP ................................................................................... 14 Features................................................................................................. 14 Basic concepts ........................................................................................ 15 embOS/IP structure ................................................................................. 15 Encapsulation.......................................................................................... 16 Tasks and interrupt usage......................................................................... 17 Background information ........................................................................... 20 Components of an Ethernet system ............................................................ 20 Further reading ....................................................................................... 23 Request for Comments (RFC) .................................................................... 23 Related books ......................................................................................... 24 Development environment (compiler)......................................................... 25
2 Running embOS/IP on target hardware.........................................................................27

2.1 2.2 2.3 Step 1: Open an embOS start project......................................................... 29 Step 2: Adding embOS/IP to the start project.............................................. 30 Step 3: Build the project and test it ........................................................... 32
3 Example applications .....................................................................................................33

3.1 3.1.1 3.1.2 3.1.3 3.1.4 3.1.5 3.1.6 3.1.7 3.1.8 3.1.9 37 Overview ................................................................................................ 34 embOS/IP DNS client (OS_IP_DNSClient.c) ................................................. 35 embOS/IP non-blocking connect (OS_IP_NonBlockingConnect.c).................... 35 embOS/IP ping (OS_IP_Ping.c).................................................................. 35 embOS/IP shell (OS_IP_Shell.c) ................................................................ 35 embOS/IP simple server (OS_IP_SimpleServer.c) ........................................ 36 embOS/IP speed client (OS_IP_SpeedClient_TCP.c) ..................................... 36 embOS/IP speed client (OS_IP_SpeedClient_UDP.c) ..................................... 37 embOS/IP start (OS_IP_Start.c) ................................................................ 37 embOS/IP UDP discover (OS_IP_UDPDiscover.c / OS_IP_UDPDiscoverZeroCopy.c)
4 Core functions................................................................................................................39
4.1 4.2 4.3 4.4 4.5 API functions .......................................................................................... 40 Configuration functions............................................................................. 42 Management functions ............................................................................. 63 Other IP stack functions ........................................................................... 67 Stack internal functions, variables and data-structures ................................. 80
5 Socket interface .............................................................................................................81

5.1 5.2 5.3 API functions .......................................................................................... 82 Socket data structures ........................................................................... 107 Error codes ........................................................................................... 111
6 TCP zero-copy interface ..............................................................................................113

6.1 6.1.1 6.1.2 6.2 TCP zero-copy ....................................................................................... 114 Allocating, freeing and sending packet buffers ........................................... 114 Callback function ................................................................................... 114 Sending data with the TCP zero-copy API.................................................. 115
10
6.2.1 6.2.2 6.2.3 6.3 6.3.1 6.3.2 6.4
Allocating a packet buffer ........................................................................115 Filling the allocated buffer with data .........................................................115 Sending the packet.................................................................................115 Receiving data with the TCP zero-copy API ................................................116 Writing a callback function.......................................................................116 Registering the callback function ..............................................................116 API functions .........................................................................................117
7 UDP zero-copy interface..............................................................................................123

7.1 7.1.1 7.1.2 7.2 7.2.1 7.2.2 7.2.3 7.3 7.3.1 7.3.2 7.4 UDP zero-copy .......................................................................................124 Allocating, freeing and sending packet buffers............................................124 Callback function....................................................................................124 Sending data with the UDP zero-copy API ..................................................125 Allocating a packet buffer ........................................................................125 Filling the allocated buffer with data .........................................................125 Sending the packet.................................................................................125 Receiving data with the UDP zero-copy API................................................126 Writing a callback function.......................................................................126 Registering the callback function ..............................................................126 API functions .........................................................................................127
8 DHCP client .................................................................................................................139

8.1 8.2 DHCP backgrounds .................................................................................140 API functions .........................................................................................141
9 Network interface drivers .............................................................................................147

9.1 9.1.1 9.1.2 9.1.3 9.2 9.2.1 9.2.2 9.2.3 9.2.4 9.2.5 9.2.6 9.3 9.3.1 General information................................................................................148 MAC address filtering ..............................................................................148 Checksum computation in hardware .........................................................148 Ethernet CRC computation.......................................................................148 Available network interface drivers ...........................................................149 ATMEL AT91SAM7X ................................................................................150 ATMEL AT91SAM9260 .............................................................................153 DAVICOM DM9000/DM9000A ...................................................................156 FREESCALE ColdFire MCF5329 .................................................................159 NXP LPC23xx / 24xx ...............................................................................162 ST STR912 ............................................................................................164 Writing your own driver ..........................................................................165 Device driver functions ...........................................................................167
10 Configuring embOS/IP ...............................................................................................173

10.1 10.1.1 10.1.2 10.1.3 10.2 10.2.1 10.2.2 Runtime configuration.............................................................................174 IP_X_Configure() ...................................................................................174 Driver handling ......................................................................................175 Memory and buffer assignment ................................................................175 Compile-time configuration......................................................................177 Compile-time configuration switches .........................................................177 Debug level ...........................................................................................178
11 Web server (Add-on)..................................................................................................179

11.1 11.2 11.3 11.4 11.4.1 11.4.2 11.5 11.5.1 11.5.2 embOS/IP web server .............................................................................180 Feature list............................................................................................181 Requirements ........................................................................................182 HTTP backgrounds..................................................................................183 HTTP communication basics.....................................................................183 HTTP status codes ..................................................................................184 Using the web server sample ...................................................................185 Using the Windows sample ......................................................................185 Running the web server example on target hardware ..................................185
11
11.5.3 11.6 11.6.1 11.6.2 11.7 11.7.1 11.7.2 11.8 11.8.1 11.9 11.9.1 11.10 11.11 11.12 11.12.1 11.12.2
Changing the file system type ................................................................. 186 Dynamic content ................................................................................... 187 Common Gateway Interface (CGI) ........................................................... 187 Virtual files ........................................................................................... 189 Authentication....................................................................................... 191 Authentication example .......................................................................... 192 Configuration of the authentication .......................................................... 193 Form handling....................................................................................... 194 Simple form processing sample ............................................................... 195 Configuration ........................................................................................ 198 Compile time configuration switches......................................................... 198 API functions ........................................................................................ 200 Web server data structures ..................................................................... 216 Resource usage ..................................................................................... 220 ROM usage ........................................................................................... 220 RAM usage: .......................................................................................... 220
12 SMTP client (Add-on).................................................................................................221

12.1 12.2 12.3 12.4 12.5 12.5.1 12.6 12.7 12.8 12.8.1 12.8.2 embOS/IP SMTP client............................................................................ 222 Feature list ........................................................................................... 223 Requirements........................................................................................ 224 SMTP backgrounds................................................................................. 225 Configuration ........................................................................................ 227 Compile time configuration switches......................................................... 227 API functions ........................................................................................ 228 SMTP client data structures ..................................................................... 230 Resource usage ..................................................................................... 238 ROM usage ........................................................................................... 238 RAM usage: .......................................................................................... 238
13 FTP server (Add-on) ..................................................................................................239

13.1 13.2 13.3 13.4 13.4.1 13.4.2 13.4.3 13.4.4 13.5 13.5.1 13.5.2 13.6 13.7 13.7.1 13.7.2 13.8 13.9 13.10 13.10.1 13.10.2 embOS/IP FTP server ............................................................................. 240 Feature list ........................................................................................... 241 Requirements........................................................................................ 242 FTP basics ............................................................................................ 243 Active mode FTP.................................................................................... 244 Passive mode FTP .................................................................................. 245 FTP reply codes ..................................................................................... 246 Supported FTP commands ...................................................................... 247 Using the FTP server sample ................................................................... 248 Using the Windows sample...................................................................... 248 Running the FTP server example on target hardware .................................. 248 Access control ....................................................................................... 249 Configuration ........................................................................................ 253 Compile time configuration switches......................................................... 253 FTP server system time .......................................................................... 254 API functions ........................................................................................ 256 FTP server data structures ...................................................................... 259 Resource usage ..................................................................................... 261 ROM usage ........................................................................................... 261 RAM usage: .......................................................................................... 261
14 FTP client (Add-on)....................................................................................................263

14.1 14.2 14.3 14.4 14.4.1 14.4.2 14.5 embOS/IP FTP client .............................................................................. 264 Feature list ........................................................................................... 265 Requirements........................................................................................ 266 FTP basics ............................................................................................ 267 Passive mode FTP .................................................................................. 268 Supported FTP client commands .............................................................. 269 Configuration ........................................................................................ 270
12
14.5.1 14.6 14.7 14.8 14.8.1 14.8.2
Compile time configuration switches .........................................................270 API functions .........................................................................................271 FTP client data structures ........................................................................278 Resource usage .....................................................................................279 ROM usage............................................................................................279 RAM usage:...........................................................................................279
15 Debugging..................................................................................................................281
15.1 15.2 15.3 15.4 Message output .....................................................................................282 Testing stability .....................................................................................283 API functions .........................................................................................284 Message types .......................................................................................290
16 OS integration ............................................................................................................293
16.1 16.2 16.2.1 General information................................................................................294 OS layer API functions ............................................................................295 Examples ..............................................................................................295
17 Performance & resource usage .................................................................................297

17.1 17.2 Memory footprint ...................................................................................298 Performance ..........................................................................................299
18 Appendix A - File system abstraction layer................................................................301

18.1 18.2 18.2.1 18.2.2 18.2.3 18.2.4 File system abstraction layer....................................................................302 File system abstraction layer function table................................................303 emFile interface .....................................................................................305 Read-only file system .............................................................................306 Using the read-only file system ................................................................306 Windows file system interface ..................................................................308
19 Glossary.....................................................................................................................309
13
Chapter 1 Introduction to embOS/IP
This chapter provides an introduction to using embOS/IP. It explains the basic concepts behind embOS/IP.
14
CHAPTER 1
Introduction to embOS/IP
1.1
What is embOS/IP
embOS/IP is a CPU-independent TCP/IP stack. embOS/IP is a high-performance library that has been optimized for speed, versatility and small memory footprint.
1.2

Features
embOS/IP is written in ANSI C and can be used on virtually any CPU. Some features of embOS/IP: Standard socket interface. High performance. Small footprint. No configuration required. Runs out-of-the-box. Very simple network interface driver structure. Works seamlessly with embOS in multitasking environment. Zero data copy for ultra fast performance. Non-blocking versions of all functions. Connections limited only by memory availability. Delayed ACKs. BSD style keep-alive option. Re-assembly of fragmented packets. Support for messages and warnings in debug build. Drivers for most common Ethernet controllers available. Support for driver side (hardware) checksum computation. Royalty-free.
15
1.3
1.3.1
Basic concepts
embOS/IP structure
embOS/IP is organized in different layers, as shown in the following illustration.
Application layer
DHCP, DNS, FTP, HTTP, POP3, SMTP, TELNET, SSL, ...
Transport layer
TCP / UDP
Network layer
IP, ICMP, IGMP, ARP, RARP, ...
Link layer
Ethernet (IEEE 802.3), ...
A short description of each layers functionality follows below.
Application layer
The application layer is the interface between embOS/IP and the user application. It uses the embOS/IP API to transmit data over an TCP/IP network. The embOS/IP API provides functions in BSD (Berkeley Software Distribution) socket style, such as connect(), bind(), listen(), etc.
Transport layer
The transport layer provides end-to-end communication services for applications. The two relevant protocols of the Transport layer protocol are the Transmission Control Protocol (TCP) and the User Datagram Protocol (UDP). TCP is a reliable connectionoriented transport service. It provides end-to-end reliability, resequencing, and flow control. UDP is a connectionless transport service.
Internet layer
All protocols of the transport layer use the Internet Protocol (IP) to carry data from source host to destination host. IP is a connectionless service, providing no end-toend delivery guarantees. IP datagrams may arrive at the destination host damaged, duplicated, out of order, or not at all. The transport layer is responsible for reliable delivery of the datagrams when it is required. The IP protocol includes provision for addressing, type-of-service specification, fragmentation and reassembly, and security information.
Link layer
The link layer provides the implementation of the communication protocol used to interface to the directly-connected network. A variety of communication protocols have been developed and standardized. The most commonly used protocol is Ethernet (IEEE 802.3). In this version of embOS/IP only Ethernet is supported.
16
CHAPTER 1
1.3.2
Encapsulation
The four layers structure is defined in [RFC 1122]. The data flow starts at the application layer and goes over the transport layer, the network layer, and the link layer. Every protocol adds an protocol-specific header and encapsulates the data and header from the layer above as data. On the receiving side, the data will be extracted in the complementary direction. The opposed protocols do not know which protocol on the above and below layers are used. The following illustration shows the encapsulation of data within an UDP datagram within an IP packet.
Data
Application layer Transport layer Network layer Link layer
UDP header
UDP data
IP header
IP data
Frame header
Frame data
Frame footer
17
1.4

Tasks and interrupt usage

embOS/IP can be used in an application in three different ways. One task dedicated to the stack (IP_Task) Two tasks dedicated to the stack (IP_Task, IP_RxTask) Zero tasks dedicated to the stack (Superloop)
The default task structure is one task dedicated to the stack. The priority of the management tasks IP_Task (and IP_RxTask if available) should be higher then the priority of an application task which uses the stack.
One task dedicated to the stack

To use one task dedicated to the stack is the simplest way to use the TCP/IP stack. It is called IP_Task and handles housekeeping operations, resending and handling of incoming packets. The Read packet operation is performed from within the ISR. Because the Read packet operation is called directly from the ISR, no additional task is required. The length of the interrupt latency will be extended for the time period which is required to process the Read packet operation. Refer to IP_Task() on page 64 for more information and an example about how to include the IP_Task into your embOS project.
Interrupt (ISR) Task Routine / Action Application tasks IP stack IP stack / Driver
embOS/IP
Rx
IP_OnRx()
App. task 1
...
App. t ask n
IP_Task
IP_Exec()
Read packet
18
CHAPTER 1
Two tasks dedicated to the stack

Two tasks are dedicated to the stack. The first task is called the IP_Task and handles housekeeping operations, resends, and handling of incoming packets. The second is called IP_RxTask and handles the Read packet operation. IP_RxTask is waked up from the interrupt service routine, if new packets are available. The interrupt latency is not extended, because the Read packet operation has been moved from the interrupt service routine to IP_RxTask. Refer to IP_Task() on page 64 and IP_RxTask() on page 65 for more information.
embOS/IP
Rx
IP_OnRx()
App. task 1
...
App. t ask n
IP_Task
IP_RxTask
IP_Exec()
Read packet
19
Zero tasks dedicated to the stack (Superloop)

embOS/IP can also be used without any additional task for the stack, if an application task calls IP_Exec() periodically. The Read packet operation is performed from within the ISR. Because the Read packet operation is called directly from the ISR, no additional task is required. The length of the interrupt latency will be extended for the time period which is required to process the Read packet operation.
embOS/IP
Rx
IP_OnRx()
App. task 1
...
App. t ask n
IP_Exec()
Read packet
20
CHAPTER 1
1.5
1.5.1
Background information
Components of an Ethernet system
Main parts of an Ethernet system are the Media Access Controller (MAC) and the Physical device (PHY). The MAC handles generating and parsing physical frames and the PHY handles how this data is actually moved to or from the wire.
MCUs with integrated MAC

Some modern MCUs (for example, the ATMEL SAM7X or the ST STR912) include the MAC and use the internal RAM to store the Ethernet data. The following block diagram illustrates such a configuration.
MAC CPU RAM
PHY
Connector
External Ethernet controllers with MAC and PHY

Chips without integrated MAC can use fully integrated single chip Ethernet MAC controller with integrated PHY and a general processor interface. The following schematic illustrates such a configuration.
MAC CPU RAM
PHY
Connector
21
1.5.1.1 MII / RMII: Interface between MAC and PHY

The MAC communicates with the PHY via the Media Independent Interface (MII) or the Reduced Media Independent Interface (RMII). The MII is defined in IEEE 802.3u. The RMII is a subset of the MII and is defined in the RMI specification. The MII/RMII can handle control over the PHY which allows for selection of such transmission criteria as line speed, duplex mode, etc. In theory, up to 32 PHYs can be connected to a single MAC. In praxis, this is never done; only one PHY is connected. In order to allow multiple PHYs to be connected to a single MAC, individual 5-bit addresses have been be assigned to the different PHYs. If only one PHY is connected, the embOS/IP driver automatically finds the address of it. The standard defines 32 16-bit PHY registers. The first 6 are defined by the standard.
Register
BMCR BSR PHYSID1 PHYSID2 ANAR LPAR
Description
Basic Mode Control Register Basic Mode Status Register PHYS ID 1 PHYS ID 2 Auto-Negotiation Advertisement Register Link Partner Ability register
Table 1.1: Standardized registers of the MAC/PHY interface
The drivers automatically recognize any PHY connected, no manual configuration of PHY address is required. The MII and RMII interface are capable of both 10Mb/s and 100Mb/s data rates as described in the IEEE 802.3u standard.
TX_CLK TX_EN TXD 0-1 TXD 2-3 PHYCLK CRS COL
MAC
MDIO MDC RX_CLK RXD 0-1 RXD 2-3 RX_DV RX_ER
PHY
The intent of the RMII is to provide a reduced pin count alternative to the IEEE 802.3u MII. It uses 2 bits for transmit (TXD0 and TXD1) and two bits for receive (RXD0 and RXD1). There is a Transmit Enable (TX_EN), a Receive Error (RX_ER), a Carrier Sense (CRS), and a 50 MHz Reference Clock (TX_CLK) for 100Mb/s data rate. The pins used by the MII and RMII interfaces are described in the following table. Signal TX_CLK TX_EN TXD[0:1] TXD[2:3] MII Transmit Clock (25 MHz) Transmit Enable 4-bit Transmit Data RMII Reference Clock (50 MHz) Transmit Enable 2-bit Transmit Data N/A
Table 1.2: MII / RMII comparison
22
CHAPTER 1
Signal PHYCLK CRS COL MDIO MDC RX_CLK RXD[0:1] RXD[2:3] RX_DV RX_ER
MII PHY Clock Output Carrier Sense Collision Detect Management data I/O Data Transfer Timing Reference Clock Receive Clock 4-bit Receive Data Data Valid Receive Error
RMII PHY Clock Output N/A N/A Management data I/O Data Transfer Timing Reference Clock N/A 2-bit Receive Data N/A Carrier Sense/Data Valid Receive Error
Table 1.2: MII / RMII comparison
23
1.6
Further reading
This guide explains the usage of the embOS/IP protocol stack. It describes all functions which are required to build a network application. For a deeper understanding about how the protocols of the internet protocol suite works use the following references. The following Request for Comments (RFC) define the relevant protocols of the internet protocol suite and have been used to build the protocol stack. They contain all required technical specifications. The listed books are simpler to read as the RFCs and give a general survey about the interconnection of the different protocols.
1.6.1
Request for Comments (RFC)

RFC# Description
UDP - User Datagram Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc768.txt IP - Internet Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc791.txt ICMP - Internet Control Message Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc792.txt TCP - Transmission Control Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc793.txt SMTP - Simple Mail Transfer Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc826.txt ARP - Ethernet Address Resolution Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc826.txt BOOTP - Bootstrap Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc951.txt FTP - File Transfer Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc959.txt DNS - Domain names - concepts and facilities Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc1034.txt DNS - Domain names - implementation and specification Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc1035.txt IE-EEE - Transmission of IP datagrams over IEEE 802 networks Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc1042.txt Requirements for Internet Hosts - Communication Layers Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc1122.txt Requirements for Internet Hosts - Application and Support Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc1123.txt PPP - Point-to-Point Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc1661.txt POP3 - Post Office Protocol - Version 3 Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc1939.txt DHCP - Dynamic Host Configuration Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc2131.txt HTTP - Hypertext Transfer Protocol -- HTTP/1.1 Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc2616.txt
[RFC 768] [RFC 791] [RFC 792] [RFC 793] [RFC 821] [RFC 826] [RFC 951] [RFC 959] [RFC 1034] [RFC 1035] [RFC 1042] [RFC 1122] [RFC 1123] [RFC 1661] [RFC 1939] [RFC 2131] [RFC 2616]
24
CHAPTER 1
1.6.2

Related books
[Comer] - Computer Networks and Internets, Douglas E Comer and Ralph E. Droms - ISBN: 978-0131433519 [Tannenbaum] - Computer Networks, Andrew S. Tannenbaum ISBN: 978-0130661029 [StevensV1] - TCP/IP Illustrated, Volume 1, W. Richard Stevens ISBN: 978-0201633467. [StevensV2] - TCP/IP Illustrated, Volume 2, W. Richard Stevens and Gary R. Wright - ISBN: 978-0201633542. [StevensV3] - TCP/IP Illustrated, Volume 3, W. Richard Stevens ISBN: 978-0201634952.
25
1.7

Development environment (compiler)

The CPU used is of no importance; only an ANSI-compliant C compiler complying with at least one of the following international standard is required: ISO/IEC/ANSI 9899:1990 (C90) with support for C++ style comments (//) ISO/IEC 9899:1999 (C99) ISO/IEC 14882:1998 (C++)
If your compiler has some limitations, let us know and we will inform you if these will be a problem when compiling the software. Any compiler for 16/32/64-bit CPUs or DSPs that we know of can be used; most 8-bit compilers can be used as well. A C++ compiler is not required, but can be used. The application program can therefore also be programmed in C++ if desired.
26
CHAPTER 1
27
Chapter 2 Running embOS/IP on target hardware
This chapter explains how to integrate and run embOS/IP on your target hardware. It explains this process step-by-step.
28
CHAPTER 2
Running embOS/IP on target hardware
Integrating embOS/IP
The embOS/IP default configuration is preconfigured with valid values, which matches the requirements of the most applications. embOS/IP is designed to be used with embOS, SEGGERs real-time operating system. We recommend to start with an embOS sample project and include embOS/IP into this project. We assume that you are familiar with the tools you have selected for your project (compiler, project manager, linker, etc.). You should therefore be able to add files, add directories to the include search path, and so on. In this document the IAR Embedded Workbench IDE is used for all examples and screenshots, but every other ANSI C toolchain can also be used. It is also possible to use make files; in this case, when we say add to the project, this translates into add to the make file.
Procedure to follow
Integration of embOS/IP is a relatively simple process, which consists of the following steps: Step 1: Open an embOS project and compile it. Step 2: Add embOS/IP to the start project Step 3: Compile the project
29
2.1
Step 1: Open an embOS start project

We recommend that you use one of the supplied embOS start projects for your target system. Compile the project and run it on your target hardware.
30
CHAPTER 2
2.2

Step 2: Adding embOS/IP to the start project

Add all source files in the following directory to your project: Config IP UTIL (optional)
The Config folder includes all configuration files of embOS/IP. The configuration files are preconfigured with valid values, which match the requirements of most applications. Add the hardware configuration IP_Config_<TargetName>.c supplied with the driver shipment. If your hardware is currently not supported, use the example configuration file and the driver template to write your own driver. The example configuration file and the driver template is located in the Sample\Driver\Template folder. The Util folder is an optional component of the embOS/IP shipment. It contains optimized MCU and/or compiler specific files, for example a special memcopy function.
Replace BSP.c and BSP.h of your embOS start project

Replace the BSP.c source file and the BSP.h header file used in your embOS start project with the one which is supplied with the embOS/IP shipment. Some drivers require a special functions which initializes the network interface of the driver. This function is called BSP_ETH_Init(). It is used to enable the ports which are connected to the network hardware. All network interface driver packages include the BSP.c and BSP.h files irrespective if the BSP_ETH_Init() function is implemented.
Configuring the include path

The include path is the path in which the compiler looks for include files. In cases where the included files (typically header files, .h) do not reside in the same directory as the C file to compile, an include path needs to be set. In order to build the project with all added files, you will need to add the following directories to your include path: Config Inc IP
31
Select the start application

For quick and easy testing of your embOS/IP integration, start with the code found in the folder Application. Add one of the applications to your project (for example OS_IP_SimpleServer.c).
32
CHAPTER 2
2.3
Step 3: Build the project and test it

Build the project. It should compile without errors and warnings. If you encounter any problem during the build process, check your include path and your project configuration settings. To test the project, download the output into your target and start the application. By default, ICMP is activated. This means that you could ping your target. Open the command line interface of your operating system and enter ping <TargetAddress>, to check if the stack runs on your target. The target should answer all pings without any error.
33
Chapter 3 Example applications
In this chapter, you will find a description of each embOS/IP example application.
34
CHAPTER 3
Example applications
3.1
Overview
Various example applications for embOS/IP are supplied. These can be used for testing the correct installation and proper function of the device running embOS/IP. The following start application files are provided: File OS_IP_DNSClient.c OS_IP_NonBlockingConnect.c OS_IP_Ping.c OS_IP_Shell.c Description Demonstrates the use of the integrated DNS client. Demonstrates how to connect to a server using non-blocking sockets. Demonstrates how to send ICMP echo requests and how to process ICMP replies in application. Demonstrates using the IP-shell to diagnose the IP stack. Demonstrates setup of a simple server which simply sends back the target system tick for every character received. Demonstrates the TCP send and receive performance of the device running embOS/IP. Refer to embOS/IP speed client (OS_IP_SpeedClient_TCP.c) on page 36 for detailed information. Demonstrates the UDP send performance of the device running embOS/IP. Demonstrates use of the IP stack without any server or client program. To ping the target, use the command line: ping <target-ip> where <target-ip> represents the IP address of the target, which depends on the configuration and is usually 192.168.5.1 if the DHCP client is not enabled. Demonstrates setup of a simple UDP application which replies to UDP broadcasts. The application sends an answer for every received discover packet. The related host application sends discover packets as UDP broadcasts and waits for the feedback of the targets which are available in the subnet. Demonstrates setup of a simple UDP application which replies to UDP broadcasts. The application uses the the embOS/IP zero-copy interface. It sends an answer for every received discover packet. The related host application sends discover packets as UDP broadcasts and waits for the feedback of the targets which are available in the subnet.
OS_IP_SimpleServer.c
OS_IP_SpeedClient_TCP.c
OS_IP_SpeedClient_UDP.c
OS_IP_Start.c
OS_IP_UDPDiscover.c
OS_IP_UDPDiscoverZeroCopy.c
Table 3.1: embOS/IP example applications
The example applications for the target-side are supplied in source code in the Application directory.
35
3.1.1
embOS/IP DNS client (OS_IP_DNSClient.c)
The embOS/IP DNS client resolves a hostname (for example, www.segger.com) to an IP address and outputs the resolved address via terminal I/O.
3.1.2 embOS/IP non-blocking connect (OS_IP_NonBlockingConnect.c)

The embOS/IP non-blocking connect sample demonstrates how to connect to a server using non-blocking sockets. The target tries to connect to TCP server with an non-blocking socket. The sample can be used with any TCP server independent of the application which is listening on the port. The client only opens a TCP connection to the server and closes it without any further communication. The terminal I/O output in your debugger should be similar to the following out:
Connecting using non-blocking socket... Successfully connected after 2ms! 1 of 1 tries were successful. Connecting using non-blocking socket... Successfully connected after 1ms! 2 of 2 tries were successful.
3.1.3
embOS/IP ping (OS_IP_Ping.c)
The embOS/IP ping sample demonstrates how to send ICMP echo requests and how to process received ICMP packets in your application. A callback function is implemented which outputs a message if an ICMP echo reply or an ICMP echo request has been received. To test the embOS/IP ICMP implementation, you have to perform the following steps: 1. Customize the Local defines, configurable section of OS_IP_Ping.c. Change the macro HOST_TO_PING accordant to your configuration. For example, if the Windows host PC which you want to ping use the IP address 192.168.5.15, change the HOST_TO_PING macro to 0xC0A8050F. Open the command line interface and enter: ping [IP_ADDRESS _OF_YOUR_TARGET_RUNNING_EMBOSIP]
2.
The terminal I/O output in your debugger should be similar to the following out:
ICMP ICMP ICMP ICMP ICMP ICMP ICMP ICMP ICMP ICMP echo echo echo echo echo echo echo echo echo echo reply received! request received! reply received! reply received! reply received! reply received! request received! reply received! reply received! reply received!
3.1.4
embOS/IP shell (OS_IP_Shell.c)
The embOS/IP shell server is a task which opens TCP-port 23 (telnet) and waits for a connection. The actual shell server is part of the stack, which keep the application program nice and small. The shell server task can be added to any application and should be used to retrieve status information while the target is running. To connect
36
CHAPTER 3
to the target, use the command line: telnet <target-ip> where <target-ip> represents the IP address of the target, which depends on the configuration and is usually 192.168.5.230 if the DHCP client is not enabled.
3.1.5
embOS/IP simple server (OS_IP_SimpleServer.c)
Demonstrates setup of a simple server which simply sends back the target system tick for every character received. It opens TCP-port 23 (telnet) and waits for a connection. To connect to the target, use the command line: telnet <target-ip> where <target-ip> represents the IP address of the target, which depends on the configuration and is usually 192.168.5.230 if the DHCP client is not enabled.
3.1.6
embOS/IP speed client (OS_IP_SpeedClient_TCP.c)
The embOS/IP speed client is a small application to detect the TCP send and receive performance of embOS/IP on your hardware.
3.1.6.1 Running the embOS/IP speed client

To test the embOS/IP performance, you have to perform the following steps: 1. Start the Windows speed test server. The example application for the host-side is supplied as executable and in source code in the Windows\SpeedTestServer\ directory. To run the speed test server, simply start the executable, for example by double-clicking it or open the supplied Visual C project and compile and start the application. Add OS_IP_SpeedClient.c to your project. Customize the Local defines, configurable section of OS_IP_SpeedClient.c. Change the macro SERVER_IP_ADDR accordant to your configuration. For example, if the Windows host PC running the speed test server uses the IP address 192.168.5.15, change the SERVER_IP_ADDR macro to 0xC0A8050F. If you have changed the port which the Windows host application uses to listen, change the macro SERVER_PORT accordingly. Build and download the speed client into your target. The target connects to the
2. 3.
4.
37
server and starts the transmission.
3.1.7
embOS/IP speed client (OS_IP_SpeedClient_UDP.c)
The embOS/IP speed client is a small application to detect the UDP send performance of embOS/IP on your hardware.
3.1.8
embOS/IP start (OS_IP_Start.c)
Demonstrates use of the IP stack without any server or client program. To ping the target, use the command line: ping <target-ip> where <target-ip> represents the IP address of the target, which depends on the configuration and is usually 192.168.5.230 if the DHCP client is not enabled.
3.1.9 embOS/IP UDP discover (OS_IP_UDPDiscover.c / OS_IP_UDPDiscoverZeroCopy.c)

To test the embOS/IP UDP discover example, you have to perform the following steps: 1. Start the Windows UDP discover example application. The example application for the host-side is supplied as executable and in source code in the Windows\UDPDiscover\ directory. To run the UDP discover example, simply start the executable, for example by double-clicking it or open the supplied Visual C project and compile and start the application. Add OS_IP_UDPDiscover.c to your project. Customize the Local defines, configurable section of OS_IP_UDPDiscover.c. By default, the example uses port 50020. If you have changed the port that the Windows host application uses, change the macro PORT accordingly. Build and download the UDP discover example into your target. The target sends an answer for every received discover packet. The related host application sends discover packets as UDP broadcasts and waits for the feedback of the targets which are available in the subnet.
2. 3. 4.
38
CHAPTER 3
39
Chapter 4 Core functions
In this chapter, you will find a description of each embOS/IP core function.
40
CHAPTER 4
Core functions
4.1
API functions
The table below lists the available API functions within their respective categories. Function Description
Configuration functions IP_AddBuffers() Adds buffers to the TCP/IP stack. IP_AddEtherInterface() Adds an Ethernet interface to the stack. IP_AllowBackpressure() Activates back pressure. IP_AssignMemory() Assigns memory. IP_ConfTCPSpace() Configures the send and receive space. IP_DNSC_SetMaxTTL() Sets the maximum TTL of a DNS entry. IP_DNS_SetServer() Sets the DNS server. IP_NI_ConfigPHYAddr() Configures the PHY address. IP_NI_ConfigPHYMode() Configures the PHY mode. Select polled mode for the network interIP_NI_ConfigPoll() face. Configures the Tx buffer size used by the IP_NI_SetTxBufferSize() network interface driver. IP_SetAddrMask() Sets the address mask of an interface. IP_SetDefaultTTL() Sets the TTL of an IP packet. IP_SetHWAddr() Sets the hardware address of an interface. Sets the maximum transmission unit of an IP_SetMTU() interface. IP_SetSupportedDuplexModes() Sets the supported duplex modes. Sets the socket options which should be IP_SOCKET_SetDefaultOptions() enabled by default. Sets the maximum number of available IP_SOCKET_SetLimit() sockets. IP_TCP_Set2MSLDelay() Sets the maximum segment lifetime. IP_TCP_SetConnKeepaliveOpt() Sets the keepalive options. IP_TCP_SetRetransDelayRange() Sets retransmission delay range. Management functions IP_Init() Initialization function of the stack. IP_Task() Main task for starting the stack. Reads all available packets and sleeps until IP_RxTask() a new packet is received. Checks if any packet has been received and IP_Exec() handles timers. Other IP stack functions Returns the IP address and the subnet mask IP_GetAddrMask() of the device. IP_GetCurrentLinkSpeed() Returns the current link speed. IP_GetGWAddr() Returns the gateway address of the device. Returns the hardware address (MAC) of the IP_GetHWAddr() device. IP_GetIPAddr() Returns the IP address of the device. Returns the start address of the data part of IP_GetIPPacketInfo() an IP packet. IP_GetVersion() Returns the version number of embOS/IP. Sets a hook function which will be called if IP_ICMP_SetRxHook() target receives a ping packet. IP_IFaceIsReady() Checks if the interface is ready.
Table 4.1: embOS/IP API function overview
41
Function IP_PrintIPAddr() IP_SendPacket() IP_SendPing() IP_SetRxHook()
Description Convert an 4 byte IP address to a dots-andnumber string. Sends a user defined packet on the interface. Sends an ICMP Echo Request. Sets a hook function that handles all received packets.
Table 4.1: embOS/IP API function overview (Continued)
42
CHAPTER 4
Core functions
4.2
4.2.1
Configuration functions
IP_AddBuffers()
Description
Adds buffers to the TCP/IP stack. This is a configuration function, typically called from IP_X_Config(). It needs to be called 2 times, one per buffer size.
Prototype
void IP_AddBuffers ( int NumBuffers, int BytesPerBuffer );
Parameter
Parameter NumBuffers BytesPerBuffer Description [IN] The number of buffers. [IN] Size of buffers in bytes.
Table 4.2: IP_AddBuffers() parameter list
Additional information
embOS/IP requires small and large buffers. We recommend to define the size of the big buffers to 1536 to allow a full Ethernet packet to fit. The small buffers are used to store packets which encapsulates no or few application data like protocol management packets (TCP SYNs, TCP ACKs, etc.). We recommend to define the size of the small buffers to 256 bytes.
Example
IP_AddBuffers(20, 256); IP_AddBuffers(12, 1536); // 20 small buffers, each 256 bytes. // 12 big buffers, each 1536 bytes.
43
4.2.2
IP_AddEtherInterface()
Description
Adds an Ethernet interface.
Prototype
void IP_AddEtherInterface ( const IP_HW_DRIVER * pDriver );
Parameter
Parameter pAddr
Table 4.3: IP_AddEthernetInterface() parameter list
Description [IN] A pointer to a network interface driver structure.
Refer to Available network interface drivers on page 149 for a list of available network interface drivers.
Example
IP_AddEtherInterface(&IP_Driver_SAM7X); // Add Ethernet driver for your hardware
44
CHAPTER 4
Core functions
4.2.3
IP_AllowBackpressure()
Description
Allows back pressure if the driver supports this feature.
Prototype
void IP_AllowBackpressure ( int v );
Parameter
Parameter v
Table 4.4: IP_AllowBackPressure() parameter list
Description [IN] Zero to disable, 1 to enable back pressure.
Back pressure is a window-based flow control mechanism for the half-duplex mode. It is a sort of feedback-based congestion control mechanism. The intent of this mechanism is to prevent loss by providing back pressure to the sending NIC on ports that are going too fast to avoid loss. Back pressure is enabled by default.
45
4.2.4
IP_AssignMemory()
Description
Assigns memory to the TCP/IP stack.
Prototype
void IP_AssignMemory ( U32 * pMem, U32 NumBytes );
Parameter
Parameter pMem NumBytes Description [IN] A pointer to the start of the memory region which should be assigned. [IN] Number of bytes which should be assigned.
Table 4.5: IP_AssignMemory() parameter list
IP_AssignMemory() should be the first function which is called in IP_X_Config(). The amount of RAM required depends on the configuration and the respective application purpose. The assigned memory pool is required for the socket buffers, memory buffers, etc.
Example
#define ALLOC_SIZE 0x8000 U32 _aPool[ALLOC_SIZE / 4]; // Size of memory dedicated to the stack in bytes // Memory area used by the stack.
IP_AssignMemory(_aPool, sizeof(_aPool));
46
CHAPTER 4
Core functions
4.2.5
IP_ConfTCPSpace()
Description
Configures the size of the TCP send and receive window size.
Prototype
void IP_ConfTCPSpace ( unsigned SendSpace, unsigned RecvSpace );
Parameter
Parameter SendSpace RecvSpace Description [IN] Size of the send window. [IN] Size of the receive window.
Table 4.6: IP_ConfTCPSpace() parameter list
The receive window size is the amount of unacknowledged data a sender can send to the receiver on a particular TCP connection before it gets an acknowledgment.
47
4.2.6
IP_DNSC_SetMaxTTL()
Description
Sets the maximum Time To Live (TTL) of a DNS entry in seconds.
Prototype
void IP_DNSC_SetMaxTTL( U32 TTL );
Parameter
Parameter TTL
Table 4.7: IP_DNSC_SetMaxTTL() parameter list
Description [IN] Maximum TTL of a DNS entry in seconds.
The real TTL is the minimum of TTL and the TTL specified by the DNS server for the entry. The embOS/IP default for the maximum TTL of an DNS entry is 600 seconds.
48
CHAPTER 4
Core functions
4.2.7
IP_DNS_SetServer()
Description
Sets the DNS server that should be used.
Prototype
void IP_DNS_SetServer ( U32 DNSServerAddr );
Parameter
Parameter DNSServerAddr
Table 4.8: IP_DNS_SetServer() parameter list
Description [IN] Address of DNS server.
If a DHCP server is used for configuring your target, IP_DNS_SetServer() must not be called. The DNS server settings are part of the DHCP configuration setup. The DNS server has to be defined before calling gethostbyname() to resolve an internet address. Refer to gethostbyname() on page 88 for detailed information about resolving an internet address.
49
4.2.8
IP_NI_ConfigPHYAddr()
Description
Configures the PHY address.
Prototype
void IP_NI_ConfigPHYAddr ( unsigned Unit, U8 Addr ); Parameter Unit Addr Description [IN] Zero-based index of available network interfaces. [IN] 5-bit address.
Table 4.9: IP_NI_ConfigPHYAddr() parameter list
The PHY address is a 5-bit value. The available embOS/IP drivers try to detect the PHY address automatically, therefore this should not be called. If you use this function to set the address explicitly, the function must be called from within IP_X_Config(). Refer to IP_X_Configure() on page 174.
50
CHAPTER 4
Core functions
4.2.9
IP_NI_ConfigPHYMode()
Description
Configures the PHY mode.
Prototype
void IP_NI_ConfigPHYMode ( unsigned Unit, U8 Mode ); Parameter Unit Mode Description [IN] Zero-based index of available network interfaces. [IN] The operating mode of the PHY.
Table 4.10: IP_NI_ConfigPHYMode() parameter list
Valid values for parameter Mode

Value IP_PHY_MODE_MII IP_PHY_MODE_RMII Description Phy uses the Media Independent Interface (MII). Phy uses the Reduced Media Independent Interface (RMII).
The PHY can be connected to the MAC via two different modes, MII or RMII. Refer to section MII / RMII: Interface between MAC and PHY on page 21 for detailed information about the differences of the MII and RMII modes. The selection which mode is used is normally done correctly by the hardware. The mode is typically sampled during power-on RESET. If you use this function to set the mode explicitly, the function must be called from within IP_X_Config(). Refer to IP_X_Configure() on page 174.
51
4.2.10 IP_NI_ConfigPoll()
Description
Select polled mode for the network interface. This should be used only if the network interface can not activate an ISR itself.
Prototype
void IP_NI_ConfigPoll( unsigned Unit ); Parameter Unit
Table 4.11: IP_NI_ConfigPoll() parameter list
Description [IN] Zero-based index of available network interfaces.
52
CHAPTER 4
Core functions
4.2.11 IP_NI_SetTxBufferSize()
Description
Sets the size of the Tx buffer of the network interface.
Prototype
int IP_NI_SetTxBufferSize ( unsigned Unit, U8 NumBytes ); Parameter Unit NumBytes Description [IN] Zero-based index of available network interfaces. [IN] Size of the Tx buffer (at least size of the MTU + 16 bytes for Ethernet.)
Table 4.12: IP_NI_SetTxBufferSize() parameter list
Return value
-1: Not supported by the network interface driver. 0: OK 1: Error, called after driver initialization has been completed.
The default Tx buffer size is 1536 bytes. It can be useful to reduce the buffer size on systems with less RAM and an application that uses a small MTU. According to RFC 576 bytes is the smallest possible MTU. The size of the Tx buffer should be at least MTU + 16 bytes for Ethernet header and footer. The function should be called in IP_X_Config(). Note: This function is not implemented in all network interface drivers, since not all Media Access Controllers (MAC) support variable buffer sizes.
53
4.2.12 IP_SetAddrMask()
Description
Sets the IP address and subnet mask of an interface.
Prototype
void IP_SetAddrMask ( U32 Addr, U32 Mask );
Parameter
Parameter Addr Mask [IN] 4-byte IPv4 address. [IN] Subnet mask. Description
Table 4.13: IP_SetAddrMask() parameter list
The address mask should only be set if no DHCP server is used to obtain IP address, subnet mask and default gateway. Refer to chapter DHCP client on page 139 for detailed information about the usage of the embOS/IP DHCP client.
Example
IP_SetAddrMask(0xC0A80505, 0xFFFF0000); // IP: 192.168.5.5 // Subnet mask: 255.255.0.0
54
CHAPTER 4
Core functions
4.2.13 IP_SetDefaultTTL()
Description
Sets the default value for the Time-To-Live IP header field.
Prototype
void IP_SetDefaultTTL ( int v );
Parameter
Parameter v [IN] Time-To-Live value.
Table 4.14: IP_SetDefaultTTL() parameter list
Description
By default the default TTL is 64. The TTL field length of the IP is 8 bits. The maximum value of the TTL field is therefore 255.
55
4.2.14 IP_SetHWAddr()
Description
Sets the media access control address (MAC) of an interface.
Prototype
void IP_SetHWAddr( const U8 * pHWAddr );
Parameter
Parameter pHWAddr [IN] 6-byte MAC address.
Table 4.15: IP_SetHWAddr() parameter list
Description
The MAC address needs to be unique for production units.
Example
IP_SetHWAddr("\x00\x22\x33\x44\x55\x66");
56
CHAPTER 4
Core functions
4.2.15 IP_SetMTU()
Description
Allows to set the maximum transmission unit (MTU) of an interface.
Prototype
void IP_SetMTU( U8 IFace, U32 Mtu );
Parameter
Parameter IFace Mtu Description [IN] Zero-based index of available network interfaces. [IN] Size of maximum transmission unit in bytes.
Table 4.16: IP_SetMTU() parameter list
The MTU is the MTU from an IP standpoint, so the size of the IP-packet without local net header. A typical value for ethernet is 1500, since the maximum size of an Ethernet packet is 1518 bytes. Since Ethernet uses 12 bytes for MAC addresses, 2 bytes for type and 4 bytes for CRC, 1500 bytes "payload" remain. The minimum size of the MTU is 576 according to RFC 879. Refer to [RFC 879] - TCP - The TCP Maximum Segment Size and Related Topics for more information about the MTU. A smaller MTU size is effective for TCP connections only, it does not affect UDP connections. All TCP connections are guaranteed to work with any MTU in the permitted range of 576 - 1500 bytes. The advantage of a smaller MTU is that smaller packets are sent in TCP communication, resulting in reduced RAM requirements especially if the window size is also reduced. The disadvantage is a loss of communication speed.
57
4.2.16 IP_SetSupportedDuplexModes()
Description
Allows to set the allowed Duplex modes.
Prototype
int IP_SetSupportedDuplexModes( unsigned Unit, unsigned DuplexMode);
Parameter
Parameter Unit DuplexMode Description [IN] Zero-based index of available network interfaces. [IN] OR-combination of one or more of the following valid values.
Table 4.17: IP_SetSupportedDuplexModes() parameter list
Valid values for parameter DuplexMode

Value IP_PHY_MODE_10_HALF IP_PHY_MODE_10_FULL IP_PHY_MODE_100_HALF IP_PHY_MODE_100_FULL Support Support Support Support Description 10 Mbit half-duplex 10 Mbit full-duplex 100 Mbit half-duplex 100 Mbit full-duplex
58
CHAPTER 4
Core functions
4.2.17 IP_SOCKET_SetDefaultOptions()
Description
Allows to set the maximum transmission unit (MTU) of an interface.
Prototype
void IP_SOCKET_SetDefaultOptions ( U16 v );
Parameter
Parameter v Description [IN] Socket options which should be enabled. By default, keepalive (SO_KEEPALIVE) socket option is enabled. Refer to setsockopt() on page 102 for a list of supported socket options.
Table 4.18: IP_SetDefaultOptions() parameter list
59
4.2.18 IP_SOCKET_SetLimit()
Description
Sets the maximum number of available sockets.
Prototype
void IP_SOCKET_SetLimit ( unsigned Limit );
Parameter
Parameter Limit Description [IN] Sets a limit on number of sockets which can be created. The embOS/IP default is 0 which means that no limit is set.
Table 4.19: IP_SetLimit() parameter list
60
CHAPTER 4
Core functions
4.2.19 IP_TCP_Set2MSLDelay()
Description
Sets the maximum segment lifetime (MSL).
Prototype
void IP_TCP_Set2MSLDelay( unsigned v );
Parameter
Parameter v Description [IN] Maximum segment lifetime. The embOS/IP default is 2 seconds.
Table 4.20: IP_Set2MSLDelay() parameter list
The maximum segment lifetime is the amount of time any segment can exist in the network before being discarded. This time limit is constricted. When TCP performs an active close the connection must stay in TIME_WAIT (2MSL) state for twice the MSL after sending the final ACK. Refer to [RFC 793] - TCP - Transmission Control Protocol for more information about TCP states.
61
4.2.20 IP_TCP_SetConnKeepaliveOpt()
Description
Sets the keepalive options.
Prototype
void IP_TCP_SetConnKeepaliveOpt( U32 U32 U32 U32 Init, Idle, Period, MaxRep );
Parameter
Parameter Init Idle Period MaxRep Description [IN] Maximum time for TCP-connection open (response to SYN) in ms. The embOS/IP default is 20 seconds. [IN] Time of TCP-inactivity before first keepalive probe is sent in ms. The embOS/IP default is 60 seconds. [IN] Time of TCP-inactivity between keepalive probes in ms. The embOS/IP default is 10 seconds. [IN] Number of keepalive probes before we give up and close the connection. The embOS/IP default is 8 repetitions.
Table 4.21: IP_TCP_SetConnKeepaliveOpt() parameter list
Keepalives are not part of the TCP specification, since they can cause good connections to be dropped during transient failures. For example, if the keepalive probes are sent during the time that an intermediate router has crashed and is rebooting, TCP will think that the client's host has crashed, which is not what has happened. Nevertheless, the keepalive feature is very useful for embedded server applications that might tie up resources on behalf of a client, and want to know if the client host crashes.
62
CHAPTER 4
Core functions
4.2.21 IP_TCP_SetRetransDelayRange()
Description
Sets the retransmission delay range.
Prototype
void IP_TCP_SetRetransDelayRange( unsigned RetransDelayMin, unsigned RetransDelayMax );
Parameter
Parameter Init Idle Description [IN] Minimum time before first retransmission. The embOS/IP default is 200 ms. [IN] Maximum time to wait before a retransmission. The embOS/IP default is 5 seconds.
Table 4.22: IP_TCP_SetRetransDelayRange() parameter list
TCP is a reliable transport layer. One of the ways it provides reliability is for each end to acknowledge the data it receives from the communication partner. But data segments and acknowledgments can get lost. TCP handles this by setting a timeout when it sends data, and if the data is not acknowledged when the timeout expires, it retransmits the data. The timeout and retransmission is the measurement of the round-trip time (RTT) experienced on a given connection. The RTT can change over time, as routes might change and as network traffic changes, and TCP should track these changes and modify its timeout accordingly. IP_TCP_SetRetransDelayRange() should be called if the default limits are not sufficient for your application.
63
4.3
4.3.1
Management functions
IP_Init()
Description
Initializes the TCP/IP stack.
Prototype
void IP_Init ( void );
IP_Init() initializes the IP stack and creates resources required for an OS integration. This function must be called before any other embOS/IP function is called.
Example
#include "IP.h" void main(void) { IP_Init(); /* * Use the stack */ }
64
CHAPTER 4
Core functions
4.3.2
IP_Task()
Description
Main task for starting the stack. After startup, it settles into a loop handling received packets. This loop sleeps until a packet has been queued in the receive queue; then it should be awakened by the driver which queued the packet.
Prototype
void IP_Task ( void );
Implementing this task is the simplest way to include embOS/IP into your project. Typical stack usage is approximately 440 bytes. To be on the safe side set the size of the task stack to 1024 bytes. Note: The priority of task IP_Task should be higher then the priority of an application task which uses the stack.
Example
#include <stdio.h> #include #include #include #include static static static static "RTOS.h" "BSP.h" "IP.h" "IP_Int.h" // // // // Task stacks Task-control-blocks Task stacks Task-control-blocks
OS_STACKPTR int _Stack0[512]; OS_TASK _TCB0; OS_STACKPTR int _IPStack[1024]; OS_TASK _IPTCB;
/********************************************************************* * * MainTask */ void MainTask(void); void MainTask(void) { printf("****************************************\nProgram start\n"); IP_Init(); OS_SetPriority(OS_GetTaskID(), 255); // This task has highest prio! OS_CREATETASK(&_IPTCB, "IP_Task", IP_Task, 150, _IPStack); while (1) { BSP_ToggleLED(1); OS_Delay (200); } } /********************************************************** * * main */ void main(void) { BSP_Init(); BSP_SetLED(0); OS_IncDI(); /* Initially disable interrupts */ OS_InitKern(); /* initialize OS */ OS_InitHW(); /* initialize Hardware for OS */ OS_CREATETASK(&_TCB0, "MainTask", MainTask, 100, _Stack0); OS_Start(); }
65
4.3.3
IP_RxTask()
Description
The task reads all available packets from the network interface and sleeps until a new packet is received.
Prototype
void IP_RxTask ( void );
This task is optional. Refer to Tasks and interrupt usage on page 17 for detailed information about the task and interrupt handling of embOS/IP. Typical stack usage is approximately 150 bytes. To be on the safe side set the size of the task stack to 1024 bytes. Note: The priority of task IP_RxTask() should be higher then the priority of an application task which uses the stack.
66
CHAPTER 4
Core functions
4.3.4
IP_Exec()
Description
Checks if the driver has received a packet and handles timers.
Prototype
void IP_Exec ( void );
This function is normally called from an endless loop in IP_Task(). If no particular IP task is implemented in your project, IP_Exec() should be called regularly.
67
4.4
4.4.1
Other IP stack functions

IP_GetAddrMask()
Description
Returns the IP address and the subnet mask of the device in network byte order (for example, 192.168.1.1 is returned as 0xc0a80101).
Prototype
void IP_GetAddrMask ( U8 IFace, U32 * pAddr, U32 * pMask );
Parameter
Parameter IFace pAddr pMask Description [IN] Interface. [OUT] Address to store the IP address. [OUT] Address to store the subnet mask.
Table 4.23: IP_GetAddrMask() parameter list
68
CHAPTER 4
Core functions
4.4.2
IP_GetCurrentLinkSpeed()
Description
Returns the current link speed.
Prototype
int IP_GetCurrentLinkSpeed( void );
Return value
0: 1: 2: 3: link link link link speed speed speed speed unknown is 10 Mbit/s is 100 Mbit/s is 1000 Mbit/s
The application should check if the link is up before a packet will be sent. It can take 2-3 seconds till the link is up if the PHY has been reset.
Example
// // Wait until link is up. // while (IP_GetCurrentLinkSpeed() == 0) { OS_IP_Delay(100); }
69
4.4.3
IP_GetGWAddr()
Description
Returns the gateway address of the interface in network byte order (for example, 192.168.1.1 is returned as 0xc0a80101).
Prototype
U32 IP_GetGWAddr ( U8 IFace );
Parameter
Parameter IFace [IN] Number of interface.
Table 4.24: IP_GetGWAddr() parameter list
Description
Return value
The gateway address of the interface.
70
CHAPTER 4
Core functions
4.4.4
IP_GetHWAddr()
Description
Returns the hardware address (Media Access Control address) of the interface.
Prototype
void IP_GetHWAddr ( U8 IFace, U8 * pDest, unsigned Len );
Parameter
Parameter IFace pDest Len Description [IN] Number of interface. [OUT] Address of the buffer to store the 48-bit MAC address. [IN] Size of the buffer. Should be at least 6-bytes.
Table 4.25: IP_GetHWAddr() parameter list
71
4.4.5
IP_GetIPAddr()
Description
Returns the IP address of the interface.
Prototype
U32 IP_GetIPAddr( U8 IFace );
Parameter
Parameter IFace [IN] Number of interface.
Table 4.26: IP_GetIPAddr() parameter list
Description
Return value
The IP address of the interface in network byte order (for example, 192.168.1.1 is returned as 0xc0a80101).
Example
void PrintIFaceIPAddr(void) { char ac[16]; U32 IPAddr; IPAddr = IP_GetIPAddr(0); IP_PrintIPAddr(ac, IPAddr, sizeof(ac)); printf("IP Addr: %s\n", ac); }
72
CHAPTER 4
Core functions
4.4.6
IP_GetIPPacketInfo()
Description
Returns the start address of the data part of an IP packet.
Prototype
const char * IP_GetIPPacketInfo( IP_PACKET * pPacket );
Parameter
Parameter pPacket
Table 4.27: IP_GetIPPacketInfo() parameter list
Description [IN] Pointer to an IP_PACKET structure.
Return value
0 > Start address of the data part of the IP packet. 0 On failure.
Example
/********************************************************************* * * _pfOnRxICMP */ static int _pfOnRxICMP(IP_PACKET * pPacket) { const char * pData; pData = IP_GetIPPacketInfo(pPacket); if(*pData == 0x08) { printf("ICMP echo request received!\n"); } if(*pData == 0x00) { printf("ICMP echo reply received!\n"); } return 0; }
73
4.4.7
IP_GetVersion()
Description
Returns the version number of the stack.
Prototype
int IP_GetVersion ( void );
The format of the version number: <Major><Minor><Minor><Revision><Revision>. For example, the return value 10201 means version 1.02a.
74
CHAPTER 4
Core functions
4.4.8
IP_ICMP_SetRxHook()
Description
Sets a hook function which will be called if target receives a ping packet.
Prototype
void IP_ICMP_SetRxHook(IP_RX_HOOK * pf);
Parameter
Parameter pf
Table 4.28: IP_ICMP_SetRxHook() parameter list
Description Pointer to the callback function of type IP_RX_HOOK.
The return value of the callback function is relevant for the further processing of the ICMP packet. A return value of 0 indicates that the stack has to process the packet after the callback has returned. A return value of 1 indicates that the packet will be freed directly after the callback has returned. The prototype for the callback function is defined as follows: typedef int (IP_RX_HOOK)(IP_PACKET * pPacket);
Example
/********************************************************************* * * Local defines, configurable * ********************************************************************** */ #define HOST_TO_PING 0xC0A80101 /********************************************************************* * * _pfOnRxICMP */ static int _pfOnRxICMP(IP_PACKET * pPacket) { const char * pData; pData = IP_GetIPPacketInfo(pPacket); if(*pData == 0x08) { printf("ICMP echo request received!\n"); } if(*pData == 0x00) { printf("ICMP echo reply received!\n"); } return 0; // Give packet back to the stack for further processing. } /********************************************************************* * * PingTask */ void PingTask(void) { int Seq; char * s = "This is a ICMP echo request!"; while (IP_IFaceIsReady() == 0) { OS_Delay(50); } IP_ICMP_SetRxHook(_pfOnRxICMP); Seq = 1111; while (1) { BSP_ToggleLED(1); OS_Delay (200); IP_SendPing(htonl(HOST_TO_PING), s, strlen(s), Seq++); } }
75
4.4.9
IP_IFaceIsReady()
Description
Checks if the interface is ready for usage.
Prototype
int IP_IFaceIsReady ( void );
Return value
1 network interface is ready. 0 network interface is not ready.
The application has to check if the link is up before a packet will be sent and if the interface is configured. If a DHCP server is used for configuring your target, this function has to be called to assure that no application data will be sent before the target is ready.
Example
// // Wait until interface is ready. // while (IP_IFaceIsReady() == 0) { OS_Delay(100); }
76
CHAPTER 4
Core functions
4.4.10 IP_PrintIPAddr()
Description
Convert an 4-byte IP address to a dots-and-number string.
Prototype
int IP_PrintIPAddr( char * pDest, U32 IPAddr, int BufferSize );
Parameter
Parameter pDest IPAddr Buffersize Description [OUT] Buffer to store the IP address string. [IN] IP address in network byte order. [IN] Size of buffer pDest. Should be 16 byte to store an IPv4 address.
Table 4.29: IP_PrintIPAddr() parameter list
Return value
0 on error. Size of the buffer is too small. >0 on success. Length of the IP address string.
Example
void PrintIPAddr(void) { U32 IPAddr; char ac[16]; IPAddr = 0xC0A80801; // IP address: 192.168.8.1 IP_PrintIPAddr(ac, IPAddr, sizeof(ac)); printf("IP address: %s\n", ac); // Output: IP address: 192.168.8.1 }
77
4.4.11 IP_SendPacket()
Description
Sends a user defined packet on the interface. The packet will not be modified by the stack. IP_SendPacket() allocates a packet control block (IP_PACKET) and adds it to the Out queue of the interface.
Prototype
int IP_SendPacket( unsigned IFace, void * pData, int NumBytes );
Parameter
Parameter IFace pData Numbytes Description [IN] Zero-based interface index. [IN] Data packet that should be sent. [IN] Length of data which should be sent.
Table 4.30: IP_SendPacket() parameter list
Return value
0 -1 1 O.K., packet in out queue Error: Could not alloc packet control block Error: Interface can not send
78
CHAPTER 4
Core functions
4.4.12 IP_SendPing()
Description
Sends a single ping (ICMP echo request) to the specified host.
Prototype
int IP_SendPing ( ip_addr host, char * data, unsigned datalen, U16 pingseq );
Parameter
Parameter host data datalen pingseq [IN] [IN] [IN] [IN] Description 4-byte IPv4 address in network endian byte order. Ping data, NULL if do not care. Length of data to attach to ping request. Ping sequence number.
Table 4.31: IP_SendPing() parameter list
Return value
Returns 0 if ICMP echo request was successfully sent, else negative error message.
If you call this function with activated logging, the ICMP reply or (in case of an error) the error message will be sent to stdout. To enable the output of ICMP status messages, add the message type IP_MTYPE_ICMP to the log filter and the warn filter. Refer to Debugging on page 281 for detailed information about logging.
79
4.4.13 IP_SetRxHook()
Description
Sets a hook function which will be called if target receives a packet.
Prototype
void IP_SetRxHook(IP_RX_HOOK * pf);
Parameter
Parameter pf
Table 4.32: IP_SetRxHook() parameter list
Description Pointer to the callback function of type IP_RX_HOOK.
The return value of the callback function is relevant for the further processing of the packet. A return value of 0 indicates that the stack has to process the packet after the callback has returned. A return value of >0 indicates that the packet will be freed directly after the callback has returned. The prototype for the callback function is defined as follows: typedef int (IP_RX_HOOK)(IP_PACKET * pPacket);
Example
Refer to IP_ICMP_SetRxHook() on page 74 for an example.
80
CHAPTER 4
Core functions
4.5 Stack internal functions, variables and data-structures

embOS/IP internal functions, variables and data-structures are not explained here as they are in no way required to use embOS/IP. Your application should not rely on any of the internal elements, as only the documented API functions are guaranteed to remain unchanged in future versions of embOS/IP.
81
Chapter 5 Socket interface
The embOS/IP socket API is almost compatible to the Berkeley socket interface. The Berkeley socket interface is the de facto standard for socket communication. All API functions are described in this chapter.
82
CHAPTER 5
Socket interface
5.1
API functions
The table below lists the available socket API functions. Function accept() bind() closesocket() connect() gethostbyname() getpeername() getsockname() getsockopt() listen() recv() recvfrom() select() send() sendto() setsockopt() shutdown() socket() Description Socket interface Accepts an incoming attempt on a socket. Assigns a name to an unnamed socket. Closes an existing socket. Establishes a connection to a socket. Resolves a host name into an IP address. Returns the IP addressing information of the connected host. Returns the current name for the specified socket. Returns the socket options. Marks a socket as accepting connections. Receives data from a connected socket. Receives a datagram and stores the source address. Checks if socket is ready. Sends data on a connected socket. Sends data to a specified address. Sets a socket option. Disables sends or receives on a socket. Creates an unbound socket. Helper macros Converts a unsigned long value from network to host byte order. Converts a unsigned long value from host byte order to network byte order. Converts a unsigned short value from host byte order to network byte order. Converts a unsigned short value from network to host byte order.
ntohl htonl htons ntohs
Table 5.1: embOS/IP socket API function overview
83
5.1.1
accept()
Description
Accepts an incoming attempt on a socket.
Prototype
long accept ( long Socket, struct sockaddr * pAddr, int * pAddrLen );
Parameter
Parameter Socket pAddr Description [IN] A descriptor identifying a socket. [OUT] An optional pointer to a buffer where the address of the connecting entity should be stored. The format of the address depends on the defined address family which was defined when the socket was created. [OUT] An optional pointer to an integer where the length of the received address should be stored. Just like the format of the address, the length of the address depends on the defined address family.
pAddrLen
Table 5.2: accept() parameter list
Return value
The returned value is a handle for the socket on which the actual connection will be made. -1 in case of an error.
This call is used with connection-based socket types, currently with SOCK_STREAM. Refer to socket() on page 105 for more information about the different socket types. Before calling accept(), the used socket Socket has to be bound to an address with bind() and should be listening for connections after calling listen(). accept() extracts the first connection on the queue of pending connections, creates a new socket with the same properties of Socket and allocates a new file descriptor for the socket. If no pending connections are present on the queue, and the socket is not marked as non-blocking, accept() blocks the caller until a connection is present. If the socket is marked non-blocking and no pending connections are present on the queue, accept() returns and reports an error. The accepted socket is used to read and write data to and from the socket which is connected to this one; it is not used to accept more connections. The original socket Socket remains open for accepting further connections. The argument pAddr is a result parameter that is filled in with the address of the connecting entity as known to the communications layer. The exact format of the pAddr parameter is determined by the domain in which the communication is occurring. The pAddrLen is a value-result parameter. It should initially contain the amount of space pointed to by pAddr.
84
CHAPTER 5
Socket interface
5.1.2
bind()
Description
Assigns a name (port) to an unnamed socket.
Prototype
int bind ( long Socket, struct sockaddr * pAddr, int AddrLen );
Parameter
Parameter Socket pAddr AddrLen Description [IN] A descriptor identifying a socket. [IN] A pointer to a buffer where the address of the connecting entity is stored. The format of the address depends on the defined address family which was defined when the socket was created. [IN] The length of the address.
Table 5.3: bind() parameter list
Return value
0 on success. -1 on failure.
When a socket is created with socket() it exists in a name space (address family) but has no name assigned. bind() is used on an unconnected socket before subsequent calls to the connect() or listen() functions. bind() assigns the name pointed to by pAddr to the socket.
85
5.1.3
closesocket()
Description
Closes an existing socket.
Prototype
int closesocket ( long Socket );
Parameter
Parameter Socket
Table 5.4: closesocket() parameter list
Description [IN] Socket descriptor of the socket that should be closed.
Return value
closesocket() closes a connection on the socket associated with Socket and the socket descriptor associated with Socket will be returned to the free socket descriptor pool. Once a socket is closed, no further socket calls should be made with it. If the socket promises reliable delivery of data and SO_LINGER is set, the system will block the caller on the closesocket() attempt until it is able to transmit the data or until it decides it is unable to deliver the information (a timeout period, termed the linger interval, is specified in the setsockopt() call when SO_LINGER is requested). If SO_LINGER is disabled and a closesocket() is issued, the system will process the close in a manner that allows the caller to continue as quickly as possible. If SO_LINGER is enabled with a timeout period of 0 and a closesocket() is issued, the system will perform a hard close.
Example
/********************************************************************* * * _CloseSocketGracefully() * * Function description * Wrapper for closesocket() with linger enabled to verify a gracefully * disconnect. */ static int _CloseSocketGracefully(long pConnectionInfo) { struct linger Linger; Linger.l_onoff = 1; // Enable linger for this socket. Linger.l_linger = 1; // Linger timeout in seconds setsockopt(hSocket, SOL_SOCKET, SO_LINGER, &Linger, sizeof(Linger)); return closesocket(hSocket); } /********************************************************************* * * _CloseSocketHard() * * Function description * Wrapper for closesocket() with linger option enabled to perform a hard close. */ static int _CloseSocketHard(long hSocket) { struct linger Linger; Linger.l_onoff = 1; // Enable linger for this socket. Linger.l_linger = 0; // Linger timeout in seconds setsockopt(hSocket, SOL_SOCKET, SO_LINGER, &Linger, sizeof(Linger)); return closesocket(hSocket); }
86
CHAPTER 5
Socket interface
5.1.4
connect()
Description
Establishes a connection to a socket.
Prototype
int connect ( long Socket, struct sockaddr * pAddr, int AddrLen );
Parameter
Parameter Socket pAddr Description [IN] A descriptor identifying an unconnected socket. [IN] A pointer to a buffer where the address of the connecting entity is stored. The format of the address depends on the defined address family which was defined when the socket was created. [IN] A pointer to an integer where the length of the received address is stored. Just like the format of the address, the length of the address depends on the defined address family.
AddrLen
Table 5.5: connect() parameter list
Return value
If Socket is of type SOCK_DGRAM, then this call specifies the peer with which the socket is to be associated. pAddr defines the address to which datagrams are sent and the only address from which datagrams are received. If Socket is of type SOCK_STREAM, then this call attempts to make a connection to another socket. The other socket is specified by pAddr which is an address in the communications space of the socket. Each communications space interprets the pAddr parameter in its own way. Generally, stream sockets may successfully connect() only once; datagram sockets may use connect() multiple times to change their association. Datagram sockets may dissolve the association by connecting to an invalid address, such as a NULL address.
Example
#define SERVER_PORT #define SERVER_IP_ADDR 1234 0xC0A80101 // 192.168.1.1
/********************************************************************* * * _TCPClientTask * * Function description * Creates a connection to a given IP address, TCP port. */ static void _TCPClientTask(void) { int TCPSockID; struct sockaddr_in ServerAddr; int ConnectStatus; // // Wait until link is up. This can take 2-3 seconds if PHY has been reset. // while (IP_GetCurrentLinkSpeed() == 0) { OS_Delay(100); UM07001 - embOS/IP User Guide 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
87 } while(1) { TCPSockID = socket(AF_INET, SOCK_STREAM, 0); // Open socket if (TCPSockID < 0) { // Error, Could not get socket while (1) { OS_Delay(20); } } else { // // Connect to server // ServerAddr.sin_family = AF_INET; ServerAddr.sin_port = htons(SERVER_PORT); ServerAddr.sin_addr.s_addr = htonl(SERVER_IP_ADDR); ConnectStatus = connect(TCPSockID, (struct sockaddr *)&ServerAddr, sizeof(struct sockaddr_in)); if (ConnectStatus == 0) { // // Do something... // } } closesocket(TCPSockID); OS_Delay(50); } }
88
CHAPTER 5
Socket interface
5.1.5
gethostbyname()
Description
Resolve a host name into an IP address.
Prototype
struct hostent * gethostbyname (char * name);
Parameter
Parameter name [OUT] Host name.
Table 5.6: gethostbyname() parameter list
Description
Return value
On success, a pointer to a hostent structure is returned. Refer to Structure hostent on page 110 for detailed information about the hostent structure. On failure, it returns NULL.
The function is called with a string containing the host name to be resolved as a fullyqualified domain name (for example, myhost.mydomain.com).
Example
static void _DNSClient() { struct hostent *pHostEnt; char **ps; char **ppAddr; // // Wait until link is up. // while (IP_IFaceIsReady() == 0) { OS_Delay(100); } while(1) { pHostEnt = gethostbyname("www.segger.com"); if (pHostEnt == NULL) { printf("Could not resolve host addr.\n"); break; } printf("h_name: %s\n", pHostEnt->h_name); // // Show aliases // ps = pHostEnt->h_aliases; for (;;) { char * s; s = *ps++; if (s == NULL) { break; } printf("h_aliases: %s\n", s); } // // Show IP addresses // ppAddr = pHostEnt->h_addr_list; for (;;) { U32 IPAddr; char * pAddr; char ac[16]; pAddr = *ppAddr++; if (pAddr == NULL) { break; }
89 IPAddr = *(U32*)pAddr; IP_PrintIPAddr(ac, IPAddr, sizeof(ac)); printf("IP Addr: %s\n", ac); } } }
90
CHAPTER 5
Socket interface
5.1.6
getpeername()
Description
Fills the passed structure sockaddr with the IP addressing information of the connected host.
Prototype
int getpeername ( long Socket, struct sockaddr * pAddr, struct int * pAddrLen );
Parameter
Parameter Socket pAddr pAddrLen Description [IN] A descriptor identifying a socket. [OUT] A pointer to a structure of type sockaddr in which the IP address information of the connected host should be stored. [OUT] A pointer to an integer to store the length of socket address.
Table 5.7: getpeername() parameter list
Return value
Refer to Structure sockaddr on page 107 for detailed information about the structure sockaddr.
91
5.1.7
getsockname()
Description
Returns the current name for the specified socket.
Prototype
int getsockname ( long Socket, struct sockaddr * pAddr );
Parameter
Parameter Socket pAddr Description [IN] A descriptor identifying a socket. [OUT] A pointer to a structure of type sockaddr in which the IP address information of the connected host should be stored.
Table 5.8: getsockname() parameter list
Return value
Refer to Structure sockaddr on page 107 for detailed information about the structure sockaddr.
92
CHAPTER 5
Socket interface
5.1.8
getsockopt()
Description
Returns the options associated with a socket.
Prototype
int getsockopt ( long Socket, int Level, int Option, void * pData, int DataLen );
Parameter
Parameter Socket Level Option pData DataLen Description [IN] A descriptor identifying a socket. [IN] Compatibility parameter for setsockopt() and getsockopt(). Use symbol SOL_SOCKET. [IN] The socket option which should be retrieved. [OUT] A pointer to the buffer in which the value of the requested option should be stored. [IN] The size of the data buffer.
Table 5.9: getsockopt() parameter list
Valid values for parameter Option

Value Description Standard option flags. SO_ACCEPTCONN Indicates that socket is in listen mode. Indicates that outgoing messages must bypass the standard routing facilities. Instead, messages are directed to the appropriate network interface according to the network portion of the destination address. Indicates that the periodic transmission of messages on a connected socket is enabled. If the connected party fails to respond to these messages, the connection is considered broken. Indicates that linger on close is enabled. Indicates that suppress slow start on this socket is enabled. Indicates that the TCP timestamp option is enabled. embOS/IP socket options. SO_ERROR SO_MYADDR SO_RCVTIMEO Stores the latest socket error in pData and clears the error in socket structure. Stores the IP address of the used interface in pData. Returns the timeout for recv(). A return value of 0 indicates that no timeout is set. Gets sockets blocking status. Allows the caller to specify blocking or non-blocking IO that works the same as the other Boolean socket options. pData points to an integer value which will contain a non-zero value to set non-blocking IO or a 0 value to reset non-blocking IO.
SO_DONTROUTE
SO_KEEPALIVE SO_LINGER SO_NOSLOWSTART SO_TIMESTAMP
SO_NONBLOCK
93
Return value
getsockopt() retrieves the current value for a socket option associated with a socket of any type, in any state, and stores the result in pData. Options can exist at multiple protocol levels, but they are always present at the uppermost socket level. Options affect socket operations, such as the packet routing. The value associated with the selected option is returned in the buffer pData. The integer pointed to by DataLen should originally contain the size of this buffer; on return, it will be set to the size of the value returned. For SO_LINGER, this will be the size of a LINGER structure. For most other options, it will be the size of an integer. The application is responsible for allocating any memory space pointed to directly or indirectly by any of the parameters it specified. If the option was never set with setsockopt(), then getsockopt() returns the default value for the option. The option SO_ERROR returns 0 or number of the socket error and clears the socket error. The following table lists the socket errors. Symbolic name ENOBUFS ETIMEDOUT EISCONN EOPNOTSUPP ECONNABORTED EWOULDBLOCK ECONNREFUSED ECONNRESET ENOTCONN EALREADY EINVAL EMSGSIZE EPIPE EDESTADDRREQ ESHUTDOWN ENOPROTOOPT ENOMEM EADDRNOTAVAIL EADDRINUSE EAFNOSUPPORT EINPROGRESS ELOWER ENOTSOCK 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 18 19 20 21 22 23 24 Value Description No internal buffer was available. Connection timed out. Socket is already connected. Operation not supported. Connection aborted. Operation on non-blocking socket could not be completed immediately. Connection refused. Peer resets connection. Socket is not connected. Operation was attempted on a non-blocking socket with an operation already in progress. Invalid argument was supplied. The message which should be sent on a datagram socket was larger than the internal message buffer or some other network limit. Connection error. A required address was omitted from an operation on a socket. Cannot send after socket shutdown. Bad protocol option. Not enough memory available. Cannot assign requested address. Address already in use. Protocol family not supported. A blocking operation is currently executing. Operation is in progress. Socket operation on non-socket.
Table 5.10: embOS/IP socket error types
94
CHAPTER 5
Socket interface
Symbolic name ETOOMANYREFS EFAULT ENETUNREACH
Value 28 29 30
Description Multicast error. Bad address. Network is unreachable.
Table 5.10: embOS/IP socket error types
95
5.1.9
listen()
Description
Prepares the socket to accept connections.
Prototype
int listen ( long Socket, int Backlog );
Parameter
Parameter Socket Backlog Description [IN] Socket descriptor of an unconnected socket. [IN] Backlog for incoming connections. Defines the maximum length of the queue of pending connections.
Table 5.11: listen() parameter list
Return value
On success 0. On failure, it returns -1.
The listen() call applies only to sockets of type SOCK_STREAM. If a connection request arrives when the queue is full, the client will receive an error with an indication of ECONNREFUSED.
Example
/********************************************************************* * * _ListenAtTcpAddr * * Function description * Starts listening at the given TCP port. */ static int _ListenAtTcpAddr(U16 Port) { int Sock; struct sockaddr_in Addr; sock = socket(AF_INET, SOCK_STREAM, 0); memset(&Addr, 0, sizeof(Addr)); addr.sin_family = AF_INET; addr.sin_port = htons(Port); addr.sin_addr.s_addr = INADDR_ANY; bind(sock, (struct sockaddr *)&Addr, sizeof(Addr)); listen(Sock, 1); return Sock; }
96
CHAPTER 5
Socket interface
5.1.10 recv()
Description
Receives data from a connected socket.
Prototype
int recv ( long Socket, char * pRecv, int Length, int Flags );
Parameter
Parameter Socket pRecv Length Flags Description [IN] A descriptor identifying a socket. [OUT] A pointer to a buffer for incoming data. [IN] The length of buffer pRecv in bytes. [IN] OR-combination of one or more of the following valid values.
Table 5.12: recv() parameter list
Valid values for parameter Flag

Value MSG_PEEK Description Peek at the data present on the socket; the data are returned, but not consumed, so that a subsequent receive operation will see the same data.
Return value
If no error occurs, recv() returns the number of bytes received. If the connection has been gracefully closed, the return value is zero. Otherwise, -1 is returned, and a specific error code can be retrieved by calling getsockopt(). Refer to getsockopt() on page 92 for detailed information.
If a message is too long to fit in the supplied buffer, excess bytes may be discarded depending on the type of socket the message is received from. Refer to connect() on page 86 for more information about the different types of sockets. You can only use the recv() function on a connected socket. To receive data on a socket, whether it is in a connected state or not refer to recvfrom() on page 97. If no messages are available at the socket and the socket is blocking, the receive call waits for a message to arrive. If the socket is non-blocking (refer to setsockopt() on page 102 for more information), 1 is returned. You can use the select() function to determine when more data arrives.
97
5.1.11 recvfrom()
Description
Receives a datagram and stores the source address.
Prototype
int recvfrom ( long char * int int struct sockaddr * int * Socket, pRecv, Length, Flags, pAddr, pAddrLen );
Parameter
Parameter Socket pRecv Length Flags Description [IN] A socket descriptor of a socket. [OUT] A pointer to a buffer for incoming data. [IN] Specifies the size of the buffer pRecv in bytes. [IN] OR-combination of one or more of the values listed in the table below. [OUT] An optional pointer to a buffer where the address of the connecting entity is stored. The format of the address depends on the defined address family which was defined when the socket was created. [IN/OUT] An optional pointer to an integer where the length of the received address is stored. Just like the format of the address, the length of the address depends on the defined address family.
pAddr
pAddrLen
Table 5.13: recvfrom() parameter list
Valid values for parameter Flags

Value MSG_PEEK Description Peek at the data present on the socket; the data are returned, but not consumed, so that a subsequent receive operation will see the same data.
Return value
The number of bytes received or -1 if an error occurred.
If pAddr is not a NULL pointer, the source address of the message is filled in. pAddrLen is a value-result parameter, initialized to the size of the buffer associated with pAddr, and modified on return to indicate the actual size of the address stored there. If a message is too long to fit in the supplied buffer, excess bytes may be discarded depending on the type of socket the message is received from. Refer to socket() on page 105 for more information about the different types of sockets. If no messages are available at the socket and the socket is blocking, the receive call waits for a message to arrive. If the socket is non-blocking (refer to setsockopt() on page 102 for more information), 1 is returned. You can use the select() function to determine when more data arrives.
98
CHAPTER 5
Socket interface
5.1.12 select()
Description
Examines the socket descriptor sets whose addresses are passed in readfds, writefds, and exceptfds to see if some of their descriptors are ready for reading, ready for writing or have an exception condition pending.
Prototype
int select ( IP_FD_set * readfds, IP_FD_set * writefds, IP_FD_set * exceptfds; long tv );
Parameter
Parameter readfds writefds exceptfds tv Description
See below.
Table 5.14: select() parameter list
Return value
Returns a non-negative value on success. A positive value indicates the number of ready descriptors in the descriptor sets. 0 indicates that the time limit specified by tv expired. On failure, select() returns -1 and the descriptor sets are not changed.
On return, select() replaces the given descriptor sets with subsets consisting of those descriptors that are ready for the requested operation. The total number of ready descriptors in all the sets is returned. Any of readfds, writefds, and exceptfds may be given as NULL pointers if no descriptors are of interest. Selecting true for reading on a socket descriptor upon which a listen() call has been performed indicates that a subsequent accept() call on that descriptor will not block. In the standard Berkeley UNIX Sockets API, the descriptor sets are stored as bit fields in arrays of integers. This works in the UNIX environment because under UNIX socket descriptors are file system descriptors which are guaranteed to be small integers that can be used as indexes into the bit fields. In embOS/IP, socket descriptors are pointers and thus a bit field representation of the descriptor sets is not feasible. Because of this, the embOS/IP API differs from the Berkeley standard in that the descriptor sets are represented as instances of the following structure:
typedef struct IP_FD_SET { unsigned fd_count; long fd_array[FD_SETSIZE]; } IP_fd_set; // The select socket array manager // how many are SET? // an array of SOCKETs
Instead of a socket descriptor being represented in a descriptor set via an indexed bit, an embOS/IP socket descriptor is represented in a descriptor set by its presence in the fd_array field of the associated IP_FD_SET structure. Despite this non-standard representation of the descriptor sets themselves, the following standard entry points are provided for manipulating such descriptor sets: IP_FD_ZERO (&fdset) initializes a descriptor set fdset to the null set. IP_FD_SET(fd, &fdset) includes a particular descriptor, fd, in fdset. IP_FD_CLR(fd, &fdset) removes fd from fdset. IP_FD_ISSET(fd, &fdset) is nonzero if fd is a member of fdset, zero otherwise. These entry points behave according to the standard Berkeley semantics.
99
You should be aware that the value of FD_SETSIZE defines the maximum number of descriptors that can be represented in a single descriptor set. The default value of FD_SETSIZE is 2. This value can be increased in the source code version of embOS/IP to accommodate a larger maximum number of descriptors at the cost of increased processor stack usage. Another difference between the Berkeley and embOS/IP select() calls is the representation of the timeout parameter. Under Berkeley Sockets, the timeout parameter is represented by a pointer to a structure. Under embOS/IP sockets, a timeout is specified by the tv parameter, which defines the maximum number of seconds that should elapse before the call to select() returns. A tv parameter equal to 0 implies that select() should return immediately (effectively a poll of the sockets in the descriptor sets). Note that there is no provision for no timeout, that is, there is no way to specify that select() block forever unless one of its descriptors become ready. The final difference between the Berkeley and embOS/IP versions of select() is the absence in the embOS/IP version of the Berkeley width parameter. The width parameter is of use only when descriptor sets are represented as bit arrays and was thus deleted in the embOS/IP implementation. Note: Under rare circumstances, select() may indicate that a descriptor is ready for writing when in fact an attempt to write would block. This can happen if system resources necessary for a write are exhausted or otherwise unavailable. If an application deems it critical that writes to a file descriptor not block, it should set the descriptor for non-blocking I/O. Refer to setsockopt() on page 102 for detailed information.
Example
static void _Client() { int so, AddrLen, r; struct sockaddr_in Addr; struct sockaddr soAddr; IP_fd_set readfds; char RecvBuffer[128]; while (IP_IFaceIsReady() == 0) { OS_Delay(100); } so = socket(AF_INET, SOCK_DGRAM, 0); // Open socket Addr.sin_family = AF_INET; Addr.sin_port = htons(2222); Addr.sin_addr.s_addr = INADDR_ANY; bind(so, (struct sockaddr *)&Addr, sizeof(Addr)); AddrLen = sizeof(soAddr); while(1) { IP_FD_ZERO(&readfds); // Clear the set IP_FD_SET(so, &readfds); // Add descriptor to the set r = select(&readfds, NULL, NULL, 5000); // Check for activity. if (r <= 0) { continue; // No socket activity or error detected } if (IP_FD_ISSET(so, &readfds)) { r = recvfrom(so, RecvBuffer, sizeof(RecvBuffer), 0, &soAddr, &AddrLen); if (r == -1){ continue; } } OS_Delay(100); } }
100
CHAPTER 5
Socket interface
5.1.13 send()
Description
Sends data to a connected socket.
Prototype
int send ( long Socket, char * pSend, int Length, int Flags );
Parameter
Parameter Socket pSend Length Flags Description [IN] A descriptor identifying a socket. [IN] A pointer to a buffer of data which should be sent. [IN] The length of the message which should be sent. [IN] OR-combination of one or more of the valid values listed in the table below.
Table 5.15: send() parameter list

Value MSG_DONTROUTE Description Specifies that the data should not be subject to routing.
Return value
The total number of bytes which were sent or -1 if an error occurred.
send() may be used only when the socket is in a connected state. Refer to sendto() on page 101 for information about sending data to a non-connected socket. If no messages space is available at the socket to hold the message to be transmitted, then send() normally blocks, unless the socket has been placed in non-blocking I/O mode. MSG_DONTROUTE is usually used only by diagnostic or routing programs.
101
5.1.14 sendto()
Description
Sends data to a specified address.
Prototype
int sendto ( long Socket, char * pSend, int Length, int Flags, struct sockaddr * pAddr, int ToLen );
Parameter
Parameter Socket pSend Length Flags Description [IN] A descriptor identifying a socket. [IN] A pointer to a buffer of data which should be sent. [IN] The length of the message which should be sent. [IN] OR-combination of one or more of the valid values listed in the table below. [IN] An optional pointer to a buffer where the address of the connected entity is stored. The format of the address depends on the defined address family which was defined when the socket was created. [IN] The size of the address in pAddr.
pAddr ToLen
Table 5.16: sendto() parameter list

Value MSG_DONTROUTE Description Specifies that the data should not be subject to routing.
Return value
The total number of bytes which were sent or -1 if an error occurred.
In contrast to send(), sendto() can be used at any time. The connection state is in which case the address of the target is given by the pAddr parameter.
102
CHAPTER 5
Socket interface
5.1.15 setsockopt()
Description
Sets a socket option.
Prototype
int setsockopt ( long Socket, int Level, int Option, void * pData, int DataLen );
Parameter
Parameter Socket Level Option pData DataLen Description [IN] A descriptor identifying a socket. [IN] Compatibility parameter for setsockopt() and getsockopt(). Use symbol SOL_SOCKET. [IN] The socket option for which the value is to be set. [IN] A pointer to the buffer in which the value for the requested option is supplied. [IN] The size of the pData buffer.
Table 5.17: setsocketopt() parameter list
Valid values for parameter Option

Value Description Standard option flags. Outgoing messages should bypass the standard routing facilities. Instead, messages are directed to the appropriate network interface according to the network portion of the destination address. By default, this socket option is disabled. Enable periodic transmission of messages on a connected socket. If the connected party fails to respond to these messages, the connection is considered broken. By default, this socket option is enabled. Controls the action taken when unsent messages are queued on a socket and a closesocket() is performed. Refer to closesocket() on page 85 for detailed information about the linger option. By default, this socket option is disabled. Enable the TCP timestamp option. By default, this socket option is disabled. embOS/IP socket options. SO_CALLBACK Sets zero-copy callback routine. Refer to TCP zero-copy interface on page 113 for detailed information. Sets a timeout for recv(). This changes the behavior of recv(). recv() is by default a blocking function which only returns if data has been received. If a timeout is set recv() will return in case of data reception or timeout. By default, this socket option is disabled.
SO_DONTROUTE
SO_KEEPALIVE
SO_LINGER
SO_TIMESTAMP
SO_RCVTIMEO
103
Value
Description Sets socket blocking status. Allows the caller to specify blocking or non-blocking IO that works the same as the other Boolean socket options. pData points to an integer value which will contain a non-zero value to set non-blocking IO or a 0 value to reset non-blocking IO. By default, this socket option is disabled.
SO_NONBLOCK
Return value
0 on success
Example
void _EnableKeepAlive(long sock) { int v = 1; setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, &v, sizeof(v)); }
104
CHAPTER 5
Socket interface
5.1.16 shutdown()
Description
Disables sends or receives on a socket.
Prototype
int shutdown( long Socket, int Mode );
Parameter
Parameter Socket Mode Description [IN] A descriptor identifying a socket. [IN] Indicator which part of communication should be disabled. Refer to additional information below.
Table 5.18: shutdown() parameter list
Return value
Returns 0 on success. On failure, it returns -1.
A shutdown() call causes all or part of a full-duplex connection on the socket associated with Socket to be shut down. If Mode is 0, then further receives will be disallowed. If Mode is 1, then further sends will be disallowed. If Mode is 2, then further sends and receives will be disallowed. The shutdown function does not block regardless of the SO_LINGER setting on the socket.
105
5.1.17 socket()
Description
Creates a socket. A socket is an endpoint for communication.
Prototype
long socket ( int Domain, int Type, int Proto );
Parameter
Parameter Domain Type Proto Description [IN] Protocol family which should be used. [IN] Specifies the type of the socket. [IN] Specifies the protocol which should be used with the socket. Must be set to zero.
Table 5.19: socket() parameter list
Valid values for parameter Domain

Value AF_INET Description IPv4 - Internet protocol version 4
Valid values for parameter Type

Value SOCK_STREAM SOCK_DGRAM Stream socket Datagram socket Description
Return value
A non-negative descriptor on success. On failure, it returns -1.
The Domain parameter specifies a communication domain within which communication will take place; the communication domain selects the protocol family which should be used. The protocol family generally is the same as the address family for the addresses supplied in later operations on the socket. A SOCK_STREAM socket provides sequenced, reliable, two-way connection based byte streams. A SOCK_DGRAM socket supports datagrams (connectionless, unreliable messages of a fixed - typically small - maximum length). Sockets of type SOCK_STREAM are full-duplex byte streams, similar to UNIX pipes. A stream socket must be in a connected state before it can send or receive data. A connection to another socket is created with a connect() call. Once connected, data can be transferred using send() and recv() calls. When a session has been completed, a closesocket() should be performed. The communications protocols used to implement a SOCK_STREAM ensure that data is not lost or duplicated. If a piece of data (for which the peer protocol has buffer space) cannot be successfully transmitted within a reasonable length of time, then the connection is considered broken and calls will return -1 which indicates an error. The protocols optionally keep sockets warm by forcing transmissions roughly every minute in the absence of other activity. An error is then indicated if no response can be elicited on an otherwise idle connection for a extended period (such as five minutes).
UM07001 - embOS/IP User Guide 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
106
CHAPTER 5
Socket interface
SOCK_DGRAM sockets allow sending of datagrams to correspondents named in sendto() calls. Datagrams are generally received with recvfrom(), which returns the next datagram with its return address. The operation of sockets is controlled by socket-level options. The getsockopt() and setsockopt() functions are used to get and set options. Refer to getsockopt() on page 92 and setsockopt() on page 102 for detailed information.
107
5.2
5.2.1
Socket data structures

Structure sockaddr
Description
This structure holds socket address information for many types of sockets.
Prototype
struct sockaddr { U16 sa_family; char sa_data[14]; }; Member sa_family sa_data Description Address family. Normally AF_INET. The character array sa_data contains the destination address and port number for the socket.
Table 5.20: Structure sockaddr member list
The structure sockaddr is mostly used as function parameter. To deal with struct sockaddr, a parallel structure struct sockaddr_in is implemented. The structure sockaddr_in is the same size as structure sockaddr, so that a pointer can freely be casted from one type to the other. Refer to Structure sockaddr_in on page 108 for more information and an example.
108
CHAPTER 5
Socket interface
5.2.2
Structure sockaddr_in
Description
Structure for handling internet addresses.
Prototype
struct sockaddr_in { short sin_family; unsigned short sin_port; struct in_addr sin_addr; char sin_zero[8]; }; Member sin_family sin_port sin_addr sin_zero Description Address family. Normally AF_INET. Port number for the socket. Structure of type in_addr. The structure represents a 4-byte number that represents one digit in an IP address per byte. sin_zero member is unused.
Table 5.21: Structure sockaddr_in member list
Example
Refer to connect() on page 86 for an example.
109
5.2.3
Structure in_addr
Description
4-byte number that represents one digit in an IP address per byte.
Prototype
struct in_addr { unsigned long s_addr; }; Member s_addr
Table 5.22: Structure in_addr member list
Description Number that represents one digit in an IP address per byte.
110
CHAPTER 5
Socket interface
5.2.4
Structure hostent
Description
The hostent structure is used by functions to store information about a given host, such as host name, IPv4 address, and so on.
Prototype
struct hostent { char * h_name; char ** h_aliases; int h_addrtype; int h_length; char ** h_addr_list; }; Member h_name h_aliases s_addrtype h_length s_addr_list Description Official name of the host. Alias list. Host address type. Length of the address. List of addresses from the name server.
Table 5.23: Structure in_addr member list
111
5.3
Error codes
The following table contains a list of generic error codes, generally full success is 0. Definite errors are negative numbers, and indeterminate conditions are positive numbers. Symbolic name IP_ERR_PARAM IP_ERR_LOGIC Value Description
IP_ERR_NOMEM IP_ERR_NOBUFFER IP_ERR_RESOURCE IP_ERR_BAD_STATE IP_ERR_TIMEOUT IP_ERR_BAD_HEADER IP_ERR_NO_ROUTE IP_ERR_SEND_PENDING IP_ERR_NOT_MINE

Table 5.24: embOS/IP error types
Programming errors -10 Bad parameter. Sequence of events that shouldn't hap-11 pen. System errors -20 malloc() or calloc() failed. -21 Run out of free packets. -22 Run out of other queue-able resource. -23 TCP layer error. -24 Timeout error on TCP layer. Networking errors -32 Bad header at upper layer (for upcalls). -33 Can not find a reasonable next IP hop. Networking errors 1 Packet queued pending an ARP reply. 2 Packet was not of interest (upcall reply).
112
CHAPTER 5
Socket interface
113
Chapter 6 TCP zero-copy interface
The TCP protocol can be used via socket functions or the TCP zero-copy interface which is described in this chapter.
114
CHAPTER 6
TCP zero-copy interface
6.1
TCP zero-copy
This section documents an optional extension to the Sockets layer, the TCP zero-copy API. The TCP zero-copy API is intended to assist the development of higher-performance embedded network applications by allowing the application direct access to the TCP/IP stack packet buffers. This feature can be used to avoid the overhead of having the stack copy data between application-owned buffers and stack-owned buffers in send() and recv(), but the application has to fit its data into, and accept its data from, the stack buffers. The TCP zero-copy API is small because it is simply an extension to the existing Sockets API that provides an alternate mechanism for sending and receiving data on a socket. The Sockets API is used for all other operations on the socket.
6.1.1
Allocating, freeing and sending packet buffers
The two functions for allocating and freeing packet buffers are straightforward requests: IP_TCP_Alloc() allocates a packet buffer from the pool of packet buffers on the stack and IP_TCP_Free() frees a packet buffer. Applications using the TCP zero-copy API are responsible for allocating packet buffers for use in sending data, as well as for freeing buffers that have been used to receive data and those that the application has allocated but decided not to use for sending data. As these packet buffers are a limited resource, it is important that applications free them promptly when they are no longer of use. The functions for sending data, IP_TCP_Send() and IP_TCP_SendAndFree(), send a packet buffer of data using a socket. The TCP zero-copy interface supports two different approaches to send and free a packet. One approach is that the stack frees the packet independent from the success of sending the packet. Therefor, IP_TCP_SendAndFree() is called to send and free the packet. It frees the packet independent from the success of the send operation. The other approach is that IP_TCP_Send() is called. In this case it is the responsibility of the application to free the packet. Depending on the return value the application can decide if IP_TCP_Free() should be called to free the packet.
6.1.2
Callback function
Applications that use the TCP Zero-copy API for receiving data must include a callback function for acceptance of received packets, and must register the callback function with the socket using the setsockopt() sockets function with the SO_CALLBACK option name. The callback function, once registered, receives not only received data packets, but also connection events that result in socket errors.
115
6.2
1. 2. 3.
Sending data with the TCP zero-copy API

To send data with the TCP zero-copy API, you should proceed as follow: Allocating a packet buffer Filling the allocated buffer Sending the packet
The following section describes the procedure for allocating a packet buffer, sending data, and freeing the packet buffer step by step.
6.2.1
Allocating a packet buffer
The first step in using the TCP zero-copy API to send data is to allocate a packet buffer from the stack using the IP_TCP_Alloc() function. This function takes the maximum length of the data you intend to send in the buffer as argument and returns a pointer to an IP_PACKET structure.
IP_PACKET * pPacket; U32 DataLen; // Amount of data to send
DataLen = 512; // Should indicate amount of data to send pPacket = IP_TCP_Alloc(DataLen); if (pPacket == NULL) { // Error, could not allocate packet buffer }
This limits how much data you can send in one call using the TCP zero-copy API, as the data sent in one call to IP_TCP_Send() must fit in a single packet buffer. The actual limit is determined by the big packet buffer size, less 68 bytes for protocol headers. If you try to request a larger buffer than this, IP_TCP_Alloc() returns NULL to indicate that it cannot allocate a sufficiently large buffer.
6.2.2
Filling the allocated buffer with data
Having allocated the packet buffer, you now fill it with the data to send. The function IP_TCP_Alloc() has initialized the returned IP_PACKET pPacket and so pPacket>pData points to where you can start depositing data.
6.2.3
Sending the packet
Finally, you send the packet by giving it back to the stack using the function IP_TCP_Send().
e = IP_TCP_Send(socket, pPacket); if (e < 0) { IP_TCP_Free(pPacket); }
This function sends the packet over TCP, or returns an error. If its return value is less than zero, it has not accepted the packet and the application has to decide either to free the packet or to retain it for sending later. Use IP_TCP_SendAndFree() if the packet should be freed automatically in any case.
116
CHAPTER 6
6.3
1. 2.
Receiving data with the TCP zero-copy API

To receive data with the TCP zero-copy API, you should proceed as follow: Writing a callback function Registering the callback function
6.3.1
Writing a callback function
Using the TCP zero-copy API for receiving data requires the application developer to write a callback function that the stack can use to inform the application of received data packets and other socket events. This function is expected to conform to the following prototype:
int rx_callback(long Socket, IP_PACKET * pPacket, int code);
The stack calls this function when it has received a data packet or other event to report for a socket. The parameter Socket identifies the socket. The parameter pPacket passes a pointer to the packet buffer (if there is a packet buffer). If pPacket is not NULL, it is a pointer to a packet buffer containing received data for the socket. pPacket->pData points to the start of the received data, and pPacket->NumBytes indicates the number of bytes of received data in this buffer. The parameter code passes an error event (if there is an error to report). If code is not 0, it is a socket error indicating that an error or other event has occurred on the socket. Typical nonzero values are ESHUTDOWN and ECONNRESET. ESHUTDOWN defines that the connected peer has closed its end of the connection and sends no more data. ECONNRESET defines that the connected peer has abruptly closed its end of the connection and neither sends nor receives more data.
Returned values
The callback function may return one of the following values: Nume rical 0
Symbolic IP_OK
Description Data handled, packet can be freed. Data will be handled by application later, the stack should NOT free the packet. This will be done by the application at a later time when the data has been handled and the packet is no longer needed.
IP_OK_KEEP_PACKET
Table 6.1: embOS/IP TCP zero-copy - Valid return values for the receive callback function
Note: The callback function is called from the stack and is expected to return promptly. Some of the places where the stack calls the callback function require that the data structures on the stack remain consistent through the callback, so the callback function must not call back into the stack except to call IP_TCP_Free().
6.3.2
Registering the callback function
The application must also inform the stack of the callback function. setsockopt() function provides an additional socket option, SO_CALLBACK, which should be used for this purpose once the socket has been created. The following code fragment illustrates the use of this option to register a callback function named RxUpcall() on the socket Socket:
setsockopt(Socket, SOL_SOCKET, SO_CALLBACK, (void *)RxUpcall, 0);
The function setsockopt() is described in setsockopt() on page 102.
117
6.4
API functions
Function IP_TCP_Alloc() IP_TCP_Free() IP_TCP_Send() IP_TCP_SendAndFree() Description Allocates a packet buffer. Frees a packet buffer. Sends a packet. Sends and frees a packet.
Table 6.2: embOS/IP TCP zero-copy API function overview
118
CHAPTER 6
6.4.1
IP_TCP_Alloc()
Description
Allocates a packet buffer large enough to hold datalen bytes of TCP data, plus TCP, IP and MAC headers.
Prototype
IP_PACKET * IP_TCP_Alloc (int datasize);
Parameter
Parameter datasize
Table 6.3: IP_TCP_Alloc() parameter list
Description [IN] Length of the data which should be received.
Return value
Success: Returns a pointer to the allocated buffer. Error: NULL
This function must be called to allocate a buffer for sending data via IP_TCP_Send(). It returns the allocated packet buffer with its pPacket->pData field set to where the application must deposit the data to be sent. This datasize limits how much data that you can send in one call using the TCP zerocopy API, as the data sent in one call to IP_TCP_Send() must fit in a single packet buffer, with the TCP, IP, and lower-layer headers that the stack needs to add in order to send the packet. The actual limit is determined by the big packet buffer size (normally 1536 bytes). Refer to IP_AddBuffers() on page 42 for more information about defining buffer sizes. If you try to request a larger buffer than this, IP_TCP_Alloc() returns NULL to indicate that it cannot allocate a sufficiently-large buffer.
Example
DataLen = 1024; // Should indicate amount of data to send pPacket = IP_TCP_Alloc(DataLen); if (pPacket == NULL) { // Error, could not allocate packet buffer }
119
6.4.2
IP_TCP_Free()
Description
Frees a packet buffer allocated by IP_TCP_Alloc().
Prototype
void IP_TCP_Free ( IP_PACKET * pPacket );
Parameter
Parameter pPacket
Table 6.4: IP_TCP_Free() parameter list
Description [IN] Pointer to the IP_Packet structure.
120
CHAPTER 6
6.4.3
IP_TCP_Send()
Description
Sends a packet buffer on a socket.
Prototype
int IP_TCP_Send ( U32 s, IP_PACKET * pPacket );
Parameter
Parameter s pPacket Description [IN] Socket descriptor. [IN] Pointer to a packet buffer.
Table 6.5: IP_TCP_Send() parameter list
Return value
0 The packet was sent successfully. <0 The packet was not accepted by the stack. The application must re-send the packet using a call to IP_TCP_Send(), or free the packet using IP_TCP_Free(). >0 The packet has been accepted and queued on the socket but has not yet been transmitted.
Applications using the TCP zero-copy API are responsible for allocating packet buffers for use in sending data, as well as for freeing buffers that have been used to receive data and those that the application has allocated but decided not to use for sending data. As these packet buffers are a limited resource, it is important that applications free them promptly when they are no longer of use. Packets have to be freed after processing. The TCP zero-copy interface supports two different approaches to free a packet. One approach is that the stack frees the packet independent from the success of sending the packet. Therefor, IP_TCP_SendAndFree() is called to send the packet and free the packet. It frees the packet independent from the success of the send operation. The other approach is that IP_TCP_Send() is called. In this case it is the responsibility application programmer to free the packet. Depending on the return value the application programmer can decide if IP_TCP_Free() should be called to free the packet.
121
6.4.4
IP_TCP_SendAndFree()
Description
Sends a packet buffer on a socket.
Prototype
int IP_TCP_SendAndFree ( U32 s, IP_PACKET * pPacket );
Parameter
Parameter s pPacket Description [IN] Socket descriptor. [IN] Pointer to the IP_Packet structure.
Table 6.6: IP_TCP_Send() parameter list
Return value
0 The packet was sent successfully. <0 The packet was not accepted by the stack. >0 The packet has been accepted and queued on the socket but has not yet been transmitted.
Applications using the TCP zero-copy API are responsible for allocating packet buffers for use in sending data, as well as for freeing buffers that have been used to receive data and those that the application has allocated but decided not to use for sending data. As these packet buffers are a limited resource, it is important that applications free them promptly when they are no longer of use. IP_TCP_SendAndFree() frees packet pPacket after processing. It frees the packet independent from the success of the send operation.
122
CHAPTER 6
123
Chapter 7 UDP zero-copy interface
The UDP transfer protocol can be used via socket functions or the zero-copy interface which is described in this chapter.
124
CHAPTER 7
UDP zero-copy interface
7.1
UDP zero-copy
The UDP zero-copy API functions are provided for systems that do not need the overhead of sockets. These routines impose a lower demand on CPU and system memory requirements than sockets. However, they do not offer the portability of sockets. UDP zero-copy API functions are intended to assist the development of higher-performance embedded network applications by allowing the application direct access to the TCP/IP stack packet buffers. This feature can be used to avoid the overhead of having the stack copy data between application-owned buffers and stack-owned buffers in sendto() and recvfrom(), but the application has to fit its data into, and accept its data from, the stack buffers. Refer to embOS/IP UDP discover (OS_IP_UDPDiscover.c / OS_IP_UDPDiscoverZeroCopy.c) on page 37 for detailed dinformation about the UDP zero-copy example application.
7.1.1
Allocating, freeing and sending packet buffers
The two functions for allocating and freeing packet buffers are straightforward requests: IP_UDP_Alloc() allocates a packet buffer from the pool of packet buffers on the stack and IP_UDP_Free() frees a packet buffer. Applications using the UDP zero-copy API are responsible for allocating packet buffers for use in sending data, as well as for freeing buffers that have been used to receive data and those that the application has allocated but decided not to use for sending data. As these packet buffers are a limited resource, it is important that applications free them promptly when they are no longer of use. The functions for sending data, IP_UDP_Send() and IP_UDP_SendAndFree(), send a packet buffer of data using a port. The UDP zero-copy interface supports two different approaches to send and free a packet. One approach is that the stack frees the packet independent from the success of sending the packet. Therefor, IP_UDP_SendAndFree() is called to send and free the packet. It frees the packet independent from the success of the send operation. The other approach is that IP_UDP_Send() is called. In this case it is the responsibility of the application to free the packet. Depending on the return value the application can decide if IP_UDP_Free() should be called to free the packet.
7.1.2
Callback function
Applications that use the UDP zero-copy API for receiving data must include a callback function for acceptance of received packets, and must register the callback function with a port using the IP_UDP_Open() function. The callback function, once registered, receives all matching data packets.
125
7.2
1. 2. 3.
Sending data with the UDP zero-copy API

To send data with the UDP zero-copy API, you should proceed as follow: Allocating a packet buffer Filling the allocated buffer Sending the packet
The following section describes the procedure for allocating a packet buffer, sending data, and freeing the packet buffer step by step.
7.2.1
Allocating a packet buffer
The first step in using the UDP zero-copy API to send data is to allocate a packet buffer from the stack using the IP_UDP_Alloc() function. This function takes the maximum length of the data you intend to send in the buffer as argument and returns a pointer to an IP_PACKET structure.
DataLen = 512; // Should indicate amount of data to send pPacket = IP_UDP_Alloc(DataLen); if (pPacket == NULL) { // Error, could not allocate packet buffer }
This limits how much data you can send in one call using the UDP zero-copy API, as the data sent in one call to IP_UDP_Send() must fit in a single packet buffer. The actual limit is determined by the big packet buffer size, less typically 42 bytes for protocol headers (14 bytes for Ethernet header, 20 bytes IP header, 8 bytes UDP header). If you try to request a larger buffer than this, IP_UDP_Alloc() returns NULL to indicate that it cannot allocate a sufficiently large buffer.
7.2.2
Filling the allocated buffer with data
Having allocated the packet buffer, you now fill it with the data to send. The function IP_UDP_Alloc() has initialized the returned IP_PACKET pPacket and so pPacket>pData points to where you can start depositing data.
7.2.3
Sending the packet
Finally, you send the packet by giving it back to the stack using the function IP_UDP_Send().
#define SRC_PORT 50020 #define DEST_PORT 50020 #define DEST_ADDR 0xC0A80101 e = IP_UDP_Send(0, DEST_ADDR, SRC_PORT, DEST_PORT, pPacket); if (e < 0) { IP_UDP_Free(pPacket); }
This function sends the packet over UDP, or returns an error. If its return value is less than zero, it has not accepted the packet and the application has to decide either to free the packet or to retain it for sending later. Use IP_UDP_SendAndFree() if the packet should be freed automatically in any case.
126
CHAPTER 7
7.3
1. 2.
Receiving data with the UDP zero-copy API

To receive data with the UDP zero-copy API, you should proceed as follow: Writing a callback function Registering the callback function
7.3.1
Writing a callback function
Using the UDP zero-copy API for receiving data requires the application developer to write a callback function that the stack can use to inform the application of received data packets. This function is expected to conform to the following prototype:
int rx_callback(IP_PACKET * pPacket, void * pContext)
The stack calls this function when it has received a data packet for a port. The parameter pPacket points to the packet buffer. The packet buffer contains the received data for the socket. pPacket->pData points to the start of the received data, and pPacket->NumBytes indicates the number of bytes of received data in this buffer.
Returned values
The callback function may return one of the following values: Nume rical 0
Symbolic IP_OK
Description Data handled. embOS/IP will free the packet. Data will be handled by application later, the stack should NOT free the packet. This will be done by the application at a later time when the data has been handled and the packet is no longer needed.
IP_OK_KEEP_PACKET
Table 7.1: embOS/IP UDP zero-copy - Valid return values for the receive callback function
Note: The callback function is called from the stack and is expected to return promptly. Some of the places where the stack calls the callback function require that the data structures on the stack remain consistent through the callback, so the callback function must not call back into the stack except to call IP_UDP_Free().
7.3.2
Registering the callback function
The application must also inform the stack of the callback function. This is done by calling the IP_UDP_Open() function. The following code fragment illustrates the use of this option to register a callback function named RxUpcall() on the port 50020:
#define SRC_PORT 50020 #define DEST_PORT 50020 IP_UDP_Open(0L /* any foreign host */, SRC_PORT, DEST_PORT, RxUpCall, 0L /* any tag */);
The function IP_UDP_Open() is described in IP_UDP_Open() on page 135.
127
7.4
API functions
Function IP_UDP_Alloc() IP_UDP_Close() IP_UDP_FindFreePort() IP_UDP_Free() IP_UDP_GetDataPtr() IP_UDP_GetLPort() IP_UDP_GetSrcAddr() IP_UDP_Open() IP_UDP_Send() IP_UDP_SendAndFree() Description Returns a pointer to a packet buffer big enough for the specified sizes. Closes a UDP connection handle. Returns a free local port number. Frees the buffer which was used for a packet. Returns pointer to data contained in the received UDP packet. Extracts local port information from a UDP packet. Retrieves the IP address of the sender of the given UDP packet. Creates a UDP connection handle. Sends an UDP packet to a specified host. Sends an UDP packet to a specified host and frees the packet.
Table 7.2: embOS/IP UDP zero-copy API function overview
128
CHAPTER 7
7.4.1
IP_UDP_Alloc()
Description
Returns a pointer to a packet buffer big enough for the specified sizes.
Prototype
IP_PACKET * IP_UDP_Alloc( int NumBytes );
Parameter
Parameter NumBytes
Table 7.3: IP_UDP_Alloc() parameter list
Description [IN] Length of the data which should be received.
Return value
Success: Returns a pointer to the allocated buffer. Error: NULL
Applications using the UDP zero-copy API are responsible for allocating packet buffers for use in sending data, as well as for freeing buffers that have been used to receive data and those that the application has allocated but decided not to use for sending data. As these packet buffers are a limited resource, it is important that applications free them promptly when they are no longer of use. The UDP zero-copy interface supports two different approaches to free a packet. One approach is that the stack frees the packet independent from the success of sending the packet. Therefor, IP_UDP_SendAndFree() is called to send the packet and free the packet. It frees the packet independent from the success of the send operation. The other approach is that IP_UDP_Send() is called. In this case it is the responsibility application programmer to free the packet. Depending on the return value the application programmer can decide if IP_UDP_Free() should be called to free the packet.
129
7.4.2
IP_UDP_Close()
Description
Closes a UDP connection handle and removes the connection from demux table list of connections and deallocates it.
Prototype
void IP_UDP_Close( IP_UDP_CONN Con );
Parameter
Parameter Con
Table 7.4: IP_UDP_Close() parameter list
Description [IN] UDP connection handle.
130
CHAPTER 7
7.4.3
IP_UDP_FindFreePort()
Description
Obtains a random port number. that is suitable for use as the lport parameter in a call to IP_UDP_Open().
Prototype
U16 IP_UDP_FindFreePort( void );
Return value
A usable port number in local endianess.
The returned port number is suitable for use as the lport parameter in a call to IP_UDP_Open(). Refer to IP_UDP_Open() on page 135 for more information. IP_UDP_FindFreePort() avoids picking port numbers in the reserved range 0-1024, or in the range 1025-1199, which may be used for server applications.
131
7.4.4
IP_UDP_Free()
Description
Frees the buffer which was used for a packet.
Prototype
void IP_UDP_Free( IP_PACKET * pPacket );
Parameter
Parameter pPacket
Table 7.5: IP_UDP_Free() parameter list
Description [IN] Pointer to a packet structure.
132
CHAPTER 7
7.4.5
IP_UDP_GetDataPtr()
Description
Returns pointer to data contained in the received UDP packet.
Prototype
void * IP_UDP_GetDataPtr(const IP_PACKET *pPacket);
Parameter
Parameter pPacket
Table 7.6: IP_UDP_GetDataPtr() parameter list
133
7.4.6
IP_UDP_GetLPort()
Description
Extracts local port information from a UDP packet.
Prototype
U16 IP_UDP_GetLPort ( const IP_PACKET * pPacket );
Parameter
Parameter pPacket
Table 7.7: IP_UDP_GetLPort() parameter list
134
CHAPTER 7
7.4.7
IP_UDP_GetSrcAddr()
Description
Returns pointer to data contained in the received UDP packet.
Prototype
void IP_UDP_GetSrcAddr( const IP_PACKET * pPacket, void * pSrcAddr, int AddrLen );
Parameter
Parameter pPacket pSrcAddr AddrLen Description [IN] Pointer to a packet structure. [IN] Pointer to a buffer to store the source address. [IN] Size of the buffer used to store the source address.
Table 7.8: IP_UDP_GetSrcAddr() parameter list
135
7.4.8
IP_UDP_Open()
Description
Creates a UDP connection handle to receive, and pass upwards, UDP packets that match the parameters passed.
Prototype
IP_UDP_CONN IP_UDP_Open( IP_ADDR U16 U16 int(*routine) void * IPAddr, fport, lport, (IP_PACKET *, void * pContext), pContext );
Parameter
Parameter IPAddr fport lport (*routine) pContext Description [IN] IP address. [IN] Foreign port. [IN] Local port. [IN] Callback function which is called when a UDP packet is received. [IN/OUT] Application defined context pointer.
Table 7.9: IP_UDP_Open() parameter list
Return value
Success: Returns a pointer to the UDP connection handle. Error: NULL
The parameters IPAddr, fport, and lport, can be set to 0 as a wild card, which enables the reception of broadcast datagrams. The callback handler function is called with a pointer to a received datagram and a copy of the data pointer which is passed to IP_UDP_Open(). This can be any data the programmer requires, such as a pointer to another function, or a control structure to aid in demultiplexing the received UDP packet. The returned handle is used as parameter for IP_UDP_Close() IP_UDP_Close() is not called, there is no need to safe the return value. only. If
136
CHAPTER 7
7.4.9
IP_UDP_Send()
Description
Send an UDP packet to a specified host.
Prototype
int IP_UDP_Send( int IP_ADDR U16 U16 IP_PACKET * IFace, FHost, fport, lport, pPacket );
Parameter
Parameter IFace IPAddr fport lport pPacket [IN] [IN] [IN] [IN] [IN] Description Zero-based index of available interfaces. IP address of the target host in network endianess. Foreign port. Local port. Data which should be sent to the target host.
Table 7.10: IP_UDP_Send() parameter list
Return value
On success: 0 On error: Non-zero error code
The packet pPacket has to be allocated by calling IP_UDP_Alloc(). Refer to IP_UDP_Alloc() on page 128 for detailed information. If you expect to get any response to this packet you should have opened a UDP connection prior to calling IP_UDP_Send(). Refer to IP_UDP_Open() on page 135 for more information about creating an UDP connection. IP_UDP_Send() does not free the packet after sending. It is the responsibility of the application programmer to free the packet. Depending on the return value the application programmer can decide if IP_UDP_Free() should be called to free the packet.
137
7.4.10 IP_UDP_SendAndFree()
Description
Send an UDP packet to a specified host and frees the packet.
Prototype
int IP_UDP_SendAndFree( int IP_ADDR U16 U16 IP_PACKET * IFace, FHost, fport, lport, pPacket );
Parameter
Parameter IFace IPAddr fport lport pPacket [IN] [IN] [IN] [IN] [IN] Description Zero-based index of available interfaces. IP address of the target host in network endianess. Foreign port. Local port. Data which should be sent to the target host.
Table 7.11: IP_UDP_SendAndFree() parameter list
Return value
On success: 0 On error: Non-zero error code
The packet pPacket has to be allocated by calling IP_UDP_Alloc(). Refer to IP_UDP_Alloc() on page 72 for detailed information. If you expect to get any response to this packet you should have opened a UDP connection prior to calling this. Refer to IP_UDP_Open() on page 135 for more information about creating an UDP connection. Packets are freed by calling IP_UDP_Free() is required. IP_UDP_SendAndFree(). Therefor, no call of
138
CHAPTER 7
139
Chapter 8 DHCP client
This chapter explains the usage of the Dynamic Host Control Protocol (DHCP) with embOS/IP. All API functions are described in this chapter.
140
CHAPTER 8
DHCP client
8.1
DHCP backgrounds
DHCP stands for Dynamic Host Configuration Protocol. It is designed to ease configuration management of large networks by allowing the network administrator to collect all the IP hosts soft configuration information into a single computer. This includes IP address, name, gateway, and default servers. Refer to [RFC 2131] - DHCP - Dynamic Host Configuration Protocol for detailed information about all settings which can be assigned with DHCP. DHCP is a client/server protocol, meaning that machine with the DHCP database serves requests from DHCP clients. The clients typically initiate the transaction by requesting an IP address and perhaps other information from the server. The server looks up the client in its database, usually by the clients media address, and assigns the requested fields. Clients do not always need to be in the servers database. If an unknown client submits a request, the server may optionally assign the client a free IP address from a pool of free addresses kept for this purpose. The server may also assign the client default information of the local network, such as the default gateway, the DNS server, and routing information. When the IP addresses is assigned, it is leased to the client for a finite amount of time. The DHCP client needs to keep track of this lease time, and obtain a lease extension from the server before the lease time runs out. Once the lease has elapsed, the client should not send any more IP packets (except DHCP requests) until he get another address. This approach allows computers (such as laptops or factory floor monitors) which will not be permanently attached to the network to share IP addresses and not hog them when they are not using the net. DHCP is just a superset of the Bootstrap Protocol (BOOTP). The main differences between the two are the lease concept, which was created for DHCP, and the ability to assigned addresses from a pool. Refer to [RFC 951] - Bootstrap Protocol for detailed information about the Bootstrap Protocol.
141
8.2
API functions
Function IP_DHCPC_Activate() IP_DHCPC_GetState() IP_DHCPC_Halt() IP_DHCPC_SetCallback() Description Activates the DHCP client. Returns the state of the DHCP client. Stops all DHCP client activity. Sets a callback for an interface.
Table 8.1: embOS/IP DHCP client interface function overview
142
CHAPTER 8
DHCP client
8.2.1
IP_DHCPC_Activate()
Description
Activates the DHCP client.
Prototype
void IP_DHCPC_Activate ( int IFIndex, const char * sHost, const char * sDomain, const char * sVendor );
Parameter
Parameter IFIndex sHost sDomain sVendor Description [IN] Zero-based index number specifying the interface which should request configuration information from a DHCP server. [IN] Pointer to host name to use in negotiation. Can be NULL. [IN] Pointer to domain name to use in negotiation. Can be NULL. [IN] Pointer to vendor to use in negotiation. Can be NULL.
Table 8.2: IP_DHCPC_Activate() parameter list
This function is typically called from within IP_X_Config(). This function initializes the DHCP client. It attempts to open a UDP connection to listen for incoming replies and begins the process of configuring a network interface using DHCP. The process may take several seconds, and the DHCP client will keep retrying if the service does not respond. The parameters sHost, sDomain, sVendor are optional (can be NULL). If not NULL, must point to a memory area which remains valid after the call since the string is not copied.
Example
// Correct function call IP_DHCPC_Activate(0, "Target", NULL, NULL); // Illegal function call char ac; sprintf(ac, "Target%d, Index); IP_DHCPC_Activate(0, ac, NULL, NULL); // Correct function call static char ac; sprintf(ac, "Target%d, Index); IP_DHCPC_Activate(0, ac, NULL, NULL);
If you start the DHCP client with activated logging the output on the terminal I/O should be similar to the listing below:
DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: DHCP: Sending discover! Received packet from 192.168.1.1 Packet type is OFFER. Renewal time: 2160 min. Rebinding time: 3780 min. Lease time: 4320 min. Host name received. Sending Request. Received packet from 192.168.1.1 Packet type is ACK. Renewal time: 2160 min. Rebinding time: 3780 min. Lease time: 4320 min. Host name received. IFace 0: IP: 192.168.199.20, Mask: 255.255.0.0, GW: 192.168.1.1. 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
143
8.2.2
IP_DHCPC_GetState()
Description
Returns the state of the DHCP client.
Prototype
int IP_DHCPC_GetState( int IFIndex );
Parameter
Parameter IFIndex Description [IN] Zero-based index number specifying the interface which should be halted.
Table 8.3: IP_DHCPC_GetState() parameter list
Return value
0 DHCP client not used. >0 DHCP client in use.
144
CHAPTER 8
DHCP client
8.2.3
IP_DHCPC_Halt()
Description
Stops all DHCP activity on a network interface.
Prototype
void IP_DHCPC_Halt( int IFIndex );
Parameter
Parameter IFIndex Description [IN] Zero-based index number specifying the interface which should be halted.
Table 8.4: IP_DHCPC_Halt() parameter list
145
8.2.4
IP_DHCPC_SetCallback()
Description
This function allows the caller to set a callback for an interface.
Prototype
void IP_DHCPC_SetCallback( int IFIndex, int (*routine)(int,int) );
Parameter
Parameter IFIndex (*routine) Description [IN] Zero-based index number of available network interfaces. [IN] Callback functions which should be called with every status change.
Table 8.5: IP_DHCPC_SetCallback() parameter list
The callback is called with every status change. This mechanism is provided so that the caller can do some processing when the interface is up (like doing initialization or blinking LEDs, etc.). Refer to [RFC 2331] DHCP - Dynamic Host Configuration Protocol for detailed information about DHCP states.
146
CHAPTER 8
DHCP client
147
Chapter 9 Network interface drivers
embOS/IP has been designed to cooperate with any kind of hardware. To use specific hardware with embOS/IP, a so-called network interface driver for that hardware is required. The network interface driver consists of basic functions for accessing the hardware and a global table that holds pointers to these functions.
148
CHAPTER 9
Network interface drivers
9.1
General information
To use embOS/IP, a network interface driver matching the target hardware is required. The code size of a network interface driver depends on the hardware and is typically between 1 and 3 Kbytes. The driver handles both the MAC (media access control) unit as well as the PHY (Physical interface). We recommend using drivers written and tested by SEGGER. However, it is possible to write your own driver. This is explained in section Writing your own driver on page 165. The driver interface has been designed to allow support of internal and external Ethernet controllers (EMACs). It also allows to take full advantage of hardware features such as MAC address filtering and checksum computation in hardware.
9.1.1
MAC address filtering
The stack passes a list of MAC addresses to the driver. The driver is responsible for making sure that all packets from all MAC addresses specified are passed to the stack. It can do so with precise filtering if the hardware has sufficient filters for the given number of MAC addresses. If more MAC addresses are passed to the driver than hardware filters are available, the driver can use a hash filter if available in hardware or switch to promiscuous mode. This is a very flexible solution which allows making best use of the hardware filtering capabilities on all known Ethernet controllers. It also allows simple implementations to simply switch to promiscuous mode.
9.1.2
Checksum computation in hardware
When the interface is initialized, the stack queries the capabilities of the driver. If the hardware can compute IP, TCP, UDP, ICMP checksums, it can indicates this to the stack. In this case, the stack does not compute these checksums, improving throughput and reducing CPU load.
9.1.3
Ethernet CRC computation
Every Ethernet packet includes a 32-bit trailing CRC. In most cases, the Ethernet controller is capable of computing the CRC. The drivers take advantage of this. The CRC is computed in the driver only if the hardware does not support CRC computation.
149
9.2
Available network interface drivers

Network interface drivers are optional components to embOS/IP. The following network interface drivers are available: Driver (Device) ATMEL AT91CAP9 ATMEL AT91RM9200 ATMEL AT91SAM7X ATMEL AT91SAM9260 ATMEL AT91SAM9263 ATMEL AT91SAM9XE DAVICOM DM9000 RENESAS H8S2472 RENESAS SH7670 FREESCALE ColdFire MCF5223x FREESCALE ColdFire MCF5329 LUMINARY LM3S6965 NXP LPC17xx NXP LPC2378 / LPC2478 NXP LPC32xx SMSC LAN9115 / LAN9215 SMSC LAN9118 SMSC LAN91C111 ST STR912 ST STM32F107 (Connectivity Line) NIOSII IFI GMACII EMAC NIOSII MaCo-Engineering EMAC NIOSII More than IP A2A bridge Identifier IP_Driver_CAP9 IP_Driver_AT91RM9200 IP_Driver_SAM7X IP_Driver_SAM9260 IP_Driver_SAM9263 IP_Driver_SAM9XE IP_Driver_DM9000 IP_Driver_H8S2472 IP_Driver_SH7670 IP_Driver_MCF5223x IP_Driver_MCF5329 IP_Driver_LM3S6965 IP_Driver_LPC17xx IP_Driver_LPC24xx IP_Driver_LPC32xx IP_Driver_LAN9115 IP_Driver_LAN9118 IP_Driver_LAN91C111 IP_Driver_STR912 IP_Driver_STM32F107 IP_Driver_GMACII IP_Driver_NIOSII_MaCo IP_Driver_NIOSII_More10IP_A2A
Table 9.1: List of default network interface driver labels
To add a driver to embOS/IP, IP_AddEtherInterface() should be called with the proper identifier before the TCP/IP stack starts any transmission. Refer to IP_AddEtherInterface() on page 43 for detailed information.
150
CHAPTER 9
9.2.1
ATMEL AT91SAM7X
The ATMEL AT91SAM7Xs are flash microcontrollers with integrated Ethernet, USB and CAN interfaces, based on the 32-bit ARM7TDMI RISC processor.
9.2.1.1 Supported hardware

The network interface driver for the AT91SAM7X can be used with every ATMEL AT91SAM7X target board. The driver has been tested on the following eval boards: Tested evaluation boards ATMEL AT91SAM7X-EK Olimex SAM7-EX256
Table 9.2: List of tested eval boards
9.2.1.2 Configuring the driver

Adding the driver to embOS/IP
To add the driver, use IP_AddEtherInterface() with the driver identifier IP_Driver_SAM7X. This function has to be called from IP_X_Config(). Refer to IP_AddEtherInterface() on page 43 and IP_X_Configure() on page 174 for more information.
Example
void IP_X_Config(void) { IP_AssignMemory(_aPool, sizeof(_aPool)); IP_AddEtherInterface(&IP_Driver_SAM7X); IP_SetHWAddr("\x00\x22\x33\x44\x55\x66"); // // // // Assigning memory Add Ethernet driver MAC addr: Needs to be unique for production units
IP_DHCPC_Activate(0, "TARGET", NULL, NULL); // // Run-time configure buffers. // The default setup will do for most cases. // IP_AddBuffers(12, 256); // IP_AddBuffers(6, 1536); // // IP_ConfTCPSpace(6 * 1024, 4 * 1024); IP_SetWarnFilter(0xFFFFFFFF); // // IP_SetLogFilter(IP_MTYPE_INIT | IP_MTYPE_LINK_CHANGE | IP_MTYPE_DHCP); }
Small buffers. Big buffers. Size should be 1536 to allow a full ether packet to fit. 0xFFFFFFFF: Do not filter: Output all warnings.
9.2.1.3 Driver specific configuration functions

Function IP_NI_SAM7X_ConfigNumRxBuffers()
Table 9.3: embOS/IP SAM7X driver specific function overview
Description Sets the number of Rx buffers.
9.2.1.3.1 IP_NI_SAM7X_ConfigNumRxBuffers() Description

Sets the number of Rx buffers of the driver. This function has to be called in the configuration phase.
Prototype
void IP_NI_SAM7X_ConfigNumRxBuffers( U16 NumRxBuffers );
151
Parameter
Parameter NumRxBuffers Description [IN] The number of Rx buffers.
Table 9.4: IP_NI_SAM7X_ConfigNumRxBuffers() parameter list
9.2.1.4 Required BSP functions

Function BSP_ETH_Init()
Table 9.5: embOS/IP driver specific function overview
Description Initializes the network interface.
9.2.1.4.1 BSP_ETH_Init() Description

This function is called from the network interface driver. It initializes the network interface. This function should be used to enable the ports which are connected to the network hardware. It is called from the driver during the initialization process.
Prototype
void BSP_ETH_Init( unsigned Unit );
Parameter
Parameter Unit
Table 9.6: BSP_ETH_Init() parameter list
Example
/* Excerpt from implementation for ATMEL AT91SAM7X-EK */ #define #define #define #define #define #define #define #define #define #define #define #define #define #define AT91C_PMC_PCER (*(volatile AT91C_PIOB_PPUDR (*(volatile AT91C_PIOB_PER (*(volatile AT91C_PIOB_OER (*(volatile AT91C_PIOB_CODR (*(volatile AT91C_PIOB_SODR (*(volatile AT91C_PIOB_ODR (*(volatile AT91C_PIOB_PDR (*(volatile AT91C_RSTC_RMR (*(volatile AT91C_PIOB_ASR (*(volatile AT91C_RSTC_RCR (*(volatile AT91C_RSTC_ERSTL AT91C_RSTC_EXTRST AT91C_RSTC_NRSTL unsigned*) unsigned*) unsigned*) unsigned*) unsigned*) unsigned*) unsigned*) unsigned*) unsigned*) unsigned*) unsigned*) 0xFFFFFC10) 0xFFFFF660) 0xFFFFF600) 0xFFFFF610) 0xFFFFF634) 0xFFFFF630) 0xFFFFF614) 0xFFFFF604) 0xFFFFFD08) 0xFFFFF670) 0xFFFFFD00) (0xF << 8) (0x1 << 3) (1UL << 16)
void BSP_ETH_Init(unsigned Unit) { unsigned v; AT91C_PMC_PCER AT91C_PIOB_PPUDR = (1 << _PIOB_ID); // Enable clock for PIOB = 1UL << 15; // Disable RXDV pullup, // enter PHY normal mode = 1UL << 16; since PHY
AT91C_PIOB_PPUDR // // Init PIO and perform a RESET of PHY // v = 0 | (1 << | (1 << | (1 << | (1 << UM07001 - embOS/IP User Guide
0) 15) 16) 18) 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
152 ; AT91C_PIOB_PER AT91C_PIOB_OER AT91C_PIOB_CODR = = = | | | | ;
CHAPTER 9
v; v; 0 (1 (1 (1 (1
// Entire lower 19 bits enabled
<< << << <<
7) 15) 16) 18)
// // // //
0: 0: 0: 0:
node mode, 1: repeater mode Normal mode, 1: test mode MII Power down
AT91C_PIOB_SODR
= 0 | (1 << 0) ;
// Isolate
// // Perform hardware reset using RESET pin of MCU // AT91C_RSTC_RMR = 0xA5000000 | AT91C_RSTC_ERSTL & (1 << 8); AT91C_RSTC_RCR = 0xA5000000 | AT91C_RSTC_EXTRST; while ((AT91C_RSTC_RSR & AT91C_RSTC_NRSTL) == 0); // Wait until RESET timer has // expired // // Switch to peripheral functions // v = 0x3FFFF; // Lower 18 bits are used for the peripheral AT91C_PIOB_ODR = v; // Entire lower 18 bits disabled AT91C_PIOB_ASR = v; // Select peripheral A use AT91C_PIOB_PDR = v; // Disable GPIO mode, select peripheral }
9.2.1.5 Addition information

None.
153
9.2.2
ATMEL AT91SAM9260
The ATMEL AT91SAM9260 is based on the ARM926EJ-S processor. Its peripheral set includes USB Full Speed Host and Device interfaces, a 10/100 Base T Ethernet MAC, Image Sensor Interface, Multimedia Card Interface (MCI), Synchronous Serial Controllers (SSC), USARTs, Master/Slave Serial Peripheral Interfaces (SPI), a threechannel 16-bit Timer Counter (TC), a Two Wire Interface (TWI) and four-channel 10bit ADC.

The network interface driver for the AT91SAM9260 can be used with every ATMEL AT91SAM9260 target board. The driver has been tested on the following eval boards: Tested evaluation boards ATMEL AT91SAM9260

To add the driver, use IP_AddEtherInterface() with the driver identifier IP_Driver_SAM9260. This function must be called from IP_X_Config(). Refer to IP_AddEtherInterface() on page 43 and IP_X_Configure() on page 174 for more information.
Example
void IP_X_Config(void) { IP_AssignMemory(_aPool, sizeof(_aPool)); IP_AddEtherInterface(&IP_Driver_SAM9260); IP_SetHWAddr("\x00\x22\xC7\xFF\xFF\xFF"); // // // // Assigning memory Add Ethernet driver MAC addr: Needs to be unique for production units
9.2.2.3 Driver specific configuration functions

Function IP_NI_SAM9260_ConfigNumRxBuffers()
Table 9.8: embOS/IP SAM9260 driver specific function overview
Description Sets the number of Rx buffers.
9.2.2.3.1 IP_NI_SAM9260_ConfigNumRxBuffers Description

Sets the number of Rx buffers of the driver. This function has to be called in the configuration phase.
Prototype
void IP_NI_SAM9260_ConfigNumRxBuffers( U16 NumRxBuffers );
154
CHAPTER 9
Parameter
Parameter NumRxBuffers Description [IN] The number of Rx buffers.
Table 9.9: IP_NI_SAM9260_ConfigNumRxBuffers() parameter list


Prototype
Parameter
Parameter Unit
Example
/********************************************************************* * * BSP_ETH_Init() * * Function description * This function is called from the network interface driver. * It initializes the network interface. This function should be used * to enable the ports which are connected to the network hardware. * It is called from the driver during the initialization process. * * Note: * (1) If your MAC is connected to the PHY via Media Independent * Interface (MII) change the macro _USE_RMII and call * IP_NI_ConfigPHYMode() from within IP_X_Config() * to change the default of driver. * */ void BSP_ETH_Init(unsigned Unit) { unsigned PinsA; unsigned PinsB; PMC_PCER = (1 << ID_EMAC_PORT); // Enable clock for PIO EMAC_PORT_PPUDR = (1 << EMAC_PORT_RXDV_BIT); // Disable RXDV pullup, // enter PHY normal mode #if _USE_RMII EMAC_PORT_PPUER = (1 << EMAC_PORT_RMII_BIT); // Enable Pullup => Switch to RMII. #else EMAC_PORT_PPUDR = (1 << EMAC_PORT_RMII_BIT); // Disable Pullup => Switch to MII. #endif // // Power up PHY, may not be required, if set as hardwired option on target // #ifdef EMAC_PORT_PWR_PHY_BIT EMAC_PORT_PER = (1 << EMAC_PORT_PWR_PHY_BIT); EMAC_PORT_OER = (1 << EMAC_PORT_PWR_PHY_BIT); EMAC_PORT_CODR = (1 << EMAC_PORT_PWR_PHY_BIT); #endif // // Init PIO Pins: EMAC is connected to specific lines of PIO UM07001 - embOS/IP User Guide 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
155 // PinsA
= (1uL << 12) | (1uL << 13) | (1uL << 14) | (1uL << 15) | (1uL << 16) | (1uL << 17) | (1uL << 18) | (1uL << 19) | (1uL << 20) | (1uL << 21) ; PinsB = (1uL << 10) | (1uL << 11) | (1uL << 22) | (1uL << 25) | (1uL << 26) | (1uL << 27) | (1uL << 28) | (1uL << 29) ; EMAC_PORT_ASR = PinsA; // Select peripheral A use EMAC_PORT_BSR = PinsB; // Select peripheral B use EMAC_PORT_PDR = PinsA | PinsB; // Disable GPIO mode, select peripheral function // // Initialize priority of BUS MATRIX. EMAC needs highest priority for SDRAM access // MATRIX_SCFG3 = 0x01160030; // Assign EMAC as default master, activate priority arbitration, increase cycles MATRIX_PRAS3 = 0x00320000; // Set Priority of EMAC to 3 (highest value) }

None.
156
CHAPTER 9
9.2.3
DAVICOM DM9000/DM9000A
The Davicom DM9000 is a fully integrated single chip Fast Ethernet MAC controller with a generic processor interface, a 10/100M PHY and SRAM.

The network interface driver for the Davicom DM9000 can be used with every target board which complies with the following: Davicom DM9000 is presented DM 9000 is connected to the data/address bus; data bus is 16-bits wide INT pin connected to CPU in a way which allows generating interrupts
The driver has been tested on the following eval boards: Tested evaluation boards ATMEL AT91SAM9261-EK

To add the driver, use IP_AddEtherInterface() with the driver identifier IP_Driver_DM9000. This function must be called from within IP_X_Config(). Refer to IP_AddEtherInterface() on page 43 and IP_X_Configure() on page 174 for more information.
Example
void IP_X_Config(void) { IP_AssignMemory(_aPool, sizeof(_aPool)); // Assigning memory IP_AddEtherInterface(&IP_Driver_DM9000); // Add Ethernet driver IP_NI_DM9000_ConfigAddr(0, (void*) (0x30000000), (void*) (0x30000000 + 0x04)); IP_NI_ConfigPoll(0); // No ISR routine IP_SetHWAddr("\x00\x22\x33\x44\x55\x66"); // MAC addr: Needs to be unique IP_DHCPC_Activate(0, "TARGET", NULL, NULL); // // Run-time configure buffers. The default setup will do for most cases. // IP_AddBuffers(12, 256); // Small buffers. IP_AddBuffers(12, 1536); // Big buffers. Size should be 1536 to // allow a full ether packet to fit. IP_ConfTCPSpace(6 * 1024, 4 * 1024); IP_SetWarnFilter(0xFFFFFFFF); // 0xFFFFFFFF: Do not filter: // Output all warnings. IP_SetLogFilter(IP_MTYPE_INIT | IP_MTYPE_LINK_CHANGE | IP_MTYPE_DHCP ); }
157
9.2.3.3 Driver-specific configuration functions

Function IP_NI_DM9000_ConfigAddr() IP_NI_DM9000_ISR_Handler() Description Sets the base address for commands and data register. Interrupt service routine for the network interface.
Table 9.13: embOS/IP DM9000 driver-specific function overview
9.2.3.3.1 IP_NI_DM9000_ConfigAddr() Description

Sets the base address (for command) and data address.
Prototype
void IP_NI_DM9000_ConfigAddr( unsigned Unit, void * pBase, void * pValue );
Parameter
Parameter Unit pBase pValue Description [IN] Zero-based index of available network interfaces. [IN] Pointer to the control register of the MAC. [IN] Pointer to the data register of the MAC.
Table 9.14: IP_NI_DM9000_ConfigAddr() parameter list
This function must be called from within IP_X_Config. Refer to IP_X_Configure() on page 174 for detailed information.
9.2.3.3.2 IP_NI_DM9000_ISR_Handler() Description

This is the interrupt service routine for the network interface (EMAC). It handles all interrupts (Rx, Tx, Error).
Prototype
void IP_NI_DM9000_ISR_Handler( unsigned Unit );
Parameter
Parameter Unit Description [IN] Zero-based index of available network interfaces.
Table 9.15: IP_NI_DM9000_ISR_Handler() parameter list
158
CHAPTER 9


Prototype
159
9.2.4
FREESCALE ColdFire MCF5329

The network interface driver for the ColdFire MCF5329 MCU can be used with every target board. The driver has been tested on the following eval boards: Tested evaluation boards LOGICPD ZOOM COLDFIRE SDK with MCF5329 Fire Engine

To add the driver, use IP_AddEtherInterface() with the driver identifier IP_Driver_MCF5329. This function must be called from IP_X_Config(). Refer to IP_AddEtherInterface() on page 43 and IP_X_Configure() on page 174 for more information.
Example
/* Sample implementation taken from the configuration for the ColdFire MCF5329 */ #define ALLOC_SIZE U32 _aPool[ALLOC_SIZE / 4]; 0xA000 // Size of memory dedicated // to the stack in bytes // This is the memory area used // by the stack.
/********************************************************************* * * IP_X_Config */ void IP_X_Config(void) { IP_AssignMemory(_aPool, sizeof(_aPool)); // Assigning memory IP_AddEtherInterface(&IP_Driver_MCF5329); // Add ethernet driver IP_SetHWAddr((const unsigned char *)"\x00\x22\xC7\xFF\xFF\xFF"); // // Use DHCP client or define IP address, subnet mask, // gateway address and DNS server according to the // requirements of your application. // IP_DHCPC_Activate(0, "TARGET", NULL, NULL); // IP_SetAddrMask(0xC0A805E6, 0xFFFF0000); // Assign IP addr. and subnet mask // IP_SetGWAddr(0, 0xC0A80201); // Set gateway address // IP_DNS_SetServer(0xCC98B84C); // Set DNS server address, // for example 204.152.184.76 // // Run-time configure buffers. // The default setup will do for most cases. // IP_AddBuffers(12, 256); // Small buffers. IP_AddBuffers(10, 1536); // Big buffers. IP_ConfTCPSpace(4 * 1024, 4 * 1024); // Define the TCP Tx and Rx window size // // Define log and warn filter // IP_SetWarnFilter(0xFFFFFFFF); IP_SetLogFilter(IP_MTYPE_INIT | IP_MTYPE_LINK_CHANGE | IP_MTYPE_DHCP ); }
160
CHAPTER 9

None.

None.

None.
161
Parameter
Parameter Unit
Example
/* Excerpt from implementation for the ATMEL AT91SAM9261-EK */ #define #define #define #define #define #define #define _PIOC_ID _PMC_PCER _PIOC_PER _PIOC_ODR _PIOC_OER _PIOC_SODR _PIOC_CODR (4) (*(volatile (*(volatile (*(volatile (*(volatile (*(volatile (*(volatile unsigned unsigned unsigned unsigned unsigned unsigned int*) int*) int*) int*) int*) int*) 0xFFFFF810) 0xFFFFFC00) 0xFFFFFC14) 0xFFFFFC10) 0xFFFFFC30) 0xFFFFFC34)
/********************************************************************* * * BSP_ETH_Init() */ void BSP_ETH_Init(unsigned Unit) { int i; _PMC_PCER |= (1 << _PIOC_ID); // Enable peripheral clock _PIOC_PER = (1 << 10) | (1 << 11); // Enable Ports for RESET and Interrupt _PIOC_OER = (1 << 10); // Switch RESET to output mode _PIOC_ODR = (1 << 11); // Switch Interrupt to output mode // // Activate & deactivate RESET of Ethernet controller. // We do this in a loop to allow sufficient time for Controller to get out of RESET // for (i = 0; i < 1000; i++) { _PIOC_SODR = (1 << 10); // Activate RESET } for (i = 0; i < 1000; i++) { _PIOC_CODR = (1 << 10); // Deactivate RESET } }

None.
162
CHAPTER 9
9.2.5
NXP LPC23xx / 24xx
The NXP LPC23xx and LPC24xx MCU families are flash microcontrollers with integrated Ethernet, USB and CAN interfaces, based on the 32-bit ARM7TDMI-S RISC processor.

The network interface driver for the NXP LPC23xx and LPC24xx MCUs can be used with every NXP LPC23xx/LPC24xx target board. The driver has been tested on the following eval boards: Tested evaluation boards KEIL MCB2300 IAR LPC2468 V1.0 EmbeddedArtists LPC2468

To add the driver, use IP_AddEtherInterface() with the driver identifier IP_Driver_LPC24xx. This function must be called from IP_X_Config(). Refer to IP_AddEtherInterface() on page 43 and IP_X_Configure() on page 174 for more information.
Example
/* Sample implementation taken from the configuration for the NXP LPC2468 */ /********************************************************************* * * IP_X_Config * * Function description * This function is called by the IP stack during IP_Init(). */ void IP_X_Config(void) { IP_AssignMemory(_aPool, sizeof(_aPool)); // Assigning memory IP_AddEtherInterface(&IP_Driver_LPC24xx); // Add ethernet driver IP_SetHWAddr("\x00\x22\x33\x44\x55\x66"); // MAC addr: Needs to be unique // for production units IP_DHCPC_Activate(0, "TARGET", NULL, NULL); // // Run-time configure buffers. // The default setup will do for most cases. // IP_AddBuffers(6, 256); // Small buffers. IP_AddBuffers(8, 1536); // Big buffers. Size should be 1536 // to allow a full ether packet to fit. IP_ConfTCPSpace(6 * 1024, 6 * 1024); IP_SetWarnFilter(0xFFFFFFFF); // Do not filter: Output all warnings. IP_SetLogFilter(IP_MTYPE_INIT | IP_MTYPE_LINK_CHANGE ); }

None.
163


Prototype
Parameter
Parameter Unit
Example
/* Sample implementation for NXP LPC2468 */ #define PINSEL2 #define PINSEL3 *(volatile unsigned long *)(0xE002C008) *(volatile unsigned long *)(0xE002C00C)
/********************************************************************* * * ETH_Init */ void BSP_ETH_Init(unsigned Unit) { /*-----------------------------------------------------------------------------* write to PINSEL2/3 to select the PHY functions on P1[17:0] *-----------------------------------------------------------------------------*/ /* P1.6, ENET-TX_CLK, has to be set for EMAC to address a BUG in the rev"xx-X" or "xx-Y" silicon(see errata). On the new rev.(xxAY, released on 06/22/2007), P1.6 should NOT be set. */ if (MAC_MODULEID == 0x39022000) { // Older chip ? PINSEL2 = 0x50151105; /* Selects P1[0,1,4,6,8,9,10,14,15] */ } else { PINSEL2 = 0x50150105; /* Selects P1[0,1,4,8,9,10,14,15] */ } PINSEL3 = (PINSEL3 & ~0x0000000f) | 0x5; }

None.
164
CHAPTER 9
9.2.6
ST STR912
The ST STR912 is based on the ARM966E-S processor. It is a flash microcontroller with integrated Ethernet, USB and CAN interfaces, AC Motor Control, 4 Timers, ADC, RTC, and DMA.

The network interface driver for the STR912 can be used with every target ST STR912 target board. The driver has been tested on the following eval boards: Tested evaluation boards IAR STR912FA development board

To add the driver, use IP_AddEtherInterface() with the driver identifier IP_Driver_STR912. This function must be called from IP_X_Config(). Refer to IP_AddEtherInterface() on page 43 and IP_X_Configure() on page 174 for more information.
Example
/* Sample implementation taken from the configuration for the ST STR912 */ void IP_X_Config(void) { IP_AssignMemory(_aPool, sizeof(_aPool)); IP_AddEtherInterface(&IP_Driver_STR912); IP_SetHWAddr("\x00\x22\x33\x44\x55\x66");
// // // //
Assigning memory Add Ethernet driver MAC addr: Needs to be unique for production units

None.

None.

None.
165
9.3
Writing your own driver

If you are going to use embOS/IP with your own hardware, you may have to write your own network interface driver. This section describes which functions are required and how to integrate your own network interface driver into embOS/IP. Note: We strongly recommend contacting SEGGER if you need to have a driver for a particular piece of hardware which is not yet supported. Writing a driver is a difficult task which requires a thorough understanding of Ethernet, MAC, and PHY.
166
CHAPTER 9
9.3.1
Network interface driver structure
embOS/IP uses a simple structure with function pointers to call the appropriate driver function for a device. Use the supplied template IP_NI_Template.c for the implementation.
Device Driver Structure
pfInit() pfSendPackedIfTxIdle() pfGetPacketSize()

Data structure
typedef struct IP_HW_DRIVER { int (*pfInit) ( unsigned int (*pfSendPacket) ( unsigned int (*pfGetPacketSize) ( unsigned int (*pfReadPacket) ( unsigned void (*pfTimer) ( unsigned int (*pfControl) ( unsigned } IP_HW_DRIVER;
pfTimer() pfReadPacket() pfControl()
Unit ); Unit ); Unit ); Unit, U8 * pDest, unsigned NumBytes ); Unit ); Unit, int Cmd, void * p );
Elements of IP_HW_DRIVER
Element pfInit pfSendPacket pfGetPacketSize pfReadPacket pfTimer pfControl Meaning Pointer to the initialization function. Pointer to the send packet function. Pointer to the get packet size function. Pointer to the read packet function. Optional: Pointer to the timer function. The routine is called from the stack periodically. Pointer to the control function.
Table 9.23: IP_HW_DRIVER - List of structure member variables
Example
/* Sample implementation taken from the driver for the ATMEL AT91SAM7X */ /********************************************************************* * * Driver API Table * ********************************************************************** */ const IP_HW_DRIVER IP_Driver_SAM7X = { _Init, _SendPacketIfTxIdle, _GetPacketSize, _ReadPacket, _Timer, _Control };
167
9.3.2
Device driver functions
This section provides descriptions of the network interface driver functions required by embOS/IP. Note that the names used for these functions are not really relevant for embOS/IP because the stack accesses them through a structure of function pointers. Function pfControl() pfInit() pfGetPacketSize() pfReadPacket() pfSendPacketIfTxIdle() pfTimer() Description This function is used to implement additional driver specific control functions. It can be empty. General initialization function of the driver. Reads buffer descriptors to find out if a packet has been received. Reads the first packet in the buffer. Send the next packet in the send queue if transmitter is idle. Timer function called by the networking task, IP_Task(), once per second.
Table 9.24: embOS/IP network interface driver functions
168
CHAPTER 9
9.3.3
Driver template
The driver template IP_NI_Template.c is supplied in the folder Sample\Driver\Template\.
Example
/********************************************************************* * SEGGER MICROCONTROLLER SYSTEME GmbH * * Solutions for real time microcontroller applications * ********************************************************************** * * * (C) 2007 - 2008 SEGGER Microcontroller Systeme GmbH * * * * www.segger.com Support: support@segger.com * * * ********************************************************************** * * * TCP/IP stack for embedded applications * * * ********************************************************************** ---------------------------------------------------------------------File : IP_NI_Template.c Purpose : Network interface driver template -------- END-OF-HEADER --------------------------------------------*/ #include "IP_Int.h"
/********************************************************************* * * _SetFilter * * Function description * Sets the MAC filter(s) * The stack tells the driver which addresses should go thru the filter. * The number of addresses can generally be unlimited. * In most cases, only one address is set. * However, if the NI is in multiple nets at the same time or if multicast is used, * multiple addresses can be set. * * Notes * (1) Procedure * In general, precise filtering is used as far as supported by the hardware. * If the more addresses need to be filtered than precise address filters are * available, then the hash filter is used. * Alternativly, the MAC can be switched to promiscuous mode for simple * implementations. */ static int _SetFilter(IP_NI_CMD_SET_FILTER_DATA * pFilter) { U32 v; U32 w; unsigned i; unsigned NumAddr; const U8 * pAddrData; NumAddr = pFilter->NumAddr; for (i = 0; i < NumAddr; i++) { pAddrData = *(&pFilter->pHWAddr + i); } return 0; } /********************************************************************* * * _SendPacket * * Function description * Send the next packet in the send queue. * Function is called from 2 places: * - from a task via pfSendPacketIfTxIdle() in Driver structure * - from ISR when Tx is completed (TxInterrupt) */ static int _SendPacket(void) { U32 v; void * pPacket; unsigned NumBytes; UM07001 - embOS/IP User Guide 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
// O.K.
169
IP_GetNextOutPacket(&pPacket, &NumBytes);
// Get information about next // packet in the Queue. 0 // means no packet in queue
if (NumBytes == 0) { return 0; } IP_LOG((IP_MTYPE_DRIVER, "DRIVER: Sending packet: %d bytes", NumBytes)); // // Start send // return 0; } /********************************************************************* * * _ISR_Handler * * Function description * This is the interrupt service routine for the NI (EMAC). * It handles all interrupts (Rx, Tx, Error). * */ static void _ISR_Handler(void) { } /********************************************************************* * * _Init * * Function description * General init function of the driver. * Called by the stack in the init phase before any other driver function. */ static int _Init(unsigned Unit) { int r; r = _PHY_Init(Unit); if (r) { return 1; } // // TBD // return 0; } /********************************************************************* * * _SendPacketIfTxIdle * * Function description * Send the next packet in the send queue if transmitter is idle. * If transmitter is busy, nothing is done since the next packet is sent * automatically with Tx-interrupt. * Function is called from a task via function pointer in in driver structure. */ static int _SendPacketIfTxIdle(unsigned Unit) { // // TBD // return 0; } /********************************************************************* * * _GetPacketSize() * * Function description * Reads buffer descriptors in order to find out if a packet has been received. * Different error conditions are checked and handled. * Function is called from a task via function pointer in driver structure. * * Return value * Number of buffers used for the next packet. // Configure the PHY
170
CHAPTER 9 * 0 if no complete packet is available. */ static int _GetPacketSize(unsigned Unit) { // // TBD // return 0; }
/********************************************************************* * * _ReadPacket * * Function description * Reads the first packet into the buffer. * NumBytes must be the correct number of bytes as retrieved by _GetPacketSize(); * Function is called from a task via function pointer in driver structure. * */ static int _ReadPacket(unsigned Unit, U8 *pDest, unsigned NumBytes) { // // TBD // return 0; } /********************************************************************* * * _Timer * * Function description * Timer function called by the Net task once per second. * Function is called from a task via function pointer in driver structure. */ static void _Timer(unsigned Unit) { // _UpdateLinkState(); } /********************************************************************* * * _Control * * Function description * Control function for various purposes. * Function is called from a task via function pointer in driver structure. * * Return value * -1: Command is not supported * !=-1: Command supported. Typically 0 means success, * but can also be a return value. */ static int _Control(unsigned Unit, int Cmd, void * p) { switch (Cmd) { case IP_NI_CMD_SET_FILTER: return _SetFilter((IP_NI_CMD_SET_FILTER_DATA*)p); case IP_NI_CMD_SET_BPRESSURE: // // TBD: Enable back pressure (if supported) and change return value to 0 // break; case IP_NI_CMD_CLR_BPRESSURE: // // TBD: Disable back pressure (if supported) and change return value to 0 // break; case IP_NI_CMD_GET_MAC_ADDR: break; case IP_NI_CMD_GET_CAPS: // // TBD: Retrieves the capabilites, which are a logical-or combination of // the IP_NI_CAPS (if any) // // { // int v; // // v = 0 // | IP_NI_CAPS_WRITE_IP_CHKSUM // Driver capable of inserting the // IP-checksum into an outgoing packet?
171 // // // // // // // | IP_NI_CAPS_WRITE_UDP_CHKSUM | IP_NI_CAPS_WRITE_TCP_CHKSUM | IP_NI_CAPS_WRITE_ICMP_CHKSUM | IP_NI_CAPS_CHECK_IP_CHKSUM | IP_NI_CAPS_CHECK_UDP_CHKSUM | IP_NI_CAPS_CHECK_TCP_CHKSUM | IP_NI_CAPS_CHECK_ICMP_CHKSUM // // // // // // // // // // // // // // // // // // Driver capable of inserting the UDP-checksum into an outgoing packet? Driver capable of inserting the TCP-checksum into an outgoing packet? Driver capable of inserting the ICMP-checksum into an outgoing packet? Driver capable of computing and comparing the IP-checksum of incoming packets? Driver capable of computing and comparing the UDP-checksum of an incoming packet? Driver capable of computing and comparing the TCP-checksum of an incoming packet? Driver capable of computing and comparing the ICMP-checksum of an incoming packet?
// } // return v; break; case IP_NI_CMD_POLL: // // Poll MAC (typically once per ms) in cases where MAC does not // trigger an interrupt. // break; default: ; } return -1; } /********************************************************************* * * Public API struct * * This is the only public part of the driver. * All driver functions are called indirectly via this structure * */ const IP_HW_DRIVER IP_Driver_Template = { _Init, _SendPacketIfTxIdle, _GetPacketSize, _ReadPacket, _Timer, _Control }; /*************************** End of file ****************************/
172
CHAPTER 9
173
Chapter 10 Configuring embOS/IP
embOS/IP can be used without changing any of the compile-time flags. All compiletime configuration flags are preconfigured with valid values, which match the requirements of most applications. Network interface drivers can be added at runtime. The default configuration of embOS/IP can be changed via compile-time flags which can be added to IP_Conf.h. IP_Conf.h is the main configuration file for the TCP/IP stack.
174
CHAPTER 10
Configuring embOS/IP
10.1 Runtime configuration

Every driver folder includes a configuration file with implementations of runtime configuration functions explained in this chapter. These functions can be customized.
10.1.1 IP_X_Configure()
Description
Helper function to prepare and configure the TCP/IP stack.
Prototype
void IP_X_Config (void);
This function is called by the startup code of the TCP/IP stack from IP_Init(). Refer to IP_Init() on page 63 for more information.
Example
/********************************************************************* * * IP_X_Config * * Function description * This function is called by the IP stack during IP_Init(). * * Typical memory/buffer configurations: * Microcontroller system, size optimized * #define ALLOC_SIZE 0x3000 // 12 KBytes RAM * mtu = 576; // 576 is minimum acc. * // to RFC, 1500 is max. for Ethernet * IP_SetMTU(0, mtu); // Maximum Transmission Unit is 1500 * // for ethernet by default * IP_AddBuffers(8, 256); // Small buffers. * IP_AddBuffers(4, mtu + 16); // Big buffers. Size should be mtu * // + 16 byte for ethernet header * // (2 bytes type, 2*6 bytes MAC, * // 2 bytes padding) * IP_ConfTCPSpace(1 * 1024, 1 * 1024); // Define TCP Tx and Rx window size * * Microcontroller system, speed optimized or multiple connections * #define ALLOC_SIZE 0x6000 // 24 KBytes RAM * mtu = 1500; // 576 is minimum acc. to RFC, * // 500 is max. for Ethernet * IP_SetMTU(0, mtu); // Maximum Transmission Unit is 1500 * // for ethernet by default * IP_AddBuffers(12, 256); // Small buffers. * IP_AddBuffers(6, mtu + 16); // Big buffers. Size should be mtu * // + 16 byte for ethernet header * // (2 bytes type, 2*6 bytes MAC, * // 2 bytes padding) * IP_ConfTCPSpace(4 * 1024, 4 * 1024); // Define TCP Tx and Rx window size * // System with lots of RAM * #define ALLOC_SIZE 0x20000 // 128 KBytes RAM * mtu = 1500; // 576 is minimum acc. to RFC, * // 1500 is max. for Ethernet * IP_SetMTU(0, mtu); // Maximum Transmission Unit is 1500 * // for ethernet by default * IP_AddBuffers(50, 256); // Small buffers. * IP_AddBuffers(50, mtu + 16); // Big buffers. Size should be mtu * // + 16 byte for ethernet header * // (2 bytes type, 2*6 bytes MAC, * // 2 bytes padding) * IP_ConfTCPSpace(8 * 1024, 8 * 1024); // Define TCP Tx and Rx window size */ void IP_X_Config(void) { IP_AssignMemory(_aPool, sizeof(_aPool)); // Assigning memory IP_AddEtherInterface(&IP_Driver_STR912); // Add ethernet driver IP_SetHWAddr("\x00\x22\x33\x44\x55\x66"); // MAC addr: Needs to be unique // for production units // // Use DHCP client or define IP address, subnet mask, // gateway address and DNS server according to the // requirements of your application. UM07001 - embOS/IP User Guide 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
175 // IP_DHCPC_Activate(0, "TARGET", NULL, NULL); // IP_SetAddrMask(0xC0A805E6, 0xFFFF0000); // IP_SetGWAddr(0, 0xC0A80201); // IP_DNS_SetServer(0xCC98B84C);
// // // //
Assign IP addr. and subnet mask Set gateway address Set DNS server address, for example 204.152.184.76
// // Run-time configure buffers. // The default setup will do for most cases. // IP_AddBuffers(20, 256); // Small buffers. IP_AddBuffers(8, 1536); // Big buffers. Size should be 1536 to // allow a full ether packet to fit. IP_ConfTCPSpace(6 * 1024, 4 * 1024); // Define the TCP Tx and Rx window size // // Define log and warn filter // Note: The terminal I/O emulation affects the timing // of your communication, since the debugger stops the target // for every terminal I/O output unless you use DCC! // IP_SetWarnFilter(0xFFFFFFFF); // 0xFFFFFFFF: Output all warnings. IP_SetLogFilter(IP_MTYPE_INIT // Output all messages from init | IP_MTYPE_LINK_CHANGE // Output a msg if link status changes | IP_MTYPE_DHCP // Output general DHCP status messages ); }
10.1.2 Driver handling

IP_X_Config() is called at initialization of the TCP/IP stack. It is called by the IP stack during IP_Init(). IP_X_Config() should help to bundle the process of adding and configuring the driver.
10.1.3 Memory and buffer assignment

The total memory requirements of the TCP/IP stack can basically be computed as the sum of the following components: Description IP-Stack core Sockets UDP connection TCP/ connection ROM app. 200 bytes n * app. 200 bytes n * app. 100 bytes n * app. 200 bytes + RAM for TCP Window
10.1.3.1 RAM for TCP window

The data for the TCP window is typically stored in large buffers. The number of large buffers required is typically: RxWindowSize / BigBufferSize This amount of buffers (and RAM for these buffers) is needed for every simultaneously active TCP connection, where "active" means sending & receiving data.
10.1.3.2 Required buffers

Most of the RAM used by the stack is used for packet buffers. Packet buffers are used to hold incoming and outgoing packets and data in receive and transmit windows of TCP connections.
176
CHAPTER 10
Example configuration - Extremly small (4 Kbytes)

#define ALLOC_SIZE 0x1000 mtu = 576; IP_SetMTU(0, mtu); IP_AddBuffers(4, 256); IP_AddBuffers(2, mtu + 16); // 6 Kbytes RAM // 576 is minimum acc. // to RFC, 1500 is max. for Ethernet // Maximum Transmission Unit is 1500 // for ethernet by default // Small buffers. // Big buffers. Size should be mtu // + 16 byte for ethernet header // (2 bytes type, 2*6 bytes MAC, // 2 bytes padding) // Define TCP Tx and Rx window size
IP_ConfTCPSpace(1 * (mtu-40), 1 * (mtu-40));
Example configuration - Small (12 Kbytes)

#define ALLOC_SIZE 0x3000 mtu = 576; IP_SetMTU(0, mtu); IP_AddBuffers(8, 256); IP_AddBuffers(4, mtu + 16); // 12 Kbytes RAM // 576 is minimum acc. // to RFC, 1500 is max. for Ethernet // Maximum Transmission Unit is 1500 // for ethernet by default // Small buffers. // Big buffers. Size should be mtu // + 16 byte for ethernet header // (2 bytes type, 2*6 bytes MAC, // 2 bytes padding) // Define TCP Tx and Rx window size
Example configuration - Normal (24 Kbytes)

#define ALLOC_SIZE 0x6000 mtu = 1500; IP_SetMTU(0, mtu); IP_AddBuffers(12, 256); IP_AddBuffers(6, mtu + 16); // 24 Kbytes RAM // 576 is minimum acc. to RFC, // 500 is max. for Ethernet // Maximum Transmission Unit is 1500 // for ethernet by default // Small buffers. // Big buffers. Size should be mtu // + 16 byte for ethernet header // (2 bytes type, 2*6 bytes MAC, // 2 bytes padding) // Define TCP Tx and Rx window size // System with lots of RAM
Example configuration - Large (128KB byte)

#define ALLOC_SIZE 0x20000 mtu = 1500; IP_SetMTU(0, mtu); IP_AddBuffers(50, 256); IP_AddBuffers(50, mtu + 16); // // // // // // // // // // // 128 Kbytes RAM 576 is minimum acc. to RFC, 1500 is max. for Ethernet Maximum Transmission Unit is 1500 for ethernet by default Small buffers. Big buffers. Size should be mtu + 16 byte for ethernet header (2 bytes type, 2*6 bytes MAC, 2 bytes padding) Define TCP Tx and Rx window size
177
10.2 Compile-time configuration

The following types of configuration macros exist:
Binary switches "B"

Switches can have a value of either 0 or 1, for deactivated and activated respectively. Actually, anything other than 0 works, but 1 makes it easier to read a configuration file. These switches can enable or disable a certain functionality or behavior. Switches are the simplest form of configuration macros.
Numerical values "N"

Numerical values are used somewhere in the code in place of a numerical constant. A typical example is the configuration of the sector size of a storage medium.
Function replacements "F"

Macros can basically be treated like regular functions although certain limitations apply, as a macro is still put into the code as simple text replacement. Function replacements are mainly used to add specific functionality to a module which is highly hardware-dependent. This type of macro is always declared using brackets (and optional parameters).
10.2.1 Compile-time configuration switches

Type N Symbolic name Default Description System configuration macros Macro to define if a big endian tar-get is used. Debug macros Macro to define the debug level of the embOS/IP build. Refer to 0 Debug level on page 178 for a description of the different debug level. Optimization macros Macro to define an optimized checksum routine to speed up the stack. An optimized checksum rouIP_cksum tine is typically implemented in (C- routine in IP assembly language. stack) Optimized versions for the GNU, IAR and ADS compilers are supplied. Macro to define an optimized memcpy routine to speed up the memcpy stack. An optimized memcpy rou(C-routine in tine is typically implemented in standard Cassembly language. library) Optimized version for the IAR compiler is supplied. Macro to define an optimized memset memset routine to speed up the (C-routine in stack. An optimized memset roustandard Ctine is typically implemented in library) assembly language.
IP_IS_BIGENDIAN
IP_DEBUG
IP_CKSUM
IP_MEMCPY
IP_MEMSET
178
CHAPTER 10
Type
Symbolic name
Default memmove (C-routine in standard Clibrary) memcmp (C-routine in standard Clibrary) Other macros
Description Macro to define an optimized memmove routine to speed up the stack. An optimized memmove routine is typically implemented in assembly language. Macro to define an optimized memcmp routine to speed up the stack. An optimized memcmp routine is typically implemented in assembly language. Configured the stack to accept 0xFFFF as TCP checksum. Some wrong TCP implementations generate the invalid TCP checksum 0xFFFF. Normally, embOS/IP does not accept packets with 0xFFFF as TCP checksum. Note: This is not compliant with RFC1071 and RFC1624.
IP_MEMMOVE
IP_MEMCMP
IP_TCP_ACCEPT_CHECK 0 SUM_FFFF
10.2.2 Debug level

embOS/IP can be configured to display debug information at higher debug levels to locate a problem (Error) or potential problem. To display information, embOS/IP uses the logging routines (see chapter Debugging on page 281). These routines can be blank, they are not required for the functionality of embOS/IP. In a target system, they are typically not required in a release (production) build, since a production build typically uses a lower debug level. If (IP_DEBUG == 0): used for release builds. Includes no debug options. If (IP_DEBUG == 1): IP_PANIC() is mapped to IP_Panic(). If (IP_DEBUG >= 2): IP_PANIC() is mapped to IP_Panic() and logging support is activated.
179
Chapter 11 Web server (Add-on)
The embOS/IP web server is an optional extension to embOS/IP. The web server can be used with embOS/IP or with a different TCP/IP stack. All functions that are required to add a web server task to your application are described in this chapter.
180
CHAPTER 11
Web server (Add-on)
11.1 embOS/IP web server

The embOS/IP web server is an optional extension which adds the HTTP protocol to the stack. It combines a maximum of performance with a small memory footprint. The web server allows an embedded system to present web pages with dynamically generated content. It comes with all features typically required by embedded systems: multiple connections, authentication, forms and low RAM usage. RAM usage has been kept to a minimum by smart buffer handling. The web server implements the relevant parts of the following Request For Comments (RFC).
RFC#
[RFC 1945] [RFC 2616] HTTP - Hypertext Direct download: HTTP - Hypertext Direct download:
Description
Transfer Protocol -- HTTP/1.0 ftp://ftp.rfc-editor.org/in-notes/rfc1945.txt Transfer Protocol -- HTTP/1.1 ftp://ftp.rfc-editor.org/in-notes/rfc2616.txt
The following table shows the contents of the embOS/IP web server root directory: Directory Application\ Content Contains the example application to run the web server with embOS/IP. Contains the web server configuration file. Refer to Configuration on page 198 for detailed information. Contains the required include files. Contains the web server sources, IP_Webserver.c, IP_Webserver.h and IP_UTIL_BASE64.c, IP_UTIL_BASE64.h. Contains the sources for the file system abstraction layer and the read-only file system. Refer to File system abstraction layer on page 302 for detailed information. Contains the source, the project files and an executable to run embOS/IP web server on a Microsoft Windows host. Refer to Using the web server sample on page 185 for detailed information.
Config Inc IP
IP\FS\
Windows\Webserver\
Supplied directory structure of embOS/IP web server package
181
11.2 Feature list

Low memory footprint. Dynamic web pages (Server Side Includes). Authentication supported. Forms: POST and GET support. Multiple connections supported. r/o file system included. HTML to C converter included. Independent of the file system: any file system can be used. Independent of the TCP/IP stack: any stack with sockets can be used. Demo with authentication, various forms, dynamic pages included. Project for executable on PC for Microsoft Visual Studio included.
182
CHAPTER 11
Web server (Add-on)
11.3 Requirements
TCP/IP stack
The embOS/IP web server requires a TCP/IP stack. It is optimized for embOS/IP, but any RFC-compliant TCP/IP stack can be used. The shipment includes a Win32 simulation, which uses the standard Winsock API and an implementation which uses the socket API of embOS/IP.
Multi tasking
The web server needs to run as a separate thread. Therefore, a multi tasking system is required to use the embOS/IP web server.
183
11.4 HTTP backgrounds

It is a communication protocol originally designed to transfer information via hypertext pages. The development of HTTP is coordinated by the IETF (Internet Engineering Task Force) and the W3C (World Wide Web Consortium). The current protocol version is 1.1.
Application layer
HTTP
Transport layer
TCP
Network layer
IP
Link layer
11.4.1 HTTP communication basics

HTTP is a challenge and response protocol. A client initiates a TCP connection to the web server and sends a HTTP request. A HTTP request starts with a method token. [RFC 2616] defines 8 method tokens. The method token indicates the method to be performed on the requested resource. embOS/IP web server supports all methods which are typically required by an embedded web server. HTTP method GET HEAD POST Description The GET method means that it retrieves whatever information is identified by the Request-URI. The HEAD method means that it retrieves the header of the content which is identified by the Request-URI. The POST method submits data to be processed to the identified resource. The data is included in the body of the request.
Table 11.1: Supported HTTP methods
The following example shows parts of a HTTP session, where a client (for example, 192.168.1.75) asks the embOS/IP web server for the hypertext page example.html. The request is followed by a blank line, so that the request ends with a double newline, each in the form of a carriage return followed by a line feed.
GET /example.html HTTP/1.1 Host: 192.168.1.75
The first line of every response message is the Status-Line, consisting of the protocol version followed by a numeric status code. The Status-Line is followed by the content-type, the server, expiration and the transfer-encoding. The server response ends with an empty line, followed by length of content that should be transferred. The length indicates the length of the web page in bytes.
184
CHAPTER 11 HTTP/1.1 200 OK Content-Type: text/html Server: embOS/IP Expires: THU, 26 OCT 1995 00:00:00 GMT Transfer-Encoding: chunked A3
Web server (Add-on)
Thereafter, the web server sends the requested hypertext page to the client. The zero at the end of the web page followed by an empty line signalizes that the transmission of the requested web page is complete.
<HTML> <HEAD> <TITLE>embOS/IP examples</TITLE> </HEAD> <BODY> <CENTER> <H1>Website: example.htm</H1> </CENTER> </BODY> </HTML> 0
11.4.2 HTTP status codes

The first line of a HTTP response is the Status-Line. It consists of the used protocol version, a status code and a short textual description of the Status-Code. The StatusCode element is a 3-digit integer result code of the attempt to understand and satisfy the request. The first digit of the Status-Code defines the class of response. The last two digits do not have any categorization role. There are 5 values for the first digit: 1xx: 2xx: 3xx: 4xx: 5xx: Informational - Request received, continuing process. Success - The action was successfully received, understood, and accepted. Redirection - Further action must be taken in order to complete the request. Client Error - The request contains bad syntax or cannot be fulfilled. Server Error - The server failed to fulfill an apparently valid request.
Refer to [RFC 2616] for a complete list of defined status-codes. embOS/IP web server supports a subset of the defined HTTP status codes. The following status codes are implemented: Status code 200 401 404 501 503 Description OK. The request has succeeded. Unauthorized. The request requires user authentication. Not found. The server has not found anything matching the Request-URI. Not implemented. The server does not support the HTTP method. Service unavailable. The server is currently unable to handle the request due to a temporary overloading of the server.
Table 11.2: embOS/IP status codes
185
11.5 Using the web server sample

Ready to use examples for Microsoft Windows and embOS/IP are supplied. If you use another TCP/IP stack, the sample OS_IP_Webserver.c has to be adapted. The sample application opens a port which listens on port 80 until an incoming connection is detected. If a connection has been established, IP_WEBS_Process() handles the client request in an extra task, so that the server is further listening on port 80. The example application uses a read-only file system to make web pages available. Refer to File system abstraction layer on page 302 and File system abstraction layer on page 302 for detailed information about the read-only file system.
11.5.1 Using the Windows sample

If you have MS Visual C++ 6.00 or any later version available, you will be able to work with a Windows sample project using embOS/IP web server. If you do not have the Microsoft compiler, an precompiled executable of the web server is also supplied.
Building the sample program

Open the workspace Start_Webserver.dsw with MS Visual Studio (for example, double-clicking it). There is no further configuration necessary. You should be able to build the application without any error or warning message. The server uses the IP address of the host PC on which it runs. Open a web browser and connect by entering the IP address of the host (127.0.0.1) to connect to the web server.
11.5.2 Running the web server example on target hardware

The embOS/IP web server sample application should always be the first step to check the proper function of the web server with your target hardware. Add all source files located in the following directories (and their subdirectories) to your project and update the include path: Application Config Inc IP IP\IP_FS\FS_RO\ IP\IP_FS\FS_RO\Generated\
It is recommended that you keep the provided folder structure. The sample application can be used on the most targets without the need for changing any of the configuration flags. The server processes up to three connections using the default configuration. Note: Three connections mean that the target can handle up to three targets in parallel, if every target uses only one connection. Because a single web browser often attempts to open more then one connection to a web server to request the files (.gif, .jpeg, etc.) which are included in the requested web page, the number of possible parallel connected targets is less than the number of possible connections. Every connection is handled in an separate task. Therefore, the web server uses up to four tasks in the default configuration, one task which listens on port 80 and accepts connections and three tasks to process the accepted connections. To modify the number of connections, only the macro MAX_CONNECTIONS has to be modified. The supplied sample web pages index.htm, embos.htm and stats.htm include dynamic content, refer to Common Gateway Interface (CGI) on page 187 for detailed information about the implementation of dynamic content.
186
CHAPTER 11
Web server (Add-on)
11.5.3 Changing the file system type

By default, the web server uses the supplied read-only file system. If a real file system like emFile should be used to store the web pages, you have to modify the function _WebServerChildTask() of the example OS_IP_Webserver.c.
/********************************************************************* * * _WebServerChildTask * */ static void _WebServerChildTask(void * Context) { long Sock; int Opt; _pFS_API = &IP_FS_ReadOnly; Sock = (long)Context; Opt = 1; setsockopt(Sock, SOL_SOCKET, SO_KEEPALIVE, &Opt, sizeof(Opt)); if (_ConnectCnt < MAX_CONNECTIONS) { IP_WEBS_Process(_Send, _Recv, Context, _pFS_API, &_Application); } else { IP_WEBS_ProcessLast(_Send, _Recv, Context, _pFS_API, &_Application); } _closesocket(Sock); _AddToConnectCnt(-1); OS_Terminate(0); }
The usage of the read-only file system is configured with the following line:
_pFS_API = &IP_FS_ReadOnly;
To use emFile as file system for your web server application, add the emFile abstraction layer IP_FS_FS.c to your project and change the line to:
_pFS_API = &IP_FS_FS;
Refer to File system abstraction layer on page 302 and File system abstraction layer on page 302 for detailed information about the emFile and read-only file system abstraction layer.
187
11.6 Dynamic content

embos/IP supports two different approaches to implement dynamic content in your web server application. A Common Gateway Interface (CGI) like interface for static HTML pages with dynamic elements and virtual files which are completely generated from the application.
11.6.1 Common Gateway Interface (CGI)

A Common Gateway Interface (CGI) like interface is used to implement dynamic content in web pages. Every web page will be parsed by the server each time a request is received. The server searches the web page for a special tag. In the default configuration, the searched tag starts . The tag will be analyzed and the parameter will be extracted. This parameter specifies a serverside command and will be given to the user application, which can handle the command. The following screenshot shows the example page index.htm.
The HTML source for the page includes the following line:

When the web page is requested, the server parses the tag and the parameter Counter is searched for in an array of structures of type WEBS_CGI. The structure includes a string to identify the command and a pointer to the function which should be called if the parameter is found.
typedef struct { const char * sName; // e.g. "Counter" void (*pf)(WEBS_OUTPUT * pOutput, const char * sParameters, const char * sValue); } WEBS_CGI;
In the example, Counter is a valid parameter and the function _callback_ExecCounter will be called. You need to implement the WEBS_CGI array and the callback functions in your application.
static const WEBS_CGI _aCGI[] = { {"Counter" , _callback_ExecCounter }, {"GetOSInfo" , _callback_ExecGetOSInfo}, {"GetIPAddr" , _callback_ExecGetIPAddr}, {NULL} };
188
CHAPTER 11
Web server (Add-on)
ExecCounter() is a simple example of how to use the CGI feature. It returns a string that includes the value of a variable which is incremented with every call to ExecCounter().
void ExecCounter( WEBS_OUTPUT * pOutput, const char * sParameters, const char * sValue ) {
char ac[40]; static char Cnt = 1; sprintf(ac, "You are visitor no.: %d", Cnt); IP_WEBS_SendString(pOutput, ac); Cnt++; }
If the web page includes the CGI tag followed by an unknown command (for example, a typo like COounter instead of Counter in the source code of the web page) an error message will be sent to the client.
11.6.1.1 Add new CGI functions to your web server application

To define new CGI functions, three things have to be done. 1. Add a new command name which should be used as tag to the WEBS_CGI structure. For example: UserCGI
static const WEBS_CGI _aCGI[] = { {"Counter" , _callback_ExecCounter }, {"GetOSInfo" , _callback_ExecGetOSInfo}, {"GetIPAddr" , _callback_ExecGetIPAddr}, {"UserCGI" , _callback_ExecUserCGI }, {NULL} };
2.
Implement the new function in your application source code.

void _callback_ExecUserCGI( WEBS_OUTPUT * pOutput, const char * sParameters const char * sValue ) { /* Add application code here */
3.
Add the new tag to the source code of your web page:

189
11.6.2 Virtual files

embOS/IP supports virtual files. A virtual file is not a real file which is stored in the used file system. It is a function which is called instead. The function generates the content of a file and sends it to the client. The web server checks the extension of all requested files, the extension .cgi is by default used for virtual files. To change the extension that is used to detect a virtual file, refer to IP_WEBS_SetFileInfoCallback() on page 208 for detailed information. The embOS/IP web server comes with an example (CallVirtualFile.htm) that requests a virtual file. The sample web page contains a form with two input test fields, named FirstName and LastName, and a button to transmit the data to the server.
When the button on the web page is pressed, the file Send.cgi is requested. The embOS/IP Web server recognizes the extension .cgi, checks if a virtual file with the name Send.cgi is defined and calls the defined function. The function in the example is _callback_SendCGI and gets the string FirstName=Foo&LastName=Bar as parameter.
typedef struct { const char * sName; void (*pf)(WEBS_OUTPUT * pOutput, const char * sParameters); } WEBS_VFILES;
In the example, Send.cgi is a valid URI and the function _callback_SendCGI will be called.
static const WEBS_VFILES _aVFiles[] = { {"Send.cgi", _callback_SendCGI }, NULL };
The virtual file Send.cgi gets two parameters. The strings entered in the input fields Firstname and LastName are transmitted with the URI. For example, you enter Foo in the first name field and Bar for last name and push the button. The browser will transmit the following string to our web server: Send.cgi?FirstName=Foo&LastName=Bar You can parse the string and use it in the way you want to. In the example we parse the string and output the values on a web page which is build from the function _callback_SendCGI().
static void _callback_SendCGI(WEBS_OUTPUT * pOutput, const char * sParameters) { char aPara0[32]; char aValue0[32]; char aPara1[32]; char aValue1[32]; int r; UM07001 - embOS/IP User Guide 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
190
CHAPTER 11
Web server (Add-on)
IP_WEBS_SendString(pOutput, "<HTML><HEAD><TITLE>CGI Sample</TITLE></HEAD>"); IP_WEBS_SendString(pOutput, "<style type=\"text/css\"> H1, H2, H3, H4 { color: blue } H1, H2, H3, H4, H5 {font-family: Helvetica;} PRE {color: black; margin-left: 2%; font-size=150%} BODY {color: black; margin-left: 2%; } </style>"); IP_WEBS_SendString(pOutput, "<HR><H2>CGI Sample</H2><HR><BODY>First name: "); r = IP_WEBS_GetParaValue(sParameters, 0, aPara0, sizeof(aPara0), aValue0, sizeof(aValue0)); if (r == 0) { IP_WEBS_SendString(pOutput, aValue0); } IP_WEBS_SendString(pOutput, "<BR>Last name: "); r = IP_WEBS_GetParaValue(sParameters, 1, aPara1, sizeof(aPara1), aValue1, sizeof(aValue1)); if (r == 0) { IP_WEBS_SendString(pOutput, aValue1); } IP_WEBS_SendString(pOutput, "<BR>"); IP_WEBS_SendString(pOutput, "<HR><CENTER> <A HREF=\"CallVirtualFile.htm\">Back</A> </CENTER><IMG SRC=\"segger.gif\"> <A HREF=\"http://www.segger.com\">www.segger.com</A> </BODY></HTML>"); }
The output of _callback_SendCGI() should be similar to:
191
11.7 Authentication
HTTP/1.0, includes the specification for a Basic Access Authentication scheme. The basic authentication scheme is a non-secure method of filtering unauthorized access to resources on an HTTP server, because the user name and password are passed over the network as clear text. It is based on the assumption that the connection between the client and the server can be regarded as a trusted carrier. As this is not generally true on an open network, the basic authentication scheme should be used accordingly. The basic access authentication scheme is described in:
RFC#
[RFC 2617]
Description
HTTP Authentication: Basic and Digest Access Authentication Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc2617.txt
The basic authentication scheme is based on the model that the client must authenticate itself with a user-ID and a password for each realm. The realm value should be considered an opaque string which can only be compared for equality with other realms on that server. The server will service the request only if it can validate the user-ID and password for the protection space of the Request-URI. There are no optional authentication parameters. Upon receipt of an unauthorized request for a URI within the protection space, the server should respond with a challenge like the following: WWW-Authenticate: Basic realm="Embedded web server" where "embOS/IP embedded web server" is the string assigned by the server to identify the protection space of the Request-URI. To receive authorization, the client sends the user-ID and password, separated by a single colon (":") character, within a base64 encoded string in the credentials. If the user agent wishes to send the user-ID user and password pass, it would use the following header field: Authorization: Basic dXNlcjpwYXNz
192
CHAPTER 11
Web server (Add-on)
11.7.1 Authentication example

The client requests a resource for which authentication is required:
GET /conf/Authen.htm HTTP/1.1 Host: 192.168.1.75
The server answers the request with a "401 Unauthorized" status page. The header of the 401 error page includes an additional line WWW-Authenticate. It includes the realm for which the proper user name and password should be transmitted from the client (for example, a web browser).
HTTP/1.1 401 Unauthorized Date: Mon, 04 Feb 2008 17:00:44 GMT Server: embOS/IP Accept-Ranges: bytes Content-Length: 695 Connection: close Content-Type: text/html X-Pad: avoid browser bug WWW-Authenticate: Basic realm="embOS/IP embedded web server" <HTML> <HEAD><TITLE>401 Unauthorized</TITLE></HEAD> <BODY> <H1>401 Unauthorized</H1> Browser not authentication-capable or authentication failed.<P> </BODY> </HTML>
The client interprets the header and opens a dialog box to enter the user name and password combination for the realm of the resource.
Note: The embOS/IP web server example always uses the following user name and the password combination: User Name: user - Password: pass Enter the proper user name/password combination for the requested realm and confirm with the OK button. The client encodes the user name/password combination to a base64 encoded string and requests the resource again. The request header is enhanced by the following line: Authorization: Basic dXNlcjpwYXNz
GET /conf/Authen.htm HTTP/1.1 Host: 192.168.1.75 Authorization: Basic dXNlcjpwYXNz
The server decodes the user name/password combination and checks if the decoded string matches to the defined user name/password combination of the realm. If the strings are identical, the server delivers the page. If the strings are not identical, the server answers again with a "401 Unauthorized" status page.
193 HTTP/1.1 200 OK Content-Type: text/html Server: embOS/IP Expires: THU, 26 OCT 1995 00:00:00 GMT Transfer-Encoding: chunked 200 <HTML> <HEAD> <TITLE>web server configuration</TITLE> </HEAD> <BODY>  </BODY> </HTML> 0
11.7.2 Configuration of the authentication

The embOS/IP web server checks the access rights of every resource before returning it. The user can define different realms to separate different parts of the web server resources. An array of WEBS_ACCESS_CONTROL structures has to be implemented in the user application. Refer to Structure WEBS_ACCESS_CONTROL on page 217 for detailed information about the elements of the WEBS_ACCESS_CONTROL structure. If no authentication should be used, the array includes only one entry for the root path.
WEBS_ACCESS_CONTROL _aAccessControl[] = { { "/", NULL, NULL }, 0 };
To define a realm "conf", an additional WEBS_ACCESS CONTROL entry has to be implemented.

WEBS_ACCESS_CONTROL _aAccessControl[] = { { "/conf/", "Login for configuration", "user:pass" }, { "/", NULL, NULL }, 0 };
The string "Login for configuration" defines the realm. "user:pass" is the user name/password combination stored in one string.
194
CHAPTER 11
Web server (Add-on)
11.8 Form handling

The embOS/IP web server supports both POST and GET actions to receive form data from a client. POST submits data to be processed to the identified resource. The data is included in the body of the request. GET is normally only used to requests a resource, but it is also possible to use GET for actions in web applications. Data processing on server side might create a new resource or update existing resources or both. Every HTML form consists of input items like textfields, buttons, checkboxes, etc. Each of these input items has a name tag. When the user places data in these items in the form, that information is encoded into the form data. Form data is a stream of <name>=<value> pairs separated by the "&" character. The value each of the input item is given by the user is called the value. The <name>=<value> pairs are URL encoded, which means that spaces are changed into "+" and special characters are encoded into hexadecimal values. Refer to [RFC 1738] for detailed information about URL encoding. The parsing and decoding of form data is handled by the embOS/IP web server. Thereafter, the server calls a callback function with the decoded and parsed strings as parameters. The responsibility to implement the callback function is on the user side. Valid characters for CGI function names: A-Z a-z 0-9 . _ A-Z a-z 0-9 All URL encoded characters . _ - *()!$\
Valid characters for CGI parameter values:
195
11.8.1 Simple form processing sample

The following example shows the handling of the output of HTML forms with your web server application. The example web page ExampleGET.htm implements a form with three inputs, two text fields and one button.
The HTML code of the web page as it is added to the server is listed below:
<html> <head><title>embOS/IP web server form example</title></head> <body> <form action="" method="GET"> <p> First name: <input name="FirstName" type="text" size="30" maxlength="30" value="" > <br> Last name: <input name="LastName" type="text" size="30" maxlength="30" value="" > <br> <input type="submit" value="Send"> </p> </form> </body> </html>
The action field of the form can specify a resource that the browser should reference when it sends back filled-in form data. If the action field defines no resource, the current resource will be requested again. If you request the web page from the embOS/IP web server and check the source of the page in your web browser, the CGI parts "" and "" will be executed before the page will be transmitted to the server, so that in the example the values of the value= fields will be empty strings. The HTML code of the web page as seen by the web browser is listed below:
<html> <head><title>embOS/IP web server form example</title></head> <body> <form action="" method="GET"> <p> First name: <input name="FirstName" type="text" size="30" maxlength="30" value="" > <br> Last name: <input name="LastName" type="text" size="30" maxlength="30" value=""
196
CHAPTER 11 > <br> <input type="submit" value="Send"> </p> </form> </body> </html>
Web server (Add-on)
To start form processing, you have to fill in the FirstName and the LastName field and click the Send button. In in the example, the browser sends a GET request for the resource referenced in the form and appends the form data to the resource name as an URL encoded string. The form data is separated from the resource name by "?". Every <name>=<value> pair is separated by "&".
For example, if you type in the FirstName field John and Doe in the LastName field and confirm the input by clicking the Send button, the following string will be transmitted to the server and shown in the address bar of the browser. http://192.168.1.230/ExampleGET.htm?FirstName=John&LastName=Doe Note: If you use POST as HTTP method, the name>=<value> pairs are not shown in the address bar of the browser. The <name>=<value> pairs are in this case included in the entity body. The embOS/IP web server parses the form data. The <name> field specifies the name of a CGI function which should be called to process the <value> field. The server checks therefore if an entry is available in the WEBS_CGI array.
static const WEBS_CGI _aCGI[] = { {"FirstName", _callback_ExecFirstName}, {"LastName", _callback_ExecLastName }, {NULL} };
If an entry can be found, the specified callback function will be called.
197
The callback function for the parameter FirstName is defined as follow:

/********************************************************************* * * Static data * ********************************************************************** */ static char _acFirstName[12]; /********************************************************************* * * _callback_FirstName */ static void _callback_ExecFirstName( WEBS_OUTPUT * pOutput, const char * sParameters, const char * sValue ) { if (sValue == NULL) { IP_WEBS_SendString(pOutput, _acFirstName); } else { _CopyString(_acFirstName, sValue, sizeof(_acFirstName)); } }
The function returns a string if sValue is NULL. If sValue is defined, it will be written into a character array. Because HTTP transmission methods GET and POST only transmit the value of filled input fields, the same function can be used to output a stored value of an input field or to set a new value. The example web page shows after entering and transmitting the input the new values of FirstName and LastName as value in the input fields.
The source of the web page as seen by the web browser is listed below:
<html> <head><title>embOS/IP web server form example</title></head> <body> <form action="" method="GET"> <p> First name: <input name="FirstName" type="text" size="30" maxlength="30" value="John" > <br> Last name: <input name="LastName" type="text" size="30" maxlength="30" value="Doe" > <br> <input type="submit" value="Send"> </p> </form> </body> </html>
198
CHAPTER 11
Web server (Add-on)
11.9 Configuration
The embOS/IP web server can be used without changing any of the compile time flags. All compile time configuration flags are preconfigured with valid values, which match the requirements of most applications. The following types of configuration macros exist:
Binary switches "B"


Numerical values are used somewhere in the source code in place of a numerical constant. A typical example is the configuration of the sector size of a storage medium.
Alias "A"
A macro which operates like a simple text substitute. An example would be the define U8, which the preprocessor would replace with unsigned char.

Macros can basically be treated like regular functions although certain limitations apply, as a macro is still put into the source code as simple text replacement. Function replacements are mainly used to add specific functionality to a module which is highly hardware-dependent. This type of macro is always declared using brackets (and optional parameters).
11.9.1 Compile time configuration switches

Type F Symbolic name Default -Description Defines a function to output warnings. In debug configurations (DEBUG == 1) WEBS_WARN maps to IP_Warnf_Application(). Defines a function to output logging messages. In debug configurations (DEBUG == 1) WEBS_LOG maps to IP_Logf_Application(). Defines the size of the input buffer. The input buffer is used to store the HTTP client requests. Defines the size of the output buffer. The output buffer is used to store the HTTP response. Defines the size of the buffer used to store the parameter/value string that is given to a virtual file. If virtual files are not used in your application, remove the definition from WEBS_Conf.h to save RAM.
WEBS_WARN
WEBS_LOG
--
WEBS_IN_BUFFER_SIZE
512
WEBS_OUT_BUFFER_SIZE
512
WEBS_PARA_BUFFER_SIZE
256
199
Type N
Symbolic name WEBS_TEMP_BUFFER_SIZE
Default 256
Description Defines the size of the TEMP buffer used internally by the web server. Defines the size of the buffer used to store the authentication string. Refer to Authentication on page 191 for detailed information about authentication. Defines the size of the buffer used to store the filename strings.
WEBS_AUTH_BUFFER_SIZE
32
WEBS_FILENAME_BUFFER_SIZE 32
Status message web pages

The status message web pages are visualizations of the information transmitted to the client in the header of the web server response. Because these visualizations are not required for the functionality of the web server, the macros can be empty. Type Symbolic name Default "<HTML>\n" \ "<HEAD>\n" \ "<TITLE>401 Unauthorized</TITLE>\n" \ </HEAD>\n" \ "<BODY>\n" \ "<H1>401 Unauthorized</H1>\n" \ "Browser not authentication-capable" \ "or authentication failed.\n" \ "</BODY>\n" \ "</HTML>\n" "<HTML>\n" \ "<HEAD>\n" \ "<TITLE>404 Not Found</TITLE>\n" \ </HEAD>\n" \ "<BODY>\n" \ "<H1>404 Not Found</H1>\n" \ "The requested document was not " \ "found on this server.\n" \ "</BODY>\n" \ "</HTML>\n" "<HTML>\n" \ "<HEAD>\n" \ "<TITLE>501 Not implemented</TITLE>\n" \ </HEAD>\n" \ "<BODY>\n" \ "<H1>Command is not implemented</H1>\n" \ "</BODY>\n" \ "</HTML>\n" "<HTML>\n" \ "<HEAD>\n" \ "<TITLE>503 Connection limit reached</TITLE>\n" \ </HEAD>\n" \ "<BODY>\n" \ "<H1>503 Connection limit reached</H1>\n" \ "The max. number of simultaneous connections to " \ "this server reached.<P>\n" \ "Please try again later.\n" \ "</BODY>\n" \ "</HTML>\n"
WEBS_401_PAGE
WEBS_404_PAGE
WEBS_501_PAGE
WEBS_503_PAGE
200
CHAPTER 11
Web server (Add-on)
11.10 API functions

Function IP_WEBS_Process() Description Processes a HTTP request of a client. Processes a HTTP request of a client and IP_WEBS_ProcessLast() closes the connection thereafter. Outputs an error message to the connected IP_WEBS_OnConnectionLimit() client. IP_WEBS_SendMem() Sends data to a connected target. IP_WEBS_SendString() Sends a string to a connected target. Encodes and sends a string to a connected IP_WEBS_SendStringEnc() target. Sends an unsigned value to a connected IP_WEBS_SendUnsigned() target. Sets a callback function to handle file inforIP_WEBS_SetFileInfoCallback() mation used by the web server. CGI/virtual file related functions IP_WEBS_CompareFileNameExt() Checks the file name extension. Returns the number of parameter/value IP_WEBS_GetNumParas() pairs. IP_WEBS_ParaValue() Gets a parameter value pair. Decodes an HTML encoded string and copy IP_WEBS_DecodeAndCopyString() it into a buffer. IP_WEBS_DecodeString() Decodes an HTML encoded string. Utility functions IP_UTIL_BASE64_Decode() Decodes a Base64 encoded string. IP_UTIL_BASE64_Encode() Encodes a string as a Base64 string.
Table 11.3: embOS/IP web server interface function overview
201
11.10.1 IP_WEBS_Process()
Description
Processes a HTTP request of a client.
Prototype
int IP_WEBS_Process ( IP_WEBS_tSend pfSend, IP_WEBS_tReceive pfReceive, void * pConnectInfo, const IP_WEBS_FS_API * pFS_API const WEBS_APPLICATION * pApplication);
Parameter
Parameter pfSend pfReceive pConnectInfo pFS_API pApplication Description [IN] Pointer to the function to be used by the server to send data to the client. [IN] Pointer to the function to be used by the server to receive data from the client. [IN] Pointer to the connection information. [IN] Pointer to the used file system API. [IN] Pointer to a structure of type WEBS_APPLICATION.
Table 11.4: IP_WEBS_Process() parameter list
Return value
0 OK.
Additional Information
This function is part of the thread functionality of the web server. The following types are used as function pointers to the routines used to send and receive bytes from/to the client: typedef int (*IP_WEBS_tSend) (const unsigned char * pData, int len, void * pConnectInfo);
typedef int (*IP_WEBS_tReceive) (const unsigned char * pData, int len, void * pConnectInfo); The send and receive functions should return the number of bytes successfully sent/ received to/from the client. The pointer pConnectInfo is passed to the send and receive routines. It can be used to pass a pointer to a structure containing connection information or to pass a socket number. For details about the parameter pFS_API and the IP_WEBS_FS_API structure, refer to File system abstraction layer on page 302. For details about the parameter pApplication and the WEBS_APPLICATION structure, refer to Structure WEBS_APPLICATION on page 218. Refer to IP_WEBS_ProcessLast() on page 202 and IP_WEBS_OnConnectionLimit() on page 203 for further information.
202
CHAPTER 11
Web server (Add-on)
11.10.2 IP_WEBS_ProcessLast()
Description
Processes a HTTP request of a client and closes the connection thereafter.
Prototype
int IP_WEBS_Process ( IP_WEBS_tSend pfSend, IP_WEBS_tReceive pfReceive, void * pConnectInfo, const IP_WEBS_FS_API * pFS_API const WEBS_APPLICATION * pApplication);
Parameter
Parameter pfSend pfReceive pConnectInfo pFS_API pApplication Description [IN] Pointer to the function to be used by the server to send data to the client. [IN] Pointer to the function to be used by the server to receive data from the client. [IN] Pointer to the connection information. [IN] Pointer to the used file system API. [IN] Pointer to a structure of type WEBS_APPLICATION.
Table 11.5: IP_WEBS_Process() parameter list
Return value
0 OK.
Additional Information
This function is part of the thread functionality of the web server. This is typically called for the last available connection. In contrast to IP_WEBS_Process(), this function closes the connection as soon as the command is completed in order to not block the last connection longer than necessary and avoid connection-limit errors. The following types are used as function pointers to the routines used to send and receive bytes from/to the client: typedef int (*IP_WEBS_tSend) (const unsigned char * pData, int len, void * pConnectInfo);
typedef int (*IP_WEBS_tReceive) (const unsigned char * pData, int len, void * pConnectInfo); The send and receive functions should return the number of bytes successfully sent/ received to/from the client. The pointer pConnectInfo is passed to the send and receive routines. It can be used to pass a pointer to a structure containing connection information or to pass a socket number. For details about the parameter pFS_API and the IP_WEBS_FS_API structure, refer to File system abstraction layer on page 302. For details about the parameter pApplication and the WEBS_APPLICATION structure, refer to Structure WEBS_APPLICATION on page 218. Refer to IP_WEBS_Process() on page 201 and IP_WEBS_OnConnectionLimit() on page 203 for further information.
203
11.10.3 IP_WEBS_OnConnectionLimit()
Description
Outputs an error message to the connected client.
Prototype
void IP_WEBS_OnConnectionLimit( const IP_WEBS_API * pIP_API, void * CtrlSock );
Parameter
Parameter pIP_API CtrlSock Description [IN] Pointer to a structure of type IP_FTPS_API. [IN] Pointer to the socket which is related to the command connection.
Table 11.6: IP_WEBS_OnConnectionLimit() parameter list
This function is typically called by the application if the connection limit is reached. The structure type IP_WEBS_API contains mappings of the required socket functions to the actual IP stack. This is required because the socket functions are slightly different on different systems. Refer to IP_WEBS_Process() on page 201 and IP_WEBS_ProcessLast() on page 202 for further information.
Example
Pseudo code:
// // Call IP_WEBS_Process() or IP_WEBS_ProcessLast() if multiple or just // one more connection is available // do { if (NumAvailableConnections > 1) { IP_WEBS_Process(); return; } else if (NumAvailableConnections == 1) { IP_WEBS_ProcessLast(); return; } Delay(); } while (!Timeout) // // No connection available even after waiting => Output error message // IP_WEBS_OnConnectionLimit();
204
CHAPTER 11
Web server (Add-on)
11.10.4 IP_WEBS_SendMem()
Description
Sends data to a connected target.
Prototype
int IP_WEBS_SendMem ( WEBS_OUTPUT * pOutput, const char * s, unsigned NumBytes);
Parameter
Parameter pOutput s NumBytes Description [IN] Pointer to the WEBS_OUTPUT structure. [IN] Pointer to a memory location that should be transmitted. [IN] Number of bytes that should be sent.
Table 11.7: IP_WEBS_SendMem() parameter list
Return value
0 OK.
205
11.10.5 IP_WEBS_SendString()
Description
Sends a zero-terminated string to a connected target.
Prototype
int IP_WEBS_SendString( WEBS_OUTPUT * pOutput, const char * s);
Parameter
Parameter pOutput s Description [IN] Pointer to the WEBS_OUTPUT structure. [IN] Pointer to a string that should be transmitted.
Table 11.8: IP_WEBS_SendString() parameter list
Return value
0 OK.
206
CHAPTER 11
Web server (Add-on)
11.10.6 IP_WEBS_SendStringEnc()
Description
Encodes and sends a zero-terminated string to a connected target.
Prototype
int IP_WEBS_SendString( WEBS_OUTPUT * pOutput, const char * s);
Parameter
Parameter pOutput s Description [IN] Pointer to the WEBS_OUTPUT structure. [IN] Pointer to a string that should be transmitted.
Table 11.9: IP_WEBS_SendStringEnc() parameter list
Return value
0 OK.
This function encodes the string s with URL encoding, which means that spaces are changed into "+" and special characters are encoded to hexadecimal values. Refer to [RFC 1738] for detailed information about URL encoding.
207
11.10.7 IP_WEBS_SendUnsigned()
Description
Sends an unsigned value to the client.
Prototype
int IP_WEBS_SendUnsigned ( WEBS_OUTPUT * pOutput, unsigned v, unsigned Base, int NumDigits );
Parameter
Parameter pOutput s Base NumDigits Description [IN] Pointer to the WEBS_OUTPUT structure. [IN] Value that should be sent. [IN] Numerical base. [IN] Number of digits that should be sent. 0 can be used as a wildcard.
Table 11.10: IP_WEBS_SendUnsigned() parameter list
Return value
0 OK.
208
CHAPTER 11
Web server (Add-on)
11.10.8 IP_WEBS_SetFileInfoCallback()
Description
Sets a callback function to receive the file information which are used by the stack.
Prototype
void IP_WEBS_SetFileInfoCallback ( IP_WEBS_pfGetFileInfo pf );
Parameter
Parameter pf Description [IN] Pointer to a callback function.
Table 11.11: IP_WEBS_SetFileInfoCallback() parameter list
The function can be used to change the default behavior of the web server. If the file info callback function is set, the web server calls it to retrieve the file information. The file information are used to decide how to handle the file and to build the HTML header. By default (no file info callback function is set), the web server parses every file with the extension.htm to check if dynamic content is included; all requested files with the extension .cgi are recognized as virtual files. Beside of that, the web server sends by default the expiration date of a web site in the HTML header. The default expiration date (THU, 01 JAN 1995 00:00:00 GMT) is in the past, so that the requested website will never be cached. This is a reasonable default for web pages with dynamic content. If the callback function returns 0 for DateExp, the expiration date will not be included in the header. For static websites, it is possible to add the optional Last-Modified header field. The Last-Modified header field is not part of the header by default. Refer to Structure IP_WEBS_FILE_INFO on page 219 for detailed information about the structure IP_WEBS_FILE_INFO.
Example
static void _GetFileInfo(const char * sFilename, IP_WEBS_FILE_INFO * pFileInfo){ int v; // // .cgi files are virtual, everything else is not // v = IP_WEBS_CompareFilenameExt(sFilename, ".cgi"); pFileInfo->IsVirtual = v ? 0 : 1; // // .htm files contain dynamic content, everything else is not // v = IP_WEBS_CompareFilenameExt(sFilename, ".htm"); pFileInfo->AllowDynContent = v ? 0 : 1; // // If file is a virtual file or includes dynamic content, // get current time and date stamp as file time // pFileInfo->DateLastMod = _GetTimeDate(); if (pFileInfo->IsVirtual || pFileInfo->AllowDynContent) { // // Set last-modified and expiration time and date // pFileInfo->DateExp = _GetTimeDate(); // If "Expires" HTTP header field should // be transmitted, set expiration date. } else { pFileInfo->DateExp = 0xEE210000; // Expiration far away (01 Jan 2099) // if content is static } }
209
11.10.9 IP_WEBS_CompareFileNameExt()
Description
Checks if the given filename has the given extension.
Prototype
char IP_WEBS_CompareFilenameExt( const char * sFilename, const char * sExt );
Parameter
Parameter sFilename sExt Description [IN] Name of the file. [IN] Extension which should be checked.
Table 11.12: IP_WEBS_CompareFilenameExt() parameter list
Return value
0 Match != 0 Mismatch
The test is case-sensitive, meaning: IP_WEBS_CompareFilenameExt("Index.html", IP_WEBS_CompareFilenameExt("Index.htm", IP_WEBS_CompareFilenameExt("Index.HTML", IP_WEBS_CompareFilenameExt("Index.html", ".html") ".html") ".html") ".HTML") ---> ---> ---> ---> Match Mismatch Mismatch Mismatch
210
CHAPTER 11
Web server (Add-on)
11.10.10IP_WEBS_GetNumParas()
Description
Returns the number of parameter/value pairs.
Prototype
int IP_WEBS_GetNumParas ( const char * sParameters );
Parameter
Parameter sParameters Description [IN] Zero-terminated string with parameter/value pairs.
Table 11.13: IP_WEBS_GetNumParas() parameter list
Return value
Number of parameters/value pairs. -1 if the string does not include parameter value pairs.
Parameters are separated from values by a =. If a string includes more as one parameter/value pair, the parameter/value pairs are separated by a &. For example, if the virtual file Send.cgi gets two parameters, the string should be similar to the following: Send.cgi?FirstName=Foo&LastName=Bar sParameter is in this case FirstName=Foo&LastName=Bar. IP_WEBS_GetNumParas() with this string, the return value will be 2. If you call
211
11.10.11IP_WEBS_GetParaValue()
Description
Parses a string for valid parameter/value pairs and writes the results in the respective buffers.
Prototype
int IP_WEBS_GetParaValue( const char * sBuffer, int ParaNum, char * sPara, int ParaLen, char * sValue, int ValueLen );
Parameter
Parameter sBuffer ParaNum sPara ParaLen sValue ValueLen Description [IN] Zero-terminated parameter/value string that should be parsed. [IN] Zero-based index of the parameter/value pairs. [Out] Buffer to store the the parameter name. (Optional, can be NULL.) [IN] Size of the buffer to store the parameter. (0 if sPara is NULL.) [Out] Buffer to store the the value. (Optional, can be NULL.) [IN] Size of the buffer to store the value. (0 if sValue is NULL.)
Table 11.14: IP_WEBS_GetParaValue() parameter list
Return value
0: O.K. >0: Error
A valid string is in the following format: <Param0>=<Value0>&<Param1>=<Value1>& ... <Paramn>=<Valuen> If the parameter value string is FirstName=John&LastName=Doo and parameter 0 should be copied, sPara will be FirstName and sValue John. If parameter 1 should be copied, sPara will be LastName and sValue Doo.
212
CHAPTER 11
Web server (Add-on)
11.10.12IP_WEBS_DecodeAndCopyStr()
Description
Checks if a string includes url encoded characters, decodes the characters and copies them into destination buffer.
Prototype
void IP_WEBS_DecodeAndCopyStr ( char * pDest, int DestLen, const char * pSrc, int SrcLen );
Parameter
Parameter pDest DestLen pSrc SrcLen Description [OUT] Buffer to store the decoded string. [IN] Size of the destination buffer. [IN] Source string that should be decoded. [IN] Size of the source string.
Table 11.15: IP_WEBS_DecodeAndCopyStr() parameter list
Destination string is 0-terminated. Source and destination buffer can be identical. pSrc "FirstName=J%F6rg" "FirstName=John"
Table 11.16: Example
SrcLen 16 14
pDest "FirstName=Jrg\0" "FirstName=John\0"
DestLen 15 15
213
11.10.13IP_WEBS_DecodeString()
Description
Checks if a string includes url encoded characters, decodes the characters.
Prototype
int IP_WEBS_DecodeString( const char * s );
Parameter
Parameter s Description [IN/OUT] Zero-terminated string that should be decoded.
Table 11.17: IP_WEBS_DecodeString() parameter list
Return value
0 String does not include url encoded characters. No change. >0 Length of the decoded string, including the terminating null character.
214
CHAPTER 11
Web server (Add-on)
11.10.14IP_UTIL_BASE64_Decode()
Description
Performs BASE-64 decoding according to RFC3548.
Prototype
int IP_UTIL_BASE64_Decode( const U8 * pSrc, int SrcLen, U8 * pDest, int * pDestLen );
Parameter
Parameter pSrc SrcLen pDest pDestLen Description [IN] Pointer to data to encode. Number of bytes to encode. [IN] Pointer to the destination buffer. [IN] Pointer to the destination buffer size. [OUT] Pointer to the number of bytes used in the destination buffer.
Table 11.18: IP_UTIL_BASE64_Decode() parameter list
Return value
< 0 > 0 0 Error Number of source bytes encoded, further call required All bytes encoded
For more information, refer to http://tools.ietf.org/html/rfc3548.
215
11.10.15IP_UTIL_BASE64_Encode()
Description
Performs BASE-64 encoding according to RFC3548.
Prototype
int IP_UTIL_BASE64_Encode( const U8 * pSrc, int SrcLen, U8 * pDest, int * pDestLen );
Parameter
Parameter pSrc SrcLen pDest pDestLen Description [IN] Pointer to data to encode. Number of bytes to encode. [IN] Pointer to the destination buffer. [IN] Pointer to the destination buffer size. [OUT] Pointer to the number of bytes used in the destination buffer.
Table 11.19: IP_UTIL_BASE64_Decode() parameter list
Return value
< 0 > 0 0 Error Number of source bytes encoded, further call required All bytes encoded
For more information, refer to http://tools.ietf.org/html/rfc3548.
216
CHAPTER 11
Web server (Add-on)
11.11 Web server data structures

11.11.1 Structure WEBS_CGI
Description
Used to store the CGI command names and the pointer to the proper callback functions.
Prototype
typedef struct { const char * sName; void (*pf)(WEBS_OUTPUT * pOutput, const char * sParameters); } WEBS_CGI; Member sName pf Description Name of the CGI command. Pointer to a callback function.
Table 11.20: Structure WEBS_CGI member list
Refer to Common Gateway Interface (CGI) on page 187 for detailed information about the use of this structure.
217
11.11.2 Structure WEBS_ACCESS_CONTROL

Description
Used to store information for the HTTP Basic Authentication scheme.
Prototype
typedef struct { const char * sPath; const char * sRealm; const char * sUserPass; } WEBS_ACCESS_CONTROL; Member sPath sRealm sUserPass Description A string which defines the path of the resources. A string which defines the realm which requires authentication. Optional, can be NULL. A string containing the user name/password combination. Optional, can be NULL.
Table 11.21: Structure WEBS_ACCESS_CONTROL member list
If sRealm is initialized with NULL, sUserPass is not interpreted by the web server. Refer to Authentication on page 191 for detailed information about the HTTP Basic Authentication scheme.
218
CHAPTER 11
Web server (Add-on)
11.11.3 Structure WEBS_APPLICATION

Description
Used to store application-specific parameters.
Prototype
typedef struct { const WEBS_CGI * paCGI; WEBS_ACCESS_CONTROL * paAccess; void (*pfHandleParameter)( WEBS_OUTPUT * pOutput, const char sPara, const char * sValue ); } WEBS_APPLICATION; Member paCGI paAccess pfHandleParameter Description Pointer to an array of structures of type WEBS_CGI. Pointer to an array of structures of type WEBS_ACCESS_CONTROL. Pointer to an array of structures of type WEBS_CGI.
Table 11.22: Structure WEBS_APPLICATION member list
219
11.11.4 Structure IP_WEBS_FILE_INFO

Description
Used to store application-specific parameters.
Prototype
typedef struct { U32 DateLastMod; U32 DateExp; U8 IsVirtual; U8 AllowDynContent; } IP_WEBS_FILE_INFO; Member DateLastModified DateExp IsVirtual // Used for "Last modified" header field // Used for "Expires" header field
Description The date when the file has been last modified. The date of the expiration of the valiity. Flag to indicate if a file is virtual or not. Valid values are 0 for non-virtual, 1 for virtual files. Flag to indicate if a file should be parsed for dynamic content or not. 0 means that the file should not be parsed for dynamic content, 1 means that the file should be parsed for dynamic content.
AllowDynContent
Table 11.23: Structure IP_WEBS_FILE_INFO member list
220
CHAPTER 11
Web server (Add-on)
11.12 Resource usage

The ROM usage depends on the compiler options, the compiler version and the used CPU. The memory requirements of the web server presented in the tables below have been measured on a system as follows: ARM7, IAR Embedded Workbench V5.11, Thumb mode, Size optimization.
Configuration used
#define #define #define #define #define #define #define WEBS_IN_BUFFER_SIZE WEBS_OUT_BUFFER_SIZE WEBS_TEMP_BUFFER_SIZE WEBS_PARA_BUFFER_SIZE WEBS_ERR_BUFFER_SIZE WEBS_AUTH_BUFFER_SIZE WEBS_FILENAME_BUFFER_SIZE 128 128 128 0 (WEBS_OUT_BUFFER_SIZE / 2) 32 32
11.12.1 ROM usage

Add-on embOS/IP web server ROM [Kbytes] 5.4
11.12.2 RAM usage:

Almost all of the RAM used by the web server is taken from task stacks. The amount of RAM required for every child task depends on the configuration of your server. Task ParentTask ChildTask Note: Description Listens for incoming connections. Handles a request. RAM [bytes] 500 1800
The web server requires at least 1 child task.
The approximately RAM usage for the web server can be calculated as follows: RAM usage = 0.1 Kbytes + ParentTask + (NumberOfChildTasks * 1.8 Kbytes)
Example: Web server accepting only 1 connection

RAM usage = 0.1 Kbytes + 500 +(1 * 1.8 Kbytes) RAM usage = 2.4 Kbytes
Example: Web server accepting up to 3 connections in parallel

RAM usage = 0.1 Kbytes + 500 + (3 * 1.8 Kbytes) RAM usage = 6.0 Kbytes
221
Chapter 12 SMTP client (Add-on)
The embOS/IP SMTP client is an optional extension to embOS/IP. The SMTP client can be used with embOS/IP or with a different TCP/IP stack. All functions that are required to add the SMTP client task to your application are described in this chapter.
222
CHAPTER 12
SMTP client (Add-on)
12.1 embOS/IP SMTP client

The embOS/IP SMTP client is an optional extension which can be seamlessly integrated into your TCP/IP application. It combines a maximum of performance with a small memory footprint. The SMTP client allows an embedded system to send emails with dynamically generated content. The RAM usage of the SMTP client module has been kept to a minimum by smart buffer handling. The SMTP client implements the relevant parts of the following Request For Comments (RFC).
RFC#
[RFC 821] [RFC 974] [RFC 2554] [RFC 5321]
Description
Simple Mail Transfer Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc821.txt Mail routing and the domain system Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc974.txt SMTP Service Extension for Authentication Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc2554.txt Simple Mail Transfer Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc5321.txt
The following table shows the contents of the embOS/IP SMTP client root directory: Directory Application\ Content Contains the example application to run the SMTP client with embOS/IP. Contains the SMTP client configuration file. Refer to Configuration on page 227 for detailed information. Contains the required include files. Contains the SMTP client sources, IP_SMTPC.c and IP_SMTPC.h. Contains the source, the project files and an executable to run embOS/IP SMTP client on a Microsoft Windows host.
Config Inc IP
Windows\SMTPC\
Supplied directory structure of embOS/IPSMTP client package
223
12.2 Feature list

Low memory footprint. Independent of the TCP/IP stack: any stack with sockets can be used. Example applications included. Project for executable on PC for Microsoft Visual Studio included.
224
CHAPTER 12
12.3 Requirements
TCP/IP stack
The embOS/IP SMTP client requires a TCP/IP stack. It is optimized for embOS/IP, but any RFC-compliant TCP/IP stack can be used. The shipment includes a Win32 simulation, which uses the standard Winsock API and an implementation which uses the socket API of embOS/IP.
Multi tasking
The SMTP client needs to run as a separate thread. Therefore, a multi tasking system is required to use the embOS/IP SMTP client.
225
12.4 SMTP backgrounds

The Simple Mail Transfer Protocol is a text based communication protocol for electronic mail transmission across IP networks.
Application layer
SMTP
Transport layer
TCP
Network layer
IP
Link layer
Using SMTP, an embOS/IP application can transfer mail to an SMTP servers on the same network or to SMTP servers in other networks via a relay or gateway server accessible to both networks. When the embOS/IP SMTP client has a message to transmit, it establishes a TCP connection to an SMTP server and transmits after the handshaking the message content. The handshaking mechanism includes normally an authentication process. The RFCs define the following four different authentication schemes: PLAIN LOGIN CRAM-MD5 NTLM
In the current version, the embOS/IP SMTP client supports only PLAIN authentication. The following listing shows a typical SMTP session:
S: C: S: C: S: C: S: C: S: C: S: C: S: C: S: C: S: C: S: C: C: C: C: 220 srv.sample.com ESMTP HELO 250 srv.sample.com AUTH LOGIN 334 VXNlcm5hbWU6 c3BzZXk29IulbkY29tZcZXIbtZ 334 UGFzc3dvcmQ6 UlblhFz7ZlblsZlZQ== 235 go ahead Mail from:<user0@sample.com> 250 ok Rcpt to:<user1@sample.com> 250 ok Rcpt to:<user2@sample.com> 250 ok Rcpt to:<user3@sample.com> 250 ok DATA 354 go ahead Message-ID: <1000.2234@sample.com> From: "User0" <User0@sample.com> TO: "User1" <User1@sample.com> CC: "User2" <User2@sample.com>, "User3" <User3@sample.com> 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
226 C: C: C: C: C: C: S: C: S: Subject: Testmail Date: 1 Jan 2008 00:00 +0100 This is a test! . 250 ok 1231221612 qp 3364 quit 221 srv.sample.com
CHAPTER 12
227
12.5 Configuration
The embOS/IP SMTP client can be used without changing any of the compile time flags. All compile time configuration flags are preconfigured with valid values, which match the requirements of most applications. The following types of configuration macros exist:
Binary switches "B"


Alias "A"


Type Symbolic name Default Description Defines a function to output warnings. In debug configurations (DEBUG == 1) SMTPC_WARN maps to IP_Warnf_Application(). Defines a function to output logging messages. In debug configurations (DEBUG == 1) SMTPC_LOG maps to IP_Logf_Application(). Defines the port where the SMTP server is listening. Defines the size of the input buffer. The input buffer is used to store the SMTP replies of the SMTP server. Defines the size of the buffer used for the Base-64 encoded user name. Defines the size of the buffer used for the Base-64 encoded password.
SMTPC_WARN
--
SMTPC_LOG
--
SMTPC_SERVER_PORT
25
SMTPC_IN_BUFFER_SIZE
256
SMTPC_AUTH_USER_BUFFER_SIZE 48
SMTPC_AUTH_PASS_BUFFER_SIZE 48
228
CHAPTER 12
12.6 API functions

Function IP_SMTPC_Send() Description SMTP client functions Sends an email to a mail transfer agent.
Table 12.1: embOS/IP SMTP client interface function overview
229
12.6.1 IP_SMTPC_Send()
Description
Sends an email to one or multiple recipients.
Prototype
int IP_SMTPC_Send( const IP_SMTPC_API IP_SMTPC_MAIL_ADDR int IP_SMTPC_MESSAGE const IP_SMTPC_MTA const IP_SMTPC_APPLICATION * pIP_API, * paMailAddr, NumMailAddr, * pMessage, * pMTA, * pApplication );
Parameter
Parameter pIP_API Description [IN] Pointer to an IP_STMPC_API structure. Refer to Structure IP_SMTPC_API on page 231 for detailed information about the elements of the IP_SMTPC_API structure. [IN] Pointer to an array of IP_SMTPC_MAIL_ADDR structures. Refer to Structure IP_SMTPC_MAIL_ADDR on page 234 for detailed information about the elements of the IP_SMTPC_MAIL_ADDR structure. The first element of the array has to be filled with the data of the sender (FROM). The order of the following data sets for recipients (TO), carbon copies (CC) and blind carbon copies (BCC) is not relevant. [IN] Number of email addresses. [IN] Pointer to an array of IP_SMTPC_MESSAGE structures. Refer to Structure IP_SMTPC_MESSAGE on page 236 for detailed information about the elements of the IP_SMTPC_MESSAGE structure. [IN] Pointer to an array of IP_SMTPC_MTA structures. Refer to Structure IP_SMTPC_MTA on page 237 for detailed information about the elements of the IP_SMTPC_MTA structure. [IN] Pointer to an array of IP_SMTPC_APPLICATION structures. Refer to Structure IP_SMTPC_APPLICATION on page 233 for detailed information about the elements of the IP_SMTPC_APPLICATION structure.
paMailAddr
NumMailAddr pMessage
pMTA
pApplication
Table 12.2: IP_SMTPC_Send() parameter list
Return value
0 OK. 1 Error.
230
CHAPTER 12
12.7 SMTP client data structures

Function IP_SMTPC_API IP_SMTPC_APPLICATION IP_SMTPC_MAIL_ADDR IP_SMTPC_MESSAGE IP_SMTPC_MTA Description Structure with pointers to the required socket interface functions. Structure with application related elements. Structure to store the mail addresses. Structure defining the message format. Structure to store the login information for the mail transfer agent.
Table 12.3: embOS/IP SMTP client interface function overview
231
12.7.1 Structure IP_SMTPC_API

Description
Structure with pointers to the required socket interface functions.
Prototype
typedef struct SMTPC_SOCKET void int { (*pfConnect) (char * SrvAddr); (*pfDisconnect) (SMTPC_SOCKET Socket); (*pfSend) (const char * pData, int Len, SMTPC_SOCKET Socket); (*pfReceive) (char * pData, int Len, SMTPC_SOCKET Socket);
int
} IP_SMTPC_API; Member pfConnect pfDisconnect pfSend pfDisconnect Pointer Pointer Pointer Pointer to to to to Description the function (for example, connect()). the disconnect function (for example, closesocket()). a callback function (for example, send()). a callback function (for example, recv()).
Table 12.4: Structure IP_SMTPC_API member list
Example
/********************************************************************* * * _Connect * * Function description * Creates a socket and opens a TCP connection to the mail host. */ static SMTPC_SOCKET _Connect(char * SrvAddr) { long IP; long Sock; struct hostent * pHostEntry; struct sockaddr_in sin; int r; // // Convert host into mail host // pHostEntry = gethostbyname(SrvAddr); if (pHostEntry == NULL) { SMTPC_LOG(("gethostbyname failed: %s\r\n", SrvAddr)); return NULL; } IP = *(unsigned*)(*pHostEntry->h_addr_list); // // Create socket and connect to mail server // Sock = socket(AF_INET, SOCK_STREAM, 0); if(Sock == -1) { SMTPC_LOG(("Could not create socket!")); return NULL; } IP_MEMSET(&sin, 0, sizeof(sin)); sin.sin_family = AF_INET; sin.sin_port = htons(SERVER_PORT); sin.sin_addr.s_addr = IP; r = connect(Sock, (struct sockaddr*)&sin, sizeof(sin)); if(r == SOCKET_ERROR) { UM07001 - embOS/IP User Guide 2007 - 2010 SEGGER Microcontroller GmbH & Co. KG
232
CHAPTER 12 SMTPC_LOG(("\nSocket error :")); return NULL; } SMTPC_LOG(("APP: Connected.\r\n")); return (SMTPC_SOCKET)Sock; }
/********************************************************************* * * _Disconnect * * Function description * Closes a socket. */ static void _Disconnect(SMTPC_SOCKET Socket) { closesocket((long)Socket); } /********************************************************************* * * _Send * * Function description * Sends data via socket interface. */ static int _Send(const char * buf, int len, void * pConnectionInfo) { return send((long)pConnectionInfo, buf, len, 0); } /********************************************************************* * * _Recv * * Function description * Receives data via socket interface. */ static int _Recv(char * buf, int len, void * pConnectionInfo) { return recv((long)pConnectionInfo, buf, len, 0); } static const IP_SMTPC_API _IP_Api = { _Connect, _Disconnect, _Send, _Recv };
233
12.7.2 Structure IP_SMTPC_APPLICATION

Description
Structure with pointers to application related functions.
Prototype
typedef struct { U32 (*pfGetTimeDate) (void); int (*pfCallback)(int Stat, void *p); const char * sDomain; // email domain } IP_SMTPC_APPLICATION; Member pfGetTimeDate pfCallback sDomain Description Pointer to the function which returns the current system time. Used to set the correct date and time of the email. Pointer to status callback function. Can be NULL. Domain name. For example, sample.com. According to RFC 821 the maximum total length of a domain name or number is 64 characters.
Table 12.5: Structure IP_SMTPC_APPLICATION member list
Example
********************************************************************* * * _GetTimeDate */ static U32 _GetTimeDate(void) { U32 r; U16 Sec, Min, Hour; U16 Day, Month, Year; // 0 based. Valid range: 0..59 // 0 based. Valid range: 0..59 // 0 based. Valid range: 0..23 // 1 based. Means that 1 is 1. // Valid range is 1..31 (depending on month) Month = 1; // 1 based. Means that January is 1. Valid range is 1..12. Year = 28; // 1980 based. Means that 2008 would be 28. r = Sec / 2 + (Min << 5) + (Hour << 11); r |= (U32)(Day + (Month << 5) + (Year << 9)) << 16; return r; } ********************************************************************* * * _Application */ static const SMTPC_APPLICATION _Application = { _GetTimeDate, NULL, "sample.com" // Your domain. }; Sec Min Hour Day = = = = 0; 0; 0; 1;
234
CHAPTER 12
12.7.3 Structure IP_SMTPC_MAIL_ADDR

Description
Structure to store an email address.
Prototype
typedef struct { const char * sName; const char * sAddr; int Type; } IP_SMTPC_MAIL_ADDR; Member sName sAddr Type Description Name of the recipient (for example, Foo Bar). Can be NULL. email address of the recipient (for example, foo@bar.com). Type of the email address.
Table 12.6: Structure IP_SMTPC_MAIL_ADDR member list
Valid values for parameter Type

Value Description
SMTPC_REC_TYPE_FROM email address of the sender (FROM). SMTPC_REC_TYPE_TO email address of the recipient (TO). email address of a recipient which should SMTPC_REC_TYPE_CC get a carbon copy (CC) of the email. email address of a recipient which should SMTPC_REC_TYPE_BC get a blind carbon copy (BCC) of the email.
The structure is used to store the data sets of the sender and all recipients. IP_SMTPC_Send() gets a pointer to an array of IP_SMTPC_MAIL_ADDR structures as parameter. The first element of these array has to be filled with the data of the sender (FROM). The order of the following data sets for Recipients (TO), Carbon Copies (CC) and Blind Carbon Copies (BCC) is not relevant. For detailed information about IP_SMTPC_Send() refer to IP_SMTPC_Send() on page 229.
Example
/********************************************************************* * * Mailer */ static void _Mailer(void) { SMTPC_MAIL_ADDR MailAddr[4]; SMTPC_MTA Mta; SMTPC_MESSAGE Message; IP_MEMSET(&MailAddr, 0, sizeof(MailAddr)); // // Sender // MailAddr[0].sName = 0; // for example, "Your name"; MailAddr[0].sAddr = 0; // for example, "user@foobar.com"; MailAddr[0].Type = SMTPC_REC_TYPE_FROM; // // Recipient(s) // MailAddr[1].sName = 0; // "Recipient"; MailAddr[1].sAddr = 0; // "recipient@foobar.com"; MailAddr[1].Type = SMTPC_REC_TYPE_TO;
235 MailAddr[2].sName = 0; // "CC Recp 1"; MailAddr[2].sAddr = 0; // "cc1@foobar.com"; MailAddr[2].Type = SMTPC_REC_TYPE_CC; MailAddr[3].sName = 0; // "BCC Recp 1" MailAddr[3].sAddr = 0; // "bcc1@foobar.com";; MailAddr[3].Type = SMTPC_REC_TYPE_BCC; // // Message // Message.sSubject = "SMTP message sent via embOS/IP SMTP client"; Message.sBody = "embOS/IP SMTP client - www.segger.com"; // // Fill mail transfer agent structure // Mta.sServer = 0; // for example, "mail.foobar.com"; Mta.sUser = 0; // for example, "user@foobar.com"; Mta.sPass = 0; // for example, "password"; // // Check if sample is configured! // if(Mta.sServer == 0) { SMTPC_WARN(("You have to enter valid SMTP server, sender and recipient(s).\r\n")); while(1); } // // Wait until link is up. This can take 2-3 seconds if PHY has been reset. // while (IP_IFaceIsReady() == 0) { OS_Delay(100); } SMTPC_Send(&_IP_Api, &MailAddr[0], 4, &Message, &Mta, &_Application); while(1); }
236
CHAPTER 12
12.7.4 Structure IP_SMTPC_MESSAGE

Description
Structure to store the subject and the text of the email.
Prototype
typedef struct { const char * sSubject; const char * sBody; int MessageSize; } IP_SMTPC_MESSAGE; Member sSubject sBody MessageSize Description Pointer to the string used as subject of the email. Pointer to the string used as message of the email. Size of the message.
Table 12.7: Structure IP_SMTPC_MESSAGE member list
237
12.7.5 Structure IP_SMTPC_MTA

Description
Structure to store the server address and the login information.
Prototype
typedef struct { const char * sServer; const char * sUser; const char * sPass; } IP_SMTPC_MTA; Member sServer sUser sPass Description Server address (for example, mail.foobar.com). Account user name (for example, foo@bar.com). Can be NULL. Account password (for example, password). Can be NULL.
Table 12.8: Structure IP_SMTPC_MTA member list
The parameters sUser and sPass have to be NULL if no authentication is used by the server. If sUser is set in the application code, the client tries to use authentication. This means that the client sends the AUTH LOGIN command to the server. If the server does not support authentication, he will return an error code and the client closes the session.
238
CHAPTER 12
12.8 Resource usage

The ROM usage depends on the compiler options, the compiler version and the used CPU. The memory requirements of the SMTP client presented in the tables below have been measured on a system as follows: ARM7, IAR Embedded Workbench V5.11, Thumb mode, Size optimization.
Configuration used
#define SMTPC_OUT_BUFFER_SIZE 256
12.8.1 ROM usage

Add-on embOS/IP SMTP client ROM [Kbytes] TBD
12.8.2 RAM usage:

Almost all of the RAM used by the SMTP client is taken from task stacks. Task Description RAM [bytes] TBD
239
Chapter 13 FTP server (Add-on)
The embOS/IP FTP server is an optional extension to the TCP/IP stack. The FTP server can be used with embOS/IP or with a different TCP/IP stack. All functions which are required to add a FTP server task to your application are described in this chapter.
240
CHAPTER 13
FTP server (Add-on)
13.1 embOS/IP FTP server

The embOS/IP FTP server is an optional extension which adds the FTP protocol to the stack. FTP stands for File Transfer Protocol. It is the basic mechanism for moving files between machines over TCP/IP based networks such as the Internet. FTP is a client/ server protocol, meaning that one machine, the client, initiates a file transfer by contacting another machine, the server and making requests. The server must be operating before the client initiates his requests. Generally a client communicates with one server at a time, while most servers are designed to work with multiple simultaneous clients. The FTP server implements the relevant parts of the following RFCs.
RFC#
[RFC 959]
Description
FTP - File Transfer Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc959.txt
The following table shows the contents of the embOS/IP FTP server root directory: Directory Application\ Config Inc IP Contents Contains the example application to run the FTP server with embOS/IP. Contains the FTP server configuration file. Contains the required include files. Contains the FTP server sources. Contains the sources for the file system abstraction layer and the read-only file system. Refer to File system abstraction layer function table on page 303 for detailed information. Contains the source, the project files and an executable to run embOS/IP FTP server on a Microsoft Windows host.
IP\FS\
Windows\FTPserver\
Supplied directory structure of embOS/IP FTP server package
241
13.2 Feature list

Low memory footprint. Multiple connections supported. Independent of the file system: Any file system can be used. Independent of the TCP/IP stack: Any stack with sockets can be used. Demo application included. Project for executable on PC for Microsoft Visual Studio included.
242
CHAPTER 13
FTP server (Add-on)
13.3 Requirements
TCP/IP stack
The embOS/IP FTP server requires a TCP/IP stack. It is optimized for embOS/IP, but any RFC-compliant TCP/IP stack can be used. The shipment includes a Win32 simulation, which uses the standard Winsock API and an implementation which uses the socket API of embOS/IP.
Multi tasking
The FTP server needs to run as a separate thread. Therefore, a multi tasking system is required to use the embOS/IP FTP server.
243
13.4 FTP basics

The File Transfer Protocol (FTP) is an application layer protocol. FTP is an unusual service in that it utilizes two ports, a 'Data' port and a 'CMD' (command) port. Traditionally these are port 21 for the command port and port 20 for the data port. FTP can be used in two modes, active and passive. Depending on the mode, the data port is not always on port 20.
Application layer
FTP
Transport layer
TCP
Network layer
IP
Link layer
When an FTP client contacts a server, a TCP connection is established between the two machines. The server does a passive open (a socket is listen) when it begins operation; thereafter clients can connect with the server via active opens. This TCP connection persists for as long as the client maintains a session with the server, (usually determined by a human user) and is used to convey commands from the client to the server, and the server replies back to the client. This connection is referred to as the FTP command connection. The FTP commands from the client to the server consist of short sets of ASCII characters, followed by optional command parameters. For example, the FTP command to display the current working directory is PWD (Print Working Directory). All commands are terminated by a carriage return-linefeed sequence (CRLF) (ASCII 10,13; or CtrlJ, Ctrl-M). The servers replies consist of a 3 digit code (in ASCII) followed by some explanatory text. Generally codes in the 200s are success and 500s are failures. See the RFC for a complete guide to reply codes. Most FTP clients support a verbose mode which will allow the user to see these codes as commands progress. If the FTP command requires the server to move a large piece of data (like a file), a second TCP connection is required to do this. This is referred to as the FTP data connection (as opposed to the aforementioned command connection). In active mode the data connection is opened by the server back to a listening client. In passive mode the client opens also the data connection. The data connection persists only for transporting the required data. It is closed as soon as all the data has been sent.
244
CHAPTER 13
FTP server (Add-on)
13.4.1 Active mode FTP

In active mode FTP the client connects from a random unprivileged port P (P > 1023) to the FTP server's command port, port 21. Then, the client starts listening to port P+1 and sends the FTP command PORT P+1 to the FTP server. The server will then connect back to the client's specified data port from its local data port, which is port 20.
Server 20 Data 21 Cmd

1 2
Client 1026 Cmd 1027 Data
245
13.4.2 Passive mode FTP

In passive mode FTP the client connects from a random unprivileged port P (P > 1023) to the FTP server's command port, port 21. In opposite to an active mode FTP connection where the client opens a passive port for data transmission and waits for the connection from server-side, the client sends in passive mode the PASV command to the server and expects an answer with the information on which port the server is listening for the data connection. After receiving this information, the client connects to the specified data port of the server from its local data port.
Server 20 Data 1655 Data 21 Cmd

1 2
246
CHAPTER 13
FTP server (Add-on)
13.4.3 FTP reply codes

Every FTP command is answered by one or more reply codes defined in [RFC 959]. A reply is an acknowledgment (positive or negative) sent from server to user via the control connection in response to FTP commands. The general form of a reply is a 3digit completion code (including error codes) followed by Space <SP>, followed by one line of text and terminated by carriage return line feed <CRLF>. The codes are for use by programs and the text is usually intended for human users. The first digit of the reply code defines the class of response. There are 5 values for the first digit: 1yz: 2yz: 3yz: 4yz: 5yz: Positive preliminary reply Positive completion reply Positive intermediate reply Transient negative Completion reply Permanent negative Completion reply
The second digit of the reply code defines the group of the response. x0z: Syntax - Syntax errors, syntactically correct commands that don't fit any functional category, unimplemented or superfluous commands. x1z: Information - These are replies to requests for information, such as status or help. x2z: Connections - Replies referring to the control and data connections. x3z: Authentication and accounting - Replies for the login process and accounting procedures. x4z: Unspecified as yet. x5z: File system - These replies indicate the status of the Server file system visa-vis the requested transfer or other file system action.
The third digit gives a finer gradation of meaning in each of the function categories, specified by the second digit.
247
13.4.4 Supported FTP commands

embOS/IP FTP server supports a subset of the defined FTP commands. Refer to [RFC 959] for a complete detailed description of the FTP commands. The following FTP commands are implemented: FTP commands CDUP CWD DELE LIST MKD NLST NOOP PASS PASV PORT PWD RETR RMD SIZE STOR SYST TYPE USER XCUP XMKD XPWD XRMD Description Change to parent directory Change working directory Delete List Make directory Name list No operation Password Passive Data port Print the current working directory Retrieve Remove directory Size of file Store System Representation type User name Change to parent directory Make directory Print the current working directory Remove directory
Table 13.1: embOS/IP FTP commands
248
CHAPTER 13
FTP server (Add-on)
13.5 Using the FTP server sample

Ready to use examples for Microsoft Windows and embOS/IP are supplied. If you use another TCP/IP stack the sample OS_IP_FTPServer.c has to be adapted. The sample application opens a port which listens on port 21 until an incoming connection is detected. If a connection has been established IP_FTPS_Process() handles the client request in an extra task, so that the server is further listening on port 21. The example application requires a file system to make data files available. Refer to File system abstraction layer on page 302 and File system abstraction layer on page 302 for detailed information.
13.5.1 Using the Windows sample

If you have MS Visual C++ 6.00 or any later version available, you will be able to work with a Windows sample project using embOS/IP FTP server. If you do not have the Microsoft compiler, an precompiled executable of the FTP server is also supplied. The base directory of the Windows sample application is C:\FTP\.
Building the sample program

Open the workspace Start_FTPServer.dsw with MS Visual Studio (for example, double-clicking it). There is no further configuration necessary. You should be able to build the application without any error or warning message. The server uses the IP address of the host PC on which it runs. Open a FTP client and connect by entering the IP address of the host (127.0.0.1) to connect to the FTP server. The server accepts anonymous logins. You can also login with the user name "Admin" and the password "Secret".
13.5.2 Running the FTP server example on target hardware

The embOS/IP FTP server sample application should always be the first step to check the proper function of the FTP server with your target hardware. Add all source files located in the following directories (and their subdirectories) to your project and update the include path: Application Config Inc IP IP\IP_FS\[NameOfUsedFileSystem]
It is recommended that you keep the provided folder structure. The sample application can be used on the most targets without the need for changing any of the configuration flags. The server processes two connections using the default configuration. Note: Two connections mean that the target can handle up one target. A target requires always two connection, one for the command transfer and one for the data transfers. Every connection is handled in an separate task. Therefore, the FTP server uses up to three tasks in the default configuration. One task which listens on port 21 and accepts connections and two tasks to process the accepted connection. To modify the number of connections only the macro MAX_CONNECTIONS has to be modified.
249
13.6 Access control

The embOS/IP FTP server supports a fine-grained access permission scheme. Access permissions can be defined on user-basis for every directory. The access permission of a directory is a combination of the following attributes: visible, readable and writable. To control the access permission three callback functions have be implemented in the user application. The callback functions are defined in the structure FTPS_ACCESS_CONTROL. For detailed information about these structure, refer to Structure FTPS_ACCESS_CONTROL on page 259.
13.6.1 pfFindUser()
Description
Callback function which checks if the user is valid.
Prototype
int (*pfFindUser) ( const char * sUser );
Return value
0 - UserID invalid or unknown 0 < - UserID, no password required 0 > - UserID, password required
Parameter
Parameter sUser [IN] User name.
Table 13.2: pfFindUser() parameter list
Description
Example
enum { USER_ID_ANONYMOUS = 1, USER_ID_ADMIN }; /********************************************************************* * * _FindUser * * Function description * Callback function for user management. * Checks if user name is valid. * * Return value * 0 UserID invalid or unknown * > 0 UserID, no password required * < 0 - UserID, password required */ static int _FindUser (const char * sUser) { if (strcmp(sUser, "Admin") == 0) { return - USER_ID_ADMIN; } if (strcmp(sUser, "anonymous") == 0) { return USER_ID_ANONYMOUS; } return 0; }
250
CHAPTER 13
FTP server (Add-on)
13.6.2 pfCheckPass()
Description
Callback function which checks if the password is valid.
Prototype
int (*pfCheckPass) ( int UserId, const char * sPass );
Parameter
Parameter UserId Pass [IN] Id number [IN] Password string. Description
Table 13.3: pfCheckPass() parameter list
Example
enum { USER_ID_ANONYMOUS = 1, USER_ID_ADMIN }; /********************************************************************* * * _CheckPass * * Function description * Callback function for user management. * Checks user password. * * Return value * 0 UserID know, password valid * 1 UserID unknown or password invalid */ static int _CheckPass (int UserId, const char * sPass) { if ((UserId == USER_ID_ADMIN) && (strcmp(sPass, "Secret") == 0)) { return 0; } else { return 1; } }
251
13.6.3 pfGetDirInfo()
Description
Callback function which checks the permissions of the connected user for every directory.
Prototype
int (*pfGetDirInfo) ( int UserId, const char * sDirIn, char * pDirOut, int SizeOfDirOut );
Parameter
Parameter UserId sDirIn pDirOut SizeOfDirOut [IN] [IN] [OUT] [IN] Size of Description
Table 13.4: pfGetDirInfo() parameter list
Additional information Example

/* Excerpt from IP_FTPServer.h */ #define IP_FTPS_PERM_VISIBLE (1 << 0) #define IP_FTPS_PERM_READ (1 << 1) #define IP_FTPS_PERM_WRITE (1 << 2) /* Excerpt from OS_IP_FTPServer.c */ /********************************************************************* * * _GetDirInfo * * Function description * Callback function for user management. * Checks user authorizations. * * Return value * Returns a combination of the following: * IP_FTPS_PERM_LIST * IP_FTPS_PERM_READ * IP_FTPS_PERM_WRITE */ static int _GetDirInfo (int UserId, const char * sDirIn, char * sDirOut, int DirOutSize) { int Perm; Perm = IP_FTPS_PERM_VISIBLE | IP_FTPS_PERM_READ | IP_FTPS_PERM_WRITE; if (strcmp(sDirIn, "ReadOnly") == 0) { Perm = IP_FTPS_PERM_VISIBLE | IP_FTPS_PERM_READ; } if (strcmp(sDirIn, "NotReadable") == 0) { Perm = IP_FTPS_PERM_VISIBLE; } if (strcmp(sDirIn, "Admin") == 0) { if (UserId != USER_ID_ADMIN) { return 0; // Only Admin is allowed for this directory } } if (sDirOut == NULL) {
252
CHAPTER 13 return Perm; } if ((int)strlen(sDirIn) >= DirOutSize) { return 0; // Does not fit } strcpy(sDirOut, sDirIn); return Perm; }
FTP server (Add-on)
253
13.7 Configuration
The embOS/IP FTP server can be used without changing any of the compile time flags. All compile time configuration flags are preconfigured with valid values, which match the requirements of most applications. The following types of configuration macros exist:
Binary switches "B"


Alias "A"


Type F Symbolic name Default -Description Defines a function to output warnings. In debug configurations (DEBUG == 1) FTPS_WARN maps to IP_Warnf_Application() Defines a function to output logging messages. In debug configurations (DEBUG == 1) FTPS_LOG maps to IP_Logf_Application(). Defines the size of the buffer used for the authentication string. Defines the size of the send and receive buffer of the FTP server. Defines the maximum length of the buffer used for the path string. Defines the maximum length of the buffer used for the directory string. Defines the size of the buffer used for the authentication string.
FTPS_WARN
FTPS_LOG
--
N N N N N
FTPS_AUTH_BUFFER_SIZE FTPS_BUFFER_SIZE FTPS_MAX_PATH FTPS_MAX_PATH_DIR FTPS_ERR_BUFFER_SIZE
32 512 128 64 256
254
CHAPTER 13
FTP server (Add-on)
13.7.2 FTP server system time

The FTP server requires a system time for the transmission of a complete file timestamp. FTP servers send only a piece of the timestamp of a file, either month, day and year or month, day and time. For the decision which pieces of the timestamp has to be transmitted, it compares the year of the current system time with the year which is stored in the timestamp of the file. Depending on the result of this comparison either the year or the time will be send. The following two examples show the output for both cases.
Example
1. If the value for year in the timestamp of the file is smaller then the value for year in the current system time, year will be sent: -rw-r--r-1 root 2000 Jan 1 2007 PAKET00.TXT In this case, the FTP client leaves this column empty or fills the missing time with 00:00. The following screenshot shows the output of the Microsoft Windows command line FTP client: If the value for year in the timestamp of the file is identical to the value for year in the current system time, the time (HH:MM) will be sent: -rw-r--r-1 root 1000 Jul 29 11:04 PAKET01.TXT In this case, the FTP client leaves this column empty or fills the missing year with the current year. The following screenshot shows the output of the Microsoft Windows command line FTP client:
2.
In the example, the value for the current time and date is defined to 1980-01-01 00:00. Therefore, the output will be similar to example 1., since no real time clock (RTC) has been implemented. Refer to pfGetTimeDate() on page 255 for detailed information.
255
13.7.2.1 pfGetTimeDate()
Description
Returns the current system time.
Prototype
int (*pfGetTimeDate) ( void );
Return value
Current system time. If no real time clock is implemented, it should return 0x00210000 (1980-01-01 00:00)
The format of the time is arranged as follows: Bit 0-4: 2-second count (0-29) Bit 5-10: Minutes (0-59) Bit 11-15: Hours (0-23) Bit 16-20: Day of month (1-31) Bit 21-24: Month of year (1-12) Bit 25-31: Number of years since1980 (0-127) This function pointer is used in the FTPS_APPLICATION structure. Refer to Structure FTPS_APPLICATION on page 260 for further information.
Example
static U32 _GetTimeDate(void) { U32 r; U16 Sec, Min, Hour; U16 Day, Month, Year; // 0 based. Valid range: 0..59 // 0 based. Valid range: 0..59 // 0 based. Valid range: 0..23 // 1 based. Means that 1 is 1. // Valid range is 1..31 (depending on month) Month = 1; // 1 based. Means that January is 1. Valid range is 1..12. Year = 28; // 1980 based. Means that 2008 would be 28. r = Sec / 2 + (Min << 5) + (Hour << 11); r |= (U32)(Day + (Month << 5) + (Year << 9)) << 16; return r; } Sec Min Hour Day = = = = 0; 0; 0; 1;
256
CHAPTER 13
FTP server (Add-on)
13.8 API functions

Function IP_FTPS_Process() IP_FTPS_OnConnectionLimit() Description Initializes and starts the embOS/IP FTP server. Returns when the connection is closed or a fatal error occurs.
Table 13.5: embOS/IP FTP server interface function overview
257
13.8.1 IP_FTPS_Process()
Description
Initializes and starts the FTP server.
Prototype
int IP_FTPS_Process ( const IP_FTPS_API void const IP_FS_API const FTPS_APPLICATION * * * * pIP_API, pConnectInfo, pFS_API, pApplication );
Parameter
Parameter pIP_API pConnectInfo pFS_API pApplication [IN] [IN] [IN] [IN] Pointer Pointer Pointer Pointer to to to to Description a structure of type IP_FTPS_API. the connection info. the used file system API. a structure of type FTPS_APPLICATION.
Table 13.6: IP_FTPS_Process() parameter list
The structure type IP_FTPS_API contains mappings of the required socket functions to the actual IP stack. This is required because the socket functions are slightly different on different systems. The connection info is the socket which was created when the client has been connected to the command port (usually port 21). For detailed information about the structure type IP_FS_API refer to Appendix A - File system abstraction layer on page 301. For detailed information about the structure type FTPS_APPLICATION refer to Structure FTPS_APPLICATION on page 260.
258
CHAPTER 13
FTP server (Add-on)
13.8.2 IP_FTPS_OnConnectionLimit()
Description
Returns when the connection is closed or a fatal error occurs.
Prototype
void IP_FTPS_OnConnectionLimit( const IP_FTPS_API * pIP_API, void * CtrlSock );
Parameter
Parameter pIP_API CtrlSock Description [IN] Pointer to a structure of type IP_FTPS_API. [IN] Pointer to the socket which is related to the command connection.
Table 13.7: IP_FTPS_OnConnectionLimit() parameter list
The structure type IP_FTPS_API contains mappings of the required socket functions to the actual IP stack. This is required because the socket functions are slightly different on different systems.
259
13.9 FTP server data structures

13.9.1 Structure FTPS_ACCESS_CONTROL
Description
This structure contains the pointer to the access control callback functions.
Prototype
typedef struct { int (*pfFindUser) int (*pfCheckPass) ( const char ( int const char int (*pfGetDirInfo) ( int const char char int } FTPS_ACCESS_CONTROL; Member pfFindUser pfCheckPass pfGetDirInfo * sUser ); UserId, * sPass ); UserId, * sDirIn, * sDirOut, SizeOfDirOut );
Description Callback function that checks if the user is valid. Callback function that checks if the password is valid. Callback function that checks the permissions of the connected user for every directory.
Table 13.8: Structure FTPS_ACCESS_CONTROL member list
Example
Refer to Access control on page 249 for an example.
260
CHAPTER 13
FTP server (Add-on)
13.9.2 Structure FTPS_APPLICATION

Description
Used to store application specific parameters.
Prototype
typedef struct { FTPS_ACCESS_CONTROL * pAccess; U32 (*pfGetTimeDate) (void); } FTPS_APPLICATION; Member Description
pAccess Pointer to the FTPS_ACCESS_APPLCIATION structure. pfGetTimeDate Pointer to the function which returns the current system time.
Table 13.9: Structure FTPS_APPLICATION member list
Example
For additional information to structure FTPS_ACCESS_APPLICATION refer to Structure FTPS_ACCESS_CONTROL on page 259. For additional information to function pointer pfGetTimeDate() refer to FTP server system time on page 254.
Example
/* Excerpt from OS_IP_FTPServer.c */ /********************************************************************* * * FTPS_ACCESS_CONTROL * * Description * User/pass data table */ static FTPS_ACCESS_CONTROL _Access_Control = { _FindUser, _CheckPass, _GetDirInfo }; ********************************************************************* * * _GetTimeDate */ static U32 _GetTimeDate(void) { U32 r; U16 Sec, Min, Hour; U16 Day, Month, Year; Sec Min Hour Day // 0 based. Valid range: 0..59 // 0 based. Valid range: 0..59 // 0 based. Valid range: 0..23 // 1 based. Means that 1 is 1. // Valid range is 1..31 (depending on month) Month = 1; // 1 based. Means that January is 1. Valid range is 1..12. Year = 28; // 1980 based. Means that 2008 would be 28. r = Sec / 2 + (Min << 5) + (Hour << 11); r |= (U32)(Day + (Month << 5) + (Year << 9)) << 16; return r; } ********************************************************************* * * FTPS_APPLICATION * * Description * Application data table, defines all application specifics * used by the FTP server */ static const FTPS_APPLICATION _Application = { &_Access_Control, _GetTimeDate }; = = = = 0; 0; 0; 1;
261
13.10 Resource usage

The ROM usage depends on the compiler options, the compiler version and the used CPU. The memory requirements of the FTP server presented in the tables below have been measured on a system as follows: ARM7, IAR Embedded Workbench V5.11, Thumb mode, Size optimization.
Configuration used
#define #define #define #define #define FTPS_AUTH_BUFFER_SIZE 32 FTPS_BUFFER_SIZE 128 FTPS_MAX_PATH 128 FTPS_MAX_PATH_DIR 64 FTPS_ERR_BUFFER_SIZE (FTPS_BUFFER_SIZE / 2)
13.10.1 ROM usage

Add-on embOS/IP FTP server ROM [Kbytes] 6.8
13.10.2 RAM usage:

Almost all of the RAM used by the FTP server is taken from task stacks. The amount of RAM required for every child task depends on the configuration of your server. Task ParentTask ChildTask Note: Description Listens for incoming connections. Handles a request. RAM [bytes] 500 1800
The FTP server requires at least 1 child task.
The approximately RAM usage for the FTP server can be calculated as follows: RAM usage = 0.2 Kbytes + ParentTask + (NumberOfChildTasks * 1.8 Kbytes)
Example: FTP server accepting up only 1 connection

RAM usage = 0.2 Kbytes + 0.5 Kbytes + (1 * 1.8 Kbytes) RAM usage = 2.5 Kbytes
262
CHAPTER 13
FTP server (Add-on)
263
Chapter 14 FTP client (Add-on)
The embOS/IP FTP client is an optional extension to the TCP/IP stack. The FTP client can be used with embOS/IP or with a different TCP/IP stack. All functions which are required to add a FTP client to your application are described in this chapter.
264
CHAPTER 14
FTP client (Add-on)
14.1 embOS/IP FTP client

The embOS/IP FTP client is an optional extension which adds the client part of FTP protocol to the stack. FTP stands for File Transfer Protocol. It is the basic mechanism for moving files between machines over TCP/IP based networks such as the Internet. FTP is a client/server protocol, meaning that one machine, the client, initiates a file transfer by contacting another machine, the server and making requests. The FTP client implements the relevant parts of the following RFCs.
RFC#
[RFC 959]
Description
FTP - File Transfer Protocol Direct download: ftp://ftp.rfc-editor.org/in-notes/rfc959.txt
The following table shows the contents of the embOS/IP FTP client root directory: Directory Application\ Config Inc IP Contents Contains the example application to run the FTP client with embOS/IP. Contains the FTP client configuration file. Contains the required include files. Contains the FTP client sources. Contains the sources for the file system abstraction layer and the read-only file system. Refer to File system abstraction layer function table on page 303 for detailed information. Contains the source, the project files and an executable to run embOS/IP FTP client on a Microsoft Windows host.
IP\FS\
Windows\FTPclient\
Supplied directory structure of embOS/IP FTP client package
265
14.2 Feature list

Low memory footprint. Multiple connections supported. Independent of the file system: Any file system can be used. Independent of the TCP/IP stack: Any stack with sockets can be used. Demo application included. Project for executable on PC for Microsoft Visual Studio included.
266
CHAPTER 14
FTP client (Add-on)
14.3 Requirements
TCP/IP stack
The embOS/IP FTP client requires a TCP/IP stack. It is optimized for embOS/IP, but any RFC-compliant TCP/IP stack can be used. The shipment includes a Win32 simulation, which uses the standard Winsock API and an implementation which uses the socket API of embOS/IP.
267
14.4 FTP basics

The File Transfer Protocol (FTP) is an application layer protocol. FTP is an unusual service in that it utilizes two ports, a 'Data' port and a 'CMD' (command) port. Traditionally these are port 21 for the command port and port 20 for the data port. FTP can be used in two modes, active and passive. Depending on the mode, the data port is not always on port 20.
Application layer
FTP
Transport layer
TCP
Network layer
IP
Link layer
When an FTP client contacts a server, a TCP connection is established between the two machines. The server does a passive open (a socket is listen) when it begins operation; thereafter clients can connect with the server via active opens. This TCP connection persists for as long as the client maintains a session with the server, (usually determined by a human user) and is used to convey commands from the client to the server, and the server replies back to the client. This connection is referred to as the FTP command connection. The FTP commands from the client to the server consist of short sets of ASCII characters, followed by optional command parameters. For example, the FTP command to display the current working directory is PWD (Print Working Directory). All commands are terminated by a carriage return-linefeed sequence (CRLF) (ASCII 10,13; or CtrlJ, Ctrl-M). The servers replies consist of a 3 digit code (in ASCII) followed by some explanatory text. Generally codes in the 200s are success and 500s are failures. See the RFC for a complete guide to reply codes. Most FTP clients support a verbose mode which will allow the user to see these codes as commands progress. If the FTP command requires the server to move a large piece of data (like a file), a second TCP connection is required to do this. This is referred to as the FTP data connection (as opposed to the aforementioned command connection). In active mode the data connection is opened by the server back to a listening client. In passive mode the client opens also the data connection. The data connection persists only for transporting the required data. It is closed as soon as all the data has been sent.
268
CHAPTER 14
FTP client (Add-on)
14.4.1 Passive mode FTP

In passive mode FTP the client connects from a random unprivileged port P (P > 1023) to the FTP server's command port, port 21. In opposite to an active mode FTP connection where the client opens a passive port for data transmission and waits for the connection from server-side, the client sends in passive mode the PASV command to the server and expects an answer with the information on which port the server is listening for the data connection. After receiving this information, the client connects to the specified data port of the server from its local data port.
Server 20 Data 1655 Data 21 Cmd

1 2
Note: In the current version of embOS/IP, the FTP client supports only passive mode FTP. Active mode FTP will be added in one of the coming versions.
269
14.4.2 Supported FTP client commands

embOS/IP FTP client supports a subset of the defined FTP commands. Refer to [RFC 959] for a complete detailed description of the FTP commands. The following FTP commands are implemented: FTP commands CDUP CWD PASS PASV PWD RETR STOR SYST TYPE USER Description Change to parent directory Change working directory Password Passive Print the current working directory Retrieve Store System Representation type User name
Table 14.1: embOS/IP FTP client commands
270
CHAPTER 14
FTP client (Add-on)
14.5 Configuration
The embOS/IP FTP client can be used without changing any of the compile time flags. All compile time configuration flags are preconfigured with valid values, which match the requirements of most applications. The following types of configuration macros exist:
Binary switches "B"


Alias "A"


Type F Symbolic name Default -Description Defines a function to output warnings. In debug configurations (DEBUG == 1) FTPS_WARN should be mapped to IP_Warnf_Application() Defines a function to output logging messages. In debug configurations (DEBUG == 1) FTPS_LOG should be mapped to IP_Logf_Application(). Defines the size of the in and the out buffer of the FTP client. This means that the client requires the defined number of bytes for each buffer. For example, FTPC_BUFFER_SIZE == 512 means 1024 bytes RAM requirement. Defines the maximum length of the buffer used for the control channel. Defines the maximum length of the buffer used for the server reply strings. This buffer is only required and used in debug builds. In release builds the memory will not be allocated.
FTPS_WARN
FTPS_LOG
--
FTPC_BUFFER_SIZE
512
FTPC_CTRL_BUFFER_SIZE
256
FTPC_SERVER_REPLY_BUFFER_ 128 SIZE
271
14.6 API functions

Function IP_FTPC_Connect() IP_FTPC_Disconnect() IP_FTPC_ExecCmd() IP_FTPC_Init() Description Establishes a connection to a FTP server. Closes an established connection to a FTP server. Sends a command to a FTP server. Initializes the embOS/IP FTP client.
Table 14.2: embOS/IP FTP client interface function overview
272
CHAPTER 14
FTP client (Add-on)
14.6.1 IP_FTPC_Connect()
Description
Establishes a connection to a FTP server.
Prototype
int IP_FTPC_Connect ( IP_FTPC_CONTEXT * pContext, const char * sServer, const char * sUser, const char * sPass, unsigned PortCmd, unsigned Mode );
Parameter
Parameter pContext sServer sUser sPass PortCmd Mode Description [IN] Pointer to a structure of type IP_FTPC_CONTEXT. [IN] Dot-decimal IP address of a FTP server, for example "192.168.1.55". [IN] User name if required for the authentication. Can be NULL. [IN] Password if required for the authentication. Can be NULL. [IN] Port number of the port which is in listening mode on the FTP server. The well-known port for an FTP server that is waiting for connections is 21. [IN] FTP transfer mode.
Table 14.3: IP_FTPC_Connect() parameter list
Valid values for parameter Mode FTPC_MODE_PASSIVE
Description Use passive mode FTP.
Return value
0 on success. 1 on error. Illegal parameter (pContext == NULL). -1 on error during the process of establishing a connection.
The function IP_FTPC_Init() must be called before a call IP_FTPC_Connect(). For detailed information about IP_FTPC_Init() refer to IP_FTPC_Init() on page 277. Note: In the current version of embOS/IP, the FTP client supports only passive mode FTP.
Example
Refer to IP_FTPC_ExecCmd() on page 274 for an example application which uses IP_FTPC_Connect().
273
14.6.2 IP_FTPC_Disconnect()
Description
Closes an established connection to a FTP server.
Prototype
int IP_FTPC_Disconnect ( IP_FTPC_CONTEXT * pContext );
Parameter
Parameter pContext
Table 14.4: IP_FTPC_Disconnect() parameter list
Description [IN] Pointer to a structure of type IP_FTPC_CONTEXT.
Return value
0 on success. 1 on error. Illegal parameter (pContext == NULL).
Example
Refer to IP_FTPC_ExecCmd() on page 274 for an example application which uses IP_FTPC_Disconnect().
274
CHAPTER 14
FTP client (Add-on)
14.6.3 IP_FTPC_ExecCmd()
Description
Executes a command on the FTP server.
Prototype
int IP_FTPC_ExecCmd ( IP_FTPC_CONTEXT * pContext, unsigned Cmd, const char * sPara );
Parameter
Parameter pContext Cmd sPara Description [IN] Pointer to a structure of type IP_FTPC_CONTEXT. [IN] See table below. [IN] String with the required parameters for the command. Depending on the command, the parameter can be NULL.
Table 14.5: IP_FTPC_ExecCmd() parameter list
Valid values for parameter Cmd
Description The command CWD (Change Working Directory). sPara is the path to the directory that should be accessed. The command CDUP (Change to Parent Directory). sPara is NULL. The command STOR (Store). sPara is the name of the file that should be stored on the server. The FTP client opens the file and transmits it to the FTP server. The command RETR (Retrieve). sPara is the name of the file that should be received from the server. The FTP client creates a file on the used storage medium and stores the retrieved file. The command PWD (Print Working Directory). sPara is NULL.
FTPC_CMD_CWD
FTPC_CMD_CDUP
FTPC_CMD_STOR
FTPC_CMD_RETR
FTPC_CMD_PWD
Return value
0 on success. 1 on error. Illegal parameter (pContext == NULL). -1 on error during command execution.
IP_FTPC_Init() and IP_FTPC_Connect() have to be called before IP_FTPC_ExecCmd(). Refer to IP_FTPC_Init() on page 277 for detailed information about how to initialize the FTP client and refer to IP_FTPC_Connect() on page 272 for detailed information about how to establish a connection to a FTP server. IP_FTPC_ExecCmd() sends a command to the server and handles everything what is required on FTP client side. The commands which are listed in section Supported FTP client commands on page 269, but not explained here, are normally not directly called from the user application. There is no need to call IP_ExecCmd() with these commands. The FTP client uses these commands internally and sends them to the server if required. For example, the call of IP_FTPC_Connect() sends the the com-
275
mands USER, PASS and SYST to the server and process the server replies for each of the commands, an explicit call of IP_FTPC_Exec() with one of these commands is not requried.
Example
/* Excerpt from the example application OS_IP_FTPClient.c */ /********************************************************************* * * MainTask * * Note: * The size of the stack of this task should be at least * 1200 bytes + FTPC_CTRL_BUFFER_SIZE + 2 * FTPC_BUFFER_SIZE. */ void MainTask(void); void MainTask(void) { IP_FTPC_CONTEXT FTPConnection; U8 acCtrlIn[FTPC_CTRL_BUFFER_SIZE]; U8 acDataIn[FTPC_BUFFER_SIZE]; U8 acDataOut[FTPC_BUFFER_SIZE]; int r; // // Initialize the IP stack // IP_Init(); OS_CREATETASK(&_TCB, "IP_Task", IP_Task , 150, _IPStack); // Start the IP_Task // // Check if target is configured // while (IP_IFaceIsReady() == 0) { BSP_ToggleLED(1); OS_Delay(50); } // // FTP client task // while (1) { BSP_SetLED(0); // // Initialize FTP client context // memset(&FTPConnection, 0, sizeof(FTPConnection)); // // Initialize the FTP client // IP_FTPC_Init(&FTPConnection, &_IP_Api, &IP_FS_FS, acCtrlIn, sizeof(acCtrlIn), acDataIn, sizeof(acDataIn), acDataOut, sizeof(acDataOut)); // // Connect to the FTP server // r = IP_FTPC_Connect(&FTPConnection, "192.168.199.164", "Admin", "Secret", 21, FTPC_MODE_PASSIVE); if (r == FTPC_ERROR) { FTPC_LOG(("APP: Could not connect to FTP server.\r\n")); goto Disconnect; } // // Change from root directory into directory "Test" // r = IP_FTPC_ExecCmd(&FTPConnection, FTPC_CMD_CWD, "/Test/"); if (r == FTPC_ERROR) { FTPC_LOG(("APP: Could not change working directory.\r\n")); goto Disconnect; }
276
CHAPTER 14 // // Upload the file "Readme.txt // r = IP_FTPC_ExecCmd(&FTPConnection, FTPC_CMD_STOR, "Readme.txt"); if (r == FTPC_ERROR) { FTPC_LOG(("APP: Could not upload data file.\r\n")); goto Disconnect; } // // Change back to root directory. // r = IP_FTPC_ExecCmd(&FTPConnection, FTPC_CMD_CDUP, NULL); if (r == FTPC_ERROR) { FTPC_LOG(("APP: Change to parent directory failed.\r\n")); goto Disconnect; } // // Disconnect. // Disconnect: IP_FTPC_Disconnect(&FTPConnection); FTPC_LOG(("APP: Done.\r\n")); BSP_ClrLED(0); OS_Delay (10000); } }
FTP client (Add-on)
277
14.6.4 IP_FTPC_Init()
Description
Initializes the FTP client context.
Prototype
int IP_FTPC_Init ( IP_FTPC_CONTEXT * pContext, const IP_FTPC_API * pIP_API, const IP_FS_API * pFS_API, U8 * pCtrlBuffer, unsigned NumBytesCtrl, U8 * pDataInBuffer, unsigned NumBytesDataIn, U8 * pDataOutBuffer, unsigned NumBytesDataOut );
Parameter
Parameter pContext pIP_API pFS_API Description
[IN] Pointer to a structure of type IP_FTPC_CONTEXT. [IN] Pointer to a structure of type IP_FTPC_API. [IN] Pointer to the file system API. [IN] Pointer to the buffer used for the control channel informapControlBuffer tion. NumBytesCtrl [IN] Size of the control buffer in bytes. pDataInBuffer [IN] Pointer to the buffer used to receive data from the server. NumBytesDataIn [IN] Size of the receive buffer in bytes. pDataOutBuffer [IN] Pointer to the buffer used to transmit data to the server. NumBytesDataOut [IN] Size of the transmit buffer in bytes.
Table 14.6: IP_FTPC_Init() parameter list
Return value
0 on success. 1 on error. Invalid parameters.
IP_FTPC_Init() must be called before any other FTP client function will be called. For detailed information about the structure type IP_FS_API refer to Appendix A - File system abstraction layer on page 301. For detailed information about the structure type IP_FTPC_API refer to Appendix A - File system abstraction layer on page 301.
Example
Refer to IP_FTPC_ExecCmd() on page 274 for an example application which uses IP_FTPC_Init().
278
CHAPTER 14
FTP client (Add-on)
14.7 FTP client data structures

14.7.1 Structure IP_FTPC_API
Description
This structure contains the pointer to the socket functions which are required to use the FTP client.
Prototype
typedef struct FTPC_SOCKET void int int } IP_FTPC_API; Member pfConnect pfDisconnect pfSend pfReceive Callback function level. Callback function socket level. Callback function Callback function level. { (*pfConnect) (const char * SrvAddr, unsigned SrvPort); (*pfDisconnect) (FTPC_SOCKET Socket); (*pfSend) (const char * pData, int Len, FTPC_SOCKET Socket); (*pfReceive) (char * pData, int Len, FTPC_SOCKET Socket);
Description that handles the connect to a FTP server on socket that disconnects a connection to the FTP server on that sends data to the FTP server on socket level. that receives data from the FTP server on socket
Table 14.7: Structure IP_FTPC_API member list
279
14.8 Resource usage

The ROM usage depends on the compiler options, the compiler version and the used CPU. The memory requirements of the FTP client presented in the tables below have been measured on a system as follows: ARM7, IAR Embedded Workbench V5.41b, Thumb mode, Size optimization.
Configuration used
#define FTPC_BUFFER_SIZE #define FTPC_CTRL_BUFFER_SIZE #define FTPC_SERVER_REPLY_BUFFER_SIZE 512 256 128
// Only required in debug builds // with enabled logging.
14.8.1 ROM usage

Add-on embOS/IP FTP client ROM [Kbytes]
14.8.2 RAM usage:

Almost all of the RAM used by the FTP server is taken from task stacks. The amount of RAM required depends on the configuration of your client. Build Release Description A task used for the FTP client without debugging features and disabled debug outputs. RAM [bytes] app. 1400
The approximately task stack size required for the FTP client can be calculated as follows: TaskStackSize = 2 * FTPC_BUFFER_SIZE + FTPC_CTRL_BUFFER_SIZE Build Debug Description A task used for the FTP client with debugging features and enabled debug outputs. RAM [bytes] app. 1550
The approximately task stack size required for the FTP client can be calculated as follows: TaskStackSize = 2 * FTPC_BUFFER_SIZE + FTPC_CTRL_BUFFER_SIZE + FTPC_SERVER_REPLY_BUFFER_SIZE
280
CHAPTER 14
FTP client (Add-on)
281
Chapter 15 Debugging
embOS/IP comes with various debugging options. These includes optional warning and log outputs, as well as other run-time options which perform checks at run time as well as options to drop incoming or outgoing packets to test stability of the implementation on the target system.
282
CHAPTER 15
Debugging
15.1 Message output

The debug builds of embOS/IP include a fine grained debug system which helps to analyze the correct implementation of the stack in your application. All modules of the TCP/IP stack can output logging and warning messages via terminal I/O, if the specific message type identifier is added to the log and/or warn filter mask. This approach provides the opportunity to get and interpret only the logging and warning messages which are relevant for the part of the stack that you want to debug. By default, all warning messages are activated in all embOS/IP sample configuration files. All logging messages are disabled except for the messages from the initialization and the DHCP setup phase.
283
15.2 Testing stability

embOS/IP allows to define drop-rates for both receiver an transmitter. This feature can be used to simulate packet loss. Packet loss means that one or more packets fail to reach their destination. Packet loss can be caused by a number of factors (for example, signal degradation over the network medium, faulty networking hardware, error in network applications, etc.). Two variables, IP_TxDropRate and IP_RxDropRate, are implemented to define the drop-rate while the target is running. There is no need to recompile the stack. The default value of these variables is 0, which means that no packets should be dropped from the stack. Any other value of n (for example, n = 2,3, ...) will drop every n-th packet. This allows testing the reliability of communication and performance drop. A good value to test the stability is typically around 50. To change the value of IP_TxDropRate and/or IP_RxDropRate the following steps are required: 1. 2. 3. 4. Download your embOS/IP application into the target. Start your debugger. Open the Watch window and add one or both drop-rate variables. Assign the transmit and/or receive drop-rate and start your application.
284
CHAPTER 15
Debugging
15.3 API functions

Function Description Filter functions This function is called by the stack in debug builds with log & warn output (debug level > 1). In a release build, this function may not be linked in. This function is called by the stack in debug builds with log & warn output (debug level > 1). In a release build, this function may not be linked in. Adds an additional filter condition to the mask which specifies the logging messages that should be displayed. Adds an additional filter condition to the mask which specifies the warning messages that should be displayed. Sets the mask that defines which logging message should be displayed. Sets the mask that defines which warning message should be displayed. General debug functions/macros Called if the stack encounters a critical situation.
IP_Log()
IP_Warn()
IP_AddLogFilter()
IP_AddWarnFilter() IP_SetLogFilter() IP_SetWarnFilter()
IP_PANIC()
Table 15.1: embOS/IP debugging API function overview
285
15.3.1 IP_AddLogFilter()
Description
Adds an additional filter condition to the mask which specifies the logging messages that should be displayed.
Prototype
void IP_AddLogFilter(U32 FilterMask);
Parameter
Parameter FilterMask Description Specifies which logging messages should be added to the filter mask. Refer to Message types on page 290 for a list of valid values for parameter FilterMask.
Table 15.2: IP_AddLogFilter() parameter list
IP_AddLogFilter() can also be used to remove a filter condition which was set before. It adds/removes the specified filter to/from the filter mask via a disjunction.
Example
IP_AddLogFilter(IP_MTYPE_DRIVER); // Activate driver logging messages /* * Do something */ IP_AddLogFilter(IP_MTYPE_DRIVER); // Deactivate all driver logging messages
286
CHAPTER 15
Debugging
15.3.2 IP_AddWarnFilter()
Description
Adds an additional filter condition to the mask which specifies the warning messages that should be displayed.
Prototype
void IP_AddWarnFilter(U32 FilterMask);
Parameter
Parameter FilterMask Description Specifies which warning messages should be added to the filter mask. Refer to Message types on page 290 for a list of valid values for parameter FilterMask.
Table 15.3: IP_AddWarnFilter() parameter list
IP_AddWarnFilter() can also be used to remove a filter condition which was set before. It adds/removes the specified filter to/from the filter mask via a disjunction.
Example
IP_AddWarnFilter(IP_MTYPE_DRIVER); // Activate driver warning messages /* * Do something */ IP_AddWarnFilter(IP_MTYPE_DRIVER); // Deactivate all driver warning messages
287
15.3.3 IP_SetLogFilter()
Description
Sets a mask that defines which logging message that should be logged. Logging messages are only available in debug builds of embOS/IP.
Prototype
void IP_SetLogFilter( U32 FilterMask );
Parameter
Parameter FilterMask Description Specifies which logging messages should be displayed. Refer to Message types on page 290 for a list of valid values for parameter FilterMask.
Table 15.4: IP_SetLogFilter() parameter list
This function should be called from IP_X_Config(). By default, the filter condition IP_MTYPE_INIT is set. Refer to IP_X_Configure() on page 174 for more information.
288
CHAPTER 15
Debugging
15.3.4 IP_SetWarnFilter()
Description
Sets a mask that defines which warning messages that should be logged. Warning messages are only available in debug builds of embOS/IP.
Prototype
void IP_SetWarnFilter( U32 FilterMask );
Parameter
Parameter FilterMask Description Specifies which warning messages should be displayed. Refer to Message types on page 290 for a list of valid values for parameter FilterMask.
Table 15.5: IP_SetWarnFilter() parameter list
This function should be called from IP_X_Config(). By default, all filter conditions are set. Refer to IP_X_Configure() on page 174 for more information.
289
15.3.5 IP_PANIC()
Description
This macro is called by the stack code when it detects a situation that should not be occurring and the stack can not continue. The intention for the IP_PANIC() macro is to invoke whatever debugger may be in use by the programmer. In this way, it acts like an embedded breakpoint.
Prototype
IP_PANIC ( const char * sError );
This macro maps to a function in debug builds only. If IP_DEBUG > 0, the macro maps to the stack internal function void IP_Panic ( const char * sError ). IP_Panic() disables all interrupts to avoid further task switches, outputs sError via terminal I/O and loops forever. When using an emulator, you should set a breakpoint at the beginning of this routine or simply stop the program after a failure. The error code is passed to the function as parameter. In a release build, this macro is defined empty, so that no additional code will be included by the linker.
290
CHAPTER 15
Debugging
15.4 Message types

The same message types are used for log and warning messages. Separate filters can be used for both log and warnings. For details, refer to IP_SetLogFilter() on page 287 and IP_SetWarnFilter() on page 288 as wells as IP_AddLogFilter() on page 285 and IP_AddLogFilter() on page 285 for more information about using the message types. Symbolic name IP_MTYPE_INIT IP_MTYPE_CORE IP_MTYPE_ALLOC IP_MTYPE_DRIVER IP_MTYPE_ARP IP_MTYPE_IP IP_MTYPE_TCP_CLOSE Description Activates output of messages from the initialization of the stack that should be logged. Activates output of messages from the core of the stack that should be logged. Activates output of messages from the memory allocating module of the stack that should be logged. Activates output of messages from the driver that should be logged. Activates output of messages from ARP module that should be logged. Activates output of messages from IP module that should be logged. Activates output of messages from TCP module that should be logged when a TCP connection gets closed. Activates output of messages from TCP module that should be logged when a TCP connection gets opened. Activates output of messages from TCP module that should be logged if a TCP packet is received. Activates output of messages from TCP module that should be logged if a TCP packet is sent. Activates output of messages from TCP module regarding TCP roundtrip time. Activates output of messages from TCP that module should be logged. Activates output of messages from UDP module that should be logged when a UDP packet is received. Activates output of messages from UDP module that should be logged if a UDP packet is sent. Activates output of messages from UDP module that should be logged if a UDP packet is sent or received. Activates output of messages regarding to the link change process. Activates output of messages from DHCP client module that should be logged. Activates output of optional messages from DHCP client module that should be logged. Activates output of messages from the ICMP module that should be logged. Activates output of messages from NET_IN module that should be logged.
IP_MTYPE_TCP_OPEN
IP_MTYPE_TCP_IN IP_MTYPE_TCP_OUT IP_MTYPE_TCP_RTT IP_MTYPE_TCP IP_MTYPE_UDP_IN
IP_MTYPE_UDP_OUT
IP_MTYPE_UDP IP_MTYPE_LINK_CHANGE IP_MTYPE_DHCP IP_MTYPE_DHCP_EXT IP_MTYPE_ICMP IP_MTYPE_NET_IN

Table 15.6: embOS/IP message types
291
Symbolic name IP_MTYPE_NET_OUT IP_MTYPE_DNS IP_MTYPE_SOCKET_STATE
Description Activates output of messages from NET_OUT module that should be logged. Activates output of messages from DNS module that should be logged. Activates output of messages from socket module that should be logged when state has been changed. Activates output of messages from socket module that should be logged if a socket is used to read data. Activates output of messages from socket module that should be logged if a socket is used to write data Activates all socket related output messages.
IP_MTYPE_SOCKET_READ
IP_MTYPE_SOCKET_WRITE IP_MTYPE_SOCKET
Table 15.6: embOS/IP message types
292
CHAPTER 15
Debugging
293
Chapter 16 OS integration
embOS/IP is designed to be used in a multitasking environment. The interface to the operating system is encapsulated in a single file, the IP/OS interface. For embOS, all functions required for this IP/OS interface are implemented in a single file which comes with embOS/IP. This chapter provides descriptions of the functions required to fully support embOS/ IP in multitasking environments.
294
CHAPTER 16
OS integration
16.1 General information

The complexity of the IP/OS Interface depends on the task model selected. Refer to Tasks and interrupt usage on page 17 for detailed informations about the different task models. All OS interface functions for embOS are implemented in IP_OS_embOS.c which is located in the root folder of the IP stack.
295
16.2 OS layer API functions

Function Description General macros IP_OS_Delay() Blocks the calling task for a given time. IP_OS_DisableInterrupt() Disables interrupts. IP_OS_EnableInterrupt() Enables interrupts. Returns the current system time in ticks. Return the current system time in ms. On 32-bit systems, the IP_OS_GetTime32() value will wrap around after approximately 49.7 days. This is taken into account by the stack. Creates and initializes all objects required for task synchronization. These are 2 events (for IP_Task and IP_OS_Init() IP_RxTask) and one semaphore for protection of critical code which may not be executed from multiple task at the same time. The stack requires a single lock, typically a resource semaphore or mutex. This function locks this object, guarding sections of the stack code against other IP_OS_Lock() tasks. If the entire stack executes from a single task, no functionality is required here. Unlocks the single lock used locked by a previous call IP_OS_Unlock() to IP_OS_Lock(). IP_Task synchronization Wakes the IP_Task if it is waiting for a NET-event or IP_OS_SignalNetEvent() timeout in the function IP_OS_WaitNetEvent(). Called from IP_Task only. Blocks until the timeout expires or a NET-event occurs, meaning IP_OS_WaitNetEvent() IP_OS_SignalNetEvent() is called from an other task or ISR. IP_RxTask synchronization Wakes the IP_RxTask if it is waiting for a NET-event or IP_OS_SignalRxEvent() timeout in the function IP_OS_WaitRxEvent(). Optional. Called from IP_RxTask, if it is used to receive data. Blocks until the timeout expires or a IP_OS_WaitRxEvent() NET-event occurs, meaning IP_OS_SignalRxEvent() is called from the ISR. Application task synchronization Suspend a task which needs to wait for a object. This IP_OS_WaitItem() object is identified by a pointer to it and can be of any type, for example a socket. Suspend a task which needs to wait for a object. This object is identified by a pointer to it and can be of any IP_OS_WaitItemTimed() type, for example a socket. The second parameter defines the maximum time in timer ticks until the event have to be signaled. Sets an event object to signaled state, or resumes IP_OS_SignalItem() tasks which are waiting at the event object. Function is called from a task, not an ISR.
Table 16.1: Target OS interface function list
16.2.1 Examples
OS interface routine for embOS
All OS interface routines are implemented in IP_OS_embOS.c which is located in the root folder of the IP stack.
296
CHAPTER 16
OS integration
297
Chapter 17 Performance & resource usage
This chapter covers the performance and resource usage of embOS/IP. It contains information about the memory requirements in typical systems which can be used to obtain sufficient estimates for most target systems.
298
CHAPTER 17
Performance & resource usage
17.1 Memory footprint

embOS/IP is designed to fit many kinds of embedded design requirements. Several features can be excluded from a build to get a minimal system. Note that the values are only valid for the given configuration.
System
The following table shows the hardware and the toolchain details of the project: Detail CPU Tool chain Model Compiler options Description ARM7 IAR Embedded Workbench for ARM V4.41A ARM7, Thumb instructions; no interwork; Highest size optimization;
Table 17.1: ARM7 sample configuration
The following table shows the ROM requirement of embOS/IP: Description embOS/IP - complete stack ROM approximately 18 Kbytes
The memory requirements of a interface driver is about 1.5 - 2.0 Kbytes.
299
17.2 Performance
System
Detail CPU Tool chain Model Compiler options Description ARM7 with integrated MAC running with 48Mhz IAR Embedded Workbench for ARM V4.41A ARM7, Thumb instructions; no interwork; Highest speed optimization;
Table 17.2: ARM7 sample configuration
The following table shows the send and receive speed of embOS/IP: Description TCP - socket interface Send speed Receive speed TCP - zero-copy interface Send speed Receive speed approximately 4.8 approximately 4.8 approximately 4.0 approximately 4.0 Speed [Mbytes per second]
The performance of any network will depend on several considerations, including the length of the cabling, the size of packets, and the amount of traffic.
300
CHAPTER 17
Performance & resource usage
301
Chapter 18 Appendix A - File system abstraction layer
302
CHAPTER 18
Appendix A - File system abstraction layer
18.1 File system abstraction layer

This section provides a description of the file system abstraction layer used by embOS/IP applications which require access to a data storage medium. The file system abstraction layer is supplied with the embOS/IP web server and the embOS/IP FTP server. Three file system abstraction layer implementations are available: File name Description Mapping of the embOS/IP file system abstraction layer functions to the emFile functions. Implementation of a read-only file system. Typically used in a web server application. Mapping of the embOS/IP file system abstraction layer functions to the Windows file I/O functions.
IP_FS_FS.c
IP_FS_RO.c
IP_FS_WIN32.c
Supplied implementations of the file system abstraction layer
303
18.2 File system abstraction layer function table

embOS/IP uses a function table to call the appropriate file system function.
Data structure
typedef struct { // // Read only file operations. These have to be present on ANY file system, // even the simplest one. // void * (*pfOpenFile) ( const char * sFilename, const char * sOpenFlags ); int (*pfCloseFile) ( void * hFile ); int (*pfReadAt) ( void * hFile, void * pBuffer, U32 Pos, U32 NumBytes ); long (*pfGetLen) ( void * hFile ); // // Directory query operations. // void (*pfForEachDirEntry) ( void * pContext, const char * sDir, void (*pf) (void * pContext, void * pFileEntry)); void (*pfGetDirEntryFileName) ( void * pFileEntry, char * sFileName, U32 SizeOfBuffer ); U32 (*pfGetDirEntryFileSize) ( void * pFileEntry, U32 * pFileSizeHigh ); int (*pfGetDirEntryFileTime) ( void * pFileEntry ); U32 (*pfGetDirEntryAttributes) ( void * pFileEntry ); // // Write file operations. // void * (*pfCreate) ( const char * sFileName ); void * (*pfDeleteFile) ( const char * sFilename ); int (*pfRenameFile) ( const char * sOldFilename, const char * sNewFilename ); int (*pfWriteAt) ( void * hFile, void * pBuffer, U32 Pos, U32 NumBytes ); // // Additional directory operations // int (*pfMKDir) (const char * sDirName); int (*pfRMDir) (const char * sDirName); } IP_FS_API;
304
CHAPTER 18
Elements of IP_FS_API
Function Description Read only file system functions (required) Pointer to a function that creates/opens a file and returns the handle of these file. Pointer to a function that closes a file. Pointer to a function that reads a file.
pfOpenFile pfCloseFile pfReadAt pfGetLen
Table 18.1: embOS/IP file system API function overview
Pointer to a function that returns the length of a file. Directory query operations Pointer to a function which is called for each pfForEachDirEntry directory entry. Pointer to a function that returns the name pfGetDirEntryFileName of a file entry. Pointer to a function that returns the size of pfGetDirEntryFileSize a file. Pointer to a function that returns the timepfGetDirEntryFileTime stamp of a file. Pointer to a function that returns the pfGetDirEntryAttributes attributes of a directory entry. Write file operations pfCreate Pointer to a function that creates a file. pfDeleteFile Pointer to a function that deletes a file. pfRenameFile Pointer to a function that renames a file. pfWriteAt Pointer to a function that writes a file. Simple write type file system functions (optional) pfCreate Pointer to a function that creates a file. pfDeleteFile Pointer to a function that deletes a file.
305
18.2.1 emFile interface

The embOS/IP web server and FTP server are shipped with an interface to emFile, SEGGERs file system for embedded applications. It is a good example how to use a real file system with the embOS/IP web server / FTP server.
/* Excerpt from IP_FS_FS.c */ const IP_FS_API IP_FS_FS = { _FS_Open, _Close, _ReadAt, _GetLen, _ForEachDirEntry, _GetDirEntryFileName, _GetDirEntryFileSize, _GetDirEntryFileTime, _GetDirEntryAttributes, _Create, _DeleteFile, _RenameFile, _WriteAt };
The emFile interface is used in all SEGGER Eval Packages.
306
CHAPTER 18
18.2.2 Read-only file system

The embOS/IP web server and FTP server are shipped with a very basic implementation of a read-only file system. It is a good solution if you use embOS/IP without a real file system like emFile.
/* Excerpt from FS_RO.c */ const IP_WEBS_FS_API IP_FS_ReadOnly = { _FS_RO_FS_Open, _FS_RO_Close, _FS_RO_ReadAt, _FS_RO_GetLen, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL };
The read-only file system can be used in the example applications. It is sufficient, if the server should only deliver predefined files which are hardcoded in the sources of your application. It is used by default with the embOS/IP Web server example application.
18.2.3 Using the read-only file system

The read-only file system relies on an array of directory entries. A directory entry consists of a file name, a pointer to the data and an entry for the file size in bytes. This array of directory entries will be searched if a client requests a page.
/* Excerpt from FS_RO.c */ typedef struct { const char * sFilename; const unsigned char * pData; unsigned int FileSize; } DIR_ENTRY; #include #include #include #include "webdata\generated\embos.h" "webdata\generated\index.h" "webdata\generated\segger.h" "webdata\generated\stats.h" /* /* /* /* HTML page */ HTML page */ segger.gif */ HTML page */
DIR_ENTRY _aFile[] = { /* file name file array current size /* ----------------------------{ "/embos.htm", embos_file, EMBOS_SIZE { "/index.htm", index_file, INDEX_SIZE { "/segger.gif", segger_file, SEGGER_SIZE { "/stats.htm", stats_file, STATS_SIZE { 0 } };
*/ */ }, }, }, },
The example source files can easily be replaced. To build new contents for the readonly file system the following steps are required: 1. 2. Copy the file which should be included in the read-only file system into the folder: IP\IP_FS\FS_RO\webdata\html\ Use an text editor (for example, Notepad) to edit the batch file m.bat. The batch file is located under: IP\IP_FS\FS_RO\webdata\. Add the file which should be built. For example: If your file is called example.htm, you have to add the following line to m.bat: call cc example htm m.bat calls cc.bat. cc.bat uses bin2C.exe an utility which converts any file to a standard C array. The new files are created in the folder: IP\IP_FS\FS_RO\webdata\generated\
3.
307
4.
Add the new source code file (for example, example.c) into your project. To add the new file to your read-only file system, you have to add the new file to the DIR_ENTRY array _aFile[] and include the generated header file (for example, example.h) in FS_RO.c. The expanded definition of _aFile[] should look like:
#include #include #include #include #include "webdata\generated\embos.h" "webdata\generated\index.h" "webdata\generated\segger.h" "webdata\generated\stats.h" "webdata\generated\example.h" /* /* /* /* /* HTML page */ HTML page */ segger.gif */ HTML page */ NEW HTML page */
DIR_ENTRY _aFile[] = { /* file name file array current size /* ----------------------------{ "/embos.htm", embos_file, EMBOS_SIZE { "/index.htm", index_file, INDEX_SIZE { "/segger.gif", segger_file, SEGGER_SIZE { "/stats.htm", stats_file, STATS_SIZE { "/example.htm", example_file, EXAMPLE_SIZE { 0 } };
*/ */ }, }, }, }, },
5.
Recompile your application.
308
CHAPTER 18
18.2.4 Windows file system interface

The embOS/IP web server and FTP server is shipped with an implementation.
const IP_FS_API IP_FS_Win32 = { // // Read only file operations. // _IP_FS_WIN32_Open, _IP_FS_WIN32_Close, _IP_FS_WIN32_ReadAt, _IP_FS_WIN32_GetLen, // // Simple directory operations. // _IP_FS_WIN32_ForEachDirEntry, _IP_FS_WIN32_GetDirEntryFileName, _IP_FS_WIN32_GetDirEntryFileSize, _IP_FS_WIN32_GetDirEntryFileTime, _IP_FS_WIN32_GetDirEntryAttributes, // // Simple write type file operations. // _IP_FS_WIN32_Create, _IP_FS_WIN32_DeleteFile, _IP_FS_WIN32_RenameFile, _IP_FS_WIN32_WriteAt, // // Additional directory operations // _IP_FS_WIN32_MakeDir, _IP_FS_WIN32_RemoveDir };
The Windows file system interface is supplied with the FTP and the Web server addon packages. It is used by default with the embOS/IP FTP server application.
309
Chapter 19 Glossary
310
CHAPTER 19
Glossary
ARP CPU
Address Resolution Protocol. Central Processing Unit. The brain of a microcontroller; the part of a processor that carries out instructions. Dynamic Host Configuration Protocol. Domain Name System. End Of Transmission. First-In, First-Out. File Transfer Protocol. Hypertext Markup Language. Hypertext Transfer Protocol. Internet Control Message Protocol. Internet Protocol. Interrupt Service Routine. The routine is called automatically by the processor when an interrupt is acknowledged. ISRs must preserve the entire context of a task (all registers). Local Area Network. Media Access Control. Network Interface Card. Point-to-Point Protocol. Request For Comments. Routing Information Protocol. Real-time Operating System. The program section of an RTOS that selects the active task, based on which tasks are ready to run, their relative priorities, and the scheduling system being used. Serial Line Internet Protocol. Simple Mail Transfer Protocol.
DHCP DNS EOT FIFO FTP HTML HTTP ICMP IP
ISR
LAN MAC NIC PPP RFC RIP RTOS Scheduler
SLIP SMTP
311
Stack
An area of memory with LIFO storage of parameters, automatic variables, return addresses, and other information that needs to be maintained across function calls. In multitasking systems, each task normally has its own stack. A program that runs in an infinite loop and uses no real-time kernel. ISRs are used for real-time parts of the software. A program running on a processor. A multitasking system allows multiple tasks to execute independently from one another. Transmission Control Protocol. Trivial File Transfer Protocol. The OS timer interrupt. Usually equals 1 ms. User Datagram Protocol.
Superloop
Task
TCP TFTP Tick UDP
312
CHAPTER 19
Glossary
313
Index
C
Compile-time configuration ................. 177
L
Logging functions IP_AddLogFilter() ............................285 IP_AddWarnFilter() ..........................286 IP_SetLogFilter() .............................287 IP_SetWarnFilter() ...........................288
D
Debugging IP_Panic() ...................................... 289 DHCP client IP_DHCPC_Activate() ....................... 142 IP_DHCPC_Halt() ..................... 144145
M
Management functions IP_Exec() ........................................ IP_Init() .......................................... IP_RxTask() ..................................... IP_Task() ......................................... 66 63 65 64
E
embOS/IP Features ...........................................14 Integrating into your system ...............28 layers ..............................................15
N
Network interface drivers ATMEL AT91SAM7X ..........................150 ATMEL AT91SAM9260 .......................153 DAVICOM DM9000 ...........................156 FREESCALE ColdFire MCF5329 ...........159 NXP LPC23xx/24xx ..........................162 ST STR912 .....................................164
F
FS abstraction layer emFile interface .............................. 305
I
IP stack function IP_AddBuffers() ................................42 IP_AddEthernetInterface() ..................43 IP_AllowBackpressure() ......................44 IP_AssignMemory() ...........................45 IP_ConfTCPSpace() ............................46 IP_GetCurrentLinkSpeed() ..................68 IP_GetIPAddr() ........................... 6971 IP_IFaceIsReady() .............................75 IP_NI_ConfigPHYAddr() ......................49 IP_NI_ConfigPHYMode() .....................50 IP_NI_ConfigPoll() .............................51 IP_SendPacket() ...............................77 IP_SendPing() ...................................78 IP_SetAddrMask() .............................53 IP_SetHWAddr() ................................55 IP_SetSupportedDuplexModes() ..........57 IP_TCP_Set2MSLDelay() .....................60 IP_TCP_SetConnKeepaliveOpt() ...........61 IP_TCP_SetRetransDelayRange() .........62
O
OS integration ...................................293 API functions ...................................295 Other IP stack functions IP_DNS_SetServer() .................... 4748 IP_GetVersion() ................................ 73 IP_PrintIPAddr() ............................... 76
S
Socket functions accept() .......................................... bind() ............................................. closesocket() ................................... connect() ........................................ gethostbyname() .............................. getpeername() ................................. getsockname() ................................. listen() ............................................ 83 84 85 86 88 90 91 95
314
Index
recv() .............................................. 96 recvfrom() ....................................... 97 select() ............................................ 98 send() ........................................... 100 sendto() ........................................ 101 setsockopt() ................................... 102 socket() ......................................... 105 Structure hostent ............................ 110 Structure in_addr ............................ 109 Structure sockaddr .......................... 107 Structure sockaddr_in ..................... 108 Syntax, conventions used ....................... 7
T
TCP zero-copy IP_TCP_Alloc() ............................... IP_TCP_Free() ................................ IP_TCP_Send() ............................... IP_TCP_SendAndFree() .................... 118 119 120 121
U
UDP zero-copy IP_UDP_Alloc() ............................... 128 IP_UDP_Close() .............................. 129 IP_UDP_FindFreePort() .................... 130 IP_UDP_Free() ............................... 131 IP_UDP_Open() .............................. 135 IP_UDP_Send() ....................... 136137 Utility functions IP_UTIL_BASE64_Decode() .............. 214 IP_UTIL_BASE64_Encode() .............. 215

Use Manual Embosip

Uploaded by

Copyright:

Available Formats

Use Manual Embosip

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Use Manual Embosip

Uploaded by

Copyright:

Available Formats

embOS/IP

CPU independent TCP/IP stack for embedded applications

Software version 1.62 Document: UM07001 Revision: 0

A product of SEGGER Microcontroller GmbH & Co. KG

Additional copyrights: Portions Copyright 2007 InterNiche Technologies Inc.

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

1.54/00 1.52/01 1.52/00

090504 090402 090223

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

SW version / Manual revision

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

SW version / Manual revision

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

About this document

How to use this manual

Typographic conventions for syntax

Reference GUIElement Emphasis

Table 1.1: Typographic conventions

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

Corporate Office: http://www.segger.com

United States Office: http://www.segger-us.com

EMBEDDED SOFTWARE (Middleware)

J-Link / J-Trace Related Software

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

2 Running embOS/IP on target hardware.........................................................................27

3 Example applications .....................................................................................................33

5 Socket interface .............................................................................................................81

6 TCP zero-copy interface ..............................................................................................113

UM07001 - embOS/IP User Guide

6.2.1 6.2.2 6.2.3 6.3 6.3.1 6.3.2 6.4

7 UDP zero-copy interface..............................................................................................123

8 DHCP client .................................................................................................................139

9 Network interface drivers .............................................................................................147

10 Configuring embOS/IP ...............................................................................................173

11 Web server (Add-on)..................................................................................................179

UM07001 - embOS/IP User Guide

12 SMTP client (Add-on).................................................................................................221

13 FTP server (Add-on) ..................................................................................................239

14 FTP client (Add-on)....................................................................................................263

UM07001 - embOS/IP User Guide

14.5.1 14.6 14.7 14.8 14.8.1 14.8.2

17 Performance & resource usage .................................................................................297

18 Appendix A - File system abstraction layer................................................................301

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

Chapter 1 Introduction to embOS/IP

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

UM07001 - embOS/IP User Guide

2007 - 2010 SEGGER Microcontroller GmbH & Co. KG

DHCP, DNS, FTP, HTTP, POP3, SMTP, TELNET, SSL, ...

IP, ICMP, IGMP, ARP, RARP, ...