Software Release 3.1 Documentation
Overview
Within this section you will find the documentation that supports software Release 3.1. These documents describe the components of the Base and Developer packages. The Base Package is software such as runtime and libraries which are essential to use the Advance cards. The Developer Package which includes the SDK is for programmers developing code for the Advance cards.
You should read the software overview for a given Release as this document describes all the software components and their dependencies. New features since the last Release, key features in the product, issues resolved and any known problems or limitations are described in the Release notes.
To access the downloads associated with Release 3.1 please click here.
Release 3.1
Documentation Packs
Base + Library Software Documentation Pack (PDF)
Developer Software Documentation Pack (PDF)
Reference Manuals Documentation Pack (PDF)
Visual Profiler Documentation Pack (PDF)
Software - Base Package
The Base Package includes:
- Runtime libraries and driver, including GDB-based debugger
- CSXL acceleration library
- A set of diagnostic tools
3.1 Software Overview and Quick Start Guide (PDF)
This document is provided to assist customers familiarize themselves rapidly with the
software tools available. It also gives detailed instructions allowing quick and simple
implementation.
Release Notes
Base Package Release Notes for 3.1 (PDF)
This document describes the most important changes to the base package since Release 3.0. In addition, it lists the known open issues and limitations in Release 3.1.
Installation Guide
Base Package Software Installation Guide for 3.1 (PDF)
Instructions for installing the runtime, driver and diagnostic software for the Advance Accelerators.
User Manual
Runtime User Manual for 3.1 (PDF)
Documentation on the tools and API provided as the runtime and drivers package.
CSAPI Migration Guide for Release 3 (PDF)
This guide assists users in porting their code from software Release 2 to Release 3.0 of the ClearSpeed host programming interface (CSAPI). The general use of the CSAPI library has not changed, but a number of functions have had their parameters changed. These changes reflect the addition of new features and work to streamline the interface.
Software - Libraries
CSXL User Guide for 3.1 (PDF)
This user guide provides detailed instructions and feature information for using CSXL 3.1.
CSDFT User Guide for 3.1 (PDF)
The ClearSpeed Discrete Fourier Transform (CSDFT) library consists of two parts: a host library allowing FFT functions to be called from host applications and a card-side library to be used by Cn programs.
Software - Developer Package
The Developer Package includes:
- Software Development Kit (SDK)
- Instruction set simulator
- FLEXlm license server
- CSDFT acceleration library
Release Notes
Developer Package Release Notes for 3.1 (PDF)
This document describes the most important changes to the developer package since Release 2.51. In addition, it lists the known open issues and limitations in Release 3.1.
Installation Guide
Developer Software Installation Guide for 3.1 for Linux and Windows (PDF)
Instructions for installing the Software Development Kit (SDK) for the Advance Accelerator cards.
User Manual
Software Development Kit (SDK) Introductory Programming Manual for 3.1 (PDF)
This document is provided to help users get started with the ClearSpeed Software Development Kit.
CSPX Accelerator
Interface Library User Guide for 3.1 (PDF)
This document describes the application programming interface for host applications using ClearSpeed accelerators.
SDK Migration Guide for Release 3 (PDF)
This guide provides information required to easily migrate from the Release 2 SDK to Release 3.
FLEXlm license server
FLEXlm Licensing End Users Guide (PDF)
The user manual for the FLEXlm license manager used by the SDK tools.
Visual Profiler
Visual Profiler User Manual for Release 3.1 (PDF)
This document is provided to introduce users to the ClearSpeed Visual Profiler which is used to visualize data contained in event-based trace files.
Visual Profiler User Workshops Portfolio for Release 3.1 (PDF)
This link provides access to a series of workshops that builds upon the User Manual and demonstrates the features of the Visual Profiler.
Reference Manuals
(Login required to view additional resources.)
Cn Standard Library Reference Files for 3.1 (PDF)
The Cn Standard Library reference manual describes library functions available to Cn programmers.