Preface
About this book
This guide is provided with the ARM Portable TCP/IP stack sources.
It is assumed that the ARM TCP/IP sources are available as a reference. It is also assumed that the reader has access to a C language programmer’s guide and the ARM Architecture Reference Manual.
Intended audience
This Programmer’s Guide is written for a moderately-experienced C programmer, with a general understanding of TCP/IP, who wants to port the stack to a new environment.
Using this book
This guide is organized into the following chapters:
Chapter 1 Introduction
Read this chapter to learn about porting in general and the system requirements for using the TCP/IP protocol stack source.
Chapter 2 TCP/IP Porting
Read this chapter for step-by-step instructions on porting and testing.
Chapter 3 TCP/IP API Functions
Read this chapter for a description of the user-provided functions required for porting the ARM TCP/IP stack.
Chapter 4 DHCP Client Functions
Read this chapter for a description of the DHCP function calls used to request information for an interface.
Chapter 5 Sockets
Read this chapter for an introduction to sockets, and for a description of the sockets API.
Chapter 6 Low-overhead UDP Functions
Read this chapter for a description of the low-overhead UDP functions.
Chapter 7 The TCP Zero-copy API
Read this chapter for information on sending and receiving data with the
TCP Zero-copy API.
viii |
Copyright © 1998-2001 ARM Limited. All rights reserved. |
ARM DUI 0144B |
Preface
Chapter 8 ARM-specific Functions
Read this chapter for details on the sample sources provided as part of the TCP/IP stack. This chapter also details functions, specific to the ARM environment, that these files contain.
Chapter 9 Miscellaneous Library Functions
Read this chapter for a description of the assortment of functions to be found in the \misclib directory. These functions perform a variety of tasks that are used by the example programs and by the TCP/IP stack.
Chapter 10 Internal Functions
Read this chapter for a description of ARP, IP, and ICMP functions.
Appendix A Error Codes
Read this appendix to see a list of both the standard ENP_ error codes you might encounter while porting, and the socket error codes.
Appendix B Editing ARM Networking .nv Files
Read this appendix to find out how to edit ARM networking parameters.
Appendix C Sample Applications
Read this appendix for information on the sample applications provided, and on how to build and run projects.
Appendix D The i8255x Ethernet Driver
Read this appendix for information on the i8255x Ethernet driver, its features and build options, and instructions on porting.
ARM DUI 0144B |
Copyright © 1998-2001 ARM Limited. All rights reserved. |
ix |
Preface
Typographical conventions
The following typographical conventions are used in this book:
typewriter Denotes text that may be entered at the keyboard, such as commands, file and program names, and source code.
typewriter italic
Denotes arguments to commands and functions where the argument is to be replaced by a specific value.
typewriter bold
|
Denotes language keywords when used outside example code. |
italic |
Introduces special terminology, denotes internal cross-references, and |
|
citations. |
bold |
Highlights interface elements, such as menu names. Also used for |
|
emphasis in descriptive lists, where appropriate. |
Further reading
This section lists publications from both ARM Limited and third parties that provide additional information on porting ARM TCP/IP.
ARM publications
This book contains reference information that is specific to ARM TCP/IP. For additional information, refer to the following ARM publications:
•Porting PPP Programmer’s Guide (ARM DUI 0143)
•the documentation set for the ARM Developer Suite (ADS)
•ARM Architecture Reference Manual (ARM DDI 0100).
Other publications
For other reference information, please refer to the following:
•Comer, Douglas E., Internetworking with TCP/IP: Principles, Protocols, and Architecture, 3rd Edition, 1995, Prentice-Hall (ISBN 0-13-216987-8).
•Jagger, David, ARM Architecture Reference Manual, 1997, Prentice-Hall (ISBN 0-13-736299-4).
•Kernighan, Brian W. and Ritchie, Dennis M., The C Programming Language, 2nd Edition, 1988, Prentice-Hall (ISBN 0-13-110370-8).
x |
Copyright © 1998-2001 ARM Limited. All rights reserved. |
ARM DUI 0144B |
Preface
•RFC 1071, Borman, D., Braden, B. and Partridge, C., Computing the Internet checksum, 09/01/1988.
•RFC 1072, Braden, B. and Jacobson, V., TCP extensions for long-delay paths, 10/01/1988.
•RFC 1213, McCloghrie, K. and Rose, M., Management Information Base for Network Management of TCP/IP-based internets: MIB-II, 03/26/1991.
ARM DUI 0144B |
Copyright © 1998-2001 ARM Limited. All rights reserved. |
xi |