Está en la página 1de 5

Getting Started Guide for

Ultra Mapper Device Software


Date: 02/06/2006

Table of Contents
1. 2. 3. 4. 5. Introduction ............................................................................................................................................ 1 Directory Structure ................................................................................................................................. 1 Documentation........................................................................................................................................ 2 Miscellaneous ......................................................................................................................................... 3 Technical Support................................................................................................................................... 3

1. Introduction
This document provides information about the Ultramapper API software package that is supplied by Agere Systems Inc. with Ultramapper silicon. The API software implementation follows a software model developed within Agere Systems to provide software standardization across multiple devices. The software is designed solely for use with Ageres Ultramapper device. The Ultramapper device comes in following different types: 1. Ultramapper Classic v1: Silicon version 1. Mapper + Framer. 2. Ultramapper Lite v1: Silicon version 1. Mapper only. 3. UltraFramer v1: Silicon version 1. Framer only. 4. Ultramapper Classic v2: Silicon version 2. Bug fixes, enhancements over v1. 5. Ultramapper Lite v2. Silicon version 2. Mapper only. 6. UltraFramer v2: Silicon version 2. Framer only. 7. Ultramapper Full Transport (FT): Based on silicon version 2. Capable of physically terminating 84 DS1s or 63 E1s. 8. Hypermapper: Multi-chip module based on silicon version 2. Contains 4 ultramapper classic v2 modules in a single package. 9. Ultramapper V3 and all variations of it. The API software supports all the above-mentioned types. The API software executes on the user's host processor and provides an interface to the Host Application for controlling and maintaining single or multiple Ultramapper devices. The host application and the device software communicate by way of API function calls and callback function notifications. This document outlines the directory structure in the release. One can find pointers to relevant documentation regarding various aspects of software in this guide.

2. Directory Structure
The API software is provided as C Source code. It is provided in either ZIP format or a regular directory structure. To uncompress the ZIP file, use any unzipping application such as WINZIP. Naming Convention: All the files and functions starting with the prefix um are part of the API interface that a host application uses. Common CGA and PM related files in the device_sw/common directory start with CGA_ or PM_ and are also considered part

of the API interface. All files and functions starting with an underscore (_) are internal to the device API software and should not be directly called by the host application. These files and functions are not part of the API interface. Following is the directory structure that will be created after uncompressing the ZIP file: /applications: Source code for sample application examples. /device_sw/umpr/device: API source code for device configuration, connection control, and interrupt handling. /device_sw/umpr/hdr: Headers for APIs. /device_sw/umpr/local_hdr: Internal headers used by the device APIs. Not part of the external interface. /device_sw/umpr/cga: Source code for CGA (Carrier Group Alarm) alarm surveillance software. /device_sw/umpr/pm: Source code for PM (Performance Monitoring) software /device_sw/common/cga: Common source code for CGA (shared with other Agere devices). /device_sw/common/hdr: Common headers for CGA/PM /device_sw/common/pm: Common source code for PM /device_sw/workspace: Tornado project files. This directory is relevant only if you are using vxWorks Tornado IDE for development. /documentation: Directory for all the documentation. software_description.txt can be found in this directory. /documentation/html: HTML formatted manual pages for all the API functions. Please note that if you want to use Tornado project files, you must create a folder called ultramapper on a PC C: drive and unzip or copy the release to that folder otherwise the Tornado project files will not work . If you are not using the Tornado files, you can unzip the release to any folder or directory.

3. Documentation
The API software release contains the following documents: /documentation/release_notes.doc: Release Notes for the current release. One can find information about bug fixes, modifications, enhancements, etc. in the current release. This file also provides test status of each API function. /documentation/ManPages/html: HTML style man pages for each API function. /documentation/software_description.txt: Software description file that explains the architecture and design of API software. Information about porting the API software to other platforms and RTOSs can be found here. /documentation/test_results.xls: This file contains test status of sample applications. /documentation/UMPR CGA Test document.doc: Test plan and results for CGA testing. /documentation/UMApplicationSwUserGuide.doc (Eval Board Users Guide): This file describes how to use Agere Systems Evaluation Platform. It also describes how to setup the host and the target systems.

/documentation/UMPMRegisterMapping.doc: This file contains the Performance Monitoring parameters and the register mappings. /documentation/ManPages/refman.pdf: API reference maual. This document contains informations about APIs in Unix style man pages.

4. Miscellaneous
None.

5. Technical Support
Below is a summary of our support to best serve you: Field Application Engineer: You can contact your Sales representative for the name of the FAE in your area. For contact information, please visit our sales <http://www.agere.com/sales/> website. World Wide Web: www.agere.com/ultramapper <http://www.agere.com/ultramapper>. Use this for frequently asked questions, updated documentation, and information on how to purchase a design kit. Please note that you would need a user id and password to access this site.