R OS and Libraries Document Collection This PDF collection describes the software packages that are provided by the Embedded Development Kit. EDK supplies libraries, board support packages, and complete operating systems, in addition to the drivers for the peripherals, to help the user develop a software platform. The following is the distribution of the software packages available for the user to include in his platform: • Xilinx Micro-Kernel (XMK) - XMK is the entity representing the collective software system formed by the following components, ♦ Standard C Libraries (libc, libm) ♦ Xilkernel - An embedded kernel ♦ Standalone Board Support Package (BSP) ♦ LibXil Net - A networking library ♦ LibXil MFS - A Memory File System ♦ LibXil File - A file I/O library ♦ LibXil FATfs - A FAT file system ♦ LibXil Profile - A Profiling library ♦ LibXil Drivers - Device drivers for supported peripherals • lwIP Libary - A third-party network library ported to Xilinx Embedded processors • VxWorks Operating System - Development of Board Support Package for the VxWorks Operating System These documents describe the Xilinx Micro-kernel, its constituent libraries and the Standalone board-support package. Documentation for the other operating systems can be found in their respective reference guides. Device drivers are documented along with the corresponding peripheral’s documentation. Getting Started The following documents are included in this collection. To view a document, click its name in the following table. Document Name Summary Xilinx Microkernel (XMK) Describes the organization of Xilinx Microkernel, its constituent component libraries, and the interactions between them and your application. LibXil Standard C Libraries Describes the software libraries available for the embedded processors. EDK 7.1i July 5, 2005 www.xilinx.com EDK OS and Libraries Document Collection 1-800-255-7778 R Document Name Summary Standalone Board Support Describes the Board Support Package (BSP), the Package lowest layer of software modules used to access processor-specific functions. The standalone BSP is used when an application accesses board/processor features directly and is below the operating system layer. Xilkernel Describes Xilkernel, a kernel for the Xilinx embedded processors. LibXil Net (v2.00.a) Describes the network library for Embedded processors, libXilNet (v2.00.a). LibXil File Describes the LibXil File. Xilinx libraries provide block access to file systems and devices using standard calls such as open, close, read, and write. These routines form the LibXil File module of the libraries. LibXil FATFile System(FATfs) Describes the XilFatfs FATfile system access library. This library provides read/write access to files stored on a Xilinx® System ACE™ compact flash or microdrive device. LibXil Memory File System Describes the Memory File System (MFS). This file (MFS) system resides in RAM/ROM/Flash memory and can be accessed directly or through the LibXil File module. The MFS is integrated with a system using the Library Generator, Libgen. LibXil Profile Describes the profiling library for embedded processors, LibXil Profile. lwIP Library (v2.00.a) Describes the Embedded Development Kit (EDK) port of the third party network library, Light Weight IP (lwIP) version v2.00.a, for embedded processors. Automatic Generation of Describes the development of the Board Support Tornado 2.x (VxWorks 5.x) Board Package (BSP). Support Packages Automatic Generation of Linux Describes the development of the Board Support Support Packages Through Structure Package (BSP). Xilinx Platform Studio (XPS) Glossary Contains definitions of EDK-specific terms and acronyms. EDK OS and Libraries Document Collection www.xilinx.com EDK 7.1i July 5, 2005 1-800-255-7778 R © 2005 Xilinx, Inc. All Rights Reserved. XILINX, the Xilinx logo, and other designated brands included herein are trademarks of Xilinx, Inc. All other trademarks are the property of their respective owners. NOTICE OF DISCLAIMER: Xilinx is providing this design, code, or information "as is." By providing the design, code, or information as one possible implementation of this feature, application, or standard, Xilinx makes no representation that this 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 the implementation, including but not limited to any warranties or representations that this implementation is free from claims of infringement and any implied warranties of merchantability or fitness for a particular purpose. EDK 7.1i July 5, 2005 www.xilinx.com EDK OS and Libraries Document Collection 1-800-255-7778 R EDK OS and Libraries Document Collection www.xilinx.com EDK 7.1i July 5, 2005 1-800-255-7778 R Xilinx Microkernel (XMK) EDK 7.1i, July 5, 2005 Summary This chapter describes the organization of Xilinx Microkernel, its constituent component libraries and the interactions between them and the user application. The chapter contains the following sections. • “Overview” • “XMK Organization” Overview There are three distinct software entities in XMK, with which user applications can interface - Standard C and Math libraries, LibXil libraries and Xilkernel or Standalone operating systems. The Standard C support library consists of the newlib libc, which contains the standard C functions such as stdio, stdlib and string routines. The math library is an enhancement over the newlib math library libm and provides the standard math routines. The LibXil libraries consist of: • LibXil Driver — Xilinx device drivers • LibXil Net — Xilinx networking support • LibXil File — Xilinx file I/O functions • LibXil MFS — Xilinx memory file system • LibXil Profile — Xilinx profiling support The Xilinx Standalone Board Support Package (BSP) and Xilkernel are the two operating system choices that are provided, in XMK, that can be included in the user application’s software platform. Most of the routines in the library are written in C and can be ported to any platform. The Library Generator (LibGen) configures the libraries for an embedded processor, using the attributes defined in the Microprocessor Software Specification (MSS) file. XMK The structure of XMK is outlined in Figure 1. As shown in the figure, the user application can Organization interface with the XMK components in a variety of ways. The libraries are independent of each other, except for a few interactions and dependencies between each other. For example, Xilkernel internally uses the standalone BSP and LibXil File can optionally work with the LibXil MFS. The LibXil Drivers and the standalone BSP form the lowermost hardware abstraction layer. All the library and OS components of XMK rely on standard C library components. The math library, libm.a is also available for linking with the user applications. Users can mix and © 2005 Xilinx, Inc. All Rights Reserved. XILINX, the Xilinx logo, and other designated brands included herein are trademarks of Xilinx, Inc. All other trademarks are the property of their respective owners. NOTICE OF DISCLAIMER: Xilinx is providing this design, code, or information "as is." By providing the design, code, or information as one possible implementation of this feature, application, or standard, Xilinx makes no representation that this 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 the implementation, including but not limited to any warranties or representations that this implementation is free from claims of infringement and any implied warranties of merchantability or fitness for a particular purpose. EDK 7.1i, July 5, 2005 www.xilinx.com 1 1-800-255-7778 R XMK Organization match the component libraries, but there may be some restrictions and implications. This will be described in the reference guides of each component. User Application libc stdio stdlib LibXil Xil Kernel LibXil Net LibXil File LibXil Mfs string Profile Other libm Standalone BSP LibXil Driver Hardware X10143 Figure 1: XMK Structure The Standalone Board Support Package (BSP) is a bare-bones kernel. It provides a very thin interface to the hardware, offering minimal functionality that will be required by applications. Some typical functions offered by the standalone BSP include setting up the interrupt system, exception system, configuring caches and other hardware specific functions. Certain standalone board support files such as the crt0.S, boot.S and eabi.S are required for the powerpc processor. These files are provided in the EDK. For a detailed description, refer to “Standalone Board Support Package.” LibXil Driver refers to the device drivers that are included in the software platform to provide an interface to the peripherals in the system. These drivers are provided along with EDK and are configured by libgen. This book contains a chapter that briefly discusses the concept of device drivers and the way they fit in with the software platform, in EDK. Refer to the “Device Drivers Programmer Guide” chapter in the Processor IP Reference Guide for this documentation. Device Drivers are documented in further detail, with information about functionality, interface, configuration and headers file information, in the Xilinx Device Drivers Reference Guide. Xilkernel(1) is a simple embedded processor kernel, which