Installation Notes

Brook+

Stream Computing SDK 1.4

This release of ATI Brook+ Software Development Kit (SDK) includes a single install package
(MSI or RPM).

1 Prerequisites
Installing the Brook+ SDK (compiler, runtime, and sample applications) on your system requires:

• Administrative privileges for the person installing the SDK.

• One of the following operating systems:
– Windows XP 32-bit
– XP 64-bit (both SP2)
– Vista 32-bit
– Vista 64-bit (both SP1)
– Linux (32-bit or 64-bit): Red Hat Enterprise Linux 5.1, SUSE Linux Enterprise Server
(SLES) 10 SP1.
• Any of the following graphics cards:
– ATI Radeon HD 2000+ series
– ATI Radeon HD 3870
– ATI Radeon HD 4850
– ATI Radeon HD 4870
– ATI FireGL V7700
– AMD FireStream 9170
– AMD FireStream 9270
• Visual Studio 2005 (VS8) and 2008 (VS9) – Brook+ platform and samples are provided in both
VS8 format and as makefiles.
• ATI Catalyst™ Driver - Brook+ and CAL require ATI Catalyst version 8.12.

2 Download Files
Access [Link] and download the following files.

• The ATI Catalyst that matches your operating system.

• The SDK version that matches your operating system. The executable file installs the Brook+
compiler and runtime, as well as the ATI CAL software.

Stream Computing SDK 1.4 1 of 5

 • The Stream KernelAnalyzer (optional) - This tool, also known as an the SKA, analyzes the
performance of pixel and vertex shaders on ATI Radeon graphics cards. It provides accurate
performance estimates for shaders and lets you view disassembly of the generated hardware
shader. The SKA provides an easy-to-use GUI to edit stream kernels written in Brook+ syntax.
The SKA invokes the underlying Stream compiler (brcc) to interactively compile the kernel.
Any compilation errors are displayed in a separate display area. On successful compilation,
SKA lets the developer perform additional analysis to get the GPU assembly and performance
metrics for the kernel. The SKA also provides UI to control brcc options.

The ATI Stream SDK compressed file contains a setup executable for the Brook+ SDK and the
CAL SDK. This package contains the following files:

File and Location Description

<BROOKROOT>\ Install directory
doc\ Documentation
platform\
[Link] Visual Studio solution
brcc\src\ Brook+ Compiler source
include\ Brook+ include files
runtime\src\ Runtime source
utils\ Misc. make files and tools
samples\ Brook+ sample apps
sdk\ SDK tree
bin\
[Link] Release build of the Brook+ compiler
brcc_d.exe Release build of the Brook+ compiler (provided
for backward compatibility)
include\ Brook+ include files
lib\
[Link] Release build of the Brook+ runtime library
brook_d.lib Debug build of the Brook+ runtime library (pro-
vided for backward compatibility)
utils\
vs8_syntaxHighlighting\ Brook+ syntax highlighting files

3 Installing Brook+

3.1 Windows Systems

1. Ensure that you have administrative privileges for the system on which you are installing the
SDK.
2. Install ATI CAL (Compute Abstraction Layer) using the CAL installer, and follow the prompts.

2 of 5 Stream Computing SDK 1.4

 a. Default install locations for CAL DLLs are:

OS Default Install Location for CAL DLLs

32-bit XP C:\Program Files\ATI\<CAL SDK name>\lib\xp32\

64-bit XP C:\Program Files\ATI\<CAL SDK name>\lib\xp64\
32-bit Vista C:\Program Files\ATI\<CAL SDK name>\lib\LH32\
64-bit Vista C:\Program Files\ATI\<CAL SDK name>\lib\LH64\

Note that DLLs for 64-bit systems have 64 appended to their names. For example, a DLL
for a 32-bit system, [Link], is [Link] in a 64-bit system.
b. The installer adds the environment variable CALROOT and sets it to the CAL install path.
The default value is:
CALROOT = C:\Program Files\ATI\<CAL SDK>
3. Install Brook+ using the provided installer, and follow the prompts.
a. The installer adds the environment variable BROOKROOT and sets it to the Brook+ install
path. The default value is:
BROOKROOT = C:\Program Files\ATI\<BROOK+ SDK>\
Ensure that BROOKROOT is set to the root directory of the ATI Brook+ installation.
b. Ensure the sdk\lib directory under the ATI Brook+ installation is included in PATH. Also,
ensure that no old versions of Brook+ are referenced in the search path.

3.2 Linux Systems

You must have root permissions to install this SDK.

Once you have the Catalyst driver installed:

• For 32-bit systems, invoke atistream-brook-1.4.0_beta.[Link]

• For 64-bit systems, invoke atistream-brook-1.4.0_beta.x86_64.run

By default, the ATI CAL SDK installs into:

