EDK OS and Libraries Reference Manual Embedded Development Kit EDK 6.3i UG114 (v3.0) August 20, 2004 R R "Xilinx" and the Xilinx logo shown above are registered trademarks of Xilinx, Inc. Any rights not expressly granted herein are reserved. CoolRunner, RocketChips, Rocket IP, Spartan, StateBENCH, StateCAD, Virtex, XACT, XC2064, XC3090, XC4005, and XC5210 are registered trademarks of Xilinx, Inc. The shadow X shown above is a trademark of Xilinx, Inc. ACE Controller, ACE Flash, A.K.A. Speed, Alliance Series, AllianceCORE, Bencher, ChipScope, Configurable Logic Cell, CORE Generator, CoreLINX, Dual Block, EZTag, Fast CLK, Fast CONNECT, Fast FLASH, FastMap, Fast Zero Power, Foundation, Gigabit Speeds...and Beyond!, HardWire, HDL Bencher, IRL, J Drive, JBits, LCA, LogiBLOX, Logic Cell, LogiCORE, LogicProfessor, MicroBlaze, MicroVia, MultiLINX, NanoBlaze, PicoBlaze, PLUSASM, PowerGuide, PowerMaze, QPro, Real-PCI, RocketIO, SelectIO, SelectRAM, SelectRAM+, Silicon Xpresso, Smartguide, Smart-IP, SmartSearch, SMARTswitch, System ACE, Testbench In A Minute, TrueMap, UIM, VectorMaze, VersaBlock, VersaRing, Virtex-II Pro, Virtex-II EasyPath, Wave Table, WebFITTER, WebPACK, WebPOWERED, XABEL, XACT- Floorplanner, XACT-Performance, XACTstep Advanced, XACTstep Foundry, XAM, XAPP, X-BLOX +, XC designated products, XChecker, XDM, XEPLD, Xilinx Foundation Series, Xilinx XDTV, Xinfo, XSI, XtremeDSP and ZERO+ are trademarks of Xilinx, Inc. The Programmable Logic Company is a service mark of Xilinx, Inc. All other trademarks are the property of their respective owners. Xilinx, Inc. does not assume any liability arising out of the application or use of any product described or shown herein; nor does it convey any license under its patents, copyrights, or maskwork rights or any rights of others. Xilinx, Inc. reserves the right to make changes, at any time, in order to improve reliability, function or design and to supply the best product possible. Xilinx, Inc. will not assume responsibility for the use of any circuitry described herein other than circuitry entirely embodied in its products. Xilinx provides any design, code, or information shown or described herein "as is." By providing the design, code, or information as one possible implementation of a feature, application, or standard, Xilinx makes no representation that such implementation is free from any claims of infringement. You are responsible for obtaining any rights you may require for your implementation. Xilinx expressly disclaims any warranty whatsoever with respect to the adequacy of any such implementation, including but not limited to any warranties or representations that the implementation is free from claims of infringement, as well as any implied warranties of merchantability or fitness for a particular purpose. Xilinx, Inc. devices and products are protected under U.S. Patents. Other U.S. and foreign patents pending. Xilinx, Inc. does not represent that devices shown or products described herein are free from patent infringement or from any other third party right. Xilinx, Inc. assumes no obligation to correct any errors contained herein or to advise any user of this text of any correction if such be made. Xilinx, Inc. will not assume any liability for the accuracy or correctness of any engineering or software support or assistance provided to a user. Xilinx products are not intended for use in life support appliances, devices, or systems. Use of a Xilinx product in such applications without the written consent of the appropriate Xilinx officer is prohibited. The contents of this manual are owned and copyrighted by Xilinx. Copyright 1994-2004 Xilinx, Inc. All Rights Reserved. Except as stated herein, none of the material may be copied, reproduced, distributed, republished, downloaded, displayed, posted, or transmitted in any form or by any means including, but not limited to, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of Xilinx. Any unauthorized use of any material contained in this manual may violate copyright laws, trademark laws, the laws of privacy and publicity, and communications regulations and statutes. EDK OS and Libraries Reference Manual www.xilinx.com UG114 (v3.0) August 20, 2004 1-800-255-7778 EDK OS and Libraries Reference Manual UG114 (v3.0) August 20, 2004 The following table shows the revision history for this document. Version Revision 01/30/04 1.0 Initial release for EDK 6.2i. 03/12/04 Updated for service pack release. 03/19/04 2.0 Updated for service pack release. 08/20/04 3.0 Updated for EDK 6.3i. UG114 (v3.0) August 20, 2004 www.xilinx.com EDK OS and Libraries Reference Manual 1-800-255-7778 EDK OS and Libraries Reference Manual www.xilinx.com UG114 (v3.0) August 20, 2004 1-800-255-7778 R Preface About This Guide This book describes the software packages provided by the Embedded Development Kit (EDK). Guide Contents This book contains the following chapters. x Chapter 1, “Introduction” x Chapter 2, “Xilinx Microkernel (XMK)” x Chapter 3, “LibXil Standard C Libraries” x Chapter 4, “Standalone Board Support Package” x Chapter 5, “Xilkernel” x Chapter 6, “LibXil Net (v2.00.a)” x Chapter 7, “LibXil File” x Chapter 8, “LibXil FATFile System (FATfs)” x Chapter 9, “LibXil Memory File System (MFS)” x Chapter 10, “LibXil Profile” x Chapter 11, “lwIP Library” Additional Resources For additional information, go to http://support.xilinx.com. The following table lists some of the resources you can access from this website. You can also directly access these resources using the provided URLs. Resource Description/URL EDK Home Embedded Development Kit home page, FAQ and tips. http://www.xilinx.com/edk EDK Examples A set of complete EDK examples. http://www.xilinx.com/ise/embedded/edk_examples.htm Tutorials Tutorials covering Xilinx design flows, from design entry to verification and debugging http://support.xilinx.com/support/techsup/tutorials/index.htm EDK OS and Libraries Reference Guide www.xilinx.com 5 UG114 (v3.0) August 20, 2004 1-800-255-7778 R Preface: About This Guide Resource Description/URL Answer Browser Database of Xilinx solution records http://support.xilinx.com/xlnx/xil_ans_browser.jsp Application Notes Descriptions of device-specific design techniques and approaches http://www.xilinx.com/xlnx/xweb/xil_publications_index.jsp?c ategory=Application+Notes Data Sheets Device-specific information on Xilinx device characteristics, including readback, boundary scan, configuration, length count, and debugging http://support.xilinx.com/xlnx/xweb/xil_publications_index.jsp Problem Solvers Interactive tools that allow you to troubleshoot your design issues http://support.xilinx.com/support/troubleshoot/psolvers.htm Tech Tips Latest news, design tips, and patch information for the Xilinx design environment http://www.support.xilinx.com/xlnx/xil_tt_home.jsp GNU Manuals The entire set of GNU manuals http://www.gnu.org/manual Conventions This document uses the following conventions. An example illustrates each convention. Typographical The following typographical conventions are used in this document: Convention Meaning or Use Example Messages, prompts, and Courier font program files that the system speed grade: - 100 displays Courier bold Literal commands that you ngdbuild design_name enter in a syntactical statement Commands that you select File o Open Helvetica bold from a menu Keyboard shortcuts Ctrl+C 6 www.xilinx.com EDK OS and Libraries Reference Guide 1-800-255-7778 UG114 (v3.0) August 20, 2004 Conventions R Convention Meaning or Use Example Variables in a syntax statement for which you must ngdbuild design_name supply values See the Development System Italic font References to other manuals Reference Guide for more information. If a wire is drawn so that it Emphasis in text overlaps the pin of a symbol, the two nets are not connected. An optional entry or parameter. However, in bus ngdbuild [ option_name] Square brackets [ ] specifications, such as design_name bus[7:0], they are required. A list of items from which you Braces { } lowpwr ={on|off} must choose one or more Separates items in a list of Vertical bar | lowpwr ={on|off} choices IOB #1: Name = QOUT’ Vertical ellipsis IOB #2: Name = CLKIN’ . Repetitive material that has . been omitted . Repetitive material that has allow block block_name Horizontal ellipsis . been omitted loc1 loc2 ... locn; Online Document The following conventions are used in this document: Convention Meaning or Use Example See the section “Additional Cross-reference link to a Resources” for details. Blue text location in the current document Refer to “Title Formats” in Chapter 1 for details. Cross-reference link to a See Figure 2-5 in the Virtex-II Red text location in another document Handbook. Go to http://www.xilinx.com Blue, underlined text Hyperlink to a website (URL) for the latest speed files. EDK OS and Libraries Reference Guide www.xilinx.com 7 UG114 (v3.0) August 20, 2004 1-800-255-7778 R Preface: About This Guide 8 www.xilinx.com EDK OS and Libraries Reference Guide 1-800-255-7778 UG114 (v3.0) August 20, 2004 Table of Contents Preface: About This Guide Guide Contents . 5 Additional Resources . 5 Conventions . 6 Typographical. 6 Online Document . 7 Chapter 1: Introduction Chapter 2: Xilinx Microkernel (XMK) Overview . 15 XMK Organization . 15 Chapter 3: LibXil Standard C Libraries Overview . 19 Standard C Library (libc.a) . 19 Xilinx C Library (libxil.a) . 20 Input/Output Functions . 20 Memory Management Functions . 21 MicroBlaze Processor . 21 PowerPC 405 Processor . 21 Arithmetic Operations . 21 MicroBlaze Processor . 21 Integer Arithmetic. 21 Floating Point Arithmetic . 22 PowerPC 405 Processor . 22 Integer Arithmetic. 22 Floating Point Arithmetic . 22 Chapter 4: Standalone Board Support Package MicroBlaze BSP . 23 Function Summary . 23 Interrupt Handling . 24 Exception Handling . 25 Instruction Cache Handling . 26 Data Cache Handling . 27 Fast Simplex Link Interface Macros . 28 PowerPC BSP . 29 Function Summary . 29 Boot Code . 30 boot.S . 30 crt0.S . 31 EDK OS and Libraries Reference Guide www.xilinx.com 9 UG114 (v3.0) August 20, 2004 1-800-255-7778 R eabi.S. 31 Cache . 31 Exception Handling . 33 Files .