Stellaris Development and Evaluation Kits for Code Composer Studio Stellaris Development and Evaluation Kits provide a low-cost way to start designing with Stellaris microcontrollers using Texas Instruments Code Composer Studio development tools. The evaluation boards can function as either a complete evaluation target or as a debugger interface to any external Stellaris device. Requirements You have a PC with a USB interface, running Microsoft Windows 7 You have the Stellaris Evaluation Kit Documentation and Software DVD or the standalone Code Composer Studio DVD found in the Development Kit CAUTION: There is a known electrical issue with the FT2232 device that is used in the on-board In Circuit Debug Interface (ICDI). Some USB hubs can cause the device to misbehave, with symptoms ranging from failed enumeration to corrupt data transfers. If you experience trouble when using the on-board ICDI, try connecting the USB cable directly to one of the USB ports on your PC or laptop. Code Composer Studio This quickstart shows you how to install the Code Composer Studio development tool and how to use it to build and run an example application on your Stellaris Evaluation or Development Board. Step 1: Install Code Composer Studio 1. Insert the Evaluation Kit Documentation and Software DVD or the standalone Code Composer Studio DVD into the DVD-ROM drive of your computer. If Autoplay is enabled on your PC, the index.htm file automatically opens in your default web browser. If Autoplay is not enabled, use Windows Explorer to open the DVD manually. 2. With the Evaluation Kit DVD, click the Tools button and then click the Code Composer Studio logo to start the setup program. NOTE: The CCS installer executable relies on additional installer executables on the DVD. Your web browser must support running files without first saving them to your hard drive to successfully run the CCS installer by clicking the CCS logo. If your web browser does not support this feature, you will need to use Windows Explorer to browse to and run the CCS installer (setup_ccs_n.n.n.nnnnn.exe) from the \Tools\CCS\ directory on the DVD. With the standalone DVD, follow the installer dialog. 3. Follow the instructions in the Code Composer Studio installation program. Select a Complete Feature Set install or a Custom install with the Stellaris ARM Cortex -M MCUs selected at a minimum. For all of the other options, keep the default values. 1
Step 2: Install the StellarisWare Package A full set of C-based peripheral drivers is provided, covering all peripherals and functionality of the Stellaris devices. The StellarisWare package includes various example applications with project files for all major tool vendors that support Stellaris, including Code Composer Studio. To install StellarisWare components, follow these steps: 1. Navigate to the Tools tab on the Evaluation Kit Documentation and Software DVD or Development Kit Documentation and Software DVD. NOTE: If you are navigating the DVD using Windows Explorer (or a similar application), go to the Tools/StellarisWare/ directory. 2. Click the Install link next in the StellarisWare section of the DVD and run the StellarisWare installer. If you prefer to manually install StellarisWare, the installer is a self-extracting zip file that is located in the Tools/StellarisWare directory. You can use a zip file extraction utility such as WinZip to manually extract the contents. 3. To view the StellarisWare documentation, navigate to the installation directory and click the Stellaris Peripheral Driver Library User s Guide PDF. NOTE: For the most recent version of StellarisWare, check the www.ti.com/stellaris web site. Step 3: Install Stellaris Drivers for LM4F Devices In order to debug and download the custom application into the microcontroller s Flash memory and use Virtual COM Port connectivity using Stellaris-based In-Circuit Debugging Interface (ICDI), install the following drivers on the host computer. Stellaris Virtual Serial Port Stellaris ICDI JTAG/SWD Stellaris ICDI DFU These drivers are available for download at http://www.ti.com/tool/stellaris_icdi_drivers. Download and extract the drivers to a known location on your computer before continuing with the following steps: 1. Right-click the Computer option from the Windows Start button and select Properties from the drop-down menu. 2. In the Control Panel column on the left side of the screen, click Device Manager. The Device Manager window opens and displays a list of hardware devices installed on the computer and allows you to set the properties for each device. When the development or evaluation board is connected to the computer for the first time, the computer detects the on-board ICDI interface and the Stellaris microcontroller. Drivers that are not yet installed display a yellow exclamation mark in the Device Manager window. 3. To install the drivers, right-click the first In-Circuit Debug Interface in the Other Devices section. Select the Update Driver Software option. 2
4. In the Update Driver Software In-Circuit Debug Interface window that appears next, select Browse my computer for driver software to point Windows to the location where the drivers are located on your computer. 5. Click the Browse button, and browse to the location where the drivers are located on your computer. If you are installing the drivers from the Documentation and Software CD/ DVD that came with the development or evaluation kit, make sure the disk is in your optical drive, or that you have extracted the drivers to a known location on your computer s hard drive. Click Next to begin the driver installation process. You will see the Update Driver Software In-Circuit Debug Interface pop-up window while Windows is installing the drivers 3
NOTE: If the Windows Security pop-up window appears, select, Install this driver software anyway. 6. After the drivers have been installed, you will see the following. 7. Go to the Windows Device Manager, and click the Scan for hardware changes button in the Device Manager toolbar. This updates the Device Manager properties. You will see Stellaris Virtual Serial Port appear under Ports (COM & LPT). This confirms that the Stellaris Virtual Serial Port driver has been successfully installed. 8. Repeat steps 3 though 7 to install the Stellaris ICDI DFU Device drivers and the Stellaris ICDI/JTAG/SWD Interface. Upon successful installation of all three drivers, the Device Manager window displays the items in the Device Manager window. These drivers provide the debugger with access to the JTAG/SWD interface, and the host PC access to the Virtual COM Port. With these drivers installed, Windows automatically detects any new Stellaris boards (with a Stellaris-based ICDI) that connect to the computer, and installs the required drivers. Step 4: Start Code Composer Studio and Open a Workspace 1. Start the Code Composer Studio IDE by selecting it from the Windows Start menu or double-clicking the icon installed on your desktop. When the IDE loads, it asks you where to open the workspace folder: 4
2. The Workspace Launcher defaults to the following path: C:\Users\<username>\workspace_v5_2 Click OK to use this default workspace location. NOTE: If you installed the Code Composer Studio IDE from the DVD, the license was automatically installed. If you downloaded the Code Composer Studio IDE, you may have to go through an extra licensing step. 3. The Code Composer Studio IDE may now open with the welcome page. If so, close the welcome page by clicking the X on the tab. You should now have an empty workspace. Step 5: Import Libraries 1. Select the Import Existing CCS Eclipse Project option from the Project menu in the IDE. 2. In the Import CCS Eclipse Projects window, browse to the root directory for the Stellaris Peripheral driver library (StellarisWare\driverlib). Two projects are displayed in the Discovered project field. Select the driverlib-cm3 option if your device 5
is a Stellaris Cortex-M3 microcontroller, or the driverlib-cm4f option if your device is a Stellaris Cortex-M4F microcontroller. Click Finish after you have made your selection. IMPORTANT: If you have installed the StellarisWare Firmware Development package for a board that does not use the USB library or Graphics library, the following steps do not apply. If the directories mentioned below do not exist in your StellarisWare installation, then click Cancel to close the Import CCS Eclipse Projects dialog box. Repeat Step 2 to import the USB Library (usblib) and the Graphics Library (grlib) as follows: 3. Select the Import Existing CCS Eclipse Project option from the Project menu in the IDE again. Browse to the root directory of USB library (StellarisWare\usblib). Select the usblib-cm3 option if your device is a Stellaris Cortex-M3 microcontroller, or the driverusblib-cm4f option if your device is a Stellaris Cortex-M4F microcontroller. Click Finish after you have made your selection. 4. Select the Import Existing CCS Eclipse Project option from the Project menu in the IDE again. Browse to the root directory of the graphics library (StellarisWare\grlib). Two projects are displayed. Select the grlib-cm3 option if your device is a Stellaris Cortex-M3 microcontroller, or the grlib-cm4f option if your device is a Stellaris Cortex- M4F microcontroller. Click Finish after you have made your selection. Step 6: Import Board Examples 1. Select the Import Existing CCS Eclipse Project option from the Project menu in the main menu bar. 2. The Import dialog box appears. Browse to the root directory for your board. The image below shows the EK-LM3S9B90 board as an example (StellarisWare\boards\eklm3s9b90). Make sure that the examples are selected in the Discovered projects field, then click Finish. 6
NOTE: You are not required to copy projects into the workspace, however, for board examples, it is recommended that you copy the projects into the workspace. 3. All of the projects now display in the Projects Explorer window. 7
Step 7: Build and Debug a Project 1. Click the hello project in the Project Explorer window to set as the Active project (see the previous image) 2. Select Build Project from the Project menu in the main menu bar. The build may take a few minutes. As the project builds, messages scroll in the console window. When the build is complete, the words Build Finished appear in the console window. 3. Select Debug from the Run menu in the main menu bar. You can also select the Debug option by clicking the Debug Launch icon on the toolbar, or pressing the F11 function key on your keyboard. 4. The Code Composer Studio debugger automatically connects to your development or evaluation board, programs the Flash memory, and runs to the beginning of the main() function. From here, you can examine and modify memory, program variables and processor registers, set breakpoints, step, and perform other typical debugging activities. To run the program, select Resume from the Run menu. Step 8: Build and Run Additional Example Programs There are several additional example projects listed in the Project Explorer window. Follow the instructions in Step 7 to build additional example programs. The quickstart application that came preloaded on the evaluation board is the qs-xxxxx project listed with the examples. Creating a New Project After you are finished exploring and building the StellarisWare example applications, you might want to create your own project to start development. Although you can start with an existing project, you can also create a new project. The example shown below creates a new project, copies code from an existing project, and then builds the new project. 1. To add a new project to your workspace, select File > New > CCS Project from the main menu bar. 2. The New CCS Project window appears which allows you to create a new CCS project. Update the following fields (shown in the screen capture below): Project name, Location, Family, Variant (device), Connection, Device endianness, Compiler version, and Output format. Leave the Linker command file and Runtime support library with their default settings (<automatic>). 8
3. Then click the arrow to display the options under Project templates and examples. Select Empty project, then click Finish. 4. A new project has now been created. The project includes only the main.c source file, but does not contain any source code. Add a loop forever function to the main.c file and then save the main.c file. 9
5. Add some startup code to the project by copying the startup_ccs.c file from an existing example directory in StellarisWare (such as \StellarisWare\boards\<board>\blinky) to your new project directory created in steps 2 and 3 above. 6. The main.c and startup_ccs.c files have automatically been added to the project. If the files were not automatically added, right-click the project, select Add Files from the drop-down menu, and then browse to the files in the new project folder to select. 7. Build the new project by selecting Project > Build Project from the main menu. Your new project has been created. Now add your own code using the existing StellarisWare board examples as a reference. 8. To create a new C source file, select File > New > Source File from the main menu. 9. In the New Source File dialog box that appears, enter a file name and click Finish. 10
Optional: Set Up Your Project to Output a Binary File You can set up your project to output a binary file (.bin) to be used with tools such as LM Flash Programmer by copying the post-build step from an existing StellarisWare example project. Right click the project and select Show Build Settings If you use standard C I/O functions such as printf or fread, you must increase the stack and heap allocations for your project as follows: 1. Right-click your project and then select Show Build Settings to open the Properties dialog box. 2. Select Basic Options under TMS470 Linker in the pane on the left side of the dialog box. 3. Enter 0x800 for both the system stack and the heap. 11
Conclusion You have now installed the Code Composer Studio development tools and used them to build and load an example application on your Stellaris development or evaluation board. You can now experiment with the debugger or start creating your own application using the example projects for reference. For more information on Code Composer Studio, go to the CCS Developer Site by clicking Help on the main menu and selecting the CCSv5 Developer Site option. References The following references are included on the Stellaris Evaluation Kit Documentation and Software DVD and are also available for download at www.ti.com/stellaris: Stellaris Evaluation Kit User's Manual StellarisWare Software, Order Number SW-LM3S StellarisWare Peripheral Driver Library User s Guide, Document Number SW-DRL-UG In addition, the following website may be useful: Code Composer Studio website at http://www.ti.com/ccstudio Copyright 2009 2012 Texas Instruments, Inc. All rights reserved. Stellaris and StellarisWare are registered trademarks of Texas Instruments. ARM and Thumb are registered trademarks, and Cortex is a trademark of ARM Limited. Other names and brands may be claimed as the property of others. Texas Instruments 108 Wild Basin Rd., Suite 350 Austin, TX 78746 http://www.ti.com/stellaris 5/29/2012