OS Default Install Location for CAL DLLs

32-bit Linux /usr/local/atical/lib

64-bit Linux /usr/local/atical/lib64

During installation, the installer asks you if you want to install the CAL SDK to a different location.

After installation:

1. Set CALROOT to the directory where CAL was installed. The default value is
/usr/local/atical.

Stream Computing SDK 1.4 3 of 5

 2. Add the lib folder of CAL installation to the LD_LIBRARY_PATH.
– For 32-bit systems, the default value is /usr/local/atical/lib.
– For 64-bit systems, the default value is /usr/local/atical/lib64.
• Under Linux, ensure that the PATH variable includes the sdk/bin folder of the Brook+
installation so that you have access to brcc in your build scripts. The default location of this
path is: /usr/local/atibrook/sdk/bin.
• Under Linux, ensure that the LD_LIBRARY_PATH variable includes the lib folder of the Brook+
installation so that Brook+ applications can find the Brook+ runtime libraries. The default
location of this path is: /usr/local/atibrook/sdk/lib.
• Under Linux, set BROOKROOT to the directory where Brook+ was installed. The default location
of this path is: /usr/local/atibrook.

4 Uninstalling Brook+

4.1 On Windows Systems

To uninstall, either run the installer again, and choose Remove. You also can use the Windows
Control Panel. For the latter option:

Uninstalling on an XP System

Step 1. Select Control Panel > Add/Remove Programs.

Step 2. Select ATI Brook+ 1.4.0_beta.
Step 3. Click Uninstall.

This removes all originally installed files. Temporary and new files created with Brook+ must be
removed manually. To ensure a clean uninstall, verify that the CALROOT and PATH environment
variables are also reverted.

Uninstalling on a Vista System

Step 1. Select Control Panel > Programs and Features.

Step 2. Select ATI Brook+ 1.4.0_beta.
Step 3. Click Uninstall/Change, and follow the prompts.

This removes all originally installed files. Temporary and new files created with Brook+ must be
removed manually. To ensure a clean uninstall, verify that the CALROOT and PATH environment
variables are also reverted.

4.2 On Linux Systems

To uninstall the CAL SDK, run as root rpm -e atibrook.

This removes all the files initially installed. Temporary and new files created with Brook+ must be
removed manually.

4 of 5 Stream Computing SDK 1.4

5 Syntax Highlighting in Visual Studio
To enable syntax highlighting for .br files in Visual Studio:

1. If not already present, copy [Link] in

<BROOKROOT>\utils\vs8_syntaxHighlighting\ to
<Visual Studio 8>\Common7\IDE\.
Otherwise, append the contents of [Link] onto
<Visual Studio 8>\Common7\IDE\[Link].
2. Open Visual Studio 8, and select Tools→Options.
3. Expand the Text Editor, and select File Extension.
4. Enter br in the Extension box, choose your favorite editor, and click Add.
5. Click OK to close the window.
6. Close Visual Studio 8; then, restart this program.

See the associated readme file (located in vs8_syntaxHighlighting\) for more information.

Contact Advanced Micro Devices, Inc. For Stream Computing:

One AMD Place URL: [Link]/stream
P.O. Box 3453 Questions: streamcomputing@[Link]
Sunnyvale, CA, 94088-3453 Developing: streamdeveloper@[Link]
Phone: +1.408.749.4000 Forum: [Link]/streamdevforum

The contents of this document are provided in connection with Advanced AMD’s products are not designed, intended, authorized or warranted for use as
Micro Devices, Inc. (“AMD”) products. AMD makes no representations or components in systems intended for surgical implant into the body, or in other
warranties with respect to the accuracy or completeness of the contents of applications intended to support or sustain life, or in any other application in
this publication and reserves the right to make changes to specifications and which the failure of AMD’s product could create a situation where personal injury,
product descriptions at any time without notice. The information contained death, or severe property or environmental damage may occur. AMD reserves
herein may be of a preliminary or advance nature and is subject to change the right to discontinue or make changes to its products at any time without
without notice. No license, whether express, implied, arising by estoppel or notice.
otherwise, to any intellectual property rights is granted by this publication. Copyright and Trademarks
Except as set forth in AMD’s Standard Terms and Conditions of Sale, AMD © 2009 Advanced Micro Devices, Inc. All rights reserved. AMD, the AMD Arrow
assumes no liability whatsoever, and disclaims any express or implied war- logo, ATI, the ATI logo, Radeon, FireStream, and combinations thereof are trade-
ranty, relating to its products including, but not limited to, the implied war- marks of Advanced Micro Devices, Inc. Other names are for informational pur-
ranty of merchantability, fitness for a particular purpose, or infringement of poses only and may be trademarks of their respective owners.
any intellectual property right.

5 of 5 Stream Computing SDK 1.4