Stellaris Peripheral Driver Library

USERS GUIDE

SW-DRL-UG-3618

Copyright 2006-2008 Luminary Micro, Inc.

Legal Disclaimers and Trademark Information

INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH LUMINARY MICRO PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN LUMINARY MICROS TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, LUMINARY MICRO ASSUMES NO LIABILITY WHATSOEVER, AND LUMINARY MICRO DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF LUMINARY MICROS PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. LUMINARY MICROS PRODUCTS ARE NOT INTENDED FOR USE IN MEDICAL, LIFE SAVING, OR LIFE-SUSTAINING APPLICATIONS. Luminary Micro may make changes to specications and product descriptions at any time, without notice. Contact your local Luminary Micro sales ofce or your distributor to obtain the latest specications and before placing your product order. Designers must not rely on the absence or characteristics of any features or instructions marked reserved or undened. Luminary Micro reserves these for future denition and shall have no responsibility whatsoever for conicts or incompatibilities arising from future changes to them. Copyright 2006-2008 Luminary Micro, Inc. All rights reserved. Stellaris, Luminary Micro, and the Luminary Micro logo are registered trademarks of Luminary Micro, Inc. or its subsidiaries in the United States and other countries. 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. Luminary Micro, Inc. 108 Wild Basin, Suite 350 Austin, TX 78746 Main: +1-512-279-8800 Fax: +1-512-279-8879 http://www.luminarymicro.com

Revision Information
This is version 3618 of this document, last updated on October 30, 2008.

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Table of Contents
Legal Disclaimers and Trademark Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Revision Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 2.1 2.2 2.3 2.4 3 3.1 3.2 3.3 4 4.1 4.2 4.3 5 5.1 5.2 5.3 6 6.1 6.2 6.3 7 7.1 7.2 7.3 8 8.1 8.2 8.3 9 9.1 9.2 9.3 10 10.1 10.2 10.3 11 11.1 11.2 11.3 12 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Programming Model . . . . . Introduction . . . . . . . . . . . Direct Register Access Model Software Driver Model . . . . . Combining The Models . . . . Analog Comparator . Introduction . . . . . . . API Functions . . . . . Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2 7 9 9 9 10 11 13 13 13 19 21 21 22 33 35 35 35 52 55 55 55 68 69 69 69 77 79 79 79 95

Analog to Digital Converter (ADC) Introduction . . . . . . . . . . . . . . API Functions . . . . . . . . . . . . Programming Example . . . . . . . Controller Area Network (CAN) . Introduction . . . . . . . . . . . . . API Functions . . . . . . . . . . . Programming Example . . . . . . Ethernet Controller . . Introduction . . . . . . . API Functions . . . . . Programming Example Flash . . . . . . . . . . Introduction . . . . . . . API Functions . . . . . Programming Example GPIO . . . . . . . . . . Introduction . . . . . . . API Functions . . . . . Programming Example Hibernation Module . Introduction . . . . . . . API Functions . . . . . Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. 97 . 97 . 97 . 110 . . . . . . . . 115 115 116 130 131 131 132 137

Inter-Integrated Circuit (I2C) Introduction . . . . . . . . . . . API Functions . . . . . . . . . Programming Example . . . . Interrupt Controller (NVIC) Introduction . . . . . . . . . . API Functions . . . . . . . . Programming Example . . . . . . .

Memory Protection Unit (MPU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

October 30, 2008

Table of Contents

12.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 12.2 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 12.3 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 13 13.1 13.2 13.3 14 14.1 14.2 14.3 15 15.1 15.2 15.3 16 16.1 16.2 16.3 17 17.1 17.2 17.3 18 18.1 18.2 18.3 19 19.1 19.2 19.3 20 20.1 20.2 20.3 21 21.1 21.2 21.3 22 22.1 22.2 22.3 22.4 23 23.1 23.2 23.3 Peripheral Pin Mapping Introduction . . . . . . . . API Functions . . . . . . Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 149 149 155 157 157 157 177 179 179 180 188 189 189 189 198 199 199 200 221 223 223 223 227 229 229 229 241 243 243 243 257 259 259 260 274 277 277 277 281 309 311 311 311 319

Pulse Width Modulator (PWM) Introduction . . . . . . . . . . . . API Functions . . . . . . . . . . Programming Example . . . . . Quadrature Encoder (QEI) Introduction . . . . . . . . . . API Functions . . . . . . . . Programming Example . . . . . . . . . . .

Synchronous Serial Interface (SSI) Introduction . . . . . . . . . . . . . . . API Functions . . . . . . . . . . . . . Programming Example . . . . . . . . System Control . . . . Introduction . . . . . . . API Functions . . . . . Programming Example System Tick (SysTick) Introduction . . . . . . . API Functions . . . . . Programming Example Timer . . . . . . . . . . Introduction . . . . . . . API Functions . . . . . Programming Example UART . . . . . . . . . . Introduction . . . . . . . API Functions . . . . . Programming Example uDMA Controller . . . Introduction . . . . . . . API Functions . . . . . Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

USB Controller . . . . . . . . . . . . Introduction . . . . . . . . . . . . . . . Using USB with the uDMA Controller API Functions . . . . . . . . . . . . . Programming Example . . . . . . . . Watchdog Timer . . . Introduction . . . . . . . API Functions . . . . . Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

24 24.1 24.2 24.3 24.4 25

Using the ROM . . Introduction . . . . . Direct ROM Calls . Mapped ROM Calls Firmware Update .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

321 321 321 322 323

Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Company Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 Support Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

October 30, 2008

Table of Contents

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Introduction
The Luminary Micro Stellaris Peripheral Driver Library is a set of drivers for accessing the peripherals found on the Stellaris family of ARM Cortex-M3 based microcontrollers. While they are not drivers in the pure operating system sense (that is, they do not have a common interface and do not connect into a global device driver infrastructure), they do provide a mechanism that makes it easy to use the devices peripherals. The capabilities and organization of the drivers are governed by the following design goals: They are written entirely in C except where absolutely not possible. They demonstrate how to use the peripheral in its common mode of operation. They are easy to understand. They are reasonably efcient in terms of memory and processor usage. They are as self-contained as possible. Where possible, computations that can be performed at compile time are done there instead of at run time. They can be built with more than one tool chain. Some consequences of these design goals are: The drivers are not necessarily as efcient as they could be (from a code size and/or execution speed point of view). While the most efcient piece of code for operating a peripheral would be written in assembly and custom tailored to the specic requirements of the application, further size optimizations of the drivers would make them more difcult to understand. The drivers do not support the full capabilities of the hardware. Some of the peripherals provide complex capabilities which can not be utilized by the drivers in this library, though the existing code can be used as a reference upon which to add support for the additional capabilities. The APIs have a means of removing all error checking code. Since the error checking is usually only useful during initial program development, it can be removed to improve code size and speed. For many applications, the drivers can be used as is. But in some cases, the drivers will have to be enhanced or rewritten in order to meet the functionality, memory, or processing requirements of the application. If so, the existing driver can be used as a reference on how to operate the peripheral. The following tool chains are supported: Keil RealView Microcontroller Development Kit CodeSourcery Sourcery G++ for Stellaris EABI IAR Embedded Workbench Code Red Technologies tools

Source Code Overview

The following is an overview of the organization of the peripheral driver library source code.

October 30, 2008

Introduction

EULA.txt

The full text of the End User License Agreement that covers the use of this software package. This directory contains the source code for the drivers. Header les, one per peripheral, that describe all the registers and the bit elds within those registers for each peripheral. These header les are used by the drivers to directly access a peripheral, and can be used by application code to bypass the peripheral driver library API. This directory holds the part specic header les used for the direct register access programming model.

driverlib/ hw_*.h

inc/

makedefs

A set of denitions used by make les.

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Programming Model
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Direct Register Access Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Software Driver Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Combining The Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.1

Introduction
The peripheral driver library provides support for two programming models: the direct register access model and the software driver model. Each model can be used independently, or combined, based on the needs of the application or the programming environment desired by the developer. Each programming model has advantages and disadvantages. Use of the direct register access model will generally result in smaller and more efcient code than using the software driver model. However, the direct register access model does require detailed knowledge of the operation of each register, bit eld, their interactions, and any sequencing required for proper operation of the peripheral; the developer is insulated from these details by the software driver model, generally requiring less time to develop applications.

2.2

Direct Register Access Model

In the direct register access model, the peripherals are programmed by the application by writing values directly into the peripherals registers. A set of macros is provided that simplies this process. These macros are stored in part-specic header les contained in the inc directory; the name of the header le matches the part number (for example, the header le for the LM3S6965 microcontroller is inc/lm3s6965.h). By including the header le that matches the part being used, macros are available for accessing all registers on that part, as well as all bit elds within those registers. No macros are available for registers that do not exist on the part in question, making it difcult to access registers that do not exist. The denes used by the direct register access model follow a naming convention that makes it easier to know how to use a particular macro. The rules are as follows: Values that end in _R are used to access the value of a register. For example, SSI0_CR0_R is used to access the CR0 register in the SSI0 module. Values that end in _M represent the mask for a multi-bit eld in a register. If the value placed in the multi-bit eld is a number, there will be a macro with the same base name but ending with _S (for example, SSI_CR0_SCR_M and SSI_CR0_SCR_S). If the value placed into the multi-bit eld is an enumeration, then there will be a set of macros with the same base name but ending with identiers for the various enumeration values (for example, the SSI_CR0_FRF_M macro denes the bit eld, and the SSI_CR0_FRF_NMW, SSI_CR0_FRF_TI, and SSI_CR0_FRF_MOTO macros provide the enumerations for the bit eld). Values that end in _S represent the number of bits to shift a value in order to align it with a multi-bit eld. These values will match the macro with the same base name but ending with _M.

October 30, 2008

Programming Model

All other macros represent the value of a bit eld. All register name macros start with the module name and instance number (for example, SSI0 for the rst SSI module) and are followed by the name of the register as it appears in the data sheet (for example, the CR0 register in the data sheet results in SSI0_CR0_R). All register bit elds start with the module name, followed by the register name, and then followed by the bit eld name as it appears in the data sheet. For example, the SCR bit eld in the CR0 register in the SSI module will be identied by SSI_CR0_SCR.... In the case where the bit eld is a single bit, there will be nothing further (for example, SSI_CR0_SPH is a single bit in the CR0 register). If the bit eld is more than a single bit, there will be a mask value (_M) and either a shift (_S) if the bit eld contains a number or a set of enumerations if not. Given these denitions, the CR0 register can be programmed as follows:
SSI0_CR0_R = ((5 << SSI_CR0_SCR_S) | SSI_CR0_SPH | SSI_CR0_SPO | SSI_CR0_FRF_MOTO | SSI_CR0_DSS_8);

Alternatively, the following has the same effect (although it is not as easy to understand):
SSI0_CR0_R = 0x000005c7;

Extracting the value of the SCR eld from the CR0 register is as follows:
ulValue = (SSI0_CR0_R & SSI_CR0_SCR_M) >> SSI0_CR0_SCR_S;

The GPIO modules have many registers that do not have bit eld denitions. For these registers, the register bits represent the individual GPIO pins; so bit zero in these registers corresponds to the Px0 pin on the part (where x is replaced by a GPIO module letter), bit one corresponds to the Px1 pin, and so on. The blinky example for each board utilizes the direct register access model to blink the on-board LED. Note: The hw_.h header les that are used by the drivers in the library contain many of the same denitions as the header les used for direct register access. As such, the two can not be included into the same source le without the compiler producing warnings about the redenition of symbols.

2.3

Software Driver Model

In the software driver model, the API provided by the peripheral driver library is used by applications to control the peripherals. Since these drivers provide complete control of the peripherals in their normal mode of operation, it is possible to write an entire application without direct access to the hardware. This provides for rapid development of the application without requiring detailed knowledge of how to program the peripherals. Corresponding to the direct register access model example, the following will also program the CR0 register in the SSI module (though that fact is hidden by the API):

10

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

SSIConfigSetExpClk(SSI0_BASE, 50000000, SSI_FRF_MOTO_MODE_3, SSI_MODE_MASTER, 1000000, 8);

The resulting value in the CR0 register might not be exactly the same since SSICongSetExpClk() may compute a different value for the SCR bit eld than what was used in the direct register access model example. All example applications other than blinky utilize the software driver model. The drivers in the peripheral driver library are described in the remaining chapters in this document. They combine to form the software driver model.

2.4

Combining The Models

The direct register access model and software driver model can be utilized together in a single application. This allows the most appropriate model to be used in any particular situation within the application; for example, the software driver model can be used to congure the peripherals (since this is not performance critical) and the direct register access model can be used for operation of the peripheral (which may be more performance critical). Or, the software driver model can be used for peripherals that are not performance critical (such as a UART used for data logging) and the direct register access model for performance critical peripherals (such as the ADC module used to capture real-time analog data).

October 30, 2008

11

Programming Model

12

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Analog Comparator
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

3.1

Introduction
The comparator API provides a set of functions for dealing with the analog comparators. A comparator can compare a test voltage against individual external reference voltage, a shared single external reference voltage, or a shared internal reference voltage. It can provide its output to a device pin, acting as a replacement for an analog comparator on the board, or it can be used to signal the application via interrupts or triggers to the ADC to cause it to start capturing a sample sequence. The interrupt generation and ADC triggering logic is separate, so that an interrupt can be generated on a rising edge and the ADC triggered on a falling edge (for example). This driver is contained in driverlib/comp.c, with driverlib/comp.h containing the API denitions for use by applications.

3.2

API Functions
Functions
void ComparatorCongure (unsigned long ulBase, unsigned long ulComp, unsigned long ulCong) void ComparatorIntClear (unsigned long ulBase, unsigned long ulComp) void ComparatorIntDisable (unsigned long ulBase, unsigned long ulComp) void ComparatorIntEnable (unsigned long ulBase, unsigned long ulComp) void ComparatorIntRegister (unsigned long ulBase, unsigned long ulComp, void (pfnHandler)(void)) tBoolean ComparatorIntStatus (unsigned long ulBase, unsigned long ulComp, tBoolean bMasked) void ComparatorIntUnregister (unsigned long ulBase, unsigned long ulComp) void ComparatorRefSet (unsigned long ulBase, unsigned long ulRef) tBoolean ComparatorValueGet (unsigned long ulBase, unsigned long ulComp)

3.2.1

Detailed Description
The comparator API is fairly simple, like the comparators themselves. There are functions for conguring a comparator and reading its output (ComparatorCongure(), ComparatorRefSet() and ComparatorValueGet()) and functions for dealing with an interrupt handler for the comparator (ComparatorIntRegister(), ComparatorIntUnregister(), ComparatorIntEnable(), ComparatorIntDisable(), ComparatorIntStatus(), and ComparatorIntClear()).

October 30, 2008

13

Analog Comparator

3.2.2
3.2.2.1

Function Documentation
ComparatorCongure
Congures a comparator. Prototype: void ComparatorConfigure(unsigned long ulBase, unsigned long ulComp, unsigned long ulConfig) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator to congure. ulCong is the conguration of the comparator. Description: This function will congure a comparator. The ulCong parameter is the result of a logical OR operation between the COMP_TRIG_xxx, COMP_INT_xxx, COMP_ASRCP_xxx, and COMP_OUTPUT_xxx values. The COMP_TRIG_xxx term can take on the following values: COMP_TRIG_NONE to have no trigger to the ADC. COMP_TRIG_HIGH to trigger the ADC when the comparator output is high. COMP_TRIG_LOW to trigger the ADC when the comparator output is low. COMP_TRIG_FALL to trigger the ADC when the comparator output goes low. COMP_TRIG_RISE to trigger the ADC when the comparator output goes high. COMP_TRIG_BOTH to trigger the ADC when the comparator output goes low or high. The COMP_INT_xxx term can take on the following values: COMP_INT_HIGH to generate an interrupt when the comparator output is high. COMP_INT_LOW to generate an interrupt when the comparator output is low. COMP_INT_FALL to generate an interrupt when the comparator output goes low. COMP_INT_RISE to generate an interrupt when the comparator output goes high. COMP_INT_BOTH to generate an interrupt when the comparator output goes low or high. The COMP_ASRCP_xxx term can take on the following values: COMP_ASRCP_PIN to use the dedicated Comp+ pin as the reference voltage. COMP_ASRCP_PIN0 to use the Comp0+ pin as the reference voltage (this the same as COMP_ASRCP_PIN for the comparator 0). COMP_ASRCP_REF to use the internally generated voltage as the reference voltage. The COMP_OUTPUT_xxx term can take on the following values: COMP_OUTPUT_NORMAL to enable a non-inverted output from the comparator to a device pin. COMP_OUTPUT_INVERT to enable an inverted output from the comparator to a device pin.

14

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

COMP_OUTPUT_NONE is COMP_OUTPUT_NORMAL. Returns: None.

deprecated

and

behaves

the

same

as

3.2.2.2

ComparatorIntClear
Clears a comparator interrupt. Prototype: void ComparatorIntClear(unsigned long ulBase, unsigned long ulComp) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator. Description: The comparator interrupt is cleared, so that it no longer asserts. This must be done in the interrupt handler to keep it from being called again immediately upon exit. Note that for a level triggered interrupt, the interrupt cannot be cleared until it stops asserting. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

3.2.2.3

ComparatorIntDisable
Disables the comparator interrupt. Prototype: void ComparatorIntDisable(unsigned long ulBase, unsigned long ulComp) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator. Description: This function disables generation of an interrupt from the specied comparator. Only comparators whose interrupts are enabled can be reected to the processor.

October 30, 2008

15

Analog Comparator

Returns: None.

3.2.2.4

ComparatorIntEnable
Enables the comparator interrupt. Prototype: void ComparatorIntEnable(unsigned long ulBase, unsigned long ulComp) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator. Description: This function enables generation of an interrupt from the specied comparator. Only comparators whose interrupts are enabled can be reected to the processor. Returns: None.

3.2.2.5

ComparatorIntRegister
Registers an interrupt handler for the comparator interrupt. Prototype: void ComparatorIntRegister(unsigned long ulBase, unsigned long ulComp, void (*pfnHandler)(void)) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator. pfnHandler is a pointer to the function to be called when the comparator interrupt occurs. Description: This sets the handler to be called when the comparator interrupt occurs. This will enable the interrupt in the interrupt controller; it is the interrupt-handlers responsibility to clear the interrupt source via ComparatorIntClear(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

16

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

3.2.2.6

ComparatorIntStatus
Gets the current interrupt status. Prototype: tBoolean ComparatorIntStatus(unsigned long ulBase, unsigned long ulComp, tBoolean bMasked) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the comparator. Either the raw or the masked interrupt status can be returned. Returns: true if the interrupt is asserted and false if it is not asserted.

3.2.2.7

ComparatorIntUnregister
Unregisters an interrupt handler for a comparator interrupt. Prototype: void ComparatorIntUnregister(unsigned long ulBase, unsigned long ulComp) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator. Description: This function will clear the handler to be called when a comparator interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

3.2.2.8

ComparatorRefSet
Sets the internal reference voltage.

October 30, 2008

17

Analog Comparator

Prototype: void ComparatorRefSet(unsigned long ulBase, unsigned long ulRef) Parameters: ulBase is the base address of the comparator module. ulRef is the desired reference voltage. Description: This function will set the internal reference voltage value. The voltage is specied as one of the following values: COMP_REF_OFF to turn off the reference voltage COMP_REF_0V to set the reference voltage to 0 V COMP_REF_0_1375V to set the reference voltage to 0.1375 V COMP_REF_0_275V to set the reference voltage to 0.275 V COMP_REF_0_4125V to set the reference voltage to 0.4125 V COMP_REF_0_55V to set the reference voltage to 0.55 V COMP_REF_0_6875V to set the reference voltage to 0.6875 V COMP_REF_0_825V to set the reference voltage to 0.825 V COMP_REF_0_928125V to set the reference voltage to 0.928125 V COMP_REF_0_9625V to set the reference voltage to 0.9625 V COMP_REF_1_03125V to set the reference voltage to 1.03125 V COMP_REF_1_134375V to set the reference voltage to 1.134375 V COMP_REF_1_1V to set the reference voltage to 1.1 V COMP_REF_1_2375V to set the reference voltage to 1.2375 V COMP_REF_1_340625V to set the reference voltage to 1.340625 V COMP_REF_1_375V to set the reference voltage to 1.375 V COMP_REF_1_44375V to set the reference voltage to 1.44375 V COMP_REF_1_5125V to set the reference voltage to 1.5125 V COMP_REF_1_546875V to set the reference voltage to 1.546875 V COMP_REF_1_65V to set the reference voltage to 1.65 V COMP_REF_1_753125V to set the reference voltage to 1.753125 V COMP_REF_1_7875V to set the reference voltage to 1.7875 V COMP_REF_1_85625V to set the reference voltage to 1.85625 V COMP_REF_1_925V to set the reference voltage to 1.925 V COMP_REF_1_959375V to set the reference voltage to 1.959375 V COMP_REF_2_0625V to set the reference voltage to 2.0625 V COMP_REF_2_165625V to set the reference voltage to 2.165625 V COMP_REF_2_26875V to set the reference voltage to 2.26875 V COMP_REF_2_371875V to set the reference voltage to 2.371875 V Returns: None.

18

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

3.2.2.9

ComparatorValueGet
Gets the current comparator output value. Prototype: tBoolean ComparatorValueGet(unsigned long ulBase, unsigned long ulComp) Parameters: ulBase is the base address of the comparator module. ulComp is the index of the comparator. Description: This function retrieves the current value of the comparator output. Returns: Returns true if the comparator output is high and false if the comparator output is low.

3.3

Programming Example
The following example shows how to use the comparator API to congure the comparator and read its value.
// // Configure the internal voltage reference. // ComparatorRefSet(COMP_BASE, COMP_REF_1_65V); // // Configure a comparator. // ComparatorConfigure(COMP_BASE, 0, (COMP_TRIG_NONE | COMP_INT_BOTH | COMP_ASRCP_REF | COMP_OUTPUT_NONE)); // // Delay for some time... // // // Read the comparator output value. // ComparatorValueGet(COMP_BASE, 0);

October 30, 2008

19

Analog Comparator

20

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Analog to Digital Converter (ADC)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.1

Introduction
The analog to digital converter (ADC) API provides a set of functions for dealing with the ADC. Functions are provided to congure the sample sequencers, read the captured data, register a sample sequence interrupt handler, and handle interrupt masking/clearing. The ADC supports up to eight input channels plus an internal temperature sensor. Four sampling sequences, each with congurable trigger events, can be captured. The rst sequence will capture up to eight samples, the second and third sequences will capture up to four samples, and the fourth sequence will capture a single sample. Each sample can be the same channel, different channels, or any combination in any order. The sample sequences have congurable priorities that determine the order in which they are captured when multiple triggers occur simultaneously. The highest priority sequence that is currently triggered will be sampled. Care must be taken with triggers that occur frequently (such as the always trigger); if their priority is too high it is possible to starve the lower priority sequences. Beginning with Rev C0 of the Stellaris microcontroller, hardware oversampling of the ADC data is available for improved accuracy. An oversampling factor of 2x, 4x, 8x, 16x, 32x, and 64x is supported, but reduces the throughput of the ADC by a corresponding factor. Hardware oversampling is applied uniformly across all sample sequences. Software oversampling of the ADC data is also available (even when hardware oversampling is available). An oversampling factor of 2x, 4x, and 8x is supported, but reduces the depth of the sample sequences by a corresponding amount. For example, the rst sample sequence will capture eight samples; in 4x oversampling mode it can only capture two samples since the rst four samples are used over the rst oversampled value and the second four samples are used for the second oversampled value. The amount of software oversampling is congured on a per sample sequence basis. A more sophisticated software oversampling can be used to eliminate the reduction of the sample sequence depth. By increasing the ADC trigger rate by 4x (for example) and averaging four triggers worth of data, 4x oversampling is achieved without any loss of sample sequence capability. In this case, an increase in the number of ADC triggers (and presumably ADC interrupts) is the consequence. Since this requires adjustments outside of the ADC driver itself, this is not directly supported by the driver (though nothing in the driver prevents it). The software oversampling APIs should not be used in this case. This driver is contained in driverlib/adc.c, with driverlib/adc.h containing the API denitions for use by applications.

October 30, 2008

21

Analog to Digital Converter (ADC)

4.2

API Functions
Functions
void ADCHardwareOversampleCongure (unsigned long ulBase, unsigned long ulFactor) void ADCIntClear (unsigned long ulBase, unsigned long ulSequenceNum) void ADCIntDisable (unsigned long ulBase, unsigned long ulSequenceNum) void ADCIntEnable (unsigned long ulBase, unsigned long ulSequenceNum) void ADCIntRegister (unsigned long ulBase, unsigned long ulSequenceNum, void (pfnHandler)(void)) unsigned long ADCIntStatus (unsigned long ulBase, unsigned long ulSequenceNum, tBoolean bMasked) void ADCIntUnregister (unsigned long ulBase, unsigned long ulSequenceNum) void ADCProcessorTrigger (unsigned long ulBase, unsigned long ulSequenceNum) void ADCSequenceCongure (unsigned long ulBase, unsigned long ulSequenceNum, unsigned long ulTrigger, unsigned long ulPriority) long ADCSequenceDataGet (unsigned long ulBase, unsigned long ulSequenceNum, unsigned long pulBuffer) void ADCSequenceDisable (unsigned long ulBase, unsigned long ulSequenceNum) void ADCSequenceEnable (unsigned long ulBase, unsigned long ulSequenceNum) long ADCSequenceOverow (unsigned long ulBase, unsigned long ulSequenceNum) void ADCSequenceOverowClear (unsigned long ulBase, unsigned long ulSequenceNum) void ADCSequenceStepCongure (unsigned long ulBase, unsigned long ulSequenceNum, unsigned long ulStep, unsigned long ulCong) long ADCSequenceUnderow (unsigned long ulBase, unsigned long ulSequenceNum) void ADCSequenceUnderowClear (unsigned long ulBase, unsigned long ulSequenceNum) void ADCSoftwareOversampleCongure (unsigned long ulBase, unsigned long ulSequenceNum, unsigned long ulFactor) void ADCSoftwareOversampleDataGet (unsigned long ulBase, unsigned long ulSequenceNum, unsigned long pulBuffer, unsigned long ulCount) void ADCSoftwareOversampleStepCongure (unsigned long ulBase, unsigned long ulSequenceNum, unsigned long ulStep, unsigned long ulCong)

4.2.1

Detailed Description
The analog to digital converter API is broken into three groups of functions: those that deal with the sample sequences, those that deal with the processor trigger, and those that deal with interrupt handling. The sample sequences are congured with ADCSequenceCongure() and ADCSequenceStepCongure(). They are enabled and disabled with ADCSequenceEnable() and ADCSequenceDisable(). The captured data is obtained with ADCSequenceDataGet(). Sample sequence FIFO overow and underow is managed with ADCSequenceOverow(), ADCSequenceOverowClear(), ADCSequenceUnderow(), and ADCSequenceUnderowClear(). Hardware oversampling of the ADC is controlled with ADCHardwareOversampleCongure(). Software oversampling of the ADC is controlled with ADCSoftwareOversampleCongure(), ADCSoftwareOversampleStepCongure(), and ADCSoftwareOversampleDataGet().

22

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

The processor trigger is generated with ADCProcessorTrigger(). The interrupt handler for the ADC sample sequence interrupts are managed with ADCIntRegister() and ADCIntUnregister(). The sample sequence interrupt sources are managed with ADCIntDisable(), ADCIntEnable(), ADCIntStatus(), and ADCIntClear().

4.2.2
4.2.2.1

Function Documentation
ADCHardwareOversampleCongure
Congures the hardware oversampling factor of the ADC. Prototype: void ADCHardwareOversampleConfigure(unsigned long ulBase, unsigned long ulFactor) Parameters: ulBase is the base address of the ADC module. ulFactor is the number of samples to be averaged. Description: This function congures the hardware oversampling for the ADC, which can be used to provide better resolution on the sampled data. Oversampling is accomplished by averaging multiple samples from the same analog input. Six different oversampling rates are supported; 2x, 4x, 8x, 16x, 32x, and 64x. Specifying an oversampling factor of zero will disable hardware oversampling. Hardware oversampling applies uniformly to all sample sequencers. It does not reduce the depth of the sample sequencers like the software oversampling APIs; each sample written into the sample sequence FIFO is a fully oversampled analog input reading. Enabling hardware averaging increases the precision of the ADC at the cost of throughput. For example, enabling 4x oversampling reduces the throughput of a 250 Ksps ADC to 62.5 Ksps. Note: Hardware oversampling is available beginning with Rev C0 of the Stellaris microcontroller. Returns: None.

4.2.2.2

ADCIntClear
Clears sample sequence interrupt source. Prototype: void ADCIntClear(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module.

October 30, 2008

23

Analog to Digital Converter (ADC)

ulSequenceNum is the sample sequence number. Description: The specied sample sequence interrupt is cleared, so that it no longer asserts. This must be done in the interrupt handler to keep it from being called again immediately upon exit. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

4.2.2.3

ADCIntDisable
Disables a sample sequence interrupt. Prototype: void ADCIntDisable(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: This function disables the requested sample sequence interrupt. Returns: None.

4.2.2.4

ADCIntEnable
Enables a sample sequence interrupt. Prototype: void ADCIntEnable(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number.

24

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function enables the requested sample sequence interrupt. Any outstanding interrupts are cleared before enabling the sample sequence interrupt. Returns: None.

4.2.2.5

ADCIntRegister
Registers an interrupt handler for an ADC interrupt. Prototype: void ADCIntRegister(unsigned long ulBase, unsigned long ulSequenceNum, void (*pfnHandler)(void)) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. pfnHandler is a pointer to the function to be called when the ADC sample sequence interrupt occurs. Description: This function sets the handler to be called when a sample sequence interrupt occurs. This will enable the global interrupt in the interrupt controller; the sequence interrupt must be enabled with ADCIntEnable(). It is the interrupt handlers responsibility to clear the interrupt source via ADCIntClear(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

4.2.2.6

ADCIntStatus
Gets the current interrupt status. Prototype: unsigned long ADCIntStatus(unsigned long ulBase, unsigned long ulSequenceNum, tBoolean bMasked) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required.

October 30, 2008

25

Analog to Digital Converter (ADC)

Description: This returns the interrupt status for the specied sample sequence. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: The current raw or masked interrupt status.

4.2.2.7

ADCIntUnregister
Unregisters the interrupt handler for an ADC interrupt. Prototype: void ADCIntUnregister(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: This function unregisters the interrupt handler. This will disable the global interrupt in the interrupt controller; the sequence interrupt must be disabled via ADCIntDisable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

4.2.2.8

ADCProcessorTrigger
Causes a processor trigger for a sample sequence. Prototype: void ADCProcessorTrigger(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: This function triggers a processor-initiated sample sequence if the sample sequence trigger is congured to ADC_TRIGGER_PROCESSOR. Returns: None.

26

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

4.2.2.9

ADCSequenceCongure
Congures the trigger source and priority of a sample sequence. Prototype: void ADCSequenceConfigure(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulSequenceNum, ulTrigger, ulPriority)

Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. ulTrigger is the trigger source that initiates the sample sequence; must be one of the ADC_TRIGGER_ values. ulPriority is the relative priority of the sample sequence with respect to the other sample sequences. Description: This function congures the initiation criteria for a sample sequence. Valid sample sequences range from zero to three; sequence zero will capture up to eight samples, sequences one and two will capture up to four samples, and sequence three will capture a single sample. The trigger condition and priority (with respect to other sample sequence execution) is set. The ulTrigger parameter can take on the following values: ADC_TRIGGER_PROCESSOR - A trigger generated by the processor, via the ADCProcessorTrigger() function. ADC_TRIGGER_COMP0 - A trigger generated by the rst analog comparator; congured with ComparatorCongure(). ADC_TRIGGER_COMP1 - A trigger generated by the second analog comparator; congured with ComparatorCongure(). ADC_TRIGGER_COMP2 - A trigger generated by the third analog comparator; congured with ComparatorCongure(). ADC_TRIGGER_EXTERNAL - A trigger generated by an input from the Port B4 pin. ADC_TRIGGER_TIMER - A trigger generated by a timer; congured with TimerControlTrigger(). ADC_TRIGGER_PWM0 - A trigger generated by the rst PWM generator; congured with PWMGenIntTrigEnable(). ADC_TRIGGER_PWM1 - A trigger generated by the second PWM generator; congured with PWMGenIntTrigEnable(). ADC_TRIGGER_PWM2 - A trigger generated by the third PWM generator; congured with PWMGenIntTrigEnable(). ADC_TRIGGER_ALWAYS - A trigger that is always asserted, causing the sample sequence to capture repeatedly (so long as there is not a higher priority source active). Note that not all trigger sources are available on all Stellaris family members; consult the data sheet for the device in question to determine the availability of triggers. The ulPriority parameter is a value between 0 and 3, where 0 represents the highest priority and 3 the lowest. Note that when programming the priority among a set of sample sequences, each must have unique priority; it is up to the caller to guarantee the uniqueness of the priorities.

October 30, 2008

27

Analog to Digital Converter (ADC)

Returns: None.

4.2.2.10 ADCSequenceDataGet
Gets the captured data for a sample sequence. Prototype: long ADCSequenceDataGet(unsigned long ulBase, unsigned long ulSequenceNum, unsigned long *pulBuffer) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. pulBuffer is the address where the data is stored. Description: This function copies data from the specied sample sequence output FIFO to a memory resident buffer. The number of samples available in the hardware FIFO are copied into the buffer, which is assumed to be large enough to hold that many samples. This will only return the samples that are presently available, which may not be the entire sample sequence if it is in the process of being executed. Returns: Returns the number of samples copied to the buffer.

4.2.2.11 ADCSequenceDisable
Disables a sample sequence. Prototype: void ADCSequenceDisable(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: Prevents the specied sample sequence from being captured when its trigger is detected. A sample sequence should be disabled before it is congured. Returns: None.

28

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

4.2.2.12 ADCSequenceEnable
Enables a sample sequence. Prototype: void ADCSequenceEnable(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: Allows the specied sample sequence to be captured when its trigger is detected. A sample sequence must be congured before it is enabled. Returns: None.

4.2.2.13 ADCSequenceOverow
Determines if a sample sequence overow occurred. Prototype: long ADCSequenceOverflow(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: This determines if a sample sequence overow has occurred. This will happen if the captured samples are not read from the FIFO before the next trigger occurs. Returns: Returns zero if there was not an overow, and non-zero if there was.

4.2.2.14 ADCSequenceOverowClear
Clears the overow condition on a sample sequence. Prototype: void ADCSequenceOverflowClear(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module.

October 30, 2008

29

Analog to Digital Converter (ADC)

ulSequenceNum is the sample sequence number. Description: This will clear an overow condition on one of the sample sequences. The overow condition must be cleared in order to detect a subsequent overow condition (it otherwise causes no harm). Returns: None.

4.2.2.15 ADCSequenceStepCongure
Congure a step of the sample sequencer. Prototype: void ADCSequenceStepConfigure(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulSequenceNum, ulStep, ulConfig)

Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. ulStep is the step to be congured. ulCong is the conguration of this step; must be a logical OR of ADC_CTL_TS, ADC_CTL_IE, ADC_CTL_END, ADC_CTL_D, and one of the input channel selects (ADC_CTL_CH0 through ADC_CTL_CH7). Description: This function will set the conguration of the ADC for one step of a sample sequence. The ADC can be congured for single-ended or differential operation (the ADC_CTL_D bit selects differential operation when set), the channel to be sampled can be chosen (the ADC_CTL_CH0 through ADC_CTL_CH7 values), and the internal temperature sensor can be selected (the ADC_CTL_TS bit). Additionally, this step can be dened as the last in the sequence (the ADC_CTL_END bit) and it can be congured to cause an interrupt when the step is complete (the ADC_CTL_IE bit). The conguration is used by the ADC at the appropriate time when the trigger for this sequence occurs. The ulStep parameter determines the order in which the samples are captured by the ADC when the trigger occurs. It can range from zero to seven for the rst sample sequence, from zero to three for the second and third sample sequence, and can only be zero for the fourth sample sequence. Differential mode only works with adjacent channel pairs (for example, 0 and 1). The channel select must be the number of the channel pair to sample (for example, ADC_CTL_CH0 for 0 and 1, or ADC_CTL_CH1 for 2 and 3) or undened results will be returned by the ADC. Additionally, if differential mode is selected when the temperature sensor is being sampled, undened results will be returned by the ADC. It is the responsibility of the caller to ensure that a valid conguration is specied; this function does not check the validity of the specied conguration.

30

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Returns: None.

4.2.2.16 ADCSequenceUnderow
Determines if a sample sequence underow occurred. Prototype: long ADCSequenceUnderflow(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: This determines if a sample sequence underow has occurred. This will happen if too many samples are read from the FIFO. Returns: Returns zero if there was not an underow, and non-zero if there was.

4.2.2.17 ADCSequenceUnderowClear
Clears the underow condition on a sample sequence. Prototype: void ADCSequenceUnderflowClear(unsigned long ulBase, unsigned long ulSequenceNum) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. Description: This will clear an underow condition on one of the sample sequences. The underow condition must be cleared in order to detect a subsequent underow condition (it otherwise causes no harm). Returns: None.

4.2.2.18 ADCSoftwareOversampleCongure
Congures the software oversampling factor of the ADC.

October 30, 2008

31

Analog to Digital Converter (ADC)

Prototype: void ADCSoftwareOversampleConfigure(unsigned long ulBase, unsigned long ulSequenceNum, unsigned long ulFactor) Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. ulFactor is the number of samples to be averaged. Description: This function congures the software oversampling for the ADC, which can be used to provide better resolution on the sampled data. Oversampling is accomplished by averaging multiple samples from the same analog input. Three different oversampling rates are supported; 2x, 4x, and 8x. Oversampling is only supported on the sample sequencers that are more than one sample in depth (that is, the fourth sample sequencer is not supported). Oversampling by 2x (for example) divides the depth of the sample sequencer by two; so 2x oversampling on the rst sample sequencer can only provide four samples per trigger. This also means that 8x oversampling is only available on the rst sample sequencer. Returns: None.

4.2.2.19 ADCSoftwareOversampleDataGet
Gets the captured data for a sample sequence using software oversampling. Prototype: void ADCSoftwareOversampleDataGet(unsigned unsigned unsigned unsigned Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. pulBuffer is the address where the data is stored. ulCount is the number of samples to be read. Description: This function copies data from the specied sample sequence output FIFO to a memory resident buffer with software oversampling applied. The requested number of samples are copied into the data buffer; if there are not enough samples in the hardware FIFO to satisfy this many oversampled data items then incorrect results will be returned. It is the callers responsibility to read only the samples that are available and wait until enough data is available, for example as a result of receiving an interrupt. Returns: None.

long long long long

ulBase, ulSequenceNum, *pulBuffer, ulCount)

32

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

4.2.2.20 ADCSoftwareOversampleStepCongure
Congures a step of the software oversampled sequencer. Prototype: void ADCSoftwareOversampleStepConfigure(unsigned unsigned unsigned unsigned Parameters: ulBase is the base address of the ADC module. ulSequenceNum is the sample sequence number. ulStep is the step to be congured. ulCong is the conguration of this step. Description: This function congures a step of the sample sequencer when using the software oversampling feature. The number of steps available depends on the oversampling factor set by ADCSoftwareOversampleCongure(). The value of ulCong is the same as dened for ADCSequenceStepCongure(). Returns: None.

long long long long

ulBase, ulSequenceNum, ulStep, ulConfig)

4.3

Programming Example
The following example shows how to use the ADC API to initialize a sample sequence for processor triggering, trigger the sample sequence, and then read back the data when it is ready.
unsigned long ulValue; // // Enable the first sample sequence to capture the value of channel 0 when // the processor trigger occurs. // ADCSequenceConfigure(ADC_BASE, 0, ADC_TRIGGER_PROCESSOR, 0); ADCSequenceStepConfigure(ADC_BASE, 0, 0, ADC_CTL_IE | ADC_CTL_END | ADC_CTL_CH0); ADCSequenceEnable(ADC_BASE, 0); // // Trigger the sample sequence. // ADCProcessorTrigger(ADC_BASE, 0); // // Wait until the sample sequence has completed. // while(!ADCIntStatus(ADC_BASE, 0, false)) { } //

October 30, 2008

33

Analog to Digital Converter (ADC)

// Read the value from the ADC. // ADCSequenceDataGet(ADC_BASE, 0, &ulValue);

34

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Controller Area Network (CAN)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

5.1

Introduction
The Controller Area Network (CAN) APIs provide a set of functions for accessing the Stellaris CAN modules. Functions are provided to congure the CAN controllers, congure message objects, and manage CAN interrupts. The Stellaris CAN module provides hardware processing of the CAN data link layer. It can be congured with message lters and preloaded message data so that it can autonomously send and receive messages on the bus, and notify the application accordingly. It automatically handles generation and checking of CRCs, error processing, and retransmission of CAN messages. The message objects are stored in the CAN controller and provide the main interface for the CAN module on the CAN bus. There are 32 message objects that can each be programmed to handle a separate message ID, or can be chained together for a sequence of frames with the same ID. The message identier lters provide masking that can be programmed to match any or all of the message ID bits, and frame types. This driver is contained in driverlib/can.c, with driverlib/can.h containing the API denitions for use by applications.

5.2

API Functions
Data Structures
tCANBitClkParms tCANMsgObject

Denes
MSG_OBJ_STATUS_MASK

Enumerations
tCANIntFlags tCANIntStsReg tCANObjFlags tCANStatusCtrl tCANStsReg tMsgObjType

October 30, 2008

35

Controller Area Network (CAN)

Functions
void CANBitTimingGet (unsigned long ulBase, tCANBitClkParms pClkParms) void CANBitTimingSet (unsigned long ulBase, tCANBitClkParms pClkParms) void CANDisable (unsigned long ulBase) void CANEnable (unsigned long ulBase) tBoolean CANErrCntrGet (unsigned long ulBase, unsigned long pulRxCount, unsigned long pulTxCount) void CANInit (unsigned long ulBase) void CANIntClear (unsigned long ulBase, unsigned long ulIntClr) void CANIntDisable (unsigned long ulBase, unsigned long ulIntFlags) void CANIntEnable (unsigned long ulBase, unsigned long ulIntFlags) void CANIntRegister (unsigned long ulBase, void (pfnHandler)(void)) unsigned long CANIntStatus (unsigned long ulBase, tCANIntStsReg eIntStsReg) void CANIntUnregister (unsigned long ulBase) void CANMessageClear (unsigned long ulBase, unsigned long ulObjID) void CANMessageGet (unsigned long ulBase, unsigned long ulObjID, tCANMsgObject pMsgObject, tBoolean bClrPendingInt) void CANMessageSet (unsigned long ulBase, unsigned long ulObjID, tCANMsgObject pMsgObject, tMsgObjType eMsgType) tBoolean CANRetryGet (unsigned long ulBase) void CANRetrySet (unsigned long ulBase, tBoolean bAutoRetry) unsigned long CANStatusGet (unsigned long ulBase, tCANStsReg eStatusReg)

5.2.1

Detailed Description
The CAN APIs provide all of the functions needed by the application to implement an interruptdriven CAN stack. These functions may be used to control any of the available CAN ports on a Stellaris microcontroller, and can be used with one port without causing conicts with the other port. The CAN module is disabled by default, so the the CANInit() function must be called before any other CAN functions are called. This call initializes the message objects to a safe state prior to enabling the controller on the CAN bus. Also, the bit timing values must be programmed prior to enabling the CAN controller. The CANSetBitTiming() function should be called with the appropriate bit timing values for the CAN bus. Once these two functions have been called, a CAN controller can be enabled using the CANEnable(), and later disabled using CANDisable() if needed. Calling CANDisable() does not reinitialize a CAN controller, so it can be used to temporarily remove a CAN controller from the bus. The CAN controller is highly congurable and contains 32 message objects that can be programmed to automatically transmit and receive CAN messages under certain conditions. Message objects allow the application to perform some actions automatically without interaction from the microcontroller. Some examples of these actions are the following: Send a data frame immediately Send a data frame when a matching remote frame is seen on the CAN bus Receive a specic data frame Receive data frames that match a certain identier pattern

36

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

To congure message objects to perform any of these actions, the application must rst set up one of the 32 message objects using CANMessageSet(). This function must be used to congure a message object to send data, or to congure a message object to receive data. Each message object can be congured to generate interrupts on transmission or reception of CAN messages. When data is received from the CAN bus, the application can use the CANMessageGet() function to read the received message. This function can also be used to read a message object that is already congured in order to populate a message structure prior to making changes to the conguration of a message object. Reading the message object using this function will also clear any pending interrupt on the message object. Once a message object has been congured using CANMessageSet(), it has allocated the message object and will continue to perform its programmed function unless it is released with a call to CANMessageClear(). The application is not required to clear out a message object before setting it with a new conguration, because each time CANMessageSet() is called, it will overwrite any previously programmed conguration. The 32 message objects are identical except for priority. The lowest numbered message objects have the highest priority. Priority affects operation in two ways. First, if multiple actions are ready at the same time, the one with the highest priority message object will occur rst. And second, when multiple message objects have interrupts pending, the highest priority will be presented rst when reading the interrupt status. It is up to the application to manage the 32 message objects as a resource, and determine the best method for allocating and releasing them. The CAN controller can generate interrupts on several conditions: When any message object transmits a message When any message object receives a message On warning conditions such as an error counter reaching a limit or occurrence of various bus errors On controller error conditions such as entering the bus-off state An interrupt handler must be installed in order to process CAN interrupts. If dynamic interrupt conguration is desired, the CANIntRegister() can be used to register the interrupt handler. This will place the vector in a RAM-based vector table. However, if the application uses a pre-loaded vector table in ash, then the CAN controller handler should be entered in the appropriate slot in the vector table. In this case, CANIntRegister() is not needed, but the interrupt will need to be enabled on the host processor master interrupt controller using the IntEnable() function. The CAN module interrupts are enabled using the CANIntEnable() function. They can be disabled by using the CANIntDisable() function. Once CAN interrupts are enabled, the handler will be invoked whenever a CAN interrupt is triggered. The handler can determine which condition caused the interrupt by using the CANIntStatus() function. Multiple conditions can be pending when an interrupt occurs, so the handler must be designed to process all pending interrupt conditions before exiting. Each interrupt condition must be cleared before exiting the handler. There are two ways to do this. The CANIntClear() function will clear a specic interrupt condition without further action required by the handler. However, the handler can also clear the condition by performing certain actions. If the interrupt is a status interrupt, the interrupt can be cleared by reading the status register with CANStatusGet(). If the interrupt is caused by one of the message objects, then it can be cleared by reading the message object using CANMessageGet(). There are several status registers that can be used to help the application manage the controller. The status registers are read using the CANStatusGet() function. There is a controller status register that provides general status information such as error or warning conditions. There are also

October 30, 2008

37

Controller Area Network (CAN)

several status registers that provide information about all of the message objects at once using a 32-bit bit map of the status, with one bit representing each message object. These status registers can be used to determine: Which message objects have unprocessed received data Which message objects have pending transmission requests Which message objects are allocated for use

5.2.2
5.2.2.1

Data Structure Documentation

tCANBitClkParms
Denition: typedef struct { unsigned int unsigned int unsigned int unsigned int } tCANBitClkParms

uSyncPropPhase1Seg; uPhase2Seg; uSJW; uQuantumPrescaler;

Members: uSyncPropPhase1Seg This value holds the sum of the Synchronization, Propagation, and Phase Buffer 1 segments, measured in time quanta. The valid values for this setting range from 2 to 16. uPhase2Seg This value holds the Phase Buffer 2 segment in time quanta. The valid values for this setting range from 1 to 8. uSJW This value holds the Resynchronization Jump Width in time quanta. The valid values for this setting range from 1 to 4. uQuantumPrescaler This value holds the CAN_CLK divider used to determine time quanta. The valid values for this setting range from 1 to 1023. Description: This structure is used for encapsulating the values associated with setting up the bit timing for a CAN controller. The structure is used when calling the CANGetBitTiming and CANSetBitTiming functions.

5.2.2.2

tCANMsgObject
Denition: typedef struct { unsigned long unsigned long unsigned long unsigned long unsigned char } tCANMsgObject

ulMsgID; ulMsgIDMask; ulFlags; ulMsgLen; *pucMsgData;

38

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Members: ulMsgID The CAN message identier used for 11 or 29 bit identiers. ulMsgIDMask The message identier mask used when identier ltering is enabled. ulFlags This value holds various status ags and settings specied by tCANObjFlags. ulMsgLen This value is the number of bytes of data in the message object. pucMsgData This is a pointer to the message objects data. Description: The structure used for encapsulating all the items associated with a CAN message object in the CAN controller.

5.2.3
5.2.3.1

Dene Documentation
MSG_OBJ_STATUS_MASK
Denition: #define MSG_OBJ_STATUS_MASK Description: This dene is used with the tCANObjFlags enumerated values to allow checking only status ags and not conguration ags.

5.2.4
5.2.4.1

Enumeration Documentation
tCANIntFlags
Description: These denitions are used to specify interrupt sources to CANIntEnable() and CANIntDisable(). Enumerators: CAN_INT_ERROR This ag is used to allow a CAN controller to generate error interrupts. CAN_INT_STATUS This ag is used to allow a CAN controller to generate status interrupts. CAN_INT_MASTER This ag is used to allow a CAN controller to generate any CAN interrupts. If this is not set, then no interrupts will be generated by the CAN controller.

5.2.4.2

tCANIntStsReg
Description: This data type is used to identify the interrupt status register. This is used when calling the CANIntStatus() function. Enumerators: CAN_INT_STS_CAUSE Read the CAN interrupt status information. CAN_INT_STS_OBJECT Read a message objects interrupt status.

October 30, 2008

39

Controller Area Network (CAN)

5.2.4.3

tCANObjFlags
Description: These are the ags used by the tCANMsgObject variable when calling the CANMessageSet() and CANMessageGet() functions. Enumerators: MSG_OBJ_TX_INT_ENABLE This indicates that transmit interrupts should be enabled, or are enabled. MSG_OBJ_RX_INT_ENABLE This indicates that receive interrupts should be enabled, or are enabled. MSG_OBJ_EXTENDED_ID This indicates that a message object will use or is using an extended identier. MSG_OBJ_USE_ID_FILTER This indicates that a message object will use or is using ltering based on the objects message identier. MSG_OBJ_NEW_DATA This indicates that new data was available in the message object. MSG_OBJ_DATA_LOST This indicates that data was lost since this message object was last read. MSG_OBJ_USE_DIR_FILTER This indicates that a message object will use or is using ltering based on the direction of the transfer. If the direction ltering is used, then ID ltering must also be enabled. MSG_OBJ_USE_EXT_FILTER This indicates that a message object will use or is using message identier ltering based on the extended identier. If the extended identier ltering is used, then ID ltering must also be enabled. MSG_OBJ_REMOTE_FRAME This indicates that a message object is a remote frame. MSG_OBJ_NO_FLAGS This indicates that a message object has no ags set.

5.2.4.4

tCANStatusCtrl
Description: The following enumeration contains all error or status indicators that can be returned when calling the CANStatusGet() function. Enumerators: CAN_STATUS_BUS_OFF CAN controller has entered a Bus Off state. CAN_STATUS_EWARN CAN controller error level has reached warning level. CAN_STATUS_EPASS CAN controller error level has reached error passive level. CAN_STATUS_RXOK A message was received successfully since the last read of this status. CAN_STATUS_TXOK A message was transmitted successfully since the last read of this status. CAN_STATUS_LEC_MSK This is the mask for the last error code eld. CAN_STATUS_LEC_NONE There was no error. CAN_STATUS_LEC_STUFF A bit stufng error has occurred. CAN_STATUS_LEC_FORM A formatting error has occurred. CAN_STATUS_LEC_ACK An acknowledge error has occurred. CAN_STATUS_LEC_BIT1 The bus remained a bit level of 1 for longer than is allowed. CAN_STATUS_LEC_BIT0 The bus remained a bit level of 0 for longer than is allowed.

40

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

CAN_STATUS_LEC_CRC A CRC error has occurred. CAN_STATUS_LEC_MASK This is the mask for the CAN Last Error Code (LEC).

5.2.4.5

tCANStsReg
Description: This data type is used to identify which of several status registers to read when calling the CANStatusGet() function. Enumerators: CAN_STS_CONTROL Read the full CAN controller status. CAN_STS_TXREQUEST Read the full 32-bit mask of message objects with a transmit request set. CAN_STS_NEWDAT Read the full 32-bit mask of message objects with new data available. CAN_STS_MSGVAL Read the full 32-bit mask of message objects that are enabled.

5.2.4.6

tMsgObjType
Description: This denition is used to determine the type of message object that will be set up via a call to the CANMessageSet() API. Enumerators: MSG_OBJ_TYPE_TX Transmit message object. MSG_OBJ_TYPE_TX_REMOTE Transmit remote request message object. MSG_OBJ_TYPE_RX Receive message object. MSG_OBJ_TYPE_RX_REMOTE Receive remote request message object. MSG_OBJ_TYPE_RXTX_REMOTE Remote frame receive remote, with auto-transmit message object.

5.2.5
5.2.5.1

Function Documentation
CANBitTimingGet
Reads the current settings for the CAN controller bit timing. Prototype: void CANBitTimingGet(unsigned long ulBase, tCANBitClkParms *pClkParms) Parameters: ulBase is the base address of the CAN controller. pClkParms is a pointer to a structure to hold the timing parameters.

October 30, 2008

41

Controller Area Network (CAN)

Description: This function reads the current conguration of the CAN controller bit clock timing, and stores the resulting information in the structure supplied by the caller. Refer to CANBitTimingSet() for the meaning of the values that are returned in the structure pointed to by pClkParms. This function replaces the original CANGetBitTiming() API and performs the same actions. A macro is provided in can.h to map the original API to this API. Returns: None.

5.2.5.2

CANBitTimingSet
Congures the CAN controller bit timing. Prototype: void CANBitTimingSet(unsigned long ulBase, tCANBitClkParms *pClkParms) Parameters: ulBase is the base address of the CAN controller. pClkParms points to the structure with the clock parameters. Description: Congures the various timing parameters for the CAN bus bit timing: Propagation segment, Phase Buffer 1 segment, Phase Buffer 2 segment, and the Synchronization Jump Width. The values for Propagation and Phase Buffer 1 segments are derived from the combination pClkParms->uSyncPropPhase1Seg parameter. Phase Buffer 2 is determined from the pClkParms->uPhase2Seg parameter. These two parameters, along with pClkParms->uSJW are based in units of bit time quanta. The actual quantum time is determined by the pClkParms>uQuantumPrescaler value, which species the divisor for the CAN module clock. The total bit time, in quanta, will be the sum of the two Seg parameters, as follows: bit_time_q = uSyncPropPhase1Seg + uPhase2Seg + 1 Note that the Sync_Seg is always one quantum in duration, and will be added to derive the correct duration of Prop_Seg and Phase1_Seg. The equation to determine the actual bit rate is as follows: CAN Clock / ((uSyncPropPhase1Seg + uPhase2Seg + 1) (uQuantumPrescaler )) This means that with uSyncPropPhase1Seg = 4, uPhase2Seg = 1, uQuantumPrescaler = 2 and an 8 MHz CAN clock, that the bit rate will be (8 MHz) / ((5 + 2 + 1) 2) or 500 Kbit/sec. This function replaces the original CANSetBitTiming() API and performs the same actions. A macro is provided in can.h to map the original API to this API. Returns: None.

42

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

5.2.5.3

CANDisable
Disables the CAN controller. Prototype: void CANDisable(unsigned long ulBase) Parameters: ulBase is the base address of the CAN controller to disable. Description: Disables the CAN controller for message processing. When disabled, the controller will no longer automatically process data on the CAN bus. The controller can be restarted by calling CANEnable(). The state of the CAN controller and the message objects in the controller are left as they were before this call was made. Returns: None.

5.2.5.4

CANEnable
Enables the CAN controller. Prototype: void CANEnable(unsigned long ulBase) Parameters: ulBase is the base address of the CAN controller to enable. Description: Enables the CAN controller for message processing. Once enabled, the controller will automatically transmit any pending frames, and process any received frames. The controller can be stopped by calling CANDisable(). Prior to calling CANEnable(), CANInit() should have been called to initialize the controller and the CAN bus clock should be congured by calling CANBitTimingSet(). Returns: None.

5.2.5.5

CANErrCntrGet
Reads the CAN controller error counter register. Prototype: tBoolean CANErrCntrGet(unsigned long ulBase, unsigned long *pulRxCount, unsigned long *pulTxCount)

October 30, 2008

43

Controller Area Network (CAN)

Parameters: ulBase is the base address of the CAN controller. pulRxCount is a pointer to storage for the receive error counter. pulTxCount is a pointer to storage for the transmit error counter. Description: Reads the error counter register and returns the transmit and receive error counts to the caller along with a ag indicating if the controller receive counter has reached the error passive limit. The values of the receive and transmit error counters are returned through the pointers provided as parameters. After this call, pulRxCount will hold the current receive error count and pulTxCount will hold the current transmit error count. Returns: Returns true if the receive error count has reached the error passive limit, and false if the error count is below the error passive limit.

5.2.5.6

CANInit
Initializes the CAN controller after reset. Prototype: void CANInit(unsigned long ulBase) Parameters: ulBase is the base address of the CAN controller. Description: After reset, the CAN controller is left in the disabled state. However, the memory used for message objects contains undened values and must be cleared prior to enabling the CAN controller the rst time. This prevents unwanted transmission or reception of data before the message objects are congured. This function must be called before enabling the controller the rst time. Returns: None.

5.2.5.7

CANIntClear
Clears a CAN interrupt source. Prototype: void CANIntClear(unsigned long ulBase, unsigned long ulIntClr) Parameters: ulBase is the base address of the CAN controller. ulIntClr is a value indicating which interrupt source to clear.

44

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function can be used to clear a specic interrupt source. The ulIntClr parameter should be one of the following values: CAN_INT_INTID_STATUS - Clears a status interrupt. 1-32 - Clears the specied message object interrupt It is not necessary to use this function to clear an interrupt. This should only be used if the application wants to clear an interrupt source without taking the normal interrupt action. Normally, the status interrupt is cleared by reading the controller status using CANStatusGet(). A specic message object interrupt is normally cleared by reading the message object using CANMessageGet(). Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

5.2.5.8

CANIntDisable
Disables individual CAN controller interrupt sources. Prototype: void CANIntDisable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the CAN controller. ulIntFlags is the bit mask of the interrupt sources to be disabled. Description: Disables the specied CAN controller interrupt sources. Only enabled interrupt sources can cause a processor interrupt. The ulIntFlags parameter has the same denition as in the CANIntEnable() function. Returns: None.

5.2.5.9

CANIntEnable
Enables individual CAN controller interrupt sources.

October 30, 2008

45

Controller Area Network (CAN)

Prototype: void CANIntEnable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the CAN controller. ulIntFlags is the bit mask of the interrupt sources to be enabled. Description: Enables specic interrupt sources of the CAN controller. Only enabled sources will cause a processor interrupt. The ulIntFlags parameter is the logical OR of any of the following: CAN_INT_ERROR - a controller error condition has occurred CAN_INT_STATUS - a message transfer has completed, or a bus error has been detected CAN_INT_MASTER - allow CAN controller to generate interrupts In order to generate any interrupts, CAN_INT_MASTER must be enabled. Further, for any particular transaction from a message object to generate an interrupt, that message object must have interrupts enabled (see CANMessageSet()). CAN_INT_ERROR will generate an interrupt if the controller enters the bus off condition, or if the error counters reach a limit. CAN_INT_STATUS will generate an interrupt under quite a few status conditions and may provide more interrupts than the application needs to handle. When an interrupt occurs, use CANIntStatus() to determine the cause. Returns: None.

5.2.5.10 CANIntRegister
Registers an interrupt handler for the CAN controller. Prototype: void CANIntRegister(unsigned long ulBase, void (*pfnHandler)(void)) Parameters: ulBase is the base address of the CAN controller. pfnHandler is a pointer to the function to be called when the enabled CAN interrupts occur. Description: This function registers the interrupt handler in the interrupt vector table, and enables CAN interrupts on the interrupt controller; specic CAN interrupt sources must be enabled using CANIntEnable(). The interrupt handler being registered must clear the source of the interrupt using CANIntClear(). If the application is using a static interrupt vector table stored in ash, then it is not necessary to register the interrupt handler this way. Instead, IntEnable() should be used to enable CAN interrupts on the interrupt controller.

46

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

5.2.5.11 CANIntStatus
Returns the current CAN controller interrupt status. Prototype: unsigned long CANIntStatus(unsigned long ulBase, tCANIntStsReg eIntStsReg) Parameters: ulBase is the base address of the CAN controller. eIntStsReg indicates which interrupt status register to read Description: Returns the value of one of two interrupt status registers. The interrupt status register read is determined by the eIntStsReg parameter, which can have one of the following values: CAN_INT_STS_CAUSE - indicates the cause of the interrupt CAN_INT_STS_OBJECT - indicates pending interrupts of all message objects CAN_INT_STS_CAUSE returns the value of the controller interrupt register and indicates the cause of the interrupt. It will be a value of CAN_INT_INTID_STATUS if the cause is a status interrupt. In this case, the status register should be read with the CANStatusGet() function. Calling this function to read the status will also clear the status interrupt. If the value of the interrupt register is in the range 1-32, then this indicates the number of the highest priority message object that has an interrupt pending. The message object interrupt can be cleared by using the CANIntClear() function, or by reading the message using CANMessageGet() in the case of a received message. The interrupt handler can read the interrupt status again to make sure all pending interrupts are cleared before returning from the interrupt. CAN_INT_STS_OBJECT returns a bit mask indicating which message objects have pending interrupts. This can be used to discover all of the pending interrupts at once, as opposed to repeatedly reading the interrupt register by using CAN_INT_STS_CAUSE. Returns: Returns the value of one of the interrupt status registers.

5.2.5.12 CANIntUnregister
Unregisters an interrupt handler for the CAN controller. Prototype: void CANIntUnregister(unsigned long ulBase)

October 30, 2008

47

Controller Area Network (CAN)

Parameters: ulBase is the base address of the controller. Description: This function unregisters the previously registered interrupt handler and disables the interrupt on the interrupt controller. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

5.2.5.13 CANMessageClear
Clears a message object so that it is no longer used. Prototype: void CANMessageClear(unsigned long ulBase, unsigned long ulObjID) Parameters: ulBase is the base address of the CAN controller. ulObjID is the message object number to disable (1-32). Description: This function frees the specied message object from use. Once a message object has been cleared, it will no longer automatically send or receive messages, or generate interrupts. Returns: None.

5.2.5.14 CANMessageGet
Reads a CAN message from one of the message object buffers. Prototype: void CANMessageGet(unsigned long ulBase, unsigned long ulObjID, tCANMsgObject *pMsgObject, tBoolean bClrPendingInt) Parameters: ulBase is the base address of the CAN controller. ulObjID is the object number to read (1-32). pMsgObject points to a structure containing message object elds. bClrPendingInt indicates whether an associated interrupt should be cleared.

48

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function is used to read the contents of one of the 32 message objects in the CAN controller, and return it to the caller. The data returned is stored in the elds of the caller-supplied structure pointed to by pMsgObject. The data consists of all of the parts of a CAN message, plus some control and status information. Normally this is used to read a message object that has received and stored a CAN message with a certain identier. However, this could also be used to read the contents of a message object in order to load the elds of the structure in case only part of the structure needs to be changed from a previous setting. When using CANMessageGet, all of the same elds of the structure are populated in the same way as when the CANMessageSet() function is used, with the following exceptions: pMsgObject->ulFlags: MSG_OBJ_NEW_DATA indicates if this is new data since the last time it was read MSG_OBJ_DATA_LOST indicates that at least one message was received on this message object, and not read by the host before being overwritten. Returns: None.

5.2.5.15 CANMessageSet
Congures a message object in the CAN controller. Prototype: void CANMessageSet(unsigned long ulBase, unsigned long ulObjID, tCANMsgObject *pMsgObject, tMsgObjType eMsgType) Parameters: ulBase is the base address of the CAN controller. ulObjID is the object number to congure (1-32). pMsgObject is a pointer to a structure containing message object settings. eMsgType indicates the type of message for this object. Description: This function is used to congure any one of the 32 message objects in the CAN controller. A message object can be congured as any type of CAN message object as well as several options for automatic transmission and reception. This call also allows the message object to be congured to generate interrupts on completion of message receipt or transmission. The message object can also be congured with a lter/mask so that actions are only taken when a message that meets certain parameters is seen on the CAN bus. The eMsgType parameter must be one of the following values: MSG_OBJ_TYPE_TX - CAN transmit message object. MSG_OBJ_TYPE_TX_REMOTE - CAN transmit remote request message object. MSG_OBJ_TYPE_RX - CAN receive message object.

October 30, 2008

49

Controller Area Network (CAN)

MSG_OBJ_TYPE_RX_REMOTE - CAN receive remote request message object. MSG_OBJ_TYPE_RXTX_REMOTE - CAN remote frame receive remote, then transmit message object. The message object pointed to by pMsgObject must be populated by the caller, as follows: ulMsgID - contains the message ID, either 11 or 29 bits. ulMsgIDMask - mask of bits from ulMsgID that must match if identier ltering is enabled. ulFlags Set MSG_OBJ_TX_INT_ENABLE ag to enable interrupt on transmission. Set MSG_OBJ_RX_INT_ENABLE ag to enable interrupt on receipt. Set MSG_OBJ_USE_ID_FILTER ag to enable ltering based on the identier mask specied by ulMsgIDMask . ulMsgLen - the number of bytes in the message data. This should be non-zero even for a remote frame; it should match the expected bytes of the data responding data frame. pucMsgData - points to a buffer containing up to 8 bytes of data for a data frame. Example: To send a data frame or remote frame(in response to a remote request), take the following steps: 1. Set eMsgType to MSG_OBJ_TYPE_TX. 2. Set pMsgObject->ulMsgID to the message ID. 3. Set pMsgObject->ulFlags. Make sure to set MSG_OBJ_TX_INT_ENABLE to allow an interrupt to be generated when the message is sent. 4. Set pMsgObject->ulMsgLen to the number of bytes in the data frame. 5. Set pMsgObject->pucMsgData to point to an array containing the bytes to send in the message. 6. Call this function with ulObjID set to one of the 32 object buffers. Example: To receive a specic data frame, take the following steps: 1. Set eMsgObjType to MSG_OBJ_TYPE_RX. 2. Set pMsgObject->ulMsgID to the full message ID, or a partial mask to use partial ID matching. 3. Set pMsgObject->ulMsgIDMask bits that should be used for masking during comparison. 4. Set pMsgObject->ulFlags as follows: Set MSG_OBJ_TX_INT_ENABLE ag to be interrupted when the data frame is received. Set MSG_OBJ_USE_ID_FILTER ag to enable identier based ltering. 5. Set pMsgObject->ulMsgLen to the number of bytes in the expected data frame. 6. The buffer pointed to by pMsgObject->pucMsgData and pMsgObject->ulMsgLen are not used by this call as no data is present at the time of the call. 7. Call this function with ulObjID set to one of the 32 object buffers. If you specify a message object buffer that already contains a message denition, it will be overwritten. Returns: None.

50

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

5.2.5.16 CANRetryGet
Returns the current setting for automatic retransmission. Prototype: tBoolean CANRetryGet(unsigned long ulBase) Parameters: ulBase is the base address of the CAN controller. Description: Reads the current setting for the automatic retransmission in the CAN controller and returns it to the caller. Returns: Returns true if automatic retransmission is enabled, false otherwise.

5.2.5.17 CANRetrySet
Sets the CAN controller automatic retransmission behavior. Prototype: void CANRetrySet(unsigned long ulBase, tBoolean bAutoRetry) Parameters: ulBase is the base address of the CAN controller. bAutoRetry enables automatic retransmission. Description: Enables or disables automatic retransmission of messages with detected errors. If bAutoRetry is true, then automatic retransmission is enabled, otherwise it is disabled. Returns: None.

5.2.5.18 CANStatusGet
Reads one of the controller status registers. Prototype: unsigned long CANStatusGet(unsigned long ulBase, tCANStsReg eStatusReg) Parameters: ulBase is the base address of the CAN controller. eStatusReg is the status register to read.

October 30, 2008

51

Controller Area Network (CAN)

Description: Reads a status register of the CAN controller and returns it to the caller. The different status registers are: CAN_STS_CONTROL - the main controller status CAN_STS_TXREQUEST - bit mask of objects pending transmission CAN_STS_NEWDAT - bit mask of objects with new data CAN_STS_MSGVAL - bit mask of objects with valid conguration When reading the main controller status register, a pending status interrupt will be cleared. This should be used in the interrupt handler for the CAN controller if the cause is a status interrupt. The controller status register elds are as follows: CAN_STATUS_BUS_OFF - controller is in bus-off condition CAN_STATUS_EWARN - an error counter has reached a limit of at least 96 CAN_STATUS_EPASS - CAN controller is in the error passive state CAN_STATUS_RXOK - a message was received successfully (independent of any message ltering). CAN_STATUS_TXOK - a message was successfully transmitted CAN_STATUS_LEC_MSK - mask of last error code bits (3 bits) CAN_STATUS_LEC_NONE - no error CAN_STATUS_LEC_STUFF - stufng error detected CAN_STATUS_LEC_FORM - a format error occurred in the xed format part of a message CAN_STATUS_LEC_ACK - a transmitted message was not acknowledged CAN_STATUS_LEC_BIT1 - dominant level detected when trying to send in recessive mode CAN_STATUS_LEC_BIT0 - recessive level detected when trying to send in dominant mode CAN_STATUS_LEC_CRC - CRC error in received message The remaining status registers are 32-bit bit maps to the message objects. They can be used to quickly obtain information about the status of all the message objects without needing to query each one. They contain the following information: CAN_STS_TXREQUEST - if a message objects TxRequest bit is set, that means that a transmission is pending on that object. The application can use this to determine which objects are still waiting to send a message. CAN_STS_NEWDAT - if a message objects NewDat bit is set, that means that a new message has been received in that object, and has not yet been picked up by the host application CAN_STS_MSGVAL - if a message objects MsgVal bit is set, that means it has a valid conguration programmed. The host application can use this to determine which message objects are empty/unused. Returns: Returns the value of the status register.

5.3

Programming Example
This example code will send out data from CAN controller 0 to be received by CAN controller 1. In order to actually receive the data, an external cable must be connected between the two ports. In

52

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

this example, both controllers are congured for 1 Mbit operation.

tCANBitClkParms CANBitClk; tCANMsgObject sMsgObjectRx; tCANMsgObject sMsgObjectTx; unsigned char ucBufferIn[8]; unsigned char ucBufferOut[8]; // // Reset the state of all the message objects and the state of the CAN // module to a known state. // CANInit(CAN0_BASE); CANInit(CAN1_BASE); // // Configure the controller for 1 Mbit operation. // CANBitClk.uSyncPropPhase1Seg = 5; CANBitClk.uPhase2Seg = 2; CANBitClk.uQuantumPrescaler = 1; CANBitClk.uSJW = 2; CANSetBitTiming(CAN0_BASE, &CANBitClk); CANSetBitTiming(CAN1_BASE, &CANBitClk); // // Take the CAN0 device out of INIT state. // CANEnable(CAN0_BASE); CANEnable(CAN1_BASE); // // Configure a receive object. // sMsgObjectRx.ulMsgID = (0x400); sMsgObjectRx.ulMsgIDMask = 0x7f8; sMsgObjectRx.ulFlags = MSG_OBJ_USE_ID_FILTER; sMsgObjectRx.ulMsgLen = 8; sMsgObjectRx.pucMsgData = ucBufferIn; CANMessageSet(CAN1_BASE, 1, &sMsgObjectRx, MSG_OBJ_TYPE_RX); // // Configure and start transmit of message object. // sMsgObjectTx.ulMsgID = 0x400; sMsgObjectTx.ulFlags = 0; sMsgObjectTx.ulMsgLen = 8; sMsgObjectTx.pucMsgData = ucBufferOut; CANMessageSet(CAN0_BASE, 2, &sMsgObjectTx, MSG_OBJ_TYPE_TX); // // Wait for new data to become available. // while((CANStatusGet(CAN1_BASE, CAN_STS_NEWDAT) & 1) == 0) { // // Read the message out of the message object. // CANMessageGet(CAN1_BASE, 1, &sMsgObjectRx, true); } // // Process new data in sMsgObjectRx.pucMsgData. // ...

October 30, 2008

53

Controller Area Network (CAN)

54

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Ethernet Controller
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

6.1

Introduction
The Stellaris Ethernet controller consists of a fully integrated media access controller (MAC) and a network physical (PHY) interface device. The Ethernet controller conforms to IEEE 802.3 specications and fully supports 10BASE-T and 100BASE-TX standards. The Ethernet API provides the set of functions required to implement an interrupt-driven Ethernet driver for this Ethernet controller. Functions are provided to congure and control the MAC, to access the register set on the PHY, to transmit and receive Ethernet packets, and to congure and control the interrupts that are available. This driver is contained in driverlib/ethernet.c, with driverlib/ethernet.h containing the API denitions for use by applications.

6.2

API Functions
Functions
unsigned long EthernetCongGet (unsigned long ulBase) void EthernetCongSet (unsigned long ulBase, unsigned long ulCong) void EthernetDisable (unsigned long ulBase) void EthernetEnable (unsigned long ulBase) void EthernetInitExpClk (unsigned long ulBase, unsigned long ulEthClk) void EthernetIntClear (unsigned long ulBase, unsigned long ulIntFlags) void EthernetIntDisable (unsigned long ulBase, unsigned long ulIntFlags) void EthernetIntEnable (unsigned long ulBase, unsigned long ulIntFlags) void EthernetIntRegister (unsigned long ulBase, void (pfnHandler)(void)) unsigned long EthernetIntStatus (unsigned long ulBase, tBoolean bMasked) void EthernetIntUnregister (unsigned long ulBase) void EthernetMACAddrGet (unsigned long ulBase, unsigned char pucMACAddr) void EthernetMACAddrSet (unsigned long ulBase, unsigned char pucMACAddr) tBoolean EthernetPacketAvail (unsigned long ulBase) long EthernetPacketGet (unsigned long ulBase, unsigned char pucBuf, long lBufLen) long EthernetPacketGetNonBlocking (unsigned long ulBase, unsigned char pucBuf, long lBufLen) long EthernetPacketPut (unsigned long ulBase, unsigned char pucBuf, long lBufLen) long EthernetPacketPutNonBlocking (unsigned long ulBase, unsigned char pucBuf, long lBufLen) unsigned long EthernetPHYRead (unsigned long ulBase, unsigned char ucRegAddr)

October 30, 2008

55

Ethernet Controller

void EthernetPHYWrite (unsigned long ulBase, unsigned char ucRegAddr, unsigned long ulData) tBoolean EthernetSpaceAvail (unsigned long ulBase)

6.2.1

Detailed Description
For any application, the EthernetInitExpClk() function must be called rst to prepare the Ethernet controller for operation. This function will congure the Ethernet controller options that are based on system parameters, such as the system clock speed. Once initialized, access to the PHY is available via the EthernetPHYRead() and EthernetPHYWrite() functions. By default, the PHY will auto-negotiate the line speed and duplex modes. For most applications, this will be sufcient. If a special conguration is required, the PHY read and write functions can be used to recongure the PHY to the desired mode of operation. The MAC must also be congured using the EthernetCongSet() function. The parameters for this function will allow the conguration of options such as Promiscuous Mode, Multicast Reception, Transmit Data Length Padding, and so on. The EthernetCongGet() function can be used to query the current conguration of the Ethernet MAC. The MAC address, used for incoming packet ltering, must also be programmed using the EthernetMACAddrSet() function. The current value can be queried using the EthernetMACAddrGet() function. When conguration has been completed, the Ethernet controller can be enabled using the EthernetEnable() function. When getting ready to terminate operations on the Ethernet controller, the EthernetDisable() function may be called. After the Ethernet controller has been enabled, Ethernet frames can be transmitted and received using the EthernetPacketPut() and EthernetPacketGet() functions. Care must be taken when using these functions, as they are blocking functions, and will not return until data is available (for RX) or buffer space is available (for TX). The EthernetSpaceAvail() and EthernetPacketAvail() functions can be called to determine if there is room for a TX packet or if there is an RX packet available prior to calling these blocking functions. Alternatively, the EthernetPacketGetNonBlocking() and EthernetPacketPutNonBlocking() functions will return immediately if a packet cannot be processed. Otherwise, the packet will be processed normally. When developing a mapping layer for a TCP/IP stack, you may wish to use the interrupt capability of the Ethernet controller. The EthernetIntRegister() and EthernetIntUnregister() functions are used to register an ISR with the system and to enable or disable the Ethernet controllers interrupt signal. The EthernetIntEnable() and EthernetIntDisable() functions are used to manipulate the individual interrupt sources available in the Ethernet controller (for example, RX Error, TX Complete). The EthernetIntStatus() and EthernetIntClear() functions would be used to query the active interrupts to determine which process to service, and to clear the indicated interrupts prior to returning from the registered ISR. The EthernetInit(), EthernetPacketNonBlockingGet(), and EthernetPacketNonBlockingPut() APIs from previous versions of the peripheral driver library have been replaced by the EthernetInitExpClk(), EthernetPacketGetNonBlocking(), and EthernetPacketPutNonBlocking() APIs, respectively. Macros have been provided in ethernet.h to map the old APIs to the new APIs, allowing existing applications to link and run with the new APIs. It is recommended that new applications utilize the new APIs in favor of the old ones.

56

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

6.2.2
6.2.2.1

Function Documentation
EthernetCongGet
Gets the current conguration of the Ethernet controller. Prototype: unsigned long EthernetConfigGet(unsigned long ulBase) Parameters: ulBase is the base address of the controller. Description: This function will query the control registers of the Ethernet controller and return a bit-mapped conguration value. See also: The description of the EthernetCongSet() function provides detailed information for the bitmapped conguration values that will be returned. Returns: Returns the bit-mapped Ethernet controller conguration value.

6.2.2.2

EthernetCongSet
Sets the conguration of the Ethernet controller. Prototype: void EthernetConfigSet(unsigned long ulBase, unsigned long ulConfig) Parameters: ulBase is the base address of the controller. ulCong is the conguration for the controller. Description: After the EthernetInitExpClk() function has been called, this API function can be used to congure the various features of the Ethernet controller. The Ethernet controller provides three control registers that are used to congure the controllers operation. The transmit control register provides settings to enable full duplex operation, to auto-generate the frame check sequence, and to pad the transmit packets to the minimum length as required by the IEEE standard. The receive control register provides settings to enable reception of packets with bad frame check sequence values and to enable multi-cast or promiscuous modes. The timestamp control register provides settings that enable support logic in the controller that allow the use of the General Purpose Timer 3 to capture timestamps for the transmitted and received packets. The ulCong parameter is the logical OR of the following values: ETH_CFG_TS_TSEN - Enable TX and RX interrupt status as CCP timer inputs

October 30, 2008

57

Ethernet Controller

ETH_CFG_RX_BADCRCDIS - Disable reception of packets with a bad CRC ETH_CFG_RX_PRMSEN - Enable promiscuous mode reception (all packets) ETH_CFG_RX_AMULEN - Enable reception of multicast packets ETH_CFG_TX_DPLXEN - Enable full duplex transmit mode ETH_CFG_TX_CRCEN - Enable transmit with auto CRC generation ETH_CFG_TX_PADEN - Enable padding of transmit data to minimum size These bit-mapped values are programmed into the transmit, receive, and/or timestamp control register. Returns: None.

6.2.2.3

EthernetDisable
Disables the Ethernet controller. Prototype: void EthernetDisable(unsigned long ulBase) Parameters: ulBase is the base address of the controller. Description: When terminating operations on the Ethernet interface, this function should be called. This function will disable the transmitter and receiver, and will clear out the receive FIFO. Returns: None.

6.2.2.4

EthernetEnable
Enables the Ethernet controller for normal operation. Prototype: void EthernetEnable(unsigned long ulBase) Parameters: ulBase is the base address of the controller. Description: Once the Ethernet controller has been congured using the EthernetCongSet() function and the MAC address has been programmed using the EthernetMACAddrSet() function, this API function can be called to enable the controller for normal operation. This function will enable the controllers transmitter and receiver, and will reset the receive FIFO. Returns: None.

58

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

6.2.2.5

EthernetInitExpClk
Initializes the Ethernet controller for operation. Prototype: void EthernetInitExpClk(unsigned long ulBase, unsigned long ulEthClk) Parameters: ulBase is the base address of the controller. ulEthClk is the rate of the clock supplied to the Ethernet module. Description: This function will prepare the Ethernet controller for rst time use in a given hardware/software conguration. This function should be called before any other Ethernet API functions are called. The peripheral clock will be the same as the processor clock. This will be the value returned by SysCtlClockGet(), or it can be explicitly hard-coded if it is constant and known (to save the code/execution overhead of a call to SysCtlClockGet()). This function replaces the original EthernetInit() API and performs the same actions. A macro is provided in ethernet.h to map the original API to this API. Note: If the device conguration is changed (for example, the system clock is reprogrammed to a different speed), then the Ethernet controller must be disabled by calling the EthernetDisable() function and the controller must be reinitialized by calling the EthernetInitExpClk() function again. After the controller has been reinitialized, the controller should be recongured using the appropriate Ethernet API calls. Returns: None.

6.2.2.6

EthernetIntClear
Clears Ethernet interrupt sources. Prototype: void EthernetIntClear(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the controller. ulIntFlags is a bit mask of the interrupt sources to be cleared. Description: The specied Ethernet interrupt sources are cleared so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to EthernetIntEnable().

October 30, 2008

59

Ethernet Controller

Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

6.2.2.7

EthernetIntDisable
Disables individual Ethernet interrupt sources. Prototype: void EthernetIntDisable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the controller. ulIntFlags is the bit mask of the interrupt sources to be disabled. Description: Disables the indicated Ethernet interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to EthernetIntEnable(). Returns: None.

6.2.2.8

EthernetIntEnable
Enables individual Ethernet interrupt sources. Prototype: void EthernetIntEnable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the controller. ulIntFlags is the bit mask of the interrupt sources to be enabled. Description: Enables the indicated Ethernet interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter is the logical OR of any of the following:

60

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

ETH_INT_PHY - An interrupt from the PHY has occurred. The integrated PHY supports a number of interrupt conditions. The PHY register, PHY_MR17, must be read to determine which PHY interrupt has occurred. This register can be read using the EthernetPHYRead() API function. ETH_INT_MDIO - This interrupt indicates that a transaction on the management interface has completed successfully. ETH_INT_RXER - This interrupt indicates that an error has occurred during reception of a frame. This error can indicate a length mismatch, a CRC failure, or an error indication from the PHY. ETH_INT_RXOF - This interrupt indicates that a frame has been received that exceeds the available space in the RX FIFO. ETH_INT_TX - This interrupt indicates that the packet stored in the TX FIFO has been successfully transmitted. ETH_INT_TXER - This interrupt indicates that an error has occurred during the transmission of a packet. This error can be either a retry failure during the back-off process, or an invalid length stored in the TX FIFO. ETH_INT_RX - This interrupt indicates that one (or more) packets are available in the RX FIFO for processing. Returns: None.

6.2.2.9

EthernetIntRegister
Registers an interrupt handler for an Ethernet interrupt. Prototype: void EthernetIntRegister(unsigned long ulBase, void (*pfnHandler)(void)) Parameters: ulBase is the base address of the controller. pfnHandler is a pointer to the function to be called when the enabled Ethernet interrupts occur. Description: This function sets the handler to be called when the Ethernet interrupt occurs. This will enable the global interrupt in the interrupt controller; specic Ethernet interrupts must be enabled via EthernetIntEnable(). It is the interrupt handlers responsibility to clear the interrupt source. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

6.2.2.10 EthernetIntStatus
Gets the current Ethernet interrupt status.

October 30, 2008

61

Ethernet Controller

Prototype: unsigned long EthernetIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the controller. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the Ethernet controller. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: Returns the current interrupt status, enumerated as a bit eld of values described in EthernetIntEnable().

6.2.2.11 EthernetIntUnregister
Unregisters an interrupt handler for an Ethernet interrupt. Prototype: void EthernetIntUnregister(unsigned long ulBase) Parameters: ulBase is the base address of the controller. Description: This function unregisters the interrupt handler. This will disable the global interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

6.2.2.12 EthernetMACAddrGet
Gets the MAC address of the Ethernet controller. Prototype: void EthernetMACAddrGet(unsigned long ulBase, unsigned char *pucMACAddr) Parameters: ulBase is the base address of the controller. pucMACAddr is the pointer to the location in which to store the array of MAC-48 address octets.

62

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function will read the currently programmed MAC address into the pucMACAddr buffer. See also: Refer to EthernetMACAddrSet() API description for more details about the MAC address format. Returns: None.

6.2.2.13 EthernetMACAddrSet
Sets the MAC address of the Ethernet controller. Prototype: void EthernetMACAddrSet(unsigned long ulBase, unsigned char *pucMACAddr) Parameters: ulBase is the base address of the controller. pucMACAddr is the pointer to the array of MAC-48 address octets. Description: This function will program the IEEE-dened MAC-48 address specied in pucMACAddr into the Ethernet controller. This address is used by the Ethernet controller for hardware-level ltering of incoming Ethernet packets (when promiscuous mode is not enabled). The MAC-48 address is dened as 6 octets, illustrated by the following example address. The numbers are shown in hexadecimal format. AC-DE-48-00-00-80 In this representation, the rst three octets (AC-DE-48) are the Organizationally Unique Identier (OUI). This is a number assigned by the IEEE to an organization that requests a block of MAC addresses. The last three octets (00-00-80) are a 24-bit number managed by the OUI owner to uniquely identify a piece of hardware within that organization that is to be connected to the Ethernet. In this representation, the octets are transmitted from left to right, with the AC octet being transmitted rst and the 80 octet being transmitted last. Within an octet, the bits are transmitted LSB to MSB. For this address, the rst bit to be transmitted would be 0, the LSB of AC, and the last bit to be transmitted would be 1, the MSB of 80. Returns: None.

6.2.2.14 EthernetPacketAvail
Check for packet available from the Ethernet controller. Prototype: tBoolean EthernetPacketAvail(unsigned long ulBase)

October 30, 2008

63

Ethernet Controller

Parameters: ulBase is the base address of the controller. Description: The Ethernet controller provides a register that contains the number of packets available in the receive FIFO. When the last bytes of a packet are successfully received (that is, the frame check sequence bytes), the packet count is incremented. Once the packet has been fully read (including the frame check sequence bytes) from the FIFO, the packet count will be decremented. Returns: Returns true if there are one or more packets available in the receive FIFO, including the current packet being read, and false otherwise.

6.2.2.15 EthernetPacketGet
Waits for a packet from the Ethernet controller. Prototype: long EthernetPacketGet(unsigned long ulBase, unsigned char *pucBuf, long lBufLen) Parameters: ulBase is the base address of the controller. pucBuf is the pointer to the packet buffer. lBufLen is the maximum number of bytes to be read into the buffer. Description: This function reads a packet from the receive FIFO of the controller and places it into pucBuf . The function will wait until a packet is available in the FIFO. Then the function will read the entire packet from the receive FIFO. If there are more bytes in the packet than will t into pucBuf (as specied by lBufLen), the function will return the negated length of the packet and the buffer will contain lBufLen bytes of the packet. Otherwise, the function will return the length of the packet that was read and pucBuf will contain the entire packet (excluding the frame check sequence bytes). Note: This function is blocking and will not return until a packet arrives. Returns: Returns the negated packet length -n if the packet is too large for pucBuf , and returns the packet length n otherwise.

6.2.2.16 EthernetPacketGetNonBlocking
Receives a packet from the Ethernet controller.

64

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: long EthernetPacketGetNonBlocking(unsigned long ulBase, unsigned char *pucBuf, long lBufLen) Parameters: ulBase is the base address of the controller. pucBuf is the pointer to the packet buffer. lBufLen is the maximum number of bytes to be read into the buffer. Description: This function reads a packet from the receive FIFO of the controller and places it into pucBuf . If no packet is available the function will return immediately. Otherwise, the function will read the entire packet from the receive FIFO. If there are more bytes in the packet than will t into pucBuf (as specied by lBufLen), the function will return the negated length of the packet and the buffer will contain lBufLen bytes of the packet. Otherwise, the function will return the length of the packet that was read and pucBuf will contain the entire packet (excluding the frame check sequence bytes). This function replaces the original EthernetPacketNonBlockingGet() API and performs the same actions. A macro is provided in ethernet.h to map the original API to this API. Note: This function will return immediately if no packet is available. Returns: Returns 0 if no packet is available, the negated packet length -n if the packet is too large for pucBuf , and the packet length n otherwise.

6.2.2.17 EthernetPacketPut
Waits to send a packet from the Ethernet controller. Prototype: long EthernetPacketPut(unsigned long ulBase, unsigned char *pucBuf, long lBufLen) Parameters: ulBase is the base address of the controller. pucBuf is the pointer to the packet buffer. lBufLen is number of bytes in the packet to be transmitted. Description: This function writes lBufLen bytes of the packet contained in pucBuf into the transmit FIFO of the controller and then activates the transmitter for this packet. This function will wait until the transmit FIFO is empty. Once space is available, the function will return once lBufLen bytes of the packet have been placed into the FIFO and the transmitter has been started. The function will not wait for the transmission to complete. The function will return the negated lBufLen if the length is larger than the space available in the transmit FIFO.

October 30, 2008

65

Ethernet Controller

Note: This function blocks and will wait until space is available for the transmit packet before returning. Returns: Returns the negated packet length -lBufLen if the packet is too large for FIFO, and the packet length lBufLen otherwise.

6.2.2.18 EthernetPacketPutNonBlocking
Sends a packet to the Ethernet controller. Prototype: long EthernetPacketPutNonBlocking(unsigned long ulBase, unsigned char *pucBuf, long lBufLen) Parameters: ulBase is the base address of the controller. pucBuf is the pointer to the packet buffer. lBufLen is number of bytes in the packet to be transmitted. Description: This function writes lBufLen bytes of the packet contained in pucBuf into the transmit FIFO of the controller and then activates the transmitter for this packet. If no space is available in the FIFO, the function will return immediately. If space is available, the function will return once lBufLen bytes of the packet have been placed into the FIFO and the transmitter has been started. The function will not wait for the transmission to complete. The function will return the negated lBufLen if the length is larger than the space available in the transmit FIFO. This function replaces the original EthernetPacketNonBlockingPut() API and performs the same actions. A macro is provided in ethernet.h to map the original API to this API. Note: This function does not block and will return immediately if no space is available for the transmit packet. Returns: Returns 0 if no space is available in the transmit FIFO, the negated packet length -lBufLen if the packet is too large for FIFO, and the packet length lBufLen otherwise.

6.2.2.19 EthernetPHYRead
Reads from a PHY register. Prototype: unsigned long EthernetPHYRead(unsigned long ulBase, unsigned char ucRegAddr) Parameters: ulBase is the base address of the controller.

66

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

ucRegAddr is the address of the PHY register to be accessed. Description: This function will return the contents of the PHY register specied by ucRegAddr . Returns: Returns the 16-bit value read from the PHY.

6.2.2.20 EthernetPHYWrite
Writes to the PHY register. Prototype: void EthernetPHYWrite(unsigned long ulBase, unsigned char ucRegAddr, unsigned long ulData) Parameters: ulBase is the base address of the controller. ucRegAddr is the address of the PHY register to be accessed. ulData is the data to be written to the PHY register. Description: This function will write the ulData to the PHY register specied by ucRegAddr . Returns: None.

6.2.2.21 EthernetSpaceAvail
Checks for packet space available in the Ethernet controller. Prototype: tBoolean EthernetSpaceAvail(unsigned long ulBase) Parameters: ulBase is the base address of the controller. Description: The Ethernet controllers transmit FIFO is designed to support a single packet at a time. After the packet has been written into the FIFO, the transmit request bit must be set to enable the transmission of the packet. Only after the packet has been transmitted can a new packet be written into the FIFO. This function will simply check to see if a packet is in progress. If so, there is no space available in the transmit FIFO. Returns: Returns true if a space is available in the transmit FIFO, and false otherwise.

October 30, 2008

67

Ethernet Controller

6.3

Programming Example
The following example shows how to use the this API to initialize the Ethernet controller to transmit and receive packets.
unsigned unsigned unsigned unsigned char char char long pucMACAddress[6]; pucMyRxPacket[]; pucMyTxPacket[]; ulMyTxPacketLength;

// // Initialize the Ethernet controller for operation // EthernetInitExpClk(ETH_BASE, SysCtlClockGet()); // // Configure the Ethernet controller for normal operation // Enable TX Duplex Mode // Enable TX Padding // EthernetConfigSet(ETH_BASE, (ETH_CFG_TX_DPLXEN | ETH_CFG_TX_PADEN)); // // Program the MAC Address (01-23-45-67-89-AB) // pucMACAddress[0] = 0x01; pucMACAddress[1] = 0x23; pucMACAddress[2] = 0x45; pucMACAddress[3] = 0x67; pucMACAddress[4] = 0x89; pucMACAddress[5] = 0xAB; EthernetMACAddrSet(ETH_BASE, pucMACAddress); // // Enable the Ethernet controller // EthernetEnable(ETH_BASE); // // Send a packet. // (assume that the packet has been filled in appropriately elsewhere // in the code). // EthernetPacketPut(ETH_BASE, pucMyTxPacket, ulMyTxPacketLength); // // Wait for a packet to come in. // EthernetPacketGet(ETH_BASE, pucMyRxPacket, sizeof(pucMyRxPacket));

68

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Flash
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

7.1

Introduction
The ash API provides a set of functions for dealing with the on-chip ash. Functions are provided to program and erase the ash, congure the ash protection, and handle the ash interrupt. The ash is organized as a set of 1 kB blocks that can be individually erased. Erasing a block causes the entire contents of the block to be reset to all ones. These blocks are paired into a set of 2 kB blocks that can be individually protected. The blocks can be marked as read-only or execute-only, providing differing levels of code protection. Read-only blocks cannot be erased or programmed, protecting the contents of those blocks from being modied. Execute-only blocks cannot be erased or programmed, and can only be read by the processor instruction fetch mechanism, protecting the contents of those blocks from being read by either the processor or by debuggers. The ash can be programmed on a word-by-word basis. Programming causes 1 bits to become 0 bits (where appropriate); because of this, a word can be repeatedly programmed so long as each programming operation only requires changing 1 bits to 0 bits. The timing for the ash is automatically handled by the ash controller. In order to do this, the ash controller must know the clock rate of the system in order to be able to time the number of micro-seconds certain signals are asserted. The number of clock cycles per micro-second must be provided to the ash controller for it to accomplish this timing. The ash controller has the ability to generate an interrupt when an invalid access is attempted (such as reading from execute-only ash). This can be used to validate the operation of a program; the interrupt will keep invalid accesses from being silently ignored, hiding potential bugs. The ash protection can be applied without being permanently enabled; this, along with the interrupt, allows the program to be debugged before the ash protection is permanently applied to the device (which is a non-reversible operation). An interrupt can also be generated when an erase or programming operation has completed. Depending upon the member of the Stellaris family used, the amount of available ash is 8 KB, 16 KB, 32 KB, 64 KB, 96 KB, 128 KB, or 256 KB. This driver is contained in driverlib/flash.c, with driverlib/flash.h containing the API denitions for use by applications.

7.2

API Functions
Functions
long FlashErase (unsigned long ulAddress) void FlashIntClear (unsigned long ulIntFlags) void FlashIntDisable (unsigned long ulIntFlags)

October 30, 2008

69

Flash

void FlashIntEnable (unsigned long ulIntFlags) unsigned long FlashIntGetStatus (tBoolean bMasked) void FlashIntRegister (void (pfnHandler)(void)) void FlashIntUnregister (void) long FlashProgram (unsigned long pulData, unsigned long ulAddress, unsigned long ulCount) tFlashProtection FlashProtectGet (unsigned long ulAddress) long FlashProtectSave (void) long FlashProtectSet (unsigned long ulAddress, tFlashProtection eProtect) unsigned long FlashUsecGet (void) void FlashUsecSet (unsigned long ulClocks) long FlashUserGet (unsigned long pulUser0, unsigned long pulUser1) long FlashUserSave (void) long FlashUserSet (unsigned long ulUser0, unsigned long ulUser1)

7.2.1

Detailed Description
The ash API is broken into three groups of functions: those that deal with programming the ash, those that deal with ash protection, and those that deal with interrupt handling. Flash programming is managed with FlashErase(), FlashProgram(), FlashUsecGet(), and FlashUsecSet(). Flash protection is managed with FlashProtectGet(), FlashProtectSet(), and FlashProtectSave(). Interrupt handling is managed with FlashIntRegister(), FlashIntUnregister(), FlashIntEnable(), FlashIntDisable(), FlashIntGetStatus(), and FlashIntClear().

7.2.2
7.2.2.1

Function Documentation
FlashErase
Erases a block of ash. Prototype: long FlashErase(unsigned long ulAddress) Parameters: ulAddress is the start address of the ash block to be erased. Description: This function will erase a 1 kB block of the on-chip ash. After erasing, the block will be lled with 0xFF bytes. Read-only and execute-only blocks cannot be erased. This function will not return until the block has been erased. Returns: Returns 0 on success, or -1 if an invalid block address was specied or the block is writeprotected.

70

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

7.2.2.2

FlashIntClear
Clears ash controller interrupt sources. Prototype: void FlashIntClear(unsigned long ulIntFlags) Parameters: ulIntFlags is the bit mask of the interrupt sources to be cleared. Can be any of the FLASH_FCMISC_PROGRAM or FLASH_FCMISC_AMISC values. Description: The specied ash controller interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

7.2.2.3

FlashIntDisable
Disables individual ash controller interrupt sources. Prototype: void FlashIntDisable(unsigned long ulIntFlags) Parameters: ulIntFlags is a bit mask of the interrupt sources to be disabled. FLASH_FCIM_PROGRAM or FLASH_FCIM_ACCESS values.

Can be any of the

Description: Disables the indicated ash controller interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. Returns: None.

7.2.2.4

FlashIntEnable
Enables individual ash controller interrupt sources.

October 30, 2008

71

Flash

Prototype: void FlashIntEnable(unsigned long ulIntFlags) Parameters: ulIntFlags is a bit mask of the interrupt sources to be enabled. FLASH_FCIM_PROGRAM or FLASH_FCIM_ACCESS values. Can be any of the

Description: Enables the indicated ash controller interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. Returns: None.

7.2.2.5

FlashIntGetStatus
Gets the current interrupt status. Prototype: unsigned long FlashIntGetStatus(tBoolean bMasked) Parameters: bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the ash controller. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: The current interrupt status, enumerated as a bit eld of FLASH_FCMISC_PROGRAM and FLASH_FCMISC_AMISC.

7.2.2.6

FlashIntRegister
Registers an interrupt handler for the ash interrupt. Prototype: void FlashIntRegister(void (*pfnHandler)(void)) Parameters: pfnHandler is a pointer to the function to be called when the ash interrupt occurs. Description: This sets the handler to be called when the ash interrupt occurs. The ash controller can generate an interrupt when an invalid ash access occurs, such as trying to program or erase a read-only block, or trying to read from an execute-only block. It can also generate an interrupt when a program or erase operation has completed. The interrupt will be automatically enabled when the handler is registered.

72

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

7.2.2.7

FlashIntUnregister
Unregisters the interrupt handler for the ash interrupt. Prototype: void FlashIntUnregister(void) Description: This function will clear the handler to be called when the ash interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler is no longer called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

7.2.2.8

FlashProgram
Programs ash. Prototype: long FlashProgram(unsigned long *pulData, unsigned long ulAddress, unsigned long ulCount) Parameters: pulData is a pointer to the data to be programmed. ulAddress is the starting address in ash to be programmed. Must be a multiple of four. ulCount is the number of bytes to be programmed. Must be a multiple of four. Description: This function will program a sequence of words into the on-chip ash. Programming each location consists of the result of an AND operation of the new data and the existing data; in other words bits that contain 1 can remain 1 or be changed to 0, but bits that are 0 cannot be changed to 1. Therefore, a word can be programmed multiple times as long as these rules are followed; if a program operation attempts to change a 0 bit to a 1 bit, that bit will not have its value changed. Since the ash is programmed one word at a time, the starting address and byte count must both be multiples of four. It is up to the caller to verify the programmed contents, if such verication is required. This function will not return until the data has been programmed.

October 30, 2008

73

Flash

Returns: Returns 0 on success, or -1 if a programming error is encountered.

7.2.2.9

FlashProtectGet
Gets the protection setting for a block of ash. Prototype: tFlashProtection FlashProtectGet(unsigned long ulAddress) Parameters: ulAddress is the start address of the ash block to be queried. Description: This function will get the current protection for the specied 2 kB block of ash. Each block can be read/write, read-only, or execute-only. Read/write blocks can be read, executed, erased, and programmed. Read-only blocks can be read and executed. Execute-only blocks can only be executed; processor and debugger data reads are not allowed. Returns: Returns the protection setting for this block. See FlashProtectSet() for possible values.

7.2.2.10 FlashProtectSave
Saves the ash protection settings. Prototype: long FlashProtectSave(void) Description: This function will make the currently programmed ash protection settings permanent. This is a non-reversible operation; a chip reset or power cycle will not change the ash protection. This function will not return until the protection has been saved. Returns: Returns 0 on success, or -1 if a hardware error is encountered.

7.2.2.11 FlashProtectSet
Sets the protection setting for a block of ash. Prototype: long FlashProtectSet(unsigned long ulAddress, tFlashProtection eProtect)

74

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulAddress is the start address of the ash block to be protected. eProtect is the protection to be applied to the block. Can be one of FlashReadWrite, FlashReadOnly, or FlashExecuteOnly. Description: This function will set the protection for the specied 2 kB block of ash. Blocks which are read/write can be made read-only or execute-only. Blocks which are read-only can be made execute-only. Blocks which are execute-only cannot have their protection modied. Attempts to make the block protection less stringent (that is, read-only to read/write) will result in a failure (and be prevented by the hardware). Changes to the ash protection are maintained only until the next reset. This allows the application to be executed in the desired ash protection environment to check for inappropriate ash access (via the ash interrupt). To make the ash protection permanent, use the FlashProtectSave() function. Returns: Returns 0 on success, or -1 if an invalid address or an invalid protection was specied.

7.2.2.12 FlashUsecGet
Gets the number of processor clocks per micro-second. Prototype: unsigned long FlashUsecGet(void) Description: This function returns the number of clocks per micro-second, as presently known by the ash controller. Returns: Returns the number of processor clocks per micro-second.

7.2.2.13 FlashUsecSet
Sets the number of processor clocks per micro-second. Prototype: void FlashUsecSet(unsigned long ulClocks) Parameters: ulClocks is the number of processor clocks per micro-second. Description: This function is used to tell the ash controller the number of processor clocks per microsecond. This value must be programmed correctly or the ash most likely will not program correctly; it has no affect on reading ash. Returns: None.

October 30, 2008

75

Flash

7.2.2.14 FlashUserGet
Gets the user registers. Prototype: long FlashUserGet(unsigned long *pulUser0, unsigned long *pulUser1) Parameters: pulUser0 is a pointer to the location to store USER Register 0. pulUser1 is a pointer to the location to store USER Register 1. Description: This function will read the contents of user registers (0 and 1), and store them in the specied locations. Returns: Returns 0 on success, or -1 if a hardware error is encountered.

7.2.2.15 FlashUserSave
Saves the user registers. Prototype: long FlashUserSave(void) Description: This function will make the currently programmed user register settings permanent. This is a non-reversible operation; a chip reset or power cycle will not change this setting. This function will not return until the protection has been saved. Returns: Returns 0 on success, or -1 if a hardware error is encountered.

7.2.2.16 FlashUserSet
Sets the user registers. Prototype: long FlashUserSet(unsigned long ulUser0, unsigned long ulUser1) Parameters: ulUser0 is the value to store in USER Register 0. ulUser1 is the value to store in USER Register 1. Description: This function will set the contents of the user registers (0 and 1) to the specied values.

76

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Returns: Returns 0 on success, or -1 if a hardware error is encountered.

7.3

Programming Example
The following example shows how to use the ash API to erase a block of the ash and program a few words.
unsigned long pulData[2]; // // Set the uSec value to 20, indicating that the processor is running at // 20 MHz. // FlashUsecSet(20); // // Erase a block of the flash. // FlashErase(0x800); // // Program some data into the newly erased block of the flash. // pulData[0] = 0x12345678; pulData[1] = 0x56789abc; FlashProgram(pulData, 0x800, sizeof(pulData));

October 30, 2008

77

Flash

78

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

GPIO
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

8.1

Introduction
The GPIO module provides control for up to eight independent GPIO pins (the actual number present depend upon the GPIO port and part number). Each pin has the following capabilities: Can be congured as an input or an output. On reset, they default to being an input. In input mode, can generate interrupts on high level, low level, rising edge, falling edge, or both edges. In output mode, can be congured for 2 mA, 4 mA, or 8 mA drive strength. The 8 mA drive strength conguration has optional slew rate control to limit the rise and fall times of the signal. On reset, they default to 2 mA drive strength. Optional weak pull-up or pull-down resistors. On reset, they default to a weak pull-up. Optional open-drain operation. On reset, they default to standard push/pull operation. Can be congured to be a GPIO or a peripheral pin. On reset, they default to being GPIOs. Note that not all pins on all parts have peripheral functions, in which case the pin is only useful as a GPIO (that is, when congured for peripheral function the pin will not do anything useful). Most of the GPIO functions can operate on more than one GPIO pin (within a single module) at a time. The ucPins parameter to these functions is used to specify the pins that are affected; the GPIO pins whose corresponding bits in this parameter that are set will be affected (where pin 0 is in bit 0, pin 1 in bit 1, and so on). For example, if ucPins is 0x09, then pins 0 and 3 will be affected by the function. This is most useful for the GPIOPinRead() and GPIOPinWrite() functions; a read will return only the value of the requested pins (with the other pin values masked out) and a write will affect the requested pins simultaneously (that is, the state of multiple GPIO pins can be changed at the same time). This data masking for the GPIO pin state occurs in the hardware; a single read or write is issued to the hardware, which interprets some of the address bits as an indication of the GPIO pins to operate upon (and therefore the ones to not affect). See the part data sheet for details of the GPIO data register address-based bit masking. For functions that have a ucPin (singular) parameter, only a single pin is affected by the function. In this case, this value species the pin number (that is, 0 through 7). This driver is contained in driverlib/gpio.c, with driverlib/gpio.h containing the API denitions for use by applications.

8.2

API Functions
Functions
unsigned long GPIODirModeGet (unsigned long ulPort, unsigned char ucPin)

October 30, 2008

79

GPIO

void GPIODirModeSet (unsigned long ulPort, unsigned char ucPins, unsigned long ulPinIO) unsigned long GPIOIntTypeGet (unsigned long ulPort, unsigned char ucPin) void GPIOIntTypeSet (unsigned long ulPort, unsigned char ucPins, unsigned long ulIntType) void GPIOPadCongGet (unsigned long ulPort, unsigned char ucPin, unsigned long pulStrength, unsigned long pulPinType) void GPIOPadCongSet (unsigned long ulPort, unsigned char ucPins, unsigned long ulStrength, unsigned long ulPinType) void GPIOPinIntClear (unsigned long ulPort, unsigned char ucPins) void GPIOPinIntDisable (unsigned long ulPort, unsigned char ucPins) void GPIOPinIntEnable (unsigned long ulPort, unsigned char ucPins) long GPIOPinIntStatus (unsigned long ulPort, tBoolean bMasked) long GPIOPinRead (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeADC (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeCAN (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeComparator (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeGPIOInput (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeGPIOOutput (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeGPIOOutputOD (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeI2C (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypePWM (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeQEI (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeSSI (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeTimer (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeUART (unsigned long ulPort, unsigned char ucPins) void GPIOPinTypeUSBDigital (unsigned long ulPort, unsigned char ucPins) void GPIOPinWrite (unsigned long ulPort, unsigned char ucPins, unsigned char ucVal) void GPIOPortIntRegister (unsigned long ulPort, void (pfnIntHandler)(void)) void GPIOPortIntUnregister (unsigned long ulPort)

8.2.1

Detailed Description
The GPIO API is broken into three groups of functions: those that deal with conguring the GPIO pins, those that deal with interrupts, and those that access the pin value. The GPIO pins are congured with GPIODirModeSet() and GPIOPadCongSet(). The conguration can be read back with GPIODirModeGet() and GPIOPadCongGet(). There are also convenience functions for conguring the pin in the required or recommended conguration for a particular peripheral; these are GPIOPinTypeCAN(), GPIOPinTypeComparator(), GPIOPinTypeGPIOInput(), GPIOPinTypeGPIOOutput(), GPIOPinTypeGPIOOutputOD(), GPIOPinTypeI2C(), GPIOPinTypePWM(), GPIOPinTypeQEI(), GPIOPinTypeSSI(), GPIOPinTypeTimer(), and GPIOPinTypeUART(). The GPIO interrupts are handled with GPIOIntTypeSet(), GPIOIntTypeGet(), GPIOPinIntEnable(), GPIOPinIntDisable(), GPIOPinIntStatus(), GPIOPinIntClear(), GPIOPortIntRegister(), and GPIOPortIntUnregister(). The GPIO pin state is accessed with GPIOPinRead() and GPIOPinWrite().

80

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

8.2.2
8.2.2.1

Function Documentation
GPIODirModeGet
Gets the direction and mode of a pin. Prototype: unsigned long GPIODirModeGet(unsigned long ulPort, unsigned char ucPin) Parameters: ulPort is the base address of the GPIO port. ucPin is the pin number. Description: This function gets the direction and control mode for a specied pin on the selected GPIO port. The pin can be congured as either an input or output under software control, or it can be under hardware control. The type of control and direction are returned as an enumerated data type. Returns: Returns one of the enumerated data types described for GPIODirModeSet().

8.2.2.2

GPIODirModeSet
Sets the direction and mode of the specied pin(s). Prototype: void GPIODirModeSet(unsigned long ulPort, unsigned char ucPins, unsigned long ulPinIO) Parameters: ulPort is the base address of the GPIO port ucPins is the bit-packed representation of the pin(s). ulPinIO is the pin direction and/or mode. Description: This function will set the specied pin(s) on the selected GPIO port as either an input or output under software control, or it will set the pin to be under hardware control. The parameter ulPinIO is an enumerated data type that can be one of the following values: GPIO_DIR_MODE_IN GPIO_DIR_MODE_OUT GPIO_DIR_MODE_HW where GPIO_DIR_MODE_IN species that the pin will be programmed as a software controlled input, GPIO_DIR_MODE_OUT species that the pin will be programmed as a software controlled output, and GPIO_DIR_MODE_HW species that the pin will be placed under hardware control.

October 30, 2008

81

GPIO

The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

8.2.2.3

GPIOIntTypeGet
Gets the interrupt type for a pin. Prototype: unsigned long GPIOIntTypeGet(unsigned long ulPort, unsigned char ucPin) Parameters: ulPort is the base address of the GPIO port. ucPin is the pin number. Description: This function gets the interrupt type for a specied pin on the selected GPIO port. The pin can be congured as a falling edge, rising edge, or both edge detected interrupt, or it can be congured as a low level or high level detected interrupt. The type of interrupt detection mechanism is returned as an enumerated data type. Returns: Returns one of the enumerated data types described for GPIOIntTypeSet().

8.2.2.4

GPIOIntTypeSet
Sets the interrupt type for the specied pin(s). Prototype: void GPIOIntTypeSet(unsigned long ulPort, unsigned char ucPins, unsigned long ulIntType) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). ulIntType species the type of interrupt trigger mechanism. Description: This function sets up the various interrupt trigger mechanisms for the specied pin(s) on the selected GPIO port. The parameter ulIntType is an enumerated data type that can be one of the following values: GPIO_FALLING_EDGE

82

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

GPIO_RISING_EDGE GPIO_BOTH_EDGES GPIO_LOW_LEVEL GPIO_HIGH_LEVEL where the different values describe the interrupt detection mechanism (edge or level) and the particular triggering event (falling, rising, or both edges for edge detect, low or high for level detect). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: In order to avoid any spurious interrupts, the user must ensure that the GPIO inputs remain stable for the duration of this function. Returns: None.

8.2.2.5

GPIOPadCongGet
Gets the pad conguration for a pin. Prototype: void GPIOPadConfigGet(unsigned unsigned unsigned unsigned

long char long long

ulPort, ucPin, *pulStrength, *pulPinType)

Parameters: ulPort is the base address of the GPIO port. ucPin is the pin number. pulStrength is a pointer to storage for the output drive strength. pulPinType is a pointer to storage for the output drive type. Description: This function gets the pad conguration for a specied pin on the selected GPIO port. The values returned in pulStrength and pulPinType correspond to the values used in GPIOPadCongSet(). This function also works for pin(s) congured as input pin(s); however, the only meaningful data returned is whether the pin is terminated with a pull-up or down resistor. Returns: None

8.2.2.6

GPIOPadCongSet
Sets the pad conguration for the specied pin(s).

October 30, 2008

83

GPIO

Prototype: void GPIOPadConfigSet(unsigned unsigned unsigned unsigned

long char long long

ulPort, ucPins, ulStrength, ulPinType)

Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). ulStrength species the output drive strength. ulPinType species the pin type. Description: This function sets the drive strength and type for the specied pin(s) on the selected GPIO port. For pin(s) congured as input ports, the pad is congured as requested, but the only real effect on the input is the conguration of the pull-up or pull-down termination. The parameter ulStrength can be one of the following values: GPIO_STRENGTH_2MA GPIO_STRENGTH_4MA GPIO_STRENGTH_8MA GPIO_STRENGTH_8MA_SC where GPIO_STRENGTH_xMA species either 2, 4, or 8 mA output drive strength, and GPIO_OUT_STRENGTH_8MA_SC species 8 mA output drive with slew control. The parameter ulPinType can be one of the following values: GPIO_PIN_TYPE_STD GPIO_PIN_TYPE_STD_WPU GPIO_PIN_TYPE_STD_WPD GPIO_PIN_TYPE_OD GPIO_PIN_TYPE_OD_WPU GPIO_PIN_TYPE_OD_WPD GPIO_PIN_TYPE_ANALOG where GPIO_PIN_TYPE_STD species a push-pull pin, GPIO_PIN_TYPE_OD species an open-drain pin, _WPU species a weak pull-up, _WPD species a weak pull-down, and GPIO_PIN_TYPE_ANALOG species an analog input (for the comparators). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

8.2.2.7

GPIOPinIntClear
Clears the interrupt for the specied pin(s).

84

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void GPIOPinIntClear(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: Clears the interrupt for the specied pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

8.2.2.8

GPIOPinIntDisable
Disables interrupts for the specied pin(s). Prototype: void GPIOPinIntDisable(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: Masks the interrupt for the specied pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

October 30, 2008

85

GPIO

8.2.2.9

GPIOPinIntEnable
Enables interrupts for the specied pin(s). Prototype: void GPIOPinIntEnable(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: Unmasks the interrupt for the specied pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

8.2.2.10 GPIOPinIntStatus
Gets interrupt status for the specied GPIO port. Prototype: long GPIOPinIntStatus(unsigned long ulPort, tBoolean bMasked) Parameters: ulPort is the base address of the GPIO port. bMasked species whether masked or raw interrupt status is returned. Description: If bMasked is set as true, then the masked interrupt status is returned; otherwise, the raw interrupt status will be returned. Returns: Returns a bit-packed byte, where each bit that is set identies an active masked or raw interrupt, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Bits 31:8 should be ignored.

8.2.2.11 GPIOPinRead
Reads the values present of the specied pin(s).

86

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: long GPIOPinRead(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The values at the specied pin(s) are read, as specied by ucPins. Values are returned for both input and output pin(s), and the value for pin(s) that are not specied by ucPins are set to 0. The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: Returns a bit-packed byte providing the state of the specied pin, where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Any bit that is not specied by ucPins is returned as a 0. Bits 31:8 should be ignored.

8.2.2.12 GPIOPinTypeADC
Congures pin(s) for use as analog-to-digital converter inputs. Prototype: void GPIOPinTypeADC(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The analog-to-digital converter input pins must be properly congured to function correctly on DustDevil-class devices. This function provides the proper conguration for those pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into an ADC input; it only congures an ADC input pin for proper operation. Returns: None.

October 30, 2008

87

GPIO

8.2.2.13 GPIOPinTypeCAN
Congures pin(s) for use as a CAN device. Prototype: void GPIOPinTypeCAN(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The CAN pins must be properly congured for the CAN peripherals to function correctly. This function provides a typical conguration for those pin(s); other congurations may work as well depending upon the board setup (for example, using the on-chip pull-ups). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into a CAN pin; it only congures a CAN pin for proper operation. Returns: None.

8.2.2.14 GPIOPinTypeComparator
Congures pin(s) for use as an analog comparator input. Prototype: void GPIOPinTypeComparator(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The analog comparator input pins must be properly congured for the analog comparator to function correctly. This function provides the proper conguration for those pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into an analog comparator input; it only congures an analog comparator pin for proper operation.

88

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Returns: None.

8.2.2.15 GPIOPinTypeGPIOInput
Congures pin(s) for use as GPIO inputs. Prototype: void GPIOPinTypeGPIOInput(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The GPIO pins must be properly congured in order to function correctly as GPIO inputs; this is especially true of Fury-class devices where the digital input enable is turned off by default. This function provides the proper conguration for those pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

8.2.2.16 GPIOPinTypeGPIOOutput
Congures pin(s) for use as GPIO outputs. Prototype: void GPIOPinTypeGPIOOutput(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The GPIO pins must be properly congured in order to function correctly as GPIO outputs; this is especially true of Fury-class devices where the digital input enable is turned off by default. This function provides the proper conguration for those pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

October 30, 2008

89

GPIO

8.2.2.17 GPIOPinTypeGPIOOutputOD
Congures pin(s) for use as GPIO open drain outputs. Prototype: void GPIOPinTypeGPIOOutputOD(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The GPIO pins must be properly congured in order to function correctly as GPIO outputs; this is especially true of Fury-class devices where the digital input enable is turned off by default. This function provides the proper conguration for those pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

8.2.2.18 GPIOPinTypeI2C
Congures pin(s) for use by the I2C peripheral. Prototype: void GPIOPinTypeI2C(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The I2C pins must be properly congured for the I2C peripheral to function correctly. This function provides the proper conguration for those pin(s). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into an I2C pin; it only congures an I2C pin for proper operation. Returns: None.

90

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

8.2.2.19 GPIOPinTypePWM
Congures pin(s) for use by the PWM peripheral. Prototype: void GPIOPinTypePWM(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The PWM pins must be properly congured for the PWM peripheral to function correctly. This function provides a typical conguration for those pin(s); other congurations may work as well depending upon the board setup (for example, using the on-chip pull-ups). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into a PWM pin; it only congures a PWM pin for proper operation. Returns: None.

8.2.2.20 GPIOPinTypeQEI
Congures pin(s) for use by the QEI peripheral. Prototype: void GPIOPinTypeQEI(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The QEI pins must be properly congured for the QEI peripheral to function correctly. This function provides a typical conguration for those pin(s); other congurations may work as well depending upon the board setup (for example, not using the on-chip pull-ups). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into a QEI pin; it only congures a QEI pin for proper operation.

October 30, 2008

91

GPIO

Returns: None.

8.2.2.21 GPIOPinTypeSSI
Congures pin(s) for use by the SSI peripheral. Prototype: void GPIOPinTypeSSI(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The SSI pins must be properly congured for the SSI peripheral to function correctly. This function provides a typical conguration for those pin(s); other congurations may work as well depending upon the board setup (for example, using the on-chip pull-ups). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into a SSI pin; it only congures a SSI pin for proper operation. Returns: None.

8.2.2.22 GPIOPinTypeTimer
Congures pin(s) for use by the Timer peripheral. Prototype: void GPIOPinTypeTimer(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The CCP pins must be properly congured for the timer peripheral to function correctly. This function provides a typical conguration for those pin(s); other congurations may work as well depending upon the board setup (for example, using the on-chip pull-ups). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on.

92

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Note: This cannot be used to turn any pin into a timer pin; it only congures a timer pin for proper operation. Returns: None.

8.2.2.23 GPIOPinTypeUART
Congures pin(s) for use by the UART peripheral. Prototype: void GPIOPinTypeUART(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). Description: The UART pins must be properly congured for the UART peripheral to function correctly. This function provides a typical conguration for those pin(s); other congurations may work as well depending upon the board setup (for example, using the on-chip pull-ups). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into a UART pin; it only congures a UART pin for proper operation. Returns: None.

8.2.2.24 GPIOPinTypeUSBDigital
Congures pin(s) for use by the USB peripheral. Prototype: void GPIOPinTypeUSBDigital(unsigned long ulPort, unsigned char ucPins) Parameters: ulPort is the base address of the USB port. ucPins is the bit-packed representation of the pin(s).

October 30, 2008

93

GPIO

Description: Some USB pins must be properly congured for the USB peripheral to function correctly. This function provides a typical conguration for the digital USB pin(s); other congurations may work as well depending upon the board setup (for example, using the on-chip pull-ups). The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Note: This cannot be used to turn any pin into a USB pin; it only congures a USB pin for proper operation. Returns: None.

8.2.2.25 GPIOPinWrite
Writes a value to the specied pin(s). Prototype: void GPIOPinWrite(unsigned long ulPort, unsigned char ucPins, unsigned char ucVal) Parameters: ulPort is the base address of the GPIO port. ucPins is the bit-packed representation of the pin(s). ucVal is the value to write to the pin(s). Description: Writes the corresponding bit values to the output pin(s) specied by ucPins. Writing to a pin congured as an input pin has no effect. The pin(s) are specied using a bit-packed byte, where each bit that is set identies the pin to be accessed, and where bit 0 of the byte represents GPIO port pin 0, bit 1 represents GPIO port pin 1, and so on. Returns: None.

8.2.2.26 GPIOPortIntRegister
Registers an interrupt handler for a GPIO port. Prototype: void GPIOPortIntRegister(unsigned long ulPort, void (*pfnIntHandler)(void))

94

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulPort is the base address of the GPIO port. pfnIntHandler is a pointer to the GPIO port interrupt handling function. Description: This function will ensure that the interrupt handler specied by pfnIntHandler is called when an interrupt is detected from the selected GPIO port. This function will also enable the corresponding GPIO interrupt in the interrupt controller; individual pin interrupts and interrupt sources must be enabled with GPIOPinIntEnable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

8.2.2.27 GPIOPortIntUnregister
Removes an interrupt handler for a GPIO port. Prototype: void GPIOPortIntUnregister(unsigned long ulPort) Parameters: ulPort is the base address of the GPIO port. Description: This function will unregister the interrupt handler for the specied GPIO port. This function will also disable the corresponding GPIO port interrupt in the interrupt controller; individual GPIO interrupts and interrupt sources must be disabled with GPIOPinIntDisable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

8.3

Programming Example
The following example shows how to use the GPIO API to initialize the GPIO, enable interrupts, read data from pins, and write data to pins.
int iVal; // // Register the port-level interrupt handler. This handler is the // first level interrupt handler for all the pin interrupts. // GPIOPortIntRegister(GPIO_PORTA_BASE, PortAIntHandler);

October 30, 2008

95

GPIO

// // Initialize the GPIO pin configuration. // // Set pins 2, 4, and 5 as input, SW controlled. // GPIOPinTypeGPIOInput(GPIO_PORTA_BASE, GPIO_PIN_2 | GPIO_PIN_4 | GPIO_PIN_5); // // Set pins 0 and 3 as output, SW controlled. // GPIOPinTypeGPIOOutput(GPIO_PORTA_BASE, GPIO_PIN_0 | GPIO_PIN_3); // // Make pins 2 and 4 rising edge triggered interrupts. // GPIOIntTypeSet(GPIO_PORTA_BASE, GPIO_PIN_2 | GPIO_PIN_4, GPIO_RISING_EDGE); // // Make pin 5 high level triggered interrupts. // GPIOIntTypeSet(GPIO_PORTA_BASE, GPIO_PIN_5, GPIO_HIGH_LEVEL); // // Read some pins. // iVal = GPIOPinRead(GPIO_PORTA_BASE, (GPIO_PIN_0 | GPIO_PIN_2 | GPIO_PIN_3 | GPIO_PIN_4 | GPIO_PIN_5)); // // Write some pins. Even though pins 2, 4, and 5 are specified, those // pins are unaffected by this write since they are configured as inputs. // At the end of this write, pin 0 will be a 0, and pin 3 will be a 1. // GPIOPinWrite(GPIO_PORTA_BASE, (GPIO_PIN_0 | GPIO_PIN_2 | GPIO_PIN_3 | GPIO_PIN_4 | GPIO_PIN_5), 0xF4); // // Enable the pin interrupts. // GPIOPinIntEnable(GPIO_PORTA_BASE, GPIO_PIN_2 | GPIO_PIN_4 | GPIO_PIN_5);

96

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Hibernation Module
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110

9.1

Introduction
The Hibernate API provides a set of functions for using the Hibernation module on the Stellaris microcontroller. The Hibernation module allows the software application to cause power to be removed from the microcontroller, and then be powered on later based on specic time or a signal on the external WAKE pin. The API provides functions to congure wake conditions, manage interrupts, read status, save and restore program state information, and request hibernation mode. Some of the features of the Hibernation module are: 32-bit real time clock Trim register for ne tuning the RTC rate Two RTC match registers for generating RTC events External WAKE pin to initiate a wake-up Low-battery detection 64 32-bit words of non-volatile memory Programmable interrupts for hibernation events This driver is contained in driverlib/hibernate.c, with driverlib/hibernate.h containing the API denitions for use by applications.

9.2

API Functions
Functions
void HibernateClockSelect (unsigned long ulClockInput) void HibernateDataGet (unsigned long pulData, unsigned long ulCount) void HibernateDataSet (unsigned long pulData, unsigned long ulCount) void HibernateDisable (void) void HibernateEnableExpClk (unsigned long ulHibClk) void HibernateIntClear (unsigned long ulIntFlags) void HibernateIntDisable (unsigned long ulIntFlags) void HibernateIntEnable (unsigned long ulIntFlags) void HibernateIntRegister (void (pfnHandler)(void)) unsigned long HibernateIntStatus (tBoolean bMasked) void HibernateIntUnregister (void) unsigned int HibernateIsActive (void) unsigned long HibernateLowBatGet (void)

October 30, 2008

97

Hibernation Module

void HibernateLowBatSet (unsigned long ulLowBatFlags) void HibernateRequest (void) void HibernateRTCDisable (void) void HibernateRTCEnable (void) unsigned long HibernateRTCGet (void) unsigned long HibernateRTCMatch0Get (void) void HibernateRTCMatch0Set (unsigned long ulMatch) unsigned long HibernateRTCMatch1Get (void) void HibernateRTCMatch1Set (unsigned long ulMatch) void HibernateRTCSet (unsigned long ulRTCValue) unsigned long HibernateRTCTrimGet (void) void HibernateRTCTrimSet (unsigned long ulTrim) unsigned long HibernateWakeGet (void) void HibernateWakeSet (unsigned long ulWakeFlags)

9.2.1

Detailed Description
The Hibernation module must be enabled before it can be used. Use the HibernateEnableExpClk() function to enable it. If a crystal is used for the clock source, then the initializing code must allow time for the crystal to stabilize after calling the HibernateEnableExpClk() function. Refer to the device data sheet for information about crystal stabilization time. If an oscillator is used, then no delay is necessary. After the module is enabled, the clock source must be congured by calling HibernateClockSelect(). In order to use the RTC feature of the Hibernation module, the RTC must be enabled by calling HibernateRTCEnable(). It can be later disabled by calling HibernateRTCDisable(). These functions can be called at any time to start and stop the RTC. The RTC value can be read or set by using the HibernateRTCGet() and HibernateRTCSet() functions. The two match registers can be read and set by using the HibernateRTCMatch0Get(), HibernateRTCMatch0Set(), HibernateRTCMatch1Get(), and HibernateRTCMatch1Set() functions. The real-time clock rate can be adjusted by using the trim register. Use the HibernateRTCTrimGet() and HibernateRTCTrimSet() functions for this purpose. Application state information can be stored in the non-volatile memory of the Hibernation module when the processor is powered off. Use the HibernateDataSet() and HibernateDataGet() functions to access the non-volatile memory area. The module can be congured to wake when the external WAKE pin is asserted, or when an RTC match occurs, or both. Use the HibernateWakeSet() function to congure the wake conditions. The present conguration can be read by calling HibernateWakeGet(). The Hibernation module can detect a low battery and signal the processor. It can also be congured to abort a hibernation request if the battery voltage is too low. Use the HibernateLowBatSet() and HibernateLowBatGet() functions to congure this feature. Several functions are provided for managing interrupts. Use the HibernateIntRegister() and HibernateIntUnregister() functions to install or uninstall an interrupt handler into the vector table. Refer to the IntRegister() function for notes about using the interrupt vector table. The module can generate several different interrupts. Use the HibernateIntEnable() and HibernateIntDisable() functions to enable and disable specic interrupt sources. The present interrupt status can be found by calling HibernateIntStatus(). In the interrupt handler, all pending interrupts must be cleared. Use the HibernateIntClear() function to clear pending interrupts.

98

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Finally, once the module is appropriately congured, the state saved, and the software application is ready to hibernate, call the HibernateRequest() function. This will initiate the sequence to remove power from the processor. At a power-on reset, the software application can use the HibernateIsActive() function to determine if the Hibernation module is already active and therefore does not need to be enabled. This can provide a hint to the software that the processor is waking from hibernation instead of a cold start. The software can then use the HibernateIntStatus() and HibernateDataGet() functions to discover the cause of the wake and to get the saved system state. The HibernateEnable() API from previous versions of the peripheral driver library has been replaced by the HibernateEnableExpClk() API. A macro has been provided in hibernate.h to map the old API to the new API, allowing existing applications to link and run with the new API. It is recommended that new applications utilize the new API in favor of the old one.

9.2.2
9.2.2.1

Function Documentation
HibernateClockSelect
Selects the clock input for the Hibernation module. Prototype: void HibernateClockSelect(unsigned long ulClockInput) Parameters: ulClockInput species the clock input. Description: Congures the clock input for the Hibernation module. The conguration option chosen depends entirely on hardware design. The clock input for the module will either be a 32.768 kHz oscillator or a 4.194304 MHz crystal. The ulClockFlags parameter must be one of the following: HIBERNATE_CLOCK_SEL_RAW - use the raw signal from a 32.768 kHz oscillator. HIBERNATE_CLOCK_SEL_DIV128 - use the crystal input, divided by 128. Returns: None.

9.2.2.2

HibernateDataGet
Reads a set of data from the non-volatile memory of the Hibernation module. Prototype: void HibernateDataGet(unsigned long *pulData, unsigned long ulCount) Parameters: pulData points to a location where the data that is read from the Hibernation module will be stored. ulCount is the count of 32-bit words to read.

October 30, 2008

99

Hibernation Module

Description: Retrieves a set of data from the Hibernation module non-volatile memory that was previously stored with the HibernateDataSet() function. The caller must ensure that pulData points to a large enough memory block to hold all the data that is read from the non-volatile memory. Returns: None.

9.2.2.3

HibernateDataSet
Stores data in the non-volatile memory of the Hibernation module. Prototype: void HibernateDataSet(unsigned long *pulData, unsigned long ulCount) Parameters: pulData points to the data that the caller wants to store in the memory of the Hibernation module. ulCount is the count of 32-bit words to store. Description: Stores a set of data in the Hibernation module non-volatile memory. This memory will be preserved when the power to the processor is turned off, and can be used to store application state information which will be available when the processor wakes. Up to 64 32-bit words can be stored in the non-volatile memory. The data can be restored by calling the HibernateDataGet() function. Returns: None.

9.2.2.4

HibernateDisable
Disables the Hibernation module for operation. Prototype: void HibernateDisable(void) Description: Disables the Hibernation module for operation. After this function is called, none of the Hibernation module features are available. Returns: None.

100

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

9.2.2.5

HibernateEnableExpClk
Enables the Hibernation module for operation. Prototype: void HibernateEnableExpClk(unsigned long ulHibClk) Parameters: ulHibClk is the rate of the clock supplied to the Hibernation module. Description: Enables the Hibernation module for operation. This function should be called before any of the Hibernation module features are used. The peripheral clock will be the same as the processor clock. This will be the value returned by SysCtlClockGet(), or it can be explicitly hard-coded if it is constant and known (to save the code/execution overhead of a call to SysCtlClockGet()). This function replaces the original HibernateEnable() API and performs the same actions. A macro is provided in hibernate.h to map the original API to this API. Returns: None.

9.2.2.6

HibernateIntClear
Clears pending interrupts from the Hibernation module. Prototype: void HibernateIntClear(unsigned long ulIntFlags) Parameters: ulIntFlags is the bit mask of the interrupts to be cleared. Description: Clears the specied interrupt sources. This must be done from within the interrupt handler or else the handler will be called again upon exit. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to the HibernateIntEnable() function. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

October 30, 2008

101

Hibernation Module

9.2.2.7

HibernateIntDisable
Disables interrupts for the Hibernation module. Prototype: void HibernateIntDisable(unsigned long ulIntFlags) Parameters: ulIntFlags is the bit mask of the interrupts to be disabled. Description: Disables the specied interrupt sources from the Hibernation module. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to the HibernateIntEnable() function. Returns: None.

9.2.2.8

HibernateIntEnable
Enables interrupts for the Hibernation module. Prototype: void HibernateIntEnable(unsigned long ulIntFlags) Parameters: ulIntFlags is the bit mask of the interrupts to be enabled. Description: Enables the specied interrupt sources from the Hibernation module. The ulIntFlags parameter must be the logical OR of any combination of the following: HIBERNATE_INT_PIN_WAKE - wake from pin interrupt HIBERNATE_INT_LOW_BAT - low battery interrupt HIBERNATE_INT_RTC_MATCH_0 - RTC match 0 interrupt HIBERNATE_INT_RTC_MATCH_1 - RTC match 1 interrupt Returns: None.

9.2.2.9

HibernateIntRegister
Registers an interrupt handler for the Hibernation module interrupt. Prototype: void HibernateIntRegister(void (*pfnHandler)(void))

102

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: pfnHandler points to the function to be called when a hibernation interrupt occurs. Description: Registers the interrupt handler in the system interrupt controller. The interrupt is enabled at the global level, but individual interrupt sources must still be enabled with a call to HibernateIntEnable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

9.2.2.10 HibernateIntStatus
Gets the current interrupt status of the Hibernation module. Prototype: unsigned long HibernateIntStatus(tBoolean bMasked) Parameters: bMasked is false to retrieve the raw interrupt status, and true to retrieve the masked interrupt status. Description: Returns the interrupt status of the Hibernation module. The caller can use this to determine the cause of a hibernation interrupt. Either the masked or raw interrupt status can be returned. Returns: Returns the interrupt status as a bit eld with the values as described in the HibernateIntEnable() function.

9.2.2.11 HibernateIntUnregister
Unregisters an interrupt handler for the Hibernation module interrupt. Prototype: void HibernateIntUnregister(void) Description: Unregisters the interrupt handler in the system interrupt controller. The interrupt is disabled at the global level, and the interrupt handler will no longer be called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

October 30, 2008

103

Hibernation Module

9.2.2.12 HibernateIsActive
Checks to see if the Hibernation module is already powered up. Prototype: unsigned int HibernateIsActive(void) Description: This function queries the control register to determine if the module is already active. This function can be called at a power-on reset to help determine if the reset is due to a wake from hibernation or a cold start. If the Hibernation module is already active, then it does not need to be re-enabled and its status can be queried immediately. The software application should also use the HibernateIntStatus() function to read the raw interrupt status to determine the cause of the wake. The HibernateDataGet() function can be used to restore state. These combinations of functions can be used by the software to determine if the processor is waking from hibernation and the appropriate action to take as a result. Returns: Returns true if the module is already active, and false if not.

9.2.2.13 HibernateLowBatGet
Gets the currently congured low battery detection behavior. Prototype: unsigned long HibernateLowBatGet(void) Description: Returns a value representing the currently congured low battery detection behavior. The return value will be one of the following: HIBERNATE_LOW_BAT_DETECT - detect a low battery condition. HIBERNATE_LOW_BAT_ABORT - detect a low battery condition, and abort hibernation if low battery is detected. Returns: Returns a value indicating the congured low battery detection.

9.2.2.14 HibernateLowBatSet
Congures the low battery detection. Prototype: void HibernateLowBatSet(unsigned long ulLowBatFlags) Parameters: ulLowBatFlags species behavior of low battery detection.

104

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: Enables the low battery detection and whether hibernation is allowed if a low battery is detected. If low battery detection is enabled, then a low battery condition will be indicated in the raw interrupt status register, and can also trigger an interrupt. Optionally, hibernation can be aborted if a low battery is detected. The ulLowBatFlags parameter is one of the following values: HIBERNATE_LOW_BAT_DETECT - detect a low battery condition. HIBERNATE_LOW_BAT_ABORT - detect a low battery condition, and abort hibernation if low battery is detected. Returns: None.

9.2.2.15 HibernateRequest
Requests hibernation mode. Prototype: void HibernateRequest(void) Description: This function requests the Hibernation module to disable the external regulator, thus removing power from the processor and all peripherals. The Hibernation module will remain powered from the battery or auxiliary power supply. The Hibernation module will re-enable the external regulator when one of the congured wake conditions occurs (such as RTC match or external WAKE pin). When the power is restored the processor will go through a normal power-on reset. The processor can retrieve saved state information with the HibernateDataGet() function. Prior to calling the function to request hibernation mode, the conditions for waking must have already been set by using the HibernateWakeSet() function. Note that this function may return because some time may elapse before the power is actually removed, or it may not be removed at all. For this reason, the processor will continue to execute instructions for some time and the caller should be prepared for this function to return. There are various reasons why the power may not be removed. For example, if the HibernateLowBatSet() function was used to congure an abort if low battery is detected, then the power will not be removed if the battery voltage is too low. There may be other reasons, related to the external circuit design, that a request for hibernation may not actually occur. For all these reasons, the caller must be prepared for this function to return. The simplest way to handle it is to just enter an innite loop and wait for the power to be removed. Returns: None.

9.2.2.16 HibernateRTCDisable
Disables the RTC feature of the Hibernation module.

October 30, 2008

105

Hibernation Module

Prototype: void HibernateRTCDisable(void) Description: Disables the RTC in the Hibernation module. After calling this function the RTC features of the Hibernation module will not be available. Returns: None.

9.2.2.17 HibernateRTCEnable
Enables the RTC feature of the Hibernation module. Prototype: void HibernateRTCEnable(void) Description: Enables the RTC in the Hibernation module. The RTC can be used to wake the processor from hibernation at a certain time, or to generate interrupts at certain times. This function must be called before using any of the RTC features of the Hibernation module. Returns: None.

9.2.2.18 HibernateRTCGet
Gets the value of the real time clock (RTC) counter. Prototype: unsigned long HibernateRTCGet(void) Description: Gets the value of the RTC and returns it to the caller. Returns: Returns the value of the RTC.

9.2.2.19 HibernateRTCMatch0Get
Gets the value of the RTC match 0 register. Prototype: unsigned long HibernateRTCMatch0Get(void) Description: Gets the value of the match 0 register for the RTC.

106

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Returns: Returns the value of the match register.

9.2.2.20 HibernateRTCMatch0Set
Sets the value of the RTC match 0 register. Prototype: void HibernateRTCMatch0Set(unsigned long ulMatch) Parameters: ulMatch is the value for the match register. Description: Sets the match 0 register for the RTC. The Hibernation module can be congured to wake from hibernation, and/or generate an interrupt when the value of the RTC counter is the same as the match register. Returns: None.

9.2.2.21 HibernateRTCMatch1Get
Gets the value of the RTC match 1 register. Prototype: unsigned long HibernateRTCMatch1Get(void) Description: Gets the value of the match 1 register for the RTC. Returns: Returns the value of the match register.

9.2.2.22 HibernateRTCMatch1Set
Sets the value of the RTC match 1 register. Prototype: void HibernateRTCMatch1Set(unsigned long ulMatch) Parameters: ulMatch is the value for the match register. Description: Sets the match 1 register for the RTC. The Hibernation module can be congured to wake from hibernation, and/or generate an interrupt when the value of the RTC counter is the same as the match register.

October 30, 2008

107

Hibernation Module

Returns: None.

9.2.2.23 HibernateRTCSet
Sets the value of the real time clock (RTC) counter. Prototype: void HibernateRTCSet(unsigned long ulRTCValue) Parameters: ulRTCValue is the new value for the RTC. Description: Sets the value of the RTC. The RTC will count seconds if the hardware is congured correctly. The RTC must be enabled by calling HibernateRTCEnable() before calling this function. Returns: None.

9.2.2.24 HibernateRTCTrimGet
Gets the value of the RTC predivider trim register. Prototype: unsigned long HibernateRTCTrimGet(void) Description: Gets the value of the pre-divider trim register. This function can be used to get the current value of the trim register prior to making an adjustment by using the HibernateRTCTrimSet() function. Returns: None.

9.2.2.25 HibernateRTCTrimSet
Sets the value of the RTC predivider trim register. Prototype: void HibernateRTCTrimSet(unsigned long ulTrim) Parameters: ulTrim is the new value for the pre-divider trim register.

108

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: Sets the value of the pre-divider trim register. The input time source is divided by the predivider to achieve a one-second clock rate. Once every 64 seconds, the value of the pre-divider trim register is applied to the predivider to allow ne-tuning of the RTC rate, in order to make corrections to the rate. The software application can make adjustments to the predivider trim register to account for variations in the accuracy of the input time source. The nominal value is 0x7FFF, and it can be adjusted up or down in order to ne-tune the RTC rate. Returns: None.

9.2.2.26 HibernateWakeGet
Gets the currently congured wake conditions for the Hibernation module. Prototype: unsigned long HibernateWakeGet(void) Description: Returns the ags representing the wake conguration for the Hibernation module. The return value will be a combination of the following ags: HIBERNATE_WAKE_PIN - wake when the external wake pin is asserted. HIBERNATE_WAKE_RTC - wake when one of the RTC matches occurs. Returns: Returns ags indicating the congured wake conditions.

9.2.2.27 HibernateWakeSet
Congures the wake conditions for the Hibernation module. Prototype: void HibernateWakeSet(unsigned long ulWakeFlags) Parameters: ulWakeFlags species which conditions should be used for waking. Description: Enables the conditions under which the Hibernation module will wake. The ulWakeFlags parameter is the logical OR of any combination of the following: HIBERNATE_WAKE_PIN - wake when the external wake pin is asserted. HIBERNATE_WAKE_RTC - wake when one of the RTC matches occurs. Returns: None.

October 30, 2008

109

Hibernation Module

9.3

Programming Example
The following example shows how to determine if the processor reset is due to a wake from hibernation, and to restore saved state:
unsigned long ulStatus; unsigned long ulNVData[64]; // // Need to enable the hibernation peripheral after wake/reset, before using // it. // SysCtlPeripheralEnable(SYSCTL_PERIPH_HIBERNATE); // // Determine if the Hibernation module is active. // if(HibernateIsActive()) { // // Read the status to determine cause of wake. // ulStatus = HibernateIntStatus(false); // // Test the status bits to see the cause. // if(ulStatus & HIBERNATE_INT_PIN_WAKE) { // // Wakeup was due to WAKE pin assertion. // } if(ulStatus & HIBERNATE_INT_RTC_MATCH_0) { // // Wakeup was due to RTC match0 register. // } // // Restore program state information that was saved prior to // hibernation. // HibernateDataGet(ulNVData, 64); // // Now that wakeup cause has been determined and state has been // restored, the program can proceed with normal processor and // peripheral initialization. // } // // Hibernation module was not active so this is a cold power-up/reset. // else { // // Perform normal power-on initialization. // }

110

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

The following example shows how to set up the Hibernation module and initiate a hibernation with wake up at a future time:
unsigned long ulStatus; unsigned long ulNVData[64]; // // Need to enable the hibernation peripheral before using it. // SysCtlPeripheralEnable(SYSCTL_PERIPH_HIBERNATE); // // Enable clocking to the Hibernation module. // HibernateEnableExpClk(SysCtlClockGet()); // // User-implemented delay here to allow crystal to power up and stabilize. // // // Configure the clock source for Hibernation module, and enable the RTC // feature. This configuration is for a 4.194304 MHz crystal. // HibernateClockSelect(HIBERNATE_CLOCK_SEL_DIV128); HibernateRTCEnable(); // // Set the RTC to 0, or an initial value. The RTC can be set once when the // system is initialized after the cold-startup, and then left to run. Or // it can be initialized before every hibernate. // HibernateRTCSet(0); // // Set the match 0 register for 30 seconds from now. // HibernateRTCMatch0Set(HibernateRTCGet() + 30); // // Clear any pending status. // ulStatus = HibernateIntStatus(0); HibernateIntClear(ulStatus); // // Save the program state information. The state information will be // stored in the ulNVData[] array. It is not necessary to save the full 64 // words of data, only as much as is actually needed by the program. // HibernateDataSet(ulNVData, 64); // // Configure to wake on RTC match. // HibernateWakeSet(HIBERNATE_WAKE_RTC); // // Request hibernation. The following call may return since it takes a // finite amount of time for power to be removed. // HibernateRequest(); // // Need a loop here to wait for the power to be removed. // removed while executing in this loop.

Power will be

October 30, 2008

111

Hibernation Module

// for(;;) { }

The following example shows how to use the Hibernation module RTC to generate an interrupt at a certain time:
// // Handler for hibernate interrupts. // void HibernateHandler(void) { unsigned long ulStatus; // // Get the interrupt status, and clear any pending interrupts. // ulStatus = HibernateIntStatus(1); HibernateIntClear(ulStatus); // // Process the RTC match 0 interrupt. // if(ulStatus & HIBERNATE_INT_RTC_MATCH_0) { // // RTC match 0 interrupt actions go here. // } } // // Main function. // int main(void) { // // System initialization code ... // // // Enable the Hibernation module. // SysCtlPeripheralEnable(SYSCTL_PERIPH_HIBERNATE); HibernateEnableExpClk(SysCtlClockGet()); // // Wait an amount of time for the module to power up. // // // Configure the clock source for Hibernation module, and enable the // RTC feature. This configuration is for the 4.194304 MHz crystal. // HibernateClockSelect(HIBERNATE_CLOCK_SEL_DIV128); HibernateRTCEnable(); // // Set the RTC to an initial value. // HibernateRTCSet(0);

112

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

// // Set Match 0 for 30 seconds from now. // HibernateRTCMatch0Set(HibernateRTCGet() + 30); // // Set up interrupts on the Hibernation module to enable the RTC match // 0 interrupt. Clear all pending interrupts and register the // interrupt handler. // HibernateIntEnable(HIBERNATE_INT_RTC_MATCH_0); HibernateIntClear(HIBERNATE_INT_PIN_WAKE | HIBERNATE_INT_LOW_BAT | HIBERNATE_INT_RTC_MATCH_0 | HIBERNATE_INT_RTC_MATCH_1); HibernateIntRegister(HibernateHandler); // // Hibernate handler (above) will now be invoked in 30 seconds. // // ...

October 30, 2008

113

Hibernation Module

114

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

10

Inter-Integrated Circuit (I2C)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130

10.1

Introduction
The Inter-Integrated Circuit (I2C) API provides a set of functions for using the Stellaris I2C master and slave modules. Functions are provided to initialize the I2C modules, to send and receive data, obtain status, and to manage interrupts for the I2C modules. The I2C master and slave modules provide the ability to communicate to other IC devices over an I2C bus. The I2C bus is specied to support devices that can both transmit and receive (write and read) data. Also, devices on the I2C bus can be designated as either a master or a slave. The Stellaris I2C modules support both sending and receiving data as either a master or a slave, and also support the simultaneous operation as both a master and a slave. Finally, the Stellaris I2C modules can operate at two speeds: Standard (100 kb/s) and Fast (400 kb/s). Both the master and slave I2C modules can generate interrupts. The I2C master module will generate interrupts when a transmit or receive operation is completed (or aborted due to an error). The I2C slave module will generate interrupts when data has been sent or requested by a master.

10.1.1 Master Operations

When using this API to drive the I2C master module, the user must rst initialize the I2C master module with a call to I2CMasterInitExpClk(). That function will set the bus speed and enable the master module. The user may transmit or receive data after the successful initialization of the I2C master module. Data is transferred by rst setting the slave address using I2CMasterSlaveAddrSet(). That function is also used to dene whether the transfer is a send (a write to the slave from the master) or a receive (a read from the slave by the master). Then, if connected to an I2C bus that has multiple masters, the Stellaris I2C master must rst call I2CMasterBusBusy() before attempting to initiate the desired transaction. After determining that the bus is not busy, if trying to send data, the user must call the I2CMasterDataPut() function. The transaction can then be initiated on the bus by calling the I2CMasterControl() function with any of the following commands: I2C_MASTER_CMD_SINGLE_SEND I2C_MASTER_CMD_SINGLE_RECEIVE I2C_MASTER_CMD_BURST_SEND_START I2C_MASTER_CMD_BURST_RECEIVE_START Any of those commands will result in the master arbitrating for the bus, driving the start sequence onto the bus, and sending the slave address and direction bit across the bus. The remainder of the transaction can then be driven using either a polling or interrupt-driven method. For the single send and receive cases, the polling method will involve looping on the return from I2CMasterBusy(). Once that function indicates that the I2C master is no longer busy, the bus transaction has been completed and can be checked for errors using I2CMasterErr(). If there are no

October 30, 2008

115

Inter-Integrated Circuit (I2C)

errors, then the data has been sent or is ready to be read using I2CMasterDataGet(). For the burst send and receive cases, the polling method also involves calling the I2CMasterControl() function for each byte transmitted or received (using either the I2C_MASTER_CMD_BURST_SEND_CONT or I2C_MASTER_CMD_BURST_RECEIVE_CONT commands), and for the last byte sent or received (using either the I2C_MASTER_CMD_BURST_SEND_FINISH or I2C_MASTER_CMD_BURST_RECEIVE_FINISH commands). If any error is detected during the burst transfer, the I2CMasterControl() function should be called using the appropriate stop command (I2C_MASTER_CMD_BURST_SEND_ERROR_STOP or I2C_MASTER_CMD_BURST_RECEIVE_ERROR_STOP). For the interrupt-driven transaction, the user must register an interrupt handler for the I2C devices and enable the I2C master interrupt; the interrupt will occur when the master is no longer busy.

10.1.2 Slave Operations

When using this API to drive the I2C slave module, the user must rst initialize the I2C slave module with a call to I2CSlaveInit(). This will enable the I2C slave module and initialize the slaves own address. After the initialization is complete, the user may poll the slave status using I2CSlaveStatus() to determine if a master requested a send or receive operation. Depending on the type of operation requested, the user can call I2CSlaveDataPut() or I2CSlaveDataGet() to complete the transaction. Alternatively, the I2C slave can handle transactions using an interrupt handler registered with I2CIntRegister(), and by enabling the I2C slave interrupt. This driver is contained in driverlib/i2c.c, with driverlib/i2c.h containing the API denitions for use by applications.

10.2

API Functions
Functions
void I2CIntRegister (unsigned long ulBase, void (pfnHandler)(void)) void I2CIntUnregister (unsigned long ulBase) tBoolean I2CMasterBusBusy (unsigned long ulBase) tBoolean I2CMasterBusy (unsigned long ulBase) void I2CMasterControl (unsigned long ulBase, unsigned long ulCmd) unsigned long I2CMasterDataGet (unsigned long ulBase) void I2CMasterDataPut (unsigned long ulBase, unsigned char ucData) void I2CMasterDisable (unsigned long ulBase) void I2CMasterEnable (unsigned long ulBase) unsigned long I2CMasterErr (unsigned long ulBase) void I2CMasterInitExpClk (unsigned long ulBase, unsigned long ulI2CClk, tBoolean bFast) void I2CMasterIntClear (unsigned long ulBase) void I2CMasterIntDisable (unsigned long ulBase) void I2CMasterIntEnable (unsigned long ulBase) tBoolean I2CMasterIntStatus (unsigned long ulBase, tBoolean bMasked) void I2CMasterSlaveAddrSet (unsigned long ulBase, unsigned char ucSlaveAddr, tBoolean bReceive)

116

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

unsigned long I2CSlaveDataGet (unsigned long ulBase) void I2CSlaveDataPut (unsigned long ulBase, unsigned char ucData) void I2CSlaveDisable (unsigned long ulBase) void I2CSlaveEnable (unsigned long ulBase) void I2CSlaveInit (unsigned long ulBase, unsigned char ucSlaveAddr) void I2CSlaveIntClear (unsigned long ulBase) void I2CSlaveIntClearEx (unsigned long ulBase, unsigned long ulIntFlags) void I2CSlaveIntDisable (unsigned long ulBase) void I2CSlaveIntDisableEx (unsigned long ulBase, unsigned long ulIntFlags) void I2CSlaveIntEnable (unsigned long ulBase) void I2CSlaveIntEnableEx (unsigned long ulBase, unsigned long ulIntFlags) tBoolean I2CSlaveIntStatus (unsigned long ulBase, tBoolean bMasked) unsigned long I2CSlaveIntStatusEx (unsigned long ulBase, tBoolean bMasked) unsigned long I2CSlaveStatus (unsigned long ulBase)

10.2.1 Detailed Description

The I2C API is broken into three groups of functions: those that deal with interrupts, those that handle status and initialization, and those that deal with sending and receiving data. The I2C master and slave interrupts are handled by the I2CIntRegister(), I2CIntUnregister(), I2CMasterIntEnable(), I2CMasterIntDisable(), I2CMasterIntClear(), I2CMasterIntStatus(), I2CSlaveIntEnable(), I2CSlaveIntDisable(), I2CSlaveIntClear(), I2CSlaveIntStatus(), I2CSlaveIntEnableEx(), I2CSlaveIntDisableEx(), I2CSlaveIntClearEx(), and I2CSlaveIntStatusEx() functions. Status and initialization functions for the I2C modules are I2CMasterInitExpClk(), I2CMasterEnable(), I2CMasterDisable(), I2CMasterBusBusy(), I2CMasterBusy(), I2CMasterErr(), I2CSlaveInit(), I2CSlaveEnable(), I2CSlaveDisable(), and I2CSlaveStatus(). Sending and receiving data from the I2C modules are handled by the I2CMasterSlaveAddrSet(), I2CMasterControl(), I2CMasterDataGet(), I2CMasterDataPut(), I2CSlaveDataGet(), and I2CSlaveDataPut() functions. The I2CMasterInit() API from previous versions of the peripheral driver library has been replaced by the I2CMasterInitExpClk() API. A macro has been provided in i2c.h to map the old API to the new API, allowing existing applications to link and run with the new API. It is recommended that new applications utilize the new API in favor of the old one.

10.2.2 Function Documentation

10.2.2.1 I2CIntRegister
Registers an interrupt handler for the I2C module. Prototype: void I2CIntRegister(unsigned long ulBase, void (*pfnHandler)(void))

October 30, 2008

117

Inter-Integrated Circuit (I2C)

Parameters: ulBase is the base address of the I2C Master module. pfnHandler is a pointer to the function to be called when the I2C interrupt occurs. Description: This sets the handler to be called when an I2C interrupt occurs. This will enable the global interrupt in the interrupt controller; specic I2C interrupts must be enabled via I2CMasterIntEnable() and I2CSlaveIntEnable(). If necessary, it is the interrupt handlers responsibility to clear the interrupt source via I2CMasterIntClear() and I2CSlaveIntClear(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

10.2.2.2 I2CIntUnregister
Unregisters an interrupt handler for the I2C module. Prototype: void I2CIntUnregister(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: This function will clear the handler to be called when an I2C interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

10.2.2.3 I2CMasterBusBusy
Indicates whether or not the I2C bus is busy. Prototype: tBoolean I2CMasterBusBusy(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: This function returns an indication of whether or not the I2C bus is busy. This function can be used in a multi-master environment to determine if another master is currently using the bus.

118

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Returns: Returns true if the I2C bus is busy; otherwise, returns false.

10.2.2.4 I2CMasterBusy
Indicates whether or not the I2C Master is busy. Prototype: tBoolean I2CMasterBusy(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: This function returns an indication of whether or not the I2C Master is busy transmitting or receiving data. Returns: Returns true if the I2C Master is busy; otherwise, returns false.

10.2.2.5 I2CMasterControl
Controls the state of the I2C Master module. Prototype: void I2CMasterControl(unsigned long ulBase, unsigned long ulCmd) Parameters: ulBase is the base address of the I2C Master module. ulCmd command to be issued to the I2C Master module Description: This function is used to control the state of the Master module send and receive operations. The ucCmd parameter can be one of the following values: I2C_MASTER_CMD_SINGLE_SEND I2C_MASTER_CMD_SINGLE_RECEIVE I2C_MASTER_CMD_BURST_SEND_START I2C_MASTER_CMD_BURST_SEND_CONT I2C_MASTER_CMD_BURST_SEND_FINISH I2C_MASTER_CMD_BURST_SEND_ERROR_STOP I2C_MASTER_CMD_BURST_RECEIVE_START I2C_MASTER_CMD_BURST_RECEIVE_CONT I2C_MASTER_CMD_BURST_RECEIVE_FINISH I2C_MASTER_CMD_BURST_RECEIVE_ERROR_STOP Returns: None.

October 30, 2008

119

Inter-Integrated Circuit (I2C)

10.2.2.6 I2CMasterDataGet
Receives a byte that has been sent to the I2C Master. Prototype: unsigned long I2CMasterDataGet(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: This function reads a byte of data from the I2C Master Data Register. Returns: Returns the byte received from by the I2C Master, cast as an unsigned long.

10.2.2.7 I2CMasterDataPut
Transmits a byte from the I2C Master. Prototype: void I2CMasterDataPut(unsigned long ulBase, unsigned char ucData) Parameters: ulBase is the base address of the I2C Master module. ucData data to be transmitted from the I2C Master Description: This function will place the supplied data into I2C Master Data Register. Returns: None.

10.2.2.8 I2CMasterDisable
Disables the I2C master block. Prototype: void I2CMasterDisable(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: This will disable operation of the I2C master block. Returns: None.

120

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

10.2.2.9 I2CMasterEnable
Enables the I2C Master block. Prototype: void I2CMasterEnable(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: This will enable operation of the I2C Master block. Returns: None.

10.2.2.10 I2CMasterErr
Gets the error status of the I2C Master module. Prototype: unsigned long I2CMasterErr(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: This function is used to obtain the error status of the Master module send and receive operations. Returns: Returns the error status, I2C_MASTER_ERR_ADDR_ACK, I2C_MASTER_ERR_ARB_LOST. as one of I2C_MASTER_ERR_NONE, I2C_MASTER_ERR_DATA_ACK, or

10.2.2.11 I2CMasterInitExpClk
Initializes the I2C Master block. Prototype: void I2CMasterInitExpClk(unsigned long ulBase, unsigned long ulI2CClk, tBoolean bFast) Parameters: ulBase is the base address of the I2C Master module. ulI2CClk is the rate of the clock supplied to the I2C module. bFast set up for fast data transfers

October 30, 2008

121

Inter-Integrated Circuit (I2C)

Description: This function initializes operation of the I2C Master block. Upon successful initialization of the I2C block, this function will have set the bus speed for the master, and will have enabled the I2C Master block. If the parameter bFast is true, then the master block will be set up to transfer data at 400 kbps; otherwise, it will be set up to transfer data at 100 kbps. The peripheral clock will be the same as the processor clock. This will be the value returned by SysCtlClockGet(), or it can be explicitly hard coded if it is constant and known (to save the code/execution overhead of a call to SysCtlClockGet()). This function replaces the original I2CMasterInit() API and performs the same actions. A macro is provided in i2c.h to map the original API to this API. Returns: None.

10.2.2.12 I2CMasterIntClear
Clears I2C Master interrupt sources. Prototype: void I2CMasterIntClear(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: The I2C Master interrupt source is cleared, so that it no longer asserts. This must be done in the interrupt handler to keep it from being called again immediately upon exit. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

10.2.2.13 I2CMasterIntDisable
Disables the I2C Master interrupt. Prototype: void I2CMasterIntDisable(unsigned long ulBase)

122

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase is the base address of the I2C Master module. Description: Disables the I2C Master interrupt source. Returns: None.

10.2.2.14 I2CMasterIntEnable
Enables the I2C Master interrupt. Prototype: void I2CMasterIntEnable(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Master module. Description: Enables the I2C Master interrupt source. Returns: None.

10.2.2.15 I2CMasterIntStatus
Gets the current I2C Master interrupt status. Prototype: tBoolean I2CMasterIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the I2C Master module. bMasked is false if the raw interrupt status is requested and true if the masked interrupt status is requested. Description: This returns the interrupt status for the I2C Master module. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: The current interrupt status, returned as true if active or false if not active.

October 30, 2008

123

Inter-Integrated Circuit (I2C)

10.2.2.16 I2CMasterSlaveAddrSet
Sets the address that the I2C Master will place on the bus. Prototype: void I2CMasterSlaveAddrSet(unsigned long ulBase, unsigned char ucSlaveAddr, tBoolean bReceive) Parameters: ulBase is the base address of the I2C Master module. ucSlaveAddr 7-bit slave address bReceive ag indicating the type of communication with the slave Description: This function will set the address that the I2C Master will place on the bus when initiating a transaction. When the bReceive parameter is set to true, the address will indicate that the I2C Master is initiating a read from the slave; otherwise the address will indicate that the I2C Master is initiating a write to the slave. Returns: None.

10.2.2.17 I2CSlaveDataGet
Receives a byte that has been sent to the I2C Slave. Prototype: unsigned long I2CSlaveDataGet(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Slave module. Description: This function reads a byte of data from the I2C Slave Data Register. Returns: Returns the byte received from by the I2C Slave, cast as an unsigned long.

10.2.2.18 I2CSlaveDataPut
Transmits a byte from the I2C Slave. Prototype: void I2CSlaveDataPut(unsigned long ulBase, unsigned char ucData)

124

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase is the base address of the I2C Slave module. ucData data to be transmitted from the I2C Slave Description: This function will place the supplied data into I2C Slave Data Register. Returns: None.

10.2.2.19 I2CSlaveDisable
Disables the I2C slave block. Prototype: void I2CSlaveDisable(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Slave module. Description: This will disable operation of the I2C slave block. Returns: None.

10.2.2.20 I2CSlaveEnable
Enables the I2C Slave block. Prototype: void I2CSlaveEnable(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Slave module. Description: This will enable operation of the I2C Slave block. Returns: None.

10.2.2.21 I2CSlaveInit
Initializes the I2C Slave block. Prototype: void I2CSlaveInit(unsigned long ulBase, unsigned char ucSlaveAddr)

October 30, 2008

125

Inter-Integrated Circuit (I2C)

Parameters: ulBase is the base address of the I2C Slave module. ucSlaveAddr 7-bit slave address Description: This function initializes operation of the I2C Slave block. Upon successful initialization of the I2C blocks, this function will have set the slave address and have enabled the I2C Slave block. The parameter ucSlaveAddr is the value that will be compared against the slave address sent by an I2C master. Returns: None.

10.2.2.22 I2CSlaveIntClear
Clears I2C Slave interrupt sources. Prototype: void I2CSlaveIntClear(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Slave module. Description: The I2C Slave interrupt source is cleared, so that it no longer asserts. This must be done in the interrupt handler to keep it from being called again immediately upon exit. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

10.2.2.23 I2CSlaveIntClearEx
Clears I2C Slave interrupt sources. Prototype: void I2CSlaveIntClearEx(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the I2C Slave module. ulIntFlags is a bit mask of the interrupt sources to be cleared.

126

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: The specied I2C Slave interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to I2CSlaveIntEnableEx(). Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

10.2.2.24 I2CSlaveIntDisable
Disables the I2C Slave interrupt. Prototype: void I2CSlaveIntDisable(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Slave module. Description: Disables the I2C Slave interrupt source. Returns: None.

10.2.2.25 I2CSlaveIntDisableEx
Disables individual I2C Slave interrupt sources. Prototype: void I2CSlaveIntDisableEx(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the I2C Slave module. ulIntFlags is the bit mask of the interrupt sources to be disabled. Description: Disables the indicated I2C Slave interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor.

October 30, 2008

127

Inter-Integrated Circuit (I2C)

The ulIntFlags parameter has the same denition as the ulIntFlags parameter to I2CSlaveIntEnableEx(). Returns: None.

10.2.2.26 I2CSlaveIntEnable
Enables the I2C Slave interrupt. Prototype: void I2CSlaveIntEnable(unsigned long ulBase) Parameters: ulBase is the base address of the I2C Slave module. Description: Enables the I2C Slave interrupt source. Returns: None.

10.2.2.27 I2CSlaveIntEnableEx
Enables individual I2C Slave interrupt sources. Prototype: void I2CSlaveIntEnableEx(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the I2C Slave module. ulIntFlags is the bit mask of the interrupt sources to be enabled. Description: Enables the indicated I2C Slave interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter is the logical OR of any of the following: I2C_SLAVE_INT_STOP - Stop condition detected interrupt I2C_SLAVE_INT_START - Start condition detected interrupt I2C_SLAVE_INT_DATA - Data interrupt Returns: None.

128

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

10.2.2.28 I2CSlaveIntStatus
Gets the current I2C Slave interrupt status. Prototype: tBoolean I2CSlaveIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the I2C Slave module. bMasked is false if the raw interrupt status is requested and true if the masked interrupt status is requested. Description: This returns the interrupt status for the I2C Slave module. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: The current interrupt status, returned as true if active or false if not active.

10.2.2.29 I2CSlaveIntStatusEx
Gets the current I2C Slave interrupt status. Prototype: unsigned long I2CSlaveIntStatusEx(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the I2C Slave module. bMasked is false if the raw interrupt status is requested and true if the masked interrupt status is requested. Description: This returns the interrupt status for the I2C Slave module. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: Returns the current interrupt status, enumerated as a bit eld of values described in I2CSlaveIntEnableEx().

10.2.2.30 I2CSlaveStatus
Gets the I2C Slave module status Prototype: unsigned long I2CSlaveStatus(unsigned long ulBase)

October 30, 2008

129

Inter-Integrated Circuit (I2C)

Parameters: ulBase is the base address of the I2C Slave module. Description: This function will return the action requested from a master, if any. Possible values are: I2C_SLAVE_ACT_NONE I2C_SLAVE_ACT_RREQ I2C_SLAVE_ACT_TREQ I2C_SLAVE_ACT_RREQ_FBR Returns: Returns I2C_SLAVE_ACT_NONE to indicate that no action has been requested of the I2C Slave module, I2C_SLAVE_ACT_RREQ to indicate that an I2C master has sent data to the I2C Slave module, I2C_SLAVE_ACT_TREQ to indicate that an I2C master has requested that the I2C Slave module send data, and I2C_SLAVE_ACT_RREQ_FBR to indicate that an I2C master has sent data to the I2C slave and the rst byte following the slaves own address has been received.

10.3

Programming Example
The following example shows how to use the I2C API to send data as a master.
// // Initialize Master and Slave // I2CMasterInitExpClk(I2C_MASTER_BASE, SysCtlClockGet(), true); // // Specify slave address // I2CMasterSlaveAddrSet(I2C_MASTER_BASE, 0x3B, false); // // Place the character to be sent in the data register // I2CMasterDataPut(I2C_MASTER_BASE, Q); // // Initiate send of character from Master to Slave // I2CMasterControl(I2C_MASTER_BASE, I2C_MASTER_CMD_SINGLE_SEND); // // Delay until transmission completes // while(I2CMasterBusBusy(I2C_MASTER_BASE)) { }

130

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

11

Interrupt Controller (NVIC)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137

11.1

Introduction
The interrupt controller API provides a set of functions for dealing with the Nested Vectored Interrupt Controller (NVIC). Functions are provided to enable and disable interrupts, register interrupt handlers, and set the priority of interrupts. The NVIC provides global interrupt masking, prioritization, and handler dispatching. This version of the Stellaris family supports thirty-two interrupt sources and eight priority levels. Individual interrupt sources can be masked, and the processor interrupt can be globally masked as well (without affecting the individual source masks). The NVIC is tightly coupled with the Cortex-M3 microprocessor. When the processor responds to an interrupt, NVIC will supply the address of the function to handle the interrupt directly to the processor. This eliminates the need for a global interrupt handler that queries the interrupt controller to determine the cause of the interrupt and branch to the appropriate handler, reducing interrupt response time. The interrupt prioritization in the NVIC allows higher priority interrupts to be handled before lower priority interrupts, as well as allowing preemption of lower priority interrupt handlers by higher priority interrupts. Again, this helps reduce interrupt response time (for example, a 1 ms system control interrupt is not held off by the execution of a lower priority 1 second housekeeping interrupt handler). Sub-prioritization is also possible; instead of having N bits of preemptable prioritization, NVIC can be congured (via software) for N - M bits of preemptable prioritization and M bits of subpriority. In this scheme, two interrupts with the same preemptable prioritization but different subpriorities will not cause a preemption; tail chaining will instead be used to process the two interrupts back-toback. If two interrupts with the same priority (and subpriority if so congured) are asserted at the same time, the one with the lower interrupt number will be processed rst. NVIC keeps track of the nesting of interrupt handlers, allowing the processor to return from interrupt context only once all nested and pending interrupts have been handled. Interrupt handlers can be congured in one of two ways; statically at compile time or dynamically at run time. Static conguration of interrupt handlers is accomplished by editing the interrupt handler table in the applications startup code. When statically congured, the interrupts must be explicitly enabled in NVIC via IntEnable() before the processor will respond to the interrupt (in addition to any interrupt enabling required within the peripheral itself). Alternatively, interrupts can be congured at run-time using IntRegister() (or the analog in each individual driver). When using IntRegister(), the interrupt must also be enabled as before; when using the analogue in each individual driver, IntEnable() is called by the driver and does not need to be call by the application. Run-time conguration of interrupt handlers requires that the interrupt handler table be placed on a 1 kB boundary in SRAM (typically this would be at the beginning of SRAM). Failure to do so will result in an incorrect vector address being fetched in response to an interrupt. The vector table is

October 30, 2008

131

Interrupt Controller (NVIC)

in a section called vtable and should be placed appropriately with a linker script. Tools that do not support linker scripts (such as the evaluation version of RV-MDK) therefore do not support run-time conguration of interrupt handlers (though the full version of RV-MDK does). This driver is contained in driverlib/interrupt.c, with driverlib/interrupt.h containing the API denitions for use by applications.

11.2

API Functions
Functions
void IntDisable (unsigned long ulInterrupt) void IntEnable (unsigned long ulInterrupt) tBoolean IntMasterDisable (void) tBoolean IntMasterEnable (void) long IntPriorityGet (unsigned long ulInterrupt) unsigned long IntPriorityGroupingGet (void) void IntPriorityGroupingSet (unsigned long ulBits) void IntPrioritySet (unsigned long ulInterrupt, unsigned char ucPriority) void IntRegister (unsigned long ulInterrupt, void (pfnHandler)(void)) void IntUnregister (unsigned long ulInterrupt)

11.2.1 Detailed Description

The primary function of the interrupt controller API is to manage the interrupt vector table used by the NVIC to dispatch interrupt requests. Registering an interrupt handler is a simple matter of inserting the handler address into the table. By default, the table is lled with pointers to an internal handler that loops forever; it is an error for an interrupt to occur when there is no interrupt handler registered to process it. Therefore, interrupt sources should not be enabled before a handler has been registered, and interrupt sources should be disabled before a handler is unregistered. Interrupt handlers are managed with IntRegister() and IntUnregister(). Each interrupt source can be individually enabled and disabled via IntEnable() and IntDisable(). The processor interrupt can be enabled and disabled via IntMasterEnable() and IntMasterDisable(); this does not affect the individual interrupt enable states. Masking of the processor interrupt can be utilized as a simple critical section (only NMI will interrupt the processor while the processor interrupt is disabled), though this will have adverse effects on the interrupt response time. The priority of each interrupt source can be set and examined via IntPrioritySet() and IntPriorityGet(). The priority assignments are dened by the hardware; the upper N bits of the 8-bit priority are examined to determine the priority of an interrupt (for the Stellaris family, N is 3). This allows priorities to be dened without a real need to know the exact number of supported priorities; moving to a device with more or fewer priority bits will continue to treat the interrupt source with a similar level of priority. Smaller priority numbers correspond to higher interrupt priority, so 0 is the highest priority.

132

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

11.2.2 Function Documentation

11.2.2.1 IntDisable
Disables an interrupt. Prototype: void IntDisable(unsigned long ulInterrupt) Parameters: ulInterrupt species the interrupt to be disabled. Description: The specied interrupt is disabled in the interrupt controller. Other enables for the interrupt (such as at the peripheral level) are unaffected by this function. Returns: None.

11.2.2.2 IntEnable
Enables an interrupt. Prototype: void IntEnable(unsigned long ulInterrupt) Parameters: ulInterrupt species the interrupt to be enabled. Description: The specied interrupt is enabled in the interrupt controller. Other enables for the interrupt (such as at the peripheral level) are unaffected by this function. Returns: None.

11.2.2.3 IntMasterDisable
Disables the processor interrupt. Prototype: tBoolean IntMasterDisable(void) Description: Prevents the processor from receiving interrupts. This does not affect the set of interrupts enabled in the interrupt controller; it just gates the single interrupt from the controller to the processor.

October 30, 2008

133

Interrupt Controller (NVIC)

Note: Previously, this function had no return value. As such, it was possible to include interrupt.h and call this function without having included hw_types.h. Now that the return is a tBoolean, a compiler error will occur in this case. The solution is to include hw_types.h before including interrupt.h. Returns: Returns true if interrupts were already disabled when the function was called or false if they were initially enabled.

11.2.2.4 IntMasterEnable
Enables the processor interrupt. Prototype: tBoolean IntMasterEnable(void) Description: Allows the processor to respond to interrupts. This does not affect the set of interrupts enabled in the interrupt controller; it just gates the single interrupt from the controller to the processor. Note: Previously, this function had no return value. As such, it was possible to include interrupt.h and call this function without having included hw_types.h. Now that the return is a tBoolean, a compiler error will occur in this case. The solution is to include hw_types.h before including interrupt.h. Returns: Returns true if interrupts were disabled when the function was called or false if they were initially enabled.

11.2.2.5 IntPriorityGet
Gets the priority of an interrupt. Prototype: long IntPriorityGet(unsigned long ulInterrupt) Parameters: ulInterrupt species the interrupt in question. Description: This function gets the priority of an interrupt. See IntPrioritySet() for a denition of the priority value. Returns: Returns the interrupt priority, or -1 if an invalid interrupt was specied.

134

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

11.2.2.6 IntPriorityGroupingGet
Gets the priority grouping of the interrupt controller. Prototype: unsigned long IntPriorityGroupingGet(void) Description: This function returns the split between preemptable priority levels and subpriority levels in the interrupt priority specication. Returns: The number of bits of preemptable priority.

11.2.2.7 IntPriorityGroupingSet
Sets the priority grouping of the interrupt controller. Prototype: void IntPriorityGroupingSet(unsigned long ulBits) Parameters: ulBits species the number of bits of preemptable priority. Description: This function species the split between preemptable priority levels and subpriority levels in the interrupt priority specication. The range of the grouping values are dependent upon the hardware implementation; on the Stellaris family, three bits are available for hardware interrupt prioritization and therefore priority grouping values of three through seven have the same effect. Returns: None.

11.2.2.8 IntPrioritySet
Sets the priority of an interrupt. Prototype: void IntPrioritySet(unsigned long ulInterrupt, unsigned char ucPriority) Parameters: ulInterrupt species the interrupt in question. ucPriority species the priority of the interrupt.

October 30, 2008

135

Interrupt Controller (NVIC)

Description: This function is used to set the priority of an interrupt. When multiple interrupts are asserted simultaneously, the ones with the highest priority are processed before the lower priority interrupts. Smaller numbers correspond to higher interrupt priorities; priority 0 is the highest interrupt priority. The hardware priority mechanism will only look at the upper N bits of the priority level (where N is 3 for the Stellaris family), so any prioritization must be performed in those bits. The remaining bits can be used to sub-prioritize the interrupt sources, and may be used by the hardware priority mechanism on a future part. This arrangement allows priorities to migrate to different NVIC implementations without changing the gross prioritization of the interrupts. Returns: None.

11.2.2.9 IntRegister
Registers a function to be called when an interrupt occurs. Prototype: void IntRegister(unsigned long ulInterrupt, void (*pfnHandler)(void)) Parameters: ulInterrupt species the interrupt in question. pfnHandler is a pointer to the function to be called. Description: This function is used to specify the handler function to be called when the given interrupt is asserted to the processor. When the interrupt occurs, if it is enabled (via IntEnable()), the handler function will be called in interrupt context. Since the handler function can preempt other code, care must be taken to protect memory or peripherals that are accessed by the handler and other non-handler code. Note: The use of this function (directly or indirectly via a peripheral driver interrupt register function) moves the interrupt vector table from ash to SRAM. Therefore, care must be taken when linking the application to ensure that the SRAM vector table is located at the beginning of SRAM; otherwise NVIC will not look in the correct portion of memory for the vector table (it requires the vector table be on a 1 kB memory alignment). Normally, the SRAM vector table is so placed via the use of linker scripts; some tool chains, such as the evaluation version of RV-MDK, do not support linker scripts and therefore will not produce a valid executable. See the discussion of compile-time versus run-time interrupt handler registration in the introduction to this chapter. Returns: None.

11.2.2.10 IntUnregister
Unregisters the function to be called when an interrupt occurs.

136

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void IntUnregister(unsigned long ulInterrupt) Parameters: ulInterrupt species the interrupt in question. Description: This function is used to indicate that no handler should be called when the given interrupt is asserted to the processor. The interrupt source will be automatically disabled (via IntDisable()) if necessary. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

11.3

Programming Example
The following example shows how to use the Interrupt Controller API to register an interrupt handler and enable the interrupt.
// // The interrupt handler function. // extern void IntHandler(void); // // Register the interrupt handler function for interrupt 5. // IntRegister(5, IntHandler); // // Enable interrupt 5. // IntEnable(5); // // Enable interrupt 5. // IntMasterEnable();

October 30, 2008

137

Interrupt Controller (NVIC)

138

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

12

Memory Protection Unit (MPU)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146

12.1

Introduction
The Memory Protection Unit (MPU) API provides functions to congure the MPU. The MPU is tightly coupled to the Cortex-M3 processor core and provides a means to establish access permissions on regions of memory. Up to eight memory regions can be dened. Each region has a base address and a size. The size is specied as a power of 2 between 32 bytes and 4 GB, inclusive. The regions base address must be aligned to the size of the region. Each region also has access permissions. Code execution can be allowed or disallowed for a region. A region can be set for read-only access, read/write access, or no access for both privileged and user modes. This can be used to set up an environment where only kernel or system code can access certain hardware registers or sections of code. The MPU creates 8 sub-regions within each region. Any sub-region or combination of sub-regions can be disabled, allowing creation of holes or complex overlaying regions with different permissions. The sub-regions can also be used to create an unaligned beginning or ending of a region by disabling one or more of the leading or trailing sub-regions. Once the regions are dened and the MPU is enabled, any access violation of a region will cause a memory management fault, and the fault handler will be activated. This driver is contained in driverlib/mpu.c, with driverlib/mpu.h containing the API denitions for use by applications.

12.2

API Functions
Functions
void MPUDisable (void) void MPUEnable (unsigned long ulMPUCong) void MPUIntRegister (void (pfnHandler)(void)) void MPUIntUnregister (void) unsigned long MPURegionCountGet (void) void MPURegionDisable (unsigned long ulRegion) void MPURegionEnable (unsigned long ulRegion) void MPURegionGet (unsigned long ulRegion, unsigned long pulAddr, unsigned long pulFlags) void MPURegionSet (unsigned long ulRegion, unsigned long ulAddr, unsigned long ulFlags)

October 30, 2008

139

Memory Protection Unit (MPU)

12.2.1 Detailed Description

The MPU APIs provide a means to enable and congure the MPU and memory protection regions. Generally, the memory protection regions should be dened before enabling the MPU. The regions can be congured by calling MPURegionSet() once for each region to be congured. A region that is dened by MPURegionSet() can be initially enabled or disabled. If the region is not initially enabled, it can be enabled later by calling MPURegionEnable(). An enabled region can be disabled by calling MPURegionDisable(). When a region is disabled, its conguration is preserved as long as it is not overwritten. In this case it can be enabled again with MPURegionEnable() without the need to recongure the region. Care must be taken when setting up a protection region using MPURegionSet(). The function will write to multiple registers and is not protected from interrupts. Therefore, it is possible that an interrupt which accesses a region may occur while that region is in the process of being changed. The safest way to protect against this is to make sure that a region is always disabled before making any changes. Otherwise, it is up to the caller to ensure that MPURegionSet() is always called from within code that cannot be interrupted, or from code that will not be affected if an interrupt occurs while the region attributes are being changed. The attributes of a region that has already been programmed can be retrieved and saved using the MPURegionGet() function. This function is intended to save the attributes in a format that can be used later to reload the region using the MPURegionSet() function. Note that the enable state of the region is saved with the attributes and will take effect when the region is reloaded. When one or more regions are dened, the MPU can be enabled by calling MPUEnable(). This turns on the MPU and also denes the behavior in privileged mode and in the Hard Fault and NMI fault handlers. The MPU can be congured so that when in privileged mode and no regions are enabled, a default memory map is applied. If this feature is not enabled, then a memory management fault is generated if the MPU is enabled and no regions are congured and enabled. The MPU can also be set to use a default memory map when in the Hard Fault or NMI handlers, instead of using the congured regions. All of these features are selected when calling MPUEnable(). When the MPU is enabled, it can be disabled by calling MPUDisable(). Finally, if the application is using run-time interrupt registration (see IntRegister()), then the function MPUIntRegister() can be used to install the fault handler which will be called whenever a memory protection violation occurs. This function will also enable the fault handler. If compile-time interrupt registration is used, then the IntEnable() function with the parameter FAULT_MPU must be used to enable the memory management fault handler. When the memory management fault handler has been installed with MPUIntRegister(), it can be removed by calling MPUIntUnregister().

12.2.2 Function Documentation

12.2.2.1 MPUDisable
Disables the MPU for use. Prototype: void MPUDisable(void) Description: This function disables the Cortex-M3 memory protection unit. When the MPU is disabled, the

140

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

default memory map is used and memory management faults are not generated. Returns: None.

12.2.2.2 MPUEnable
Enables and congures the MPU for use. Prototype: void MPUEnable(unsigned long ulMPUConfig) Parameters: ulMPUCong is the logical OR of the possible congurations. Description: This function enables the Cortex-M3 memory protection unit. It also congures the default behavior when in privileged mode and while handling a hard fault or NMI. Prior to enabling the MPU, at least one region must be set by calling MPURegionSet() or else by enabling the default region for privileged mode by passing the MPU_CONFIG_PRIV_DEFAULT ag to MPUEnable(). Once the MPU is enabled, a memory management fault will be generated for any memory access violations. The ulMPUCong parameter should be the logical OR of any of the following: MPU_CONFIG_PRIV_DEFAULT enables the default memory map when in privileged mode and when no other regions are dened. If this option is not enabled, then there must be at least one valid region already dened when the MPU is enabled. MPU_CONFIG_HARDFLT_NMI enables the MPU while in a hard fault or NMI exception handler. If this option is not enabled, then the MPU is disabled while in one of these exception handlers and the default memory map is applied. MPU_CONFIG_NONE chooses none of the above options. In this case, no default memory map is provided in privileged mode, and the MPU will not be enabled in the fault handlers. Returns: None.

12.2.2.3 MPUIntRegister
Registers an interrupt handler for the memory management fault. Prototype: void MPUIntRegister(void (*pfnHandler)(void)) Parameters: pfnHandler is a pointer to the function to be called when the memory management fault occurs.

October 30, 2008

141

Memory Protection Unit (MPU)

Description: This sets and enables the handler to be called when the MPU generates a memory management fault due to a protection region access violation. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

12.2.2.4 MPUIntUnregister
Unregisters an interrupt handler for the memory management fault. Prototype: void MPUIntUnregister(void) Description: This function will disable and clear the handler to be called when a memory management fault occurs. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

12.2.2.5 MPURegionCountGet
Gets the count of regions supported by the MPU. Prototype: unsigned long MPURegionCountGet(void) Description: This function is used to get the number of regions that are supported by the MPU. This is the total number that are supported, including regions that are already programmed. Returns: The number of memory protection regions that are available for programming using MPURegionSet().

12.2.2.6 MPURegionDisable
Disables a specic region.

142

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void MPURegionDisable(unsigned long ulRegion) Parameters: ulRegion is the region number to disable. Description: This function is used to disable a previously enabled memory protection region. The region will remain congured if it is not overwritten with another call to MPURegionSet(), and can be enabled again by calling MPURegionEnable(). Returns: None.

12.2.2.7 MPURegionEnable
Enables a specic region. Prototype: void MPURegionEnable(unsigned long ulRegion) Parameters: ulRegion is the region number to enable. Description: This function is used to enable a memory protection region. The region should already be set up with the MPURegionSet() function. Once enabled, the memory protection rules of the region will be applied and access violations will cause a memory management fault. Returns: None.

12.2.2.8 MPURegionGet
Gets the current settings for a specic region. Prototype: void MPURegionGet(unsigned long ulRegion, unsigned long *pulAddr, unsigned long *pulFlags) Parameters: ulRegion is the region number to get. pulAddr points to storage for the base address of the region. pulFlags points to the attribute ags for the region.

October 30, 2008

143

Memory Protection Unit (MPU)

Description: This function retrieves the conguration of a specic region. The meanings and format of the parameters is the same as that of the MPURegionSet() function. This function can be used to save the conguration of a region for later use with the MPURegionSet() function. The regions enable state will be preserved in the attributes that are saved. Returns: None.

12.2.2.9 MPURegionSet
Sets up the access rules for a specic region. Prototype: void MPURegionSet(unsigned long ulRegion, unsigned long ulAddr, unsigned long ulFlags) Parameters: ulRegion is the region number to set up. ulAddr is the base address of the region. It must be aligned according to the size of the region specied in ulFlags. ulFlags is a set of ags to dene the attributes of the region. Description: This function sets up the protection rules for a region. The region has a base address and a set of attributes including the size, which must be a power of 2. The base address parameter, ulAddr , must be aligned according to the size. The ulFlags parameter is the logical OR of all of the attributes of the region. It is a combination of choices for region size, execute permission, read/write permissions, disabled sub-regions, and a ag to determine if the region is enabled. The size ag determines the size of a region, and must be one of the following: MPU_RGN_SIZE_32B MPU_RGN_SIZE_64B MPU_RGN_SIZE_128B MPU_RGN_SIZE_256B MPU_RGN_SIZE_512B MPU_RGN_SIZE_1K MPU_RGN_SIZE_2K MPU_RGN_SIZE_4K MPU_RGN_SIZE_8K MPU_RGN_SIZE_16K MPU_RGN_SIZE_32K MPU_RGN_SIZE_64K MPU_RGN_SIZE_128K MPU_RGN_SIZE_256K

144

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

MPU_RGN_SIZE_512K MPU_RGN_SIZE_1M MPU_RGN_SIZE_2M MPU_RGN_SIZE_4M MPU_RGN_SIZE_8M MPU_RGN_SIZE_16M MPU_RGN_SIZE_32M MPU_RGN_SIZE_64M MPU_RGN_SIZE_128M MPU_RGN_SIZE_256M MPU_RGN_SIZE_512M MPU_RGN_SIZE_1G MPU_RGN_SIZE_2G MPU_RGN_SIZE_4G The execute permission ag must be one of the following: MPU_RGN_PERM_EXEC enables the region for execution of code MPU_RGN_PERM_NOEXEC disables the region for execution of code The read/write access permissions are applied separately for the privileged and user modes. The read/write access ags must be one of the following: MPU_RGN_PERM_PRV_NO_USR_NO - no access in privileged or user mode MPU_RGN_PERM_PRV_RW_USR_NO - privileged read/write, user no access MPU_RGN_PERM_PRV_RW_USR_RO - privileged read/write, user read-only MPU_RGN_PERM_PRV_RW_USR_RW - privileged read/write, user read/write MPU_RGN_PERM_PRV_RO_USR_NO - privileged read-only, user no access MPU_RGN_PERM_PRV_RO_USR_RO - privileged read-only, user read-only The region is automatically divided into 8 equally-sized sub-regions by the MPU. Sub-regions can only be used in regions of size 256 bytes or larger. Any of these 8 sub-regions can be disabled. This allows for creation of holes in a region which can be left open, or overlaid by another region with different attributes. Any of the 8 sub-regions can be disabled with a logical OR of any of the following ags: MPU_SUB_RGN_DISABLE_0 MPU_SUB_RGN_DISABLE_1 MPU_SUB_RGN_DISABLE_2 MPU_SUB_RGN_DISABLE_3 MPU_SUB_RGN_DISABLE_4 MPU_SUB_RGN_DISABLE_5 MPU_SUB_RGN_DISABLE_6 MPU_SUB_RGN_DISABLE_7 Finally, the region can be initially enabled or disabled with one of the following ags: MPU_RGN_ENABLE MPU_RGN_DISABLE

October 30, 2008

145

Memory Protection Unit (MPU)

As an example, to set a region with the following attributes: size of 32 KB, execution enabled, read-only for both privileged and user, one sub-region disabled, and initially enabled; the ulFlags parameter would have the following value: (MPU_RG_SIZE_32K | MPU_RGN_PERM_EXEC | MPU_RGN_PERM_PRV_RO_USR_RO | MPU_SUB_RGN_DISABLE_2 | MPU_RGN_ENABLE) Note: This function will write to multiple registers and is not protected from interrupts. It is possible that an interrupt which accesses a region may occur while that region is in the process of being changed. The safest way to handle this is to disable a region before changing it. Refer to the discussion of this in the API Detailed Description section. Returns: None.

12.3

Programming Example
The following example sets up a basic set of protection regions to provide the following: a 28 KB region in ash for read-only code execution 32 KB of RAM for read-write access in privileged and user modes an additional 8 KB of RAM for use only in privileged mode 1 MB of peripheral space for access only in privileged mode, except for a 128 KB hole that is not accessible at all, and another 128 KB region within that is accessible from user mode
// // Define a 28 KB region of flash from 0x00000000 to 0x00007000. The // region will be executable, and read-only for both privileged and user // modes. To set up the region, a 32 KB region (#0) will be defined // starting at address 0, and then a 4 KB hole removed at the end by // disabling the last sub-region. The region will be initially enabled. // MPURegionSet(0, 0, MPU_RGN_SIZE_32K | MPU_RGN_PERM_EXEC | MPU_RGN_PERM_PRV_RO_USR_RO | MPU_SUB_RGN_DISABLE_7 | MPU_RGN_ENABLE); // // Define a 32 KB region (#1) of RAM from 0x20000000 to 0x20008000. // region will not be executable, and will be read/write access for // privileged and user modes. // MPURegionSet(1, 0x20000000, MPU_RGN_SIZE_32K | MPU_RGN_PERM_NOEXEC | MPU_RGN_PERM_PRV_RW_USR_RW | MPU_RGN_ENABLE);

The

// // Define an additional 8 KB region (#2) in RAM from 0x20008000 to // 0x2000A000, which will be read/write accessible only from privileged // mode. This region will be initially disabled, to be enabled later. //

146

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

MPURegionSet(2, 0x20008000, MPU_RGN_SIZE_8K | MPU_RGN_PERM_NOEXEC | MPU_RGN_PERM_PRV_RW_USR_NO| MPU_RGN_DISABLE); // // Define a region (#3) in peripheral space from 0x40000000 to 0x40100000 // (1 MB). This region is accessible only in privileged mode. There is a // an area from 0x40020000 to 0x40040000 that has no peripherals and is not // accessible at all. This is created by disabling the second sub-region // (1) and creating a hole. Further, there is an area from 0x40080000 to // 0x400A0000 that should be accessible from user mode as well. This is // created by disabling the fifth sub-region (4), and overlaying an // additional region (#4) in that space with the appropriate permissions. // MPURegionSet(3, 0x40000000, MPU_RGN_SIZE_1M | MPU_RGN_PERM_NOEXEC | MPU_RGN_PERM_PRV_RW_USR_NO | MPU_SUB_RGN_DISABLE_1 | MPU_SUB_RGN_DISABLE_4 | MPU_RGN_ENABLE); MPURegionSet(4, 0x40080000, MPU_RGN_SIZE_128K | MPU_RGN_PERM_NOEXEC | MPU_RGN_PERM_PRV_RW_USR_RW | MPU_RGN_ENABLE); // // In this example, compile-time registration of interrupts is used, so the // handler does not need to be registered. However, it does need to be // enabled. // IntEnable(FAULT_MPU); // // When setting up the regions, region 2 was initially disabled for some // reason. At some point it needs to be enabled. // MPURegionEnable(2); // // Now the MPU will be enabled. It will be configured so that a default // map is available in privileged mode if no regions are defined. The MPU // will not be enabled for the hard fault and NMI handlers, which means a // default map will be used whenever these handlers are active, effectively // giving the fault handlers access to all of memory without any // protection. // MPUEnable(MPU_CONFIG_PRIV_DEFAULT); // // At this point the MPU is configured and enabled and if any code causes // an access violation, the memory management fault will occur. //

The following example shows how to save and restore region congurations.
// // The following arrays provide space for saving the address and // attributes for 4 region configurations. // unsigned long ulRegionAddr[4]; unsigned long ulRegionAttr[4];

October 30, 2008

147

Memory Protection Unit (MPU)

... // // At some point in the system code, we want to save the state of 4 regions // (0-3). // for(uIdx = 0; uIdx < 4; uIdx++) { MPURegionGet(uIdx, &ulRegionAddr[uIdx], &ulRegionAttr[uIdx]); } ... // // At some other point, the previously saved regions should be restored. // for(uIdx = 0; uIdx < 4; uIdx++) { MPURegionSet(uIdx, ulRegionAddr[uIdx], ulRegionAttr[uIdx]); }

148

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

13

Peripheral Pin Mapping

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155

13.1

Introduction
The peripheral pin mapping functions provide an easy method of conguring a peripheral pin without having to know which GPIO pin is shared with the peripheral pin. This makes peripheral pin conguration easier (and clearer) since the pin can be specied by the peripheral pin name instead of the GPIO name (which may be error prone). The mapping of peripheral pins to GPIO pins varies from part to part, meaning that the associated denitions change based on the part being used. The part to be used can be specied in two ways; either via an explicit #define in the source code or via a denition provided to the compiler. Using a #define is very direct, but not very exible. Using a denition provided to the compiler is not as explicit (since it does not appear clearly in the source code) but is much more exible. The real value of the peripheral pin mapping functions is the ability to share a piece of peripheral conguration/control code between projects that utilize different parts; if the part denition is provided to the compiler instead of in the source code, each project can provide its own denition and the code will automatically recongure itself based on the target part. Since the peripheral pin mapping functions congure a single pin at a time, it may be more efcient to use the GPIOPinType() functions instead of the PinType() functions, although this requires explicit knowledge of the GPIO pin(s) to be used. For example, it will take four PinTypeSSI() calls to congure the four pins on the SSI peripheral, but this could be done with a single call to GPIOPinTypeSSI() if the pins are all in the same GPIO module. But using GPIOPinType() instead of PinType() results in the code no longer automatically reconguring itself (without the use of explicit conditionals in the code, of course). This driver is contained in driverlib/pin_map.h.

13.2

API Functions
Functions
void PeripheralEnable (unsigned long ulName) void PinTypeADC (unsigned long ulName) void PinTypeCAN (unsigned long ulName) void PinTypeComparator (unsigned long ulName) void PinTypeI2C (unsigned long ulName) void PinTypePWM (unsigned long ulName) void PinTypeQEI (unsigned long ulName) void PinTypeSSI (unsigned long ulName) void PinTypeTimer (unsigned long ulName) void PinTypeUART (unsigned long ulName)

October 30, 2008

149

Peripheral Pin Mapping

void PinTypeUSBDigital (unsigned long ulName)

13.2.1 Detailed Description

The peripheral pin mapping functions require that the part being used be specied by a dene of the PART_LM3Sxxx form. The xxx portion is replaced with the part number of the part being used; for example, if using the LM3S6965 microcontroller, the dene will be PART_LM3S6965. This must be dened before pin_map.h is included by the source code.

13.2.2 Function Documentation

13.2.2.1 PeripheralEnable
Enables the peripheral port used by the given pin. Prototype: void PeripheralEnable(unsigned long ulName) Parameters: ulName is one of the valid names for a pin. Description: This function takes one of the valid names for a pin function and enables the peripheral port for that pin depending on the part that is dened. Any valid pin name can be used. See also: SysCtlPeripheralEnable() in order to enable a single port when multiple pins are on the same port. Returns: None.

13.2.2.2 PinTypeADC
Congures the specied ADC pin to function as an ADC pin. Prototype: void PinTypeADC(unsigned long ulName) Parameters: ulName is one of the valid names for the ADC pins. Description: This function takes on of the valid names for an ADC pin and congures the pin for its ADC functionality depending on the part that is dened.

150

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

The valid names for the pins are as follows: ADC0, ADC1, ADC2, ADC3, ADC4, ADC5, ADC6, or ADC7. See also: GPIOPinTypeADC() in order to congure multiple ADC pins at once. Returns: None.

13.2.2.3 PinTypeCAN
Congures the specied CAN pin to function as a CAN pin. Prototype: void PinTypeCAN(unsigned long ulName) Parameters: ulName is one of the valid names for the CAN pins. Description: This function takes one of the valid names for a CAN pin and congures the pin for its CAN functionality depending on the part that is dened. The valid names for the pins are as follows: CAN0RX, CAN0TX, CAN1RX, CAN1TX, CAN2RX, or CAN2TX. See also: GPIOPinTypeCAN() in order to congure multiple CAN pins at once. Returns: None.

13.2.2.4 PinTypeComparator
Congures the specied comparator pin to function as a comparator pin. Prototype: void PinTypeComparator(unsigned long ulName) Parameters: ulName is one of the valid names for the Comparator pins. Description: This function takes one of the valid names for a comparator pin and congures the pin for its comparator functionality depending on the part that is dened. The valid names for the pins are as follows: C0_MINUS, C0_PLUS, C1_MINUS, C1_PLUS, C2_MINUS, or C2_PLUS. See also: GPIOPinTypeComparator() in order to congure multiple comparator pins at once.

October 30, 2008

151

Peripheral Pin Mapping

Returns: None.

13.2.2.5 PinTypeI2C
Congures the specied I2C pin to function as an I2C pin. Prototype: void PinTypeI2C(unsigned long ulName) Parameters: ulName is one of the valid names for the I2C pins. Description: This function takes one of the valid names for an I2C pin and congures the pin for its I2C functionality depending on the part that is dened. The valid names for the pins are as follows: I2C0SCL, I2C0SDA, I2C1SCL, or I2C1SDA. See also: GPIOPinTypeI2C() in order to congure multiple I2C pins at once. Returns: None.

13.2.2.6 PinTypePWM
Congures the specied PWM pin to function as a PWM pin. Prototype: void PinTypePWM(unsigned long ulName) Parameters: ulName is one of the valid names for the PWM pins. Description: This function takes one of the valid names for a PWM pin and congures the pin for its PWM functionality depending on the part that is dened. The valid names for the pins are as follows: PWM0, PWM1, PWM2, PWM3, PWM4, PWM5, or FAULT. See also: GPIOPinTypePWM() in order to congure multiple PWM pins at once. Returns: None.

152

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

13.2.2.7 PinTypeQEI
Congures the specied QEI pin to function as a QEI pin. Prototype: void PinTypeQEI(unsigned long ulName) Parameters: ulName is one of the valid names for the QEI pins. Description: This function takes one of the valid names for a QEI pin and congures the pin for its QEI functionality depending on the part that is dened. The valid names for the pins are as follows: PHA0, PHB0, IDX0, PHA1, PHB1, or IDX1. See also: GPIOPinTypeQEI() in order to congure multiple QEI pins at once. Returns: None.

13.2.2.8 PinTypeSSI
Congures the specied SSI pin to function as an SSI pin. Prototype: void PinTypeSSI(unsigned long ulName) Parameters: ulName is one of the valid names for the SSI pins. Description: This function takes one of the valid names for an SSI pin and congures the pin for its SSI functionality depending on the part that is dened. The valid names for the pins are as follows: SSI0CLK, SSI0FSS, SSI0RX, SSI0TX, SSI1CLK, SSI1FSS, SSI1RX, or SSI1TX. See also: GPIOPinTypeSSI() in order to congure multiple SSI pins at once. Returns: None.

13.2.2.9 PinTypeTimer
Congures the specied Timer pin to function as a Timer pin.

October 30, 2008

153

Peripheral Pin Mapping

Prototype: void PinTypeTimer(unsigned long ulName) Parameters: ulName is one of the valid names for the Timer pins. Description: This function takes one of the valid names for a Timer pin and congures the pin for its Timer functionality depending on the part that is dened. The valid names for the pins are as follows: CCP0, CCP1, CCP2, CCP3, CCP4, CCP5, CCP6, or CCP7. See also: GPIOPinTypeTimer() in order to congure multiple CCP pins at once. Returns: None.

13.2.2.10 PinTypeUART
Congures the specied UART pin to function as a UART pin. Prototype: void PinTypeUART(unsigned long ulName) Parameters: ulName is one of the valid names for the UART pins. Description: This function takes one of the valid names for a UART pin and congures the pin for its UART functionality depending on the part that is dened. The valid names for the pins are as follows: U0RX, U0TX, U1RX, U1TX, U2RX, or U2TX. See also: GPIOPinTypeUART() in order to congure multiple UART pins at once. Returns: None.

13.2.2.11 PinTypeUSBDigital
Congures the specied USB digital pin to function as a USB pin. Prototype: void PinTypeUSBDigital(unsigned long ulName) Parameters: ulName is one of the valid names for a USB digital pin.

154

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function takes one of the valid names for a USB digital pin and congures the pin for its USB functionality depending on the part that is dened. The valid names for the pins are as follows: EPEN or PFAULT. See also: GPIOPinTypeUSBDigital() in order to congure multiple USB pins at once. Returns: None.

13.3

Programming Example
This example shows the difference in code when conguring a PWM pin on two different parts in the same application. In this case, the PWM0 pin is actually on a different GPIO port on the two parts and requires special conditional code if the GPIOPinTypePWM() function is used directly. Instead, if PinTypePWM() is used, then the code can remain the same and only the part denition in the project le needs to change. Example for PWM0 pin conguration using PinTypePWM():
... // // Configure the pin for use as a PWM pin. // PinTypePWM(PWM0); ...

Example for PWM0 pin conguration using GPIOPinTypePWM():

... #ifdef LM3S2110 // // Configure the pin for use as a PWM pin. // GPIOPinTypePWM(GPIO_PORTF_BASE, GPIO_PIN_0); #endif #ifdef LM3S2620 // // Configure the pin for use as a PWM pin. // GPIOPinTypeTimer(GPIO_PORTG_BASE, GPIO_PIN_0); #endif ...

October 30, 2008

155

Peripheral Pin Mapping

156

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

14

Pulse Width Modulator (PWM)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177

14.1

Introduction
Each instance of a Stellaris PWM module provides three instances of a PWM generator block, and an output control block. Each generator block has two PWM output signals, which can be operated independently, or as a pair of signals with dead band delays inserted. Each generator block also has an interrupt output and a trigger output. The control block determines the polarity of the PWM signals, and which signals are passed through to the pins. Some of the features of the Stellaris PWM module are: Three generator blocks, each containing One 16-bit down or up/down counter Two comparators PWM generator Dead band generator PWM output enable Output polarity control Synchronization Fault handling Interrupt status

Control block

This driver is contained in driverlib/pwm.c, with driverlib/pwm.h containing the API denitions for use by applications.

14.2

API Functions
Functions
void PWMDeadBandDisable (unsigned long ulBase, unsigned long ulGen) void PWMDeadBandEnable (unsigned long ulBase, unsigned long ulGen, unsigned short usRise, unsigned short usFall) void PWMFaultIntClear (unsigned long ulBase) void PWMFaultIntClearExt (unsigned long ulBase, unsigned long ulFaultInts) void PWMFaultIntRegister (unsigned long ulBase, void (pfnIntHandler)(void)) void PWMFaultIntUnregister (unsigned long ulBase) void PWMGenCongure (unsigned long ulBase, unsigned long ulGen, unsigned long ulCong) void PWMGenDisable (unsigned long ulBase, unsigned long ulGen)

October 30, 2008

157

Pulse Width Modulator (PWM)

void PWMGenEnable (unsigned long ulBase, unsigned long ulGen) void PWMGenFaultClear (unsigned long ulBase, unsigned long ulGen, unsigned long ulGroup, unsigned long ulFaultTriggers) void PWMGenFaultCongure (unsigned long ulBase, unsigned long ulGen, unsigned long ulMinFaultPeriod, unsigned long ulFaultSenses) unsigned long PWMGenFaultStatus (unsigned long ulBase, unsigned long ulGen, unsigned long ulGroup) unsigned long PWMGenFaultTriggerGet (unsigned long ulBase, unsigned long ulGen, unsigned long ulGroup) void PWMGenFaultTriggerSet (unsigned long ulBase, unsigned long ulGen, unsigned long ulGroup, unsigned long ulFaultTriggers) void PWMGenIntClear (unsigned long ulBase, unsigned long ulGen, unsigned long ulInts) void PWMGenIntRegister (unsigned long ulBase, unsigned long ulGen, void (pfnIntHandler)(void)) unsigned long PWMGenIntStatus (unsigned long ulBase, unsigned long ulGen, tBoolean bMasked) void PWMGenIntTrigDisable (unsigned long ulBase, unsigned long ulGen, unsigned long ulIntTrig) void PWMGenIntTrigEnable (unsigned long ulBase, unsigned long ulGen, unsigned long ulIntTrig) void PWMGenIntUnregister (unsigned long ulBase, unsigned long ulGen) unsigned long PWMGenPeriodGet (unsigned long ulBase, unsigned long ulGen) void PWMGenPeriodSet (unsigned long ulBase, unsigned long ulGen, unsigned long ulPeriod) void PWMIntDisable (unsigned long ulBase, unsigned long ulGenFault) void PWMIntEnable (unsigned long ulBase, unsigned long ulGenFault) unsigned long PWMIntStatus (unsigned long ulBase, tBoolean bMasked) void PWMOutputFault (unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bFaultSuppress) void PWMOutputFaultLevel (unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bDriveHigh) void PWMOutputInvert (unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bInvert) void PWMOutputState (unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bEnable) unsigned long PWMPulseWidthGet (unsigned long ulBase, unsigned long ulPWMOut) void PWMPulseWidthSet (unsigned long ulBase, unsigned long ulPWMOut, unsigned long ulWidth) void PWMSyncTimeBase (unsigned long ulBase, unsigned long ulGenBits) void PWMSyncUpdate (unsigned long ulBase, unsigned long ulGenBits)

14.2.1 Detailed Description

These are a group of functions for performing high-level operations on PWM modules. Although Stellaris only has one PWM module, these functions are dened to support using multiple instances of PWM modules. The following functions provide the user with a way to congure the PWM for the most common operations, such as setting the period, generating left and center aligned pulses, modifying the

158

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

pulse width, and controlling interrupts, triggers, and output characteristics. However, the PWM module is very versatile, and it can be congured in a number of different ways, many of which are beyond the scope of this API. In order to fully exploit the many features of the PWM module, users are advised to use register access macros. When discussing the various components of a PWM module, this API uses the following labeling convention: The three generator blocks are called Gen0, Gen1, and Gen2. The two PWM output signals associated with each generator block are called OutA and OutB. The six output signals are called PWM0, PWM1, PWM2, PWM3, PWM4, and PWM5. PWM0 and PWM1 are associated with Gen0, PWM2 and PWM3 are associated with Gen1, and PWM4 and PWM5 are associated with Gen2. Also, as a simplifying assumption for this API, comparator A for each generator block is used exclusively to adjust the pulse width of the even numbered PWM outputs (PWM0, PWM2, and PWM4). In addition, comparator B is used exclusively for the odd numbered PWM outputs (PWM1, PWM3, PWM5).

14.2.2 Function Documentation

14.2.2.1 PWMDeadBandDisable
Disables the PWM dead band output. Prototype: void PWMDeadBandDisable(unsigned long ulBase, unsigned long ulGen) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to modify. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. Description: This function disables the dead band mode for the specied PWM generator. Doing so decouples the OutA and OutB signals. Returns: None.

14.2.2.2 PWMDeadBandEnable
Enables the PWM dead band output, and sets the dead band delays. Prototype: void PWMDeadBandEnable(unsigned long ulBase,

October 30, 2008

159

Pulse Width Modulator (PWM)

unsigned long ulGen, unsigned short usRise, unsigned short usFall) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to modify. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. usRise species the width of delay from the rising edge. usFall species the width of delay from the falling edge. Description: This function sets the dead bands for the specied PWM generator, where the dead bands are dened as the number of PWM clock ticks from the rising or falling edge of the generators OutA signal. Note that this function causes the coupling of OutB to OutA. Returns: None.

14.2.2.3 PWMFaultIntClear
Clears the fault interrupt for a PWM module. Prototype: void PWMFaultIntClear(unsigned long ulBase) Parameters: ulBase is the base address of the PWM module. Description: Clears the fault interrupt by writing to the appropriate bit of the interrupt status register for the selected PWM module. This function clears only the FAULT0 interrupt and is retained for backwards compatibility. It is recommended that PWMFaultIntClearExt() be used instead since it supports all fault interrupts supported on devices with and without extended PWM fault handling support. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

160

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

14.2.2.4 PWMFaultIntClearExt
Clears the fault interrupt for a PWM module. Prototype: void PWMFaultIntClearExt(unsigned long ulBase, unsigned long ulFaultInts) Parameters: ulBase is the base address of the PWM module. ulFaultInts species the fault interrupts to clear. Description: Clears one or more fault interrupts by writing to the appropriate bit of the PWM interrupt status register. The parameter ulFaultInts must be the logical OR of any of PWM_INT_FAULT0, PWM_INT_FAULT1, PWM_INT_FAULT2, or PWM_INT_FAULT3. When running on a device supporting extended PWM fault handling, the fault interrupts are derived by performing a logical OR of each of the congured fault trigger signals for a given generator. Therefore, these interrupts are not directly related to the four possible FAULTn inputs to the device but indicate that a fault has been signaled to one of the four possible PWM generators. On a device without extended PWM fault handling, the interrupt is directly related to the state of the single FAULT pin. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

14.2.2.5 PWMFaultIntRegister
Registers an interrupt handler for a fault condition detected in a PWM module. Prototype: void PWMFaultIntRegister(unsigned long ulBase, void (*pfnIntHandler)(void)) Parameters: ulBase is the base address of the PWM module. pfnIntHandler is a pointer to the function to be called when the PWM fault interrupt occurs. Description: This function will ensure that the interrupt handler specied by pfnIntHandler is called when a fault interrupt is detected for the selected PWM module. This function will also enable the

October 30, 2008

161

Pulse Width Modulator (PWM)

PWM fault interrupt in the NVIC; the PWM fault interrupt must also be enabled at the module level using PWMIntEnable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

14.2.2.6 PWMFaultIntUnregister
Removes the PWM fault condition interrupt handler. Prototype: void PWMFaultIntUnregister(unsigned long ulBase) Parameters: ulBase is the base address of the PWM module. Description: This function will remove the interrupt handler for a PWM fault interrupt from the selected PWM module. This function will also disable the PWM fault interrupt in the NVIC; the PWM fault interrupt must also be disabled at the module level using PWMIntDisable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

14.2.2.7 PWMGenCongure
Congures a PWM generator. Prototype: void PWMGenConfigure(unsigned long ulBase, unsigned long ulGen, unsigned long ulConfig) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to congure. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulCong is the conguration for the PWM generator. Description: This function is used to set the mode of operation for a PWM generator. The counting mode, synchronization mode, and debug behavior are all congured. After conguration, the generator is left in the disabled state.

162

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

A PWM generator can count in two different modes: count down mode or count up/down mode. In count down mode, it will count from a value down to zero, and then reset to the preset value. This will produce left-aligned PWM signals (that is the rising edge of the two PWM signals produced by the generator will occur at the same time). In count up/down mode, it will count up from zero to the preset value, count back down to zero, and then repeat the process. This will produce center-aligned PWM signals (that is, the middle of the high/low period of the PWM signals produced by the generator will occur at the same time). When the PWM generator parameters (period and pulse width) are modied, their affect on the output PWM signals can be delayed. In synchronous mode, the parameter updates are not applied until a synchronization event occurs. This allows multiple parameters to be modied and take affect simultaneously, instead of one at a time. Additionally, parameters to multiple PWM generators in synchronous mode can be updated simultaneously, allowing them to be treated as if they were a unied generator. In non-synchronous mode, the parameter updates are not delayed until a synchronization event. In either mode, the parameter updates only occur when the counter is at zero to help prevent oddly formed PWM signals during the update (that is, a PWM pulse that is too short or too long). The PWM generator can either pause or continue running when the processor is stopped via the debugger. If congured to pause, it will continue to count until it reaches zero, at which point it will pause until the processor is restarted. If congured to continue running, it will keep counting as if nothing had happened. The ulCong parameter contains the desired conguration. It is the logical OR of the following: PWM_GEN_MODE_DOWN or PWM_GEN_MODE_UP_DOWN to specify the counting mode PWM_GEN_MODE_SYNC or PWM_GEN_MODE_NO_SYNC to specify the counter load and comparator update synchronization mode PWM_GEN_MODE_DBG_RUN or PWM_GEN_MODE_DBG_STOP to specify the debug behavior PWM_GEN_MODE_GEN_NO_SYNC, PWM_GEN_MODE_GEN_SYNC_LOCAL, or PWM_GEN_MODE_GEN_SYNC_GLOBAL to specify the update synchronization mode for generator counting mode changes PWM_GEN_MODE_DB_NO_SYNC, PWM_GEN_MODE_DB_SYNC_LOCAL, or PWM_GEN_MODE_DB_SYNC_GLOBAL to specify the deadband parameter synchronization mode PWM_GEN_MODE_FAULT_LATCHED or PWM_GEN_MODE_FAULT_UNLATCHED to specify whether fault conditions are latched or not PWM_GEN_MODE_FAULT_MINPER or PWM_GEN_MODE_FAULT_NO_MINPER to specify whether minimum fault period support is required PWM_GEN_MODE_FAULT_EXT or PWM_GEN_MODE_FAULT_LEGACY to specify whether extended fault source selection support is enabled or not Setting PWM_GEN_MODE_FAULT_MINPER allows an application to set the minimum duration of a PWM fault signal. Fault will be signaled for at least this time even if the external fault pin deasserts earlier. Care should be taken when using this mode since during the fault signal period, the fault interrupt from the PWM generator will remain asserted. The fault interrupt handler may, therefore, reenter immediately if it exits prior to expiration of the fault timer. Note: Changes to the counter mode will affect the period of the PWM signals produced. PWMGenPeriodSet() and PWMPulseWidthSet() should be called after any changes to the counter mode of a generator.

October 30, 2008

163

Pulse Width Modulator (PWM)

Returns: None.

14.2.2.8 PWMGenDisable
Disables the timer/counter for a PWM generator block. Prototype: void PWMGenDisable(unsigned long ulBase, unsigned long ulGen) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to be disabled. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. Description: This function blocks the PWM clock from driving the timer/counter for the specied generator block. Returns: None.

14.2.2.9 PWMGenEnable
Enables the timer/counter for a PWM generator block. Prototype: void PWMGenEnable(unsigned long ulBase, unsigned long ulGen) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to be enabled. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. Description: This function allows the PWM clock to drive the timer/counter for the specied generator block. Returns: None.

14.2.2.10 PWMGenFaultClear
Clears one or more latched fault triggers for a given PWM generator.

164

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void PWMGenFaultClear(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulGen, ulGroup, ulFaultTriggers)

Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator whose fault trigger states are being queried. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulGroup indicates the subset of faults that are being queried. This must be PWM_FAULT_GROUP_0. ulFaultTriggers is the set of fault triggers which are to be cleared. Description: This function allows an application to clear the fault triggers for a given PWM generator. This is only required if PWMGenCongure() has previously been called with ag PWM_GEN_MODE_LATCH_FAULT in parameter ulCong. Note: This function is only available on devices supporting extended PWM fault handling. Returns: None.

14.2.2.11 PWMGenFaultCongure
Congures the minimum fault period and fault pin senses for a given PWM generator. Prototype: void PWMGenFaultConfigure(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulGen, ulMinFaultPeriod, ulFaultSenses)

Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator whose fault conguration is being set. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulMinFaultPeriod is the minimum fault active period expressed in PWM clock cycles. ulFaultSenses indicates which sense of each FAULT input should be considered the asserted state. Valid values are logical OR combinations of PWM_FAULTn_SENSE_HIGH and PWM_FAULTn_SENSE_LOW. Description: This function sets the minimum fault period for a given generator along with the sense of each of the 4 possible fault inputs. The minimum fault period is expressed in PWM clock cycles and takes effect only if PWMGenCongure() is called with ag PWM_GEN_MODE_FAULT_PER set in the ulCong parameter. When a fault input is asserted, the minimum fault period timer ensures that it remains asserted for at least the number of clock cycles specied.

October 30, 2008

165

Pulse Width Modulator (PWM)

Note: This function is only available on devices supporting extended PWM fault handling. Returns: None.

14.2.2.12 PWMGenFaultStatus
Returns the current state of the fault triggers for a given PWM generator. Prototype: unsigned long PWMGenFaultStatus(unsigned long ulBase, unsigned long ulGen, unsigned long ulGroup) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator whose fault trigger states are being queried. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulGroup indicates the subset of faults that are being queried. This must be PWM_FAULT_GROUP_0. Description: This function allows an application to query the current state of each of the fault trigger inputs to a given PWM generator. The current state of each fault trigger input is returned unless PWMGenCongure() has previously been called with ag PWM_GEN_MODE_LATCH_FAULT in the ulCong parameter in which case the returned status is the latched fault trigger status. If latched faults are congured, the application must call PWMGenFaultClear() to clear each trigger. Note: This function is only available on devices supporting extended PWM fault handling. Returns: Returns the current state of the fault triggers for the given PWM generator. A set bit indicates that the associated trigger is active. For PWM_FAULT_GROUP_0, the returned value will be a logical OR of PWM_FAULT_FAULT0, PWM_FAULT_FAULT1, PWM_FAULT_FAULT2, or PWM_FAULT_FAULT3.

14.2.2.13 PWMGenFaultTriggerGet
Returns the set of fault triggers currently congured for a given PWM generator. Prototype: unsigned long PWMGenFaultTriggerGet(unsigned long ulBase, unsigned long ulGen, unsigned long ulGroup)

166

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator whose fault triggers are being queried. PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulGroup indicates the subset of faults that are being queried. PWM_FAULT_GROUP_0.

Must be one of This must be

Description: This function allows an application to query the current set of inputs that contribute towards the generation of a fault condition to a given PWM generator. Note: This function is only available on devices supporting extended PWM fault handling. Returns: Returns the current fault triggers congured for the fault group provided. For PWM_FAULT_GROUP_0, the returned value will be a logical OR of PWM_FAULT_FAULT0, PWM_FAULT_FAULT1, PWM_FAULT_FAULT2, or PWM_FAULT_FAULT3.

14.2.2.14 PWMGenFaultTriggerSet
Congures the set of fault triggers for a given PWM generator. Prototype: void PWMGenFaultTriggerSet(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulGen, ulGroup, ulFaultTriggers)

Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator whose fault triggers are being set. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulGroup indicates the subset of possible faults that are to be congured. This must be PWM_FAULT_GROUP_0. ulFaultTriggers denes the set of inputs that are to contribute towards generation of the fault signal to the given PWM generator. For PWM_FAULT_GROUP_0, this will be the logical OR of PWM_FAULT_FAULT0, PWM_FAULT_FAULT1, PWM_FAULT_FAULT2, or PWM_FAULT_FAULT3. Description: This function allows selection of the set of fault inputs that will be combined to generate a fault condition to a given PWM generator. By default, all generators use only FAULT0 (for backwards compatibility) but if PWMGenCongure() is called with ag PWM_GEN_MODE_FAULT_SRC in the ulCong parameter, extended fault handling is enabled and this function must be called to congure the fault triggers. The fault signal to the PWM generator is generated by ORing together each of the signals whose inputs are specied in the ulFaultTriggers parameter after having adjusted the sense of each FAULTn input based on the conguration previously set using a call to PWMGenFaultCongure().

October 30, 2008

167

Pulse Width Modulator (PWM)

Note: This function is only available on devices supporting extended PWM fault handling. Returns: None.

14.2.2.15 PWMGenIntClear
Clears the specied interrupt(s) for the specied PWM generator block. Prototype: void PWMGenIntClear(unsigned long ulBase, unsigned long ulGen, unsigned long ulInts) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to query. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulInts species the interrupts to be cleared. Description: Clears the specied interrupt(s) by writing a 1 to the specied bits of the interrupt status register for the specied PWM generator. The ulInts parameter is the logical OR of PWM_INT_CNT_ZERO, PWM_INT_CNT_LOAD, PWM_INT_CNT_AU, PWM_INT_CNT_AD, PWM_INT_CNT_BU, or PWM_INT_CNT_BD. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

14.2.2.16 PWMGenIntRegister
Registers an interrupt handler for the specied PWM generator block. Prototype: void PWMGenIntRegister(unsigned long ulBase, unsigned long ulGen, void (*pfnIntHandler)(void)) Parameters: ulBase is the base address of the PWM module.

168

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

ulGen is the PWM generator in question. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. pfnIntHandler is a pointer to the function to be called when the PWM generator interrupt occurs. Description: This function will ensure that the interrupt handler specied by pfnIntHandler is called when an interrupt is detected for the specied PWM generator block. This function will also enable the corresponding PWM generator interrupt in the interrupt controller; individual generator interrupts and interrupt sources must be enabled with PWMIntEnable() and PWMGenIntTrigEnable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

14.2.2.17 PWMGenIntStatus
Gets interrupt status for the specied PWM generator block. Prototype: unsigned long PWMGenIntStatus(unsigned long ulBase, unsigned long ulGen, tBoolean bMasked) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to query. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. bMasked species whether masked or raw interrupt status is returned. Description: If bMasked is set as true, then the masked interrupt status is returned; otherwise, the raw interrupt status will be returned. Returns: Returns the contents of the interrupt status register, or the contents of the raw interrupt status register, for the specied PWM generator.

14.2.2.18 PWMGenIntTrigDisable
Disables interrupts for the specied PWM generator block. Prototype: void PWMGenIntTrigDisable(unsigned long ulBase, unsigned long ulGen, unsigned long ulIntTrig)

October 30, 2008

169

Pulse Width Modulator (PWM)

Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to have interrupts and triggers disabled. PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulIntTrig species the interrupts and triggers to be disabled.

Must be one of

Description: Masks the specied interrupt(s) and trigger(s) by clearing the specied bits of the interrupt/trigger enable register for the specied PWM generator. The ulIntTrig parameter is the logical OR of PWM_INT_CNT_ZERO, PWM_INT_CNT_LOAD, PWM_INT_CNT_AU, PWM_INT_CNT_AD, PWM_INT_CNT_BU, PWM_INT_CNT_BD, PWM_TR_CNT_ZERO, PWM_TR_CNT_LOAD, PWM_TR_CNT_AU, PWM_TR_CNT_AD, PWM_TR_CNT_BU, or PWM_TR_CNT_BD. Returns: None.

14.2.2.19 PWMGenIntTrigEnable
Enables interrupts and triggers for the specied PWM generator block. Prototype: void PWMGenIntTrigEnable(unsigned long ulBase, unsigned long ulGen, unsigned long ulIntTrig) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to have interrupts and triggers enabled. PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulIntTrig species the interrupts and triggers to be enabled.

Must be one of

Description: Unmasks the specied interrupt(s) and trigger(s) by setting the specied bits of the interrupt/trigger enable register for the specied PWM generator. The ulIntTrig parameter is the logical OR of PWM_INT_CNT_ZERO, PWM_INT_CNT_LOAD, PWM_INT_CNT_AU, PWM_INT_CNT_AD, PWM_INT_CNT_BU, PWM_INT_CNT_BD, PWM_TR_CNT_ZERO, PWM_TR_CNT_LOAD, PWM_TR_CNT_AU, PWM_TR_CNT_AD, PWM_TR_CNT_BU, or PWM_TR_CNT_BD. Returns: None.

14.2.2.20 PWMGenIntUnregister
Removes an interrupt handler for the specied PWM generator block.

170

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void PWMGenIntUnregister(unsigned long ulBase, unsigned long ulGen) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator in question. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. Description: This function will unregister the interrupt handler for the specied PWM generator block. This function will also disable the corresponding PWM generator interrupt in the interrupt controller; individual generator interrupts and interrupt sources must be disabled with PWMIntDisable() and PWMGenIntTrigDisable(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

14.2.2.21 PWMGenPeriodGet
Gets the period of a PWM generator block. Prototype: unsigned long PWMGenPeriodGet(unsigned long ulBase, unsigned long ulGen) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to query. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. Description: This function gets the period of the specied PWM generator block. The period of the generator block is dened as the number of PWM clock ticks between pulses on the generator block zero signal. If the update of the counter for the specied PWM generator has yet to be completed, the value returned may not be the active period. The value returned is the programmed period, measured in PWM clock ticks. Returns: Returns the programmed period of the specied generator block in PWM clock ticks.

14.2.2.22 PWMGenPeriodSet
Set the period of a PWM generator.

October 30, 2008

171

Pulse Width Modulator (PWM)

Prototype: void PWMGenPeriodSet(unsigned long ulBase, unsigned long ulGen, unsigned long ulPeriod) Parameters: ulBase is the base address of the PWM module. ulGen is the PWM generator to be modied. Must be one of PWM_GEN_0, PWM_GEN_1, PWM_GEN_2, or PWM_GEN_3. ulPeriod species the period of PWM generator output, measured in clock ticks. Description: This function sets the period of the specied PWM generator block, where the period of the generator block is dened as the number of PWM clock ticks between pulses on the generator block zero signal. Note: Any subsequent calls made to this function before an update occurs will cause the previous values to be overwritten. Returns: None.

14.2.2.23 PWMIntDisable
Disables generator and fault interrupts for a PWM module. Prototype: void PWMIntDisable(unsigned long ulBase, unsigned long ulGenFault) Parameters: ulBase is the base address of the PWM module. ulGenFault contains the interrupts to be disabled. Must be a logical OR of any of PWM_INT_GEN_0, PWM_INT_GEN_1, PWM_INT_GEN_2, PWM_INT_GEN_3, PWM_INT_FAULT0, PWM_INT_FAULT1, PWM_INT_FAULT2, or PWM_INT_FAULT3. Description: Masks the specied interrupt(s) by clearing the specied bits of the interrupt enable register for the selected PWM module. Returns: None.

14.2.2.24 PWMIntEnable
Enables generator and fault interrupts for a PWM module.

172

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void PWMIntEnable(unsigned long ulBase, unsigned long ulGenFault) Parameters: ulBase is the base address of the PWM module. ulGenFault contains the interrupts to be enabled. Must be a logical OR of any of PWM_INT_GEN_0, PWM_INT_GEN_1, PWM_INT_GEN_2, PWM_INT_GEN_3, PWM_INT_FAULT0, PWM_INT_FAULT1, PWM_INT_FAULT2, or PWM_INT_FAULT3. Description: Unmasks the specied interrupt(s) by setting the specied bits of the interrupt enable register for the selected PWM module. Returns: None.

14.2.2.25 PWMIntStatus
Gets the interrupt status for a PWM module. Prototype: unsigned long PWMIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the PWM module. bMasked species whether masked or raw interrupt status is returned. Description: If bMasked is set as true, then the masked interrupt status is returned; otherwise, the raw interrupt status will be returned. Returns: The current interrupt status, enumerated as a bit eld of PWM_INT_GEN_0, PWM_INT_GEN_1, PWM_INT_GEN_2, PWM_INT_GEN_3, PWM_INT_FAULT0, PWM_INT_FAULT1, PWM_INT_FAULT2, and PWM_INT_FAULT3.

14.2.2.26 PWMOutputFault
Species the state of PWM outputs in response to a fault condition. Prototype: void PWMOutputFault(unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bFaultSuppress) Parameters: ulBase is the base address of the PWM module.

October 30, 2008

173

Pulse Width Modulator (PWM)

ulPWMOutBits are the PWM outputs to be modied. Must be the logical OR of any of PWM_OUT_0_BIT, PWM_OUT_1_BIT, PWM_OUT_2_BIT, PWM_OUT_3_BIT, PWM_OUT_4_BIT, PWM_OUT_5_BIT, PWM_OUT_6_BIT, or PWM_OUT_7_BIT. bFaultSuppress determines if the signal is suppressed or passed through during an active fault condition. Description: This function sets the fault handling characteristics of the selected PWM outputs. The outputs are selected using the parameter ulPWMOutBits. The parameter bFaultSuppress determines the fault handling characteristics for the selected outputs. If bFaultSuppress is true, then the selected outputs will be made inactive. If bFaultSuppress is false, then the selected outputs are unaffected by the detected fault. On devices supporting extended PWM fault handling, the state the affected output pins are driven to can be congured with PWMOutputFaultLevel(). If not congured, or if the device does not support extended PWM fault handling, affected outputs will be driven low on a fault condition. Returns: None.

14.2.2.27 PWMOutputFaultLevel
Species the level of PWM outputs suppressed in response to a fault condition. Prototype: void PWMOutputFaultLevel(unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bDriveHigh) Parameters: ulBase is the base address of the PWM module. ulPWMOutBits are the PWM outputs to be modied. Must be the logical OR of any of PWM_OUT_0_BIT, PWM_OUT_1_BIT, PWM_OUT_2_BIT, PWM_OUT_3_BIT, PWM_OUT_4_BIT, PWM_OUT_5_BIT, PWM_OUT_6_BIT, or PWM_OUT_7_BIT. bDriveHigh determines if the signal is driven high or low during an active fault condition. Description: This function determines whether a PWM output pin that is suppressed in response to a fault condition will be driven high or low. The affected outputs are selected using the parameter ulPWMOutBits. The parameter bDriveHigh determines the output level for the pins identied by ulPWMOutBits. If bDriveHigh is true then the selected outputs will be driven high when a fault is detected. If it is false, the pins will be driven low. In a fault condition, pins which have not been congured to be suppressed via a call to PWMOutputFault() are unaffected by this function. Note: This function is available only on devices which support extended PWM fault handling. Returns: None.

174

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

14.2.2.28 PWMOutputInvert
Selects the inversion mode for PWM outputs. Prototype: void PWMOutputInvert(unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bInvert) Parameters: ulBase is the base address of the PWM module. ulPWMOutBits are the PWM outputs to be modied. Must be the logical OR of any of PWM_OUT_0_BIT, PWM_OUT_1_BIT, PWM_OUT_2_BIT, PWM_OUT_3_BIT, PWM_OUT_4_BIT, PWM_OUT_5_BIT, PWM_OUT_6_BIT, or PWM_OUT_7_BIT. bInvert determines if the signal is inverted or passed through. Description: This function is used to select the inversion mode for the selected PWM outputs. The outputs are selected using the parameter ulPWMOutBits. The parameter bInvert determines the inversion mode for the selected outputs. If bInvert is true, this function will cause the specied PWM output signals to be inverted, or made active low. If bInvert is false, the specied output will be passed through as is, or be made active high. Returns: None.

14.2.2.29 PWMOutputState
Enables or disables PWM outputs. Prototype: void PWMOutputState(unsigned long ulBase, unsigned long ulPWMOutBits, tBoolean bEnable) Parameters: ulBase is the base address of the PWM module. ulPWMOutBits are the PWM outputs to be modied. Must be the logical OR of any of PWM_OUT_0_BIT, PWM_OUT_1_BIT, PWM_OUT_2_BIT, PWM_OUT_3_BIT, PWM_OUT_4_BIT, PWM_OUT_5_BIT, PWM_OUT_6_BIT, or PWM_OUT_7_BIT. bEnable determines if the signal is enabled or disabled. Description: This function is used to enable or disable the selected PWM outputs. The outputs are selected using the parameter ulPWMOutBits. The parameter bEnable determines the state of the selected outputs. If bEnable is true, then the selected PWM outputs are enabled, or placed in the active state. If bEnable is false, then the selected outputs are disabled, or placed in the inactive state. Returns: None.

October 30, 2008

175

Pulse Width Modulator (PWM)

14.2.2.30 PWMPulseWidthGet
Gets the pulse width of a PWM output. Prototype: unsigned long PWMPulseWidthGet(unsigned long ulBase, unsigned long ulPWMOut) Parameters: ulBase is the base address of the PWM module. ulPWMOut is the PWM output to query. Must be one of PWM_OUT_0, PWM_OUT_1, PWM_OUT_2, PWM_OUT_3, PWM_OUT_4, PWM_OUT_5, PWM_OUT_6, or PWM_OUT_7. Description: This function gets the currently programmed pulse width for the specied PWM output. If the update of the comparator for the specied output has yet to be completed, the value returned may not be the active pulse width. The value returned is the programmed pulse width, measured in PWM clock ticks. Returns: Returns the width of the pulse in PWM clock ticks.

14.2.2.31 PWMPulseWidthSet
Sets the pulse width for the specied PWM output. Prototype: void PWMPulseWidthSet(unsigned long ulBase, unsigned long ulPWMOut, unsigned long ulWidth) Parameters: ulBase is the base address of the PWM module. ulPWMOut is the PWM output to modify. Must be one of PWM_OUT_0, PWM_OUT_1, PWM_OUT_2, PWM_OUT_3, PWM_OUT_4, PWM_OUT_5, PWM_OUT_6, or PWM_OUT_7. ulWidth species the width of the positive portion of the pulse. Description: This function sets the pulse width for the specied PWM output, where the pulse width is dened as the number of PWM clock ticks. Note: Any subsequent calls made to this function before an update occurs will cause the previous values to be overwritten. Returns: None.

176

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

14.2.2.32 PWMSyncTimeBase
Synchronizes the counters in one or multiple PWM generator blocks. Prototype: void PWMSyncTimeBase(unsigned long ulBase, unsigned long ulGenBits) Parameters: ulBase is the base address of the PWM module. ulGenBits are the PWM generator blocks to be synchronized. Must be the logical OR of any of PWM_GEN_0_BIT, PWM_GEN_1_BIT, PWM_GEN_2_BIT, or PWM_GEN_3_BIT. Description: For the selected PWM module, this function synchronizes the time base of the generator blocks by causing the specied generator counters to be reset to zero. Returns: None.

14.2.2.33 PWMSyncUpdate
Synchronizes all pending updates. Prototype: void PWMSyncUpdate(unsigned long ulBase, unsigned long ulGenBits) Parameters: ulBase is the base address of the PWM module. ulGenBits are the PWM generator blocks to be updated. Must be the logical OR of any of PWM_GEN_0_BIT, PWM_GEN_1_BIT, PWM_GEN_2_BIT, or PWM_GEN_3_BIT. Description: For the selected PWM generators, this function causes all queued updates to the period or pulse width to be applied the next time the corresponding counter becomes zero. Returns: None.

14.3

Programming Example
The following example shows how to use the PWM API to initialize the PWM0 with a 50 KHz frequency, and with a 25% duty cycle on PWM0 and a 75% duty cycle on PWM1.
// // Configure the PWM generator for count down mode with immediate updates // to the parameters.

October 30, 2008

177

Pulse Width Modulator (PWM)

// PWMGenConfigure(PWM_BASE, PWM_GEN_0, PWM_GEN_MODE_DOWN | PWM_GEN_MODE_NO_SYNC); // // Set the period. For a 50 KHz frequency, the period = 1/50,000, or 20 // microseconds. For a 20 MHz clock, this translates to 400 clock ticks. // Use this value to set the period. // PWMGenPeriodSet(PWM_BASE, PWM_GEN_0, 400); // // Set the pulse width of PWM0 for a 25% duty cycle. // PWMPulseWidthSet(PWM_BASE, PWM_OUT_0, 100); // // Set the pulse width of PWM1 for a 75% duty cycle. // PWMPulseWidthSet(PWM_BASE, PWM_OUT_1, 300); // // Start the timers in generator 0. // PWMGenEnable(PWM_BASE, PWM_GEN_0); // // Enable the outputs. // PWMOutputState(PWM_BASE, (PWM_OUT_0_BIT | PWM_OUT_1_BIT), true);

178

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

15

Quadrature Encoder (QEI)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188

15.1

Introduction
The quadrature encoder API provides a set of functions for dealing with the Quadrature Encoder with Index (QEI). Functions are provided to congure and read the position and velocity captures, register a QEI interrupt handler, and handle QEI interrupt masking/clearing. The quadrature encoder module provides hardware encoding of the two channels and the index signal from a quadrature encoder device into an absolute or relative position. There is additional hardware for capturing a measure of the encoder velocity, which is simply a count of encoder pulses during a xed time period; the number of pulses is directly proportional to the encoder speed. Note that the velocity capture can only operate when the position capture is enabled. The QEI module supports two modes of operation: phase mode and clock/direction mode. In phase mode, the encoder produces two clocks that are 90 degrees out of phase; the edge relationship is used to determine the direction of rotation. In clock/direction mode, the encoder produces a clock signal to indicate steps and a direction signal to indicate the direction of rotation. When in phase mode, edges on the rst channel or edges on both channels can be counted; counting edges on both channels provides higher encoder resolution if required. In either mode, the input signals can be swapped before being processed; this allows wiring mistakes on the circuit board to be corrected without modifying the board. The index pulse can be used to reset the position counter; this causes the position counter to maintain the absolute encoder position. Otherwise, the position counter maintains the relative position and is never reset. The velocity capture has a timer to measure equal periods of time. The number of encoder pulses over each time period is accumulated as a measure of the encoder velocity. The running total for the current time period and the nal count for the previous time period are available to be read. The nal count for the previous time period is usually used as the velocity measure. The QEI module will generate interrupts when the index pulse is detected, when the velocity timer expires, when the encoder direction changes, and when a phase signal error is detected. These interrupt sources can be individually masked so that only the events of interest cause a processor interrupt. This driver is contained in driverlib/qei.c, with driverlib/qei.h containing the API denitions for use by applications.

October 30, 2008

179

Quadrature Encoder (QEI)

15.2

API Functions
Functions
void QEICongure (unsigned long ulBase, unsigned long ulCong, unsigned long ulMaxPosition) long QEIDirectionGet (unsigned long ulBase) void QEIDisable (unsigned long ulBase) void QEIEnable (unsigned long ulBase) tBoolean QEIErrorGet (unsigned long ulBase) void QEIIntClear (unsigned long ulBase, unsigned long ulIntFlags) void QEIIntDisable (unsigned long ulBase, unsigned long ulIntFlags) void QEIIntEnable (unsigned long ulBase, unsigned long ulIntFlags) void QEIIntRegister (unsigned long ulBase, void (pfnHandler)(void)) unsigned long QEIIntStatus (unsigned long ulBase, tBoolean bMasked) void QEIIntUnregister (unsigned long ulBase) unsigned long QEIPositionGet (unsigned long ulBase) void QEIPositionSet (unsigned long ulBase, unsigned long ulPosition) void QEIVelocityCongure (unsigned long ulBase, unsigned long ulPreDiv, unsigned long ulPeriod) void QEIVelocityDisable (unsigned long ulBase) void QEIVelocityEnable (unsigned long ulBase) unsigned long QEIVelocityGet (unsigned long ulBase)

15.2.1 Detailed Description

The quadrature encoder API is broken into three groups of functions: those that deal with position capture, those that deal with velocity capture, and those that deal with interrupt handling. The position capture is managed with QEIEnable(), QEIDisable(),QEICongure(), and QEIPositionSet(). The positional information is retrieved with QEIPositionGet(), QEIDirectionGet(), and QEIErrorGet(). The velocity capture is managed with QEIVelocityEnable(), QEIVelocityDisable(), and QEIVelocityCongure(). The computed encoder velocity is retrieved with QEIVelocityGet(). The interrupt handler for the QEI interrupt is managed with QEIIntRegister() and QEIIntUnregister(). The individual interrupt sources within the QEI module are managed with QEIIntEnable(), QEIIntDisable(), QEIIntStatus(), and QEIIntClear().

15.2.2 Function Documentation

15.2.2.1 QEICongure
Congures the quadrature encoder.

180

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void QEIConfigure(unsigned long ulBase, unsigned long ulConfig, unsigned long ulMaxPosition) Parameters: ulBase is the base address of the quadrature encoder module. ulCong is the conguration for the quadrature encoder. See below for a description of this parameter. ulMaxPosition species the maximum position value. Description: This will congure the operation of the quadrature encoder. The ulCong parameter provides the conguration of the encoder and is the logical OR of several values: QEI_CONFIG_CAPTURE_A or QEI_CONFIG_CAPTURE_A_B to specify if edges on channel A or on both channels A and B should be counted by the position integrator and velocity accumulator. QEI_CONFIG_NO_RESET or QEI_CONFIG_RESET_IDX to specify if the position integrator should be reset when the index pulse is detected. QEI_CONFIG_QUADRATURE or QEI_CONFIG_CLOCK_DIR to specify if quadrature signals are being provided on ChA and ChB, or if a direction signal and a clock are being provided instead. QEI_CONFIG_NO_SWAP or QEI_CONFIG_SWAP to specify if the signals provided on ChA and ChB should be swapped before being processed. ulMaxPosition is the maximum value of the position integrator, and is the value used to reset the position capture when in index reset mode and moving in the reverse (negative) direction. Returns: None.

15.2.2.2 QEIDirectionGet
Gets the current direction of rotation. Prototype: long QEIDirectionGet(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This returns the current direction of rotation. In this case, current means the most recently detected direction of the encoder; it may not be presently moving but this is the direction it last moved before it stopped. Returns: Returns 1 if moving in the forward direction or -1 if moving in the reverse direction.

October 30, 2008

181

Quadrature Encoder (QEI)

15.2.2.3 QEIDisable
Disables the quadrature encoder. Prototype: void QEIDisable(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This will disable operation of the quadrature encoder module. Returns: None.

15.2.2.4 QEIEnable
Enables the quadrature encoder. Prototype: void QEIEnable(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This will enable operation of the quadrature encoder module. It must be congured before it is enabled. See also: QEICongure() Returns: None.

15.2.2.5 QEIErrorGet
Gets the encoder error indicator. Prototype: tBoolean QEIErrorGet(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This returns the error indicator for the quadrature encoder. It is an error for both of the signals of the quadrature input to change at the same time.

182

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Returns: Returns true if an error has occurred and false otherwise.

15.2.2.6 QEIIntClear
Clears quadrature encoder interrupt sources. Prototype: void QEIIntClear(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the quadrature encoder module. ulIntFlags is a bit mask of the interrupt sources to be cleared. Can be any of the QEI_INTERROR, QEI_INTDIR, QEI_INTTIMER, or QEI_INTINDEX values. Description: The specied quadrature encoder interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

15.2.2.7 QEIIntDisable
Disables individual quadrature encoder interrupt sources. Prototype: void QEIIntDisable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the quadrature encoder module. ulIntFlags is a bit mask of the interrupt sources to be disabled. Can be any of the QEI_INTERROR, QEI_INTDIR, QEI_INTTIMER, or QEI_INTINDEX values. Description: Disables the indicated quadrature encoder interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor.

October 30, 2008

183

Quadrature Encoder (QEI)

Returns: None.

15.2.2.8 QEIIntEnable
Enables individual quadrature encoder interrupt sources. Prototype: void QEIIntEnable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the quadrature encoder module. ulIntFlags is a bit mask of the interrupt sources to be enabled. Can be any of the QEI_INTERROR, QEI_INTDIR, QEI_INTTIMER, or QEI_INTINDEX values. Description: Enables the indicated quadrature encoder interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. Returns: None.

15.2.2.9 QEIIntRegister
Registers an interrupt handler for the quadrature encoder interrupt. Prototype: void QEIIntRegister(unsigned long ulBase, void (*pfnHandler)(void)) Parameters: ulBase is the base address of the quadrature encoder module. pfnHandler is a pointer to the function to be called when the quadrature encoder interrupt occurs. Description: This sets the handler to be called when a quadrature encoder interrupt occurs. This will enable the global interrupt in the interrupt controller; specic quadrature encoder interrupts must be enabled via QEIIntEnable(). It is the interrupt handlers responsibility to clear the interrupt source via QEIIntClear(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

184

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

15.2.2.10 QEIIntStatus
Gets the current interrupt status. Prototype: unsigned long QEIIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the quadrature encoder module. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the quadrature encoder module. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: Returns the current interrupt status, enumerated as a bit eld of QEI_INTERROR, QEI_INTDIR, QEI_INTTIMER, and QEI_INTINDEX.

15.2.2.11 QEIIntUnregister
Unregisters an interrupt handler for the quadrature encoder interrupt. Prototype: void QEIIntUnregister(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This function will clear the handler to be called when a quadrature encoder interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

15.2.2.12 QEIPositionGet
Gets the current encoder position. Prototype: unsigned long QEIPositionGet(unsigned long ulBase)

October 30, 2008

185

Quadrature Encoder (QEI)

Parameters: ulBase is the base address of the quadrature encoder module. Description: This returns the current position of the encoder. Depending upon the conguration of the encoder, and the incident of an index pulse, this value may or may not contain the expected data (that is, if in reset on index mode, if an index pulse has not been encountered, the position counter will not be aligned with the index pulse yet). Returns: The current position of the encoder.

15.2.2.13 QEIPositionSet
Sets the current encoder position. Prototype: void QEIPositionSet(unsigned long ulBase, unsigned long ulPosition) Parameters: ulBase is the base address of the quadrature encoder module. ulPosition is the new position for the encoder. Description: This sets the current position of the encoder; the encoder position will then be measured relative to this value. Returns: None.

15.2.2.14 QEIVelocityCongure
Congures the velocity capture. Prototype: void QEIVelocityConfigure(unsigned long ulBase, unsigned long ulPreDiv, unsigned long ulPeriod) Parameters: ulBase is the base address of the quadrature encoder module. ulPreDiv species the predivider applied to the input quadrature signal before it is counted; can be one of QEI_VELDIV_1, QEI_VELDIV_2, QEI_VELDIV_4, QEI_VELDIV_8, QEI_VELDIV_16, QEI_VELDIV_32, QEI_VELDIV_64, or QEI_VELDIV_128. ulPeriod species the number of clock ticks over which to measure the velocity; must be nonzero.

186

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This will congure the operation of the velocity capture portion of the quadrature encoder. The position increment signal is predivided as specied by ulPreDiv before being accumulated by the velocity capture. The divided signal is accumulated over ulPeriod system clock before being saved and resetting the accumulator. Returns: None.

15.2.2.15 QEIVelocityDisable
Disables the velocity capture. Prototype: void QEIVelocityDisable(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This will disable operation of the velocity capture in the quadrature encoder module. Returns: None.

15.2.2.16 QEIVelocityEnable
Enables the velocity capture. Prototype: void QEIVelocityEnable(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This will enable operation of the velocity capture in the quadrature encoder module. It must be congured before it is enabled. Velocity capture will not occur if the quadrature encoder is not enabled. See also: QEIVelocityCongure() and QEIEnable() Returns: None.

October 30, 2008

187

Quadrature Encoder (QEI)

15.2.2.17 QEIVelocityGet
Gets the current encoder speed. Prototype: unsigned long QEIVelocityGet(unsigned long ulBase) Parameters: ulBase is the base address of the quadrature encoder module. Description: This returns the current speed of the encoder. The value returned is the number of pulses detected in the specied time period; this number can be multiplied by the number of time periods per second and divided by the number of pulses per revolution to obtain the number of revolutions per second. Returns: Returns the number of pulses captured in the given time period.

15.3

Programming Example
The following example shows how to use the Quadrature Encoder API to congure the quadrature encoder read back an absolute position.
// // Configure the quadrature encoder to capture edges on both signals and // maintain an absolute position by resetting on index pulses. Using a // 1000 line encoder at four edges per line, there are 4000 pulses per // revolution; therefore set the maximum position to 3999 since the count // is zero based. // QEIConfigure(QEI_BASE, (QEI_CONFIG_CAPTURE_A_B | QEI_CONFIG_RESET_IDX | QEI_CONFIG_QUADRATURE | QEI_CONFIG_NO_SWAP), 3999); // // Enable the quadrature encoder. // QEIEnable(QEI_BASE); // // Delay for some time... // // // Read the encoder position. // QEIPositionGet(QEI_BASE);

188

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

16

Synchronous Serial Interface (SSI)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198

16.1

Introduction
The Synchronous Serial Interface (SSI) module provides the functionality for synchronous serial communications with peripheral devices, and can be congured to use either the Motorola SPI, National Semiconductor Microwire, or the Texas Instruments synchronous serial interface frame formats. The size of the data frame is also congurable, and can be set to be between 4 and 16 bits, inclusive. The SSI module performs serial-to-parallel data conversion on data received from a peripheral device, and parallel-to-serial conversion on data transmitted to a peripheral device. The TX and RX paths are buffered with internal FIFOs allowing up to eight 16-bit values to be stored independently. The SSI module can be congured as either a master or a slave device. As a slave device, the SSI module can also be congured to disable its output, which allows a master device to be coupled with multiple slave devices. The SSI module also includes a programmable bit rate clock divider and prescaler to generate the output serial clock derived from the SSI modules input clock. Bit rates are generated based on the input clock and the maximum bit rate supported by the connected peripheral. For parts that include a DMA controller, the SSI module also provides a DMA interface to facilitate data transfer via DMA. This driver is contained in driverlib/ssi.c, with driverlib/ssi.h containing the API denitions for use by applications.

16.2

API Functions
Functions
void SSICongSetExpClk (unsigned long ulBase, unsigned long ulSSIClk, unsigned long ulProtocol, unsigned long ulMode, unsigned long ulBitRate, unsigned long ulDataWidth) void SSIDataGet (unsigned long ulBase, unsigned long pulData) long SSIDataGetNonBlocking (unsigned long ulBase, unsigned long pulData) void SSIDataPut (unsigned long ulBase, unsigned long ulData) long SSIDataPutNonBlocking (unsigned long ulBase, unsigned long ulData) void SSIDisable (unsigned long ulBase) void SSIDMADisable (unsigned long ulBase, unsigned long ulDMAFlags) void SSIDMAEnable (unsigned long ulBase, unsigned long ulDMAFlags) void SSIEnable (unsigned long ulBase) void SSIIntClear (unsigned long ulBase, unsigned long ulIntFlags) void SSIIntDisable (unsigned long ulBase, unsigned long ulIntFlags)

October 30, 2008

189

Synchronous Serial Interface (SSI)

void SSIIntEnable (unsigned long ulBase, unsigned long ulIntFlags) void SSIIntRegister (unsigned long ulBase, void (pfnHandler)(void)) unsigned long SSIIntStatus (unsigned long ulBase, tBoolean bMasked) void SSIIntUnregister (unsigned long ulBase)

16.2.1 Detailed Description

The SSI API is broken into 3 groups of functions: those that deal with conguration and state, those that handle data, and those that manage interrupts. The conguration of the SSI module is managed by the SSICongSetExpClk() function, while state is managed by the SSIEnable() and SSIDisable() functions. The DMA interface is enabled or disabled by the SSIDMAEnable() and SSIDMADisable() functions. Data handling is performed by the SSIDataPut(), SSIDataPutNonBlocking(), SSIDataGet(), and SSIDataGetNonBlocking() functions. Interrupts from the SSI module are managed using the SSIIntClear(), SSIIntDisable(), SSIIntEnable(), SSIIntRegister(), SSIIntStatus(), and SSIIntUnregister() functions. The SSICong(), SSIDataNonBlockingGet(), and SSIDataNonBlockingPut() APIs from previous versions of the peripheral driver library have been replaced by the SSICongSetExpClk(), SSIDataGetNonBlocking(), and SSIDataPutNonBlocking() APIs. Macros have been provided in ssi.h to map the old APIs to the new APIs, allowing existing applications to link and run with the new APIs. It is recommended that new applications utilize the new APIs in favor of the old ones.

16.2.2 Function Documentation

16.2.2.1 SSICongSetExpClk
Congures the synchronous serial interface. Prototype: void SSIConfigSetExpClk(unsigned unsigned unsigned unsigned unsigned unsigned

long long long long long long

ulBase, ulSSIClk, ulProtocol, ulMode, ulBitRate, ulDataWidth)

Parameters: ulBase species the SSI module base address. ulSSIClk is the rate of the clock supplied to the SSI module. ulProtocol species the data transfer protocol. ulMode species the mode of operation. ulBitRate species the clock rate. ulDataWidth species number of bits transferred per frame.

190

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function congures the synchronous serial interface. It sets the SSI protocol, mode of operation, bit rate, and data width. The ulProtocol parameter denes the data frame format. The ulProtocol parameter can be one of the following values: SSI_FRF_MOTO_MODE_0, SSI_FRF_MOTO_MODE_1, SSI_FRF_MOTO_MODE_2, SSI_FRF_MOTO_MODE_3, SSI_FRF_TI, or SSI_FRF_NMW. The Motorola frame formats imply the following polarity and phase congurations:
Polarity Phase Mode 0 0 SSI_FRF_MOTO_MODE_0 0 1 SSI_FRF_MOTO_MODE_1 1 0 SSI_FRF_MOTO_MODE_2 1 1 SSI_FRF_MOTO_MODE_3

The ulMode parameter denes the operating mode of the SSI module. The SSI module can operate as a master or slave; if a slave, the SSI can be congured to disable output on its serial output line. The ulMode parameter can be one of the following values: SSI_MODE_MASTER, SSI_MODE_SLAVE, or SSI_MODE_SLAVE_OD. The ulBitRate parameter denes the bit rate for the SSI. This bit rate must satisfy the following clock ratio criteria: FSSI >= 2 bit rate (master mode) FSSI >= 12 bit rate (slave modes) where FSSI is the frequency of the clock supplied to the SSI module. The ulDataWidth parameter denes the width of the data transfers, and can be a value between 4 and 16, inclusive. The peripheral clock will be the same as the processor clock. This will be the value returned by SysCtlClockGet(), or it can be explicitly hard coded if it is constant and known (to save the code/execution overhead of a call to SysCtlClockGet()). This function replaces the original SSICong() API and performs the same actions. A macro is provided in ssi.h to map the original API to this API. Returns: None.

16.2.2.2 SSIDataGet
Gets a data element from the SSI receive FIFO. Prototype: void SSIDataGet(unsigned long ulBase, unsigned long *pulData) Parameters: ulBase species the SSI module base address. pulData pointer to a storage location for data that was received over the SSI interface.

October 30, 2008

191

Synchronous Serial Interface (SSI)

Description: This function will get received data from the receive FIFO of the specied SSI module, and place that data into the location specied by the pulData parameter. Note: Only the lower N bits of the value written to pulData will contain valid data, where N is the data width as congured by SSICongSetExpClk(). For example, if the interface is congured for 8-bit data width, only the lower 8 bits of the value written to pulData will contain valid data. Returns: None.

16.2.2.3 SSIDataGetNonBlocking
Gets a data element from the SSI receive FIFO. Prototype: long SSIDataGetNonBlocking(unsigned long ulBase, unsigned long *pulData) Parameters: ulBase species the SSI module base address. pulData pointer to a storage location for data that was received over the SSI interface. Description: This function will get received data from the receive FIFO of the specied SSI module, and place that data into the location specied by the ulData parameter. If there is no data in the FIFO, then this function will return a zero. This function replaces the original SSIDataNonBlockingGet() API and performs the same actions. A macro is provided in ssi.h to map the original API to this API. Note: Only the lower N bits of the value written to pulData will contain valid data, where N is the data width as congured by SSICongSetExpClk(). For example, if the interface is congured for 8-bit data width, only the lower 8 bits of the value written to pulData will contain valid data. Returns: Returns the number of elements read from the SSI receive FIFO.

16.2.2.4 SSIDataPut
Puts a data element into the SSI transmit FIFO. Prototype: void SSIDataPut(unsigned long ulBase, unsigned long ulData) Parameters: ulBase species the SSI module base address.

192

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

ulData data to be transmitted over the SSI interface. Description: This function will place the supplied data into the transmit FIFO of the specied SSI module. Note: The upper 32 - N bits of the ulData will be discarded by the hardware, where N is the data width as congured by SSICongSetExpClk(). For example, if the interface is congured for 8-bit data width, the upper 24 bits of ulData will be discarded. Returns: None.

16.2.2.5 SSIDataPutNonBlocking
Puts a data element into the SSI transmit FIFO. Prototype: long SSIDataPutNonBlocking(unsigned long ulBase, unsigned long ulData) Parameters: ulBase species the SSI module base address. ulData data to be transmitted over the SSI interface. Description: This function will place the supplied data into the transmit FIFO of the specied SSI module. If there is no space in the FIFO, then this function will return a zero. This function replaces the original SSIDataNonBlockingPut() API and performs the same actions. A macro is provided in ssi.h to map the original API to this API. Note: The upper 32 - N bits of the ulData will be discarded by the hardware, where N is the data width as congured by SSICongSetExpClk(). For example, if the interface is congured for 8-bit data width, the upper 24 bits of ulData will be discarded. Returns: Returns the number of elements written to the SSI transmit FIFO.

16.2.2.6 SSIDisable
Disables the synchronous serial interface. Prototype: void SSIDisable(unsigned long ulBase) Parameters: ulBase species the SSI module base address.

October 30, 2008

193

Synchronous Serial Interface (SSI)

Description: This will disable operation of the synchronous serial interface. Returns: None.

16.2.2.7 SSIDMADisable
Disable SSI DMA operation. Prototype: void SSIDMADisable(unsigned long ulBase, unsigned long ulDMAFlags) Parameters: ulBase is the base address of the SSI port. ulDMAFlags is a bit mask of the DMA features to disable. Description: This function is used to disable SSI DMA features that were enabled by SSIDMAEnable(). The specied SSI DMA features are disabled. The ulDMAFlags parameter is the logical OR of any of the following values: SSI_DMA_RX - disable DMA for receive SSI_DMA_TX - disable DMA for transmit Returns: None.

16.2.2.8 SSIDMAEnable
Enable SSI DMA operation. Prototype: void SSIDMAEnable(unsigned long ulBase, unsigned long ulDMAFlags) Parameters: ulBase is the base address of the SSI port. ulDMAFlags is a bit mask of the DMA features to enable. Description: The specied SSI DMA features are enabled. The SSI can be congured to use DMA for transmit and/or receive data transfers. The ulDMAFlags parameter is the logical OR of any of the following values: SSI_DMA_RX - enable DMA for receive SSI_DMA_TX - enable DMA for transmit

194

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Note: The uDMA controller must also be set up before DMA can be used with the SSI. Returns: None.

16.2.2.9 SSIEnable
Enables the synchronous serial interface. Prototype: void SSIEnable(unsigned long ulBase) Parameters: ulBase species the SSI module base address. Description: This will enable operation of the synchronous serial interface. It must be congured before it is enabled. Returns: None.

16.2.2.10 SSIIntClear
Clears SSI interrupt sources. Prototype: void SSIIntClear(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase species the SSI module base address. ulIntFlags is a bit mask of the interrupt sources to be cleared. Description: The specied SSI interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. The ulIntFlags parameter can consist of either or both the SSI_RXTO and SSI_RXOR values. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

October 30, 2008

195

Synchronous Serial Interface (SSI)

16.2.2.11 SSIIntDisable
Disables individual SSI interrupt sources. Prototype: void SSIIntDisable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase species the SSI module base address. ulIntFlags is a bit mask of the interrupt sources to be disabled. Description: Disables the indicated SSI interrupt sources. The ulIntFlags parameter can be any of the SSI_TXFF, SSI_RXFF, SSI_RXTO, or SSI_RXOR values. Returns: None.

16.2.2.12 SSIIntEnable
Enables individual SSI interrupt sources. Prototype: void SSIIntEnable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase species the SSI module base address. ulIntFlags is a bit mask of the interrupt sources to be enabled. Description: Enables the indicated SSI interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter can be any of the SSI_TXFF, SSI_RXFF, SSI_RXTO, or SSI_RXOR values. Returns: None.

16.2.2.13 SSIIntRegister
Registers an interrupt handler for the synchronous serial interface. Prototype: void SSIIntRegister(unsigned long ulBase, void (*pfnHandler)(void))

196

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase species the SSI module base address. pfnHandler is a pointer to the function to be called when the synchronous serial interface interrupt occurs. Description: This sets the handler to be called when an SSI interrupt occurs. This will enable the global interrupt in the interrupt controller; specic SSI interrupts must be enabled via SSIIntEnable(). If necessary, it is the interrupt handlers responsibility to clear the interrupt source via SSIIntClear(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

16.2.2.14 SSIIntStatus
Gets the current interrupt status. Prototype: unsigned long SSIIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase species the SSI module base address. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the SSI module. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: The current interrupt status, enumerated as a bit eld of SSI_TXFF, SSI_RXFF, SSI_RXTO, and SSI_RXOR.

16.2.2.15 SSIIntUnregister
Unregisters an interrupt handler for the synchronous serial interface. Prototype: void SSIIntUnregister(unsigned long ulBase) Parameters: ulBase species the SSI module base address.

October 30, 2008

197

Synchronous Serial Interface (SSI)

Description: This function will clear the handler to be called when a SSI interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

16.3

Programming Example
The following example shows how to use the SSI API to congure the SSI module as a master device, and how to do a simple send of data.
char *pcChars = "SSI Master send data."; long lIdx; // // Configure the SSI. // SSIConfigSetExpClk(SSI_BASE, SysCtlClockGet(), SSI_FRF_MOTO_MODE0, SSI_MODE_MASTER, 2000000, 8); // // Enable the SSI module. // SSIEnable(SSI_BASE); // // Send some data. // lIdx = 0; while(pcChars[lIdx]) { if(SSIDataPut(SSI_BASE, pcChars[lIdx])) { lIdx++; } }

198

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

17

System Control
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221

17.1

Introduction
System control determines the overall operation of the device. It controls the clocking of the device, the set of peripherals that are enabled, conguration of the device and its resets, and provides information about the device. The members of the Stellaris family have a varying peripheral set and memory sizes. The device has a set of read-only registers that indicate the size of the memories, the peripherals that are present, and the pins that are present for peripherals that have a varying number of pins. This information can be used to write adaptive software that will run on more than one member of the Stellaris family. The device can be clocked from one of ve sources: an external oscillator, the main oscillator, the internal oscillator, the internal oscillator divided by four, or the PLL. The PLL can use any of the four oscillators as its input. Since the internal oscillator has a very wide error range (+/- 50%), it cannot be used for applications that require specic timing; its real use is for detecting failures of the main oscillator and the PLL, and for applications that strictly respond to external events and do not use time-based peripherals (such as a UART). When using the PLL, the input clock frequency is constrained to specic frequencies between 3.579545 MHz and 8.192 MHz (that is, the standard crystal frequencies in that range). When direct clocking with an external oscillator or the main oscillator, the frequency is constrained to between 0 Hz and 50 MHz (depending on the part). The internal oscillator is 15 MHz, +/- 50%; its frequency will vary by device, with voltage, and with temperature. The internal oscillator provides no tuning or frequency measurement mechanism; its frequency is not adjustable. Almost the entire device operates from a single clock. The ADC and PWM blocks have their own clocks. In order to use the ADC, the PLL must be used; the PLL output will be used to create the clock required by the ADC. The PWM has its own optional divider from the system clock; this can be power of two divides between 1 and 64. Three modes of operation are supported by the Stellaris family: run mode, sleep mode, and deepsleep mode. In run mode, the processor is actively executing code. In sleep mode, the clocking of the device is unchanged but the processor no longer executes code (and is no longer clocked). In deep-sleep mode, the clocking of the device may change (depending upon the run mode clock conguration) and the processor no longer executes code (and is no longer clocked). An interrupt will return the device to run mode from one of the sleep modes; the sleep modes are entered upon request from the code. The device has an internal LDO for generating the on-chip 2.5 V power supply; the output voltage of the LDO can be adjusted between 2.25 V and 2.75 V. Depending upon the application, lower voltage may be advantageous for its power savings, or higher voltage may be advantageous for its improved performance. The default setting of 2.5 V is a good compromise between the two, and should not be changed without careful consideration and evaluation. There are several system events that, when detected, will cause system control to reset the device. These events are the input voltage dropping too low, the LDO voltage dropping too low, an external

October 30, 2008

199

System Control

reset, a software reset request, and a watchdog timeout. The properties of some of these events can be congured, and the reason for a reset can be determined from system control. Each peripheral in the device can be individually enabled, disabled, or reset. Additionally, the set of peripherals that remain enabled during sleep mode and deep-sleep mode can be congured, allowing custom sleep and deep-sleep modes to be dened. Care must be taken with deep-sleep mode, though, since in this mode the PLL is no longer used and the system is clocked by the input crystal. Peripherals that depend upon a particular input clock rate (such as a UART) will not operate as expected in deep-sleep mode due to the clock rate change; these peripherals must either be recongured upon entry to and exit from deep-sleep mode, or simply not enabled in deep-sleep mode. There are various system events that, when detected, will cause system control to generate a processor interrupt. These events are the PLL achieving lock, the internal LDO current limit being exceeded, the internal oscillator failing, the main oscillator failing, the input voltage dropping too low, the internal LDO voltage dropping too low, and the PLL failing. Each of these interrupts can be individually enabled or disabled, and the sources must be cleared by the interrupt handler when they occur. This driver is contained in driverlib/sysctl.c, with driverlib/sysctl.h containing the API denitions for use by applications.

17.2

API Functions
Functions
unsigned long SysCtlADCSpeedGet (void) void SysCtlADCSpeedSet (unsigned long ulSpeed) void SysCtlBrownOutCongSet (unsigned long ulCong, unsigned long ulDelay) void SysCtlClkVericationClear (void) unsigned long SysCtlClockGet (void) void SysCtlClockSet (unsigned long ulCong) void SysCtlDeepSleep (void) void SysCtlDelay (unsigned long ulCount) unsigned long SysCtlFlashSizeGet (void) void SysCtlGPIOAHBDisable (unsigned long ulGPIOPeripheral) void SysCtlGPIOAHBEnable (unsigned long ulGPIOPeripheral) void SysCtlIntClear (unsigned long ulInts) void SysCtlIntDisable (unsigned long ulInts) void SysCtlIntEnable (unsigned long ulInts) void SysCtlIntRegister (void (pfnHandler)(void)) unsigned long SysCtlIntStatus (tBoolean bMasked) void SysCtlIntUnregister (void) void SysCtlIOSCVericationSet (tBoolean bEnable) void SysCtlLDOCongSet (unsigned long ulCong) unsigned long SysCtlLDOGet (void) void SysCtlLDOSet (unsigned long ulVoltage) void SysCtlMOSCVericationSet (tBoolean bEnable)

200

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

void SysCtlPeripheralClockGating (tBoolean bEnable) void SysCtlPeripheralDeepSleepDisable (unsigned long ulPeripheral) void SysCtlPeripheralDeepSleepEnable (unsigned long ulPeripheral) void SysCtlPeripheralDisable (unsigned long ulPeripheral) void SysCtlPeripheralEnable (unsigned long ulPeripheral) tBoolean SysCtlPeripheralPresent (unsigned long ulPeripheral) void SysCtlPeripheralReset (unsigned long ulPeripheral) void SysCtlPeripheralSleepDisable (unsigned long ulPeripheral) void SysCtlPeripheralSleepEnable (unsigned long ulPeripheral) tBoolean SysCtlPinPresent (unsigned long ulPin) void SysCtlPLLVericationSet (tBoolean bEnable) unsigned long SysCtlPWMClockGet (void) void SysCtlPWMClockSet (unsigned long ulCong) void SysCtlReset (void) void SysCtlResetCauseClear (unsigned long ulCauses) unsigned long SysCtlResetCauseGet (void) void SysCtlSleep (void) unsigned long SysCtlSRAMSizeGet (void) void SysCtlUSBPLLDisable (void) void SysCtlUSBPLLEnable (void)

17.2.1 Detailed Description

The SysCtl API is broken up into eight groups of functions: those that provide device information, those that deal with device clocking, those that provide peripheral control, those that deal with the SysCtl interrupt, those that deal with the LDO, those that deal with sleep modes, those that deal with reset reasons, those that deal with the brown-out reset, and those that deal with clock verication timers. Information about the device is provided by SysCtlSRAMSizeGet(), SysCtlFlashSizeGet(), SysCtlPeripheralPresent(), and SysCtlPinPresent(). Clocking of the device is congured with SysCtlClockSet() and SysCtlPWMClockSet(). Information about device clocking is provided by SysCtlClockGet() and SysCtlPWMClockGet(). Peripheral enabling and reset are controlled with SysCtlPeripheralReset(), SysCtlPeripheralEnable(), SysCtlPeripheralDisable(), SysCtlPeripheralSleepEnable(), SysCtlPeripheralSleepDisable(), SysCtlPeripheralDeepSleepEnable(), SysCtlPeripheralDeepSleepDisable(), and SysCtlPeripheralClockGating(). The system control interrupt is managed with SysCtlIntRegister(), SysCtlIntUnregister(), SysCtlIntEnable(), SysCtlIntDisable(), SysCtlIntClear(), SysCtlIntStatus(). The LDO is controlled with SysCtlLDOSet() and SysCtlLDOCongSet(). Its status is provided by SysCtlLDOGet(). The device is put into sleep modes with SysCtlSleep() and SysCtlDeepSleep(). The reset reason is managed with SysCtlResetCauseGet() and SysCtlResetCauseClear(). A software reset is performed with SysCtlReset(). The brown-out reset is congured with SysCtlBrownOutCongSet().

October 30, 2008

201

System Control

The clock verication timers are managed with SysCtlIOSCVericationSet(), SysCtlMOSCVericationSet(), SysCtlPLLVericationSet(), and SysCtlClkVericationClear().

17.2.2 Function Documentation

17.2.2.1 SysCtlADCSpeedGet
Gets the sample rate of the ADC. Prototype: unsigned long SysCtlADCSpeedGet(void) Description: This function gets the current sample rate of the ADC. Returns: Returns the current ADC sample rate; will be one of SYSCTL_ADCSPEED_1MSPS, SYSCTL_ADCSPEED_500KSPS, SYSCTL_ADCSPEED_250KSPS, or SYSCTL_ADCSPEED_125KSPS.

17.2.2.2 SysCtlADCSpeedSet
Sets the sample rate of the ADC. Prototype: void SysCtlADCSpeedSet(unsigned long ulSpeed) Parameters: ulSpeed is the desired sample rate of the ADC; must be one of SYSCTL_ADCSPEED_1MSPS, SYSCTL_ADCSPEED_500KSPS, SYSCTL_ADCSPEED_250KSPS, or SYSCTL_ADCSPEED_125KSPS. Description: This function sets the rate at which the ADC samples are captured by the ADC block. The sampling speed may be limited by the hardware, so the sample rate may end up being slower than requested. SysCtlADCSpeedGet() will return the actual speed in use. Returns: None.

17.2.2.3 SysCtlBrownOutCongSet
Congures the brown-out control. Prototype: void SysCtlBrownOutConfigSet(unsigned long ulConfig, unsigned long ulDelay)

202

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulCong is the desired conguration of the brown-out control. Must be the logical OR of SYSCTL_BOR_RESET and/or SYSCTL_BOR_RESAMPLE. ulDelay is the number of internal oscillator cycles to wait before resampling an asserted brown-out signal. This value only has meaning when SYSCTL_BOR_RESAMPLE is set and must be less than 8192. Description: This function congures how the brown-out control operates. It can detect a brown-out by looking at only the brown-out output, or it can wait for it to be active for two consecutive samples separated by a congurable time. When it detects a brown-out condition, it can either reset the device or generate a processor interrupt. Returns: None.

17.2.2.4 SysCtlClkVericationClear
Clears the clock verication status. Prototype: void SysCtlClkVerificationClear(void) Description: This function clears the status of the clock verication timers, allowing them to assert another failure if detected. The clock verication timers are only available on Sandstorm-class devices. Returns: None.

17.2.2.5 SysCtlClockGet
Gets the processor clock rate. Prototype: unsigned long SysCtlClockGet(void) Description: This function determines the clock rate of the processor clock. This is also the clock rate of all the peripheral modules (with the exception of PWM, which has its own clock divider). Note: This will not return accurate results if SysCtlClockSet() has not been called to congure the clocking of the device, or if the device is directly clocked from a crystal (or a clock source) that is not one of the supported crystal frequencies. In the later case, this function should be modied to directly return the correct system clock rate. Returns: The processor clock rate.

October 30, 2008

203

System Control

17.2.2.6 SysCtlClockSet
Sets the clocking of the device. Prototype: void SysCtlClockSet(unsigned long ulConfig) Parameters: ulCong is the required conguration of the device clocking. Description: This function congures the clocking of the device. The input crystal frequency, oscillator to be used, use of the PLL, and the system clock divider are all congured with this function. The ulCong parameter is the logical OR of several different values, many of which are grouped into sets where only one can be chosen. The system clock divider is chosen with one of the following values: SYSCTL_SYSDIV_1, SYSCTL_SYSDIV_2, SYSCTL_SYSDIV_3, ... SYSCTL_SYSDIV_64. Only SYSCTL_SYSDIV_1 through SYSCTL_SYSDIV_16 are valid on Sandstorm-class devices. The use of the PLL is chosen with either SYSCTL_USE_PLL or SYSCTL_USE_OSC. The external crystal frequency is chosen with one of the following values: SYSCTL_XTAL_1MHZ, SYSCTL_XTAL_1_84MHZ, SYSCTL_XTAL_2MHZ, SYSCTL_XTAL_2_45MHZ, SYSCTL_XTAL_3_57MHZ, SYSCTL_XTAL_3_68MHZ, SYSCTL_XTAL_4MHZ, SYSCTL_XTAL_4_09MHZ, SYSCTL_XTAL_4_91MHZ, SYSCTL_XTAL_5MHZ, SYSCTL_XTAL_5_12MHZ, SYSCTL_XTAL_6MHZ, SYSCTL_XTAL_6_14MHZ, SYSCTL_XTAL_7_37MHZ, SYSCTL_XTAL_8MHZ, SYSCTL_XTAL_8_19MHZ, SYSCTL_XTAL_10MHZ, SYSCTL_XTAL_12MHZ, SYSCTL_XTAL_12_2MHZ, SYSCTL_XTAL_13_5MHZ, SYSCTL_XTAL_14_3MHZ, SYSCTL_XTAL_16MHZ, or SYSCTL_XTAL_16_3MHZ. Values below SYSCTL_XTAL_3_57MHZ are not valid when the PLL is in operation. On Sandstormand Fury-class devices, values above SYSCTL_XTAL_8_19MHZ are not valid. The oscillator source is chosen with one of the following values: SYSCTL_OSC_MAIN, SYSCTL_OSC_INT, SYSCTL_OSC_INT4, SYSCTL_OSC_INT30, or SYSCTL_OSC_EXT32. On Sandstorm-class devices, SYSCTL_OSC_INT30 and SYSCTL_OSC_EXT32 are not valid. SYSCTL_OSC_EXT32 is only available on devices with the hibernate module, and then only when the hibernate module has been enabled. The internal and main oscillators are disabled with the SYSCTL_INT_OSC_DIS and SYSCTL_MAIN_OSC_DIS ags, respectively. The external oscillator must be enabled in order to use an external clock source. Note that attempts to disable the oscillator used to clock the device will be prevented by the hardware. To clock the system from an external source (such as an external crystal oscillator), use SYSCTL_USE_OSC | SYSCTL_OSC_MAIN. To clock the system from the main oscillator, use SYSCTL_USE_OSC | SYSCTL_OSC_MAIN. To clock the system from the PLL, use SYSCTL_USE_PLL | SYSCTL_OSC_MAIN, and select the appropriate crystal with one of the SYSCTL_XTAL_xxx values. Note: If selecting the PLL as the system clock source (that is, via SYSCTL_USE_PLL), this function will poll the PLL lock interrupt to determine when the PLL has locked. If an interrupt handler for the system control interrupt is in place, and it responds to and clears the PLL lock interrupt,

204

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

this function will delay until its timeout has occurred instead of completing as soon as PLL lock is achieved. Returns: None.

17.2.2.7 SysCtlDeepSleep
Puts the processor into deep-sleep mode. Prototype: void SysCtlDeepSleep(void) Description: This function places the processor into deep-sleep mode; it will not return until the processor returns to run mode. The peripherals that are enabled via SysCtlPeripheralDeepSleepEnable() continue to operate and can wake up the processor (if automatic clock gating is enabled with SysCtlPeripheralClockGating(), otherwise all peripherals continue to operate). Returns: None.

17.2.2.8 SysCtlDelay
Provides a small delay. Prototype: void SysCtlDelay(unsigned long ulCount) Parameters: ulCount is the number of delay loop iterations to perform. Description: This function provides a means of generating a constant length delay. It is written in assembly to keep the delay consistent across tool chains, avoiding the need to tune the delay based on the tool chain in use. The loop takes 3 cycles/loop. Returns: None.

17.2.2.9 SysCtlFlashSizeGet
Gets the size of the ash. Prototype: unsigned long SysCtlFlashSizeGet(void)

October 30, 2008

205

System Control

Description: This function determines the size of the ash on the Stellaris device. Returns: The total number of bytes of ash.

17.2.2.10 SysCtlGPIOAHBDisable
Disables a GPIO peripheral for access from the high speed bus. Prototype: void SysCtlGPIOAHBDisable(unsigned long ulGPIOPeripheral) Parameters: ulGPIOPeripheral is the GPIO peripheral to disable. Description: This function will disable the specied GPIO peripherals for access from the high speed bus. Once disabled, the GPIO peripheral is accessed from the peripheral bus. The ulGPIOPeripheral argument must be only one SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOG, or SYSCTL_PERIPH_GPIOH. Returns: None. of the following values: SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOF,

17.2.2.11 SysCtlGPIOAHBEnable
Enables a GPIO peripheral for access from the high speed bus. Prototype: void SysCtlGPIOAHBEnable(unsigned long ulGPIOPeripheral) Parameters: ulGPIOPeripheral is the GPIO peripheral to enable. Description: This function is used to enable the specied GPIO peripherals to be accessed from the high speed bus instead of the peripheral bus. When a GPIO peripheral is enabled for high speed access, the _AHB_BASE form of the base address should be used for GPIO functions. For example, instead of using GPIO_PORTA_BASE as the base address for GPIO functions, use GPIO_PORTA_AHB_BASE instead. The ulGPIOPeripheral argument must be only one SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOG, or SYSCTL_PERIPH_GPIOH. of the following values: SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOF,

206

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Returns: None.

17.2.2.12 SysCtlIntClear
Clears system control interrupt sources. Prototype: void SysCtlIntClear(unsigned long ulInts) Parameters: ulInts is a bit mask of the interrupt sources to be cleared. Must be a logical OR of SYSCTL_INT_PLL_LOCK, SYSCTL_INT_CUR_LIMIT, SYSCTL_INT_IOSC_FAIL, SYSCTL_INT_MOSC_FAIL, SYSCTL_INT_POR, SYSCTL_INT_BOR, and/or SYSCTL_INT_PLL_FAIL. Description: The specied system control interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

17.2.2.13 SysCtlIntDisable
Disables individual system control interrupt sources. Prototype: void SysCtlIntDisable(unsigned long ulInts) Parameters: ulInts is a bit mask of the interrupt sources to be disabled. Must be a logical OR of SYSCTL_INT_PLL_LOCK, SYSCTL_INT_CUR_LIMIT, SYSCTL_INT_IOSC_FAIL, SYSCTL_INT_MOSC_FAIL, SYSCTL_INT_POR, SYSCTL_INT_BOR, and/or SYSCTL_INT_PLL_FAIL. Description: Disables the indicated system control interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. Returns: None.

October 30, 2008

207

System Control

17.2.2.14 SysCtlIntEnable
Enables individual system control interrupt sources. Prototype: void SysCtlIntEnable(unsigned long ulInts) Parameters: ulInts is a bit mask of the interrupt sources to be enabled. Must be a logical OR of SYSCTL_INT_PLL_LOCK, SYSCTL_INT_CUR_LIMIT, SYSCTL_INT_IOSC_FAIL, SYSCTL_INT_MOSC_FAIL, SYSCTL_INT_POR, SYSCTL_INT_BOR, and/or SYSCTL_INT_PLL_FAIL. Description: Enables the indicated system control interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. Returns: None.

17.2.2.15 SysCtlIntRegister
Registers an interrupt handler for the system control interrupt. Prototype: void SysCtlIntRegister(void (*pfnHandler)(void)) Parameters: pfnHandler is a pointer to the function to be called when the system control interrupt occurs. Description: This sets the handler to be called when a system control interrupt occurs. This will enable the global interrupt in the interrupt controller; specic system control interrupts must be enabled via SysCtlIntEnable(). It is the interrupt handlers responsibility to clear the interrupt source via SysCtlIntClear(). System control can generate interrupts when the PLL achieves lock, if the internal LDO current limit is exceeded, if the internal oscillator fails, if the main oscillator fails, if the internal LDO output voltage droops too much, if the external voltage droops too much, or if the PLL fails. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

17.2.2.16 SysCtlIntStatus
Gets the current interrupt status.

208

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: unsigned long SysCtlIntStatus(tBoolean bMasked) Parameters: bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the system controller. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: The current interrupt status, enumerated as a bit eld of SYSCTL_INT_PLL_LOCK, SYSCTL_INT_CUR_LIMIT, SYSCTL_INT_IOSC_FAIL, SYSCTL_INT_MOSC_FAIL, SYSCTL_INT_POR, SYSCTL_INT_BOR, and SYSCTL_INT_PLL_FAIL.

17.2.2.17 SysCtlIntUnregister
Unregisters the interrupt handler for the system control interrupt. Prototype: void SysCtlIntUnregister(void) Description: This function will clear the handler to be called when a system control interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

17.2.2.18 SysCtlIOSCVericationSet
Congures the internal oscillator verication timer. Prototype: void SysCtlIOSCVerificationSet(tBoolean bEnable) Parameters: bEnable is a boolean that is true if the internal oscillator verication timer should be enabled. Description: This function allows the internal oscillator verication timer to be enabled or disabled. When enabled, an interrupt will be generated if the internal oscillator ceases to operate. The internal oscillator verication timer is only available on Sandstorm-class devices.

October 30, 2008

209

System Control

Note: Both oscillators (main and internal) must be enabled for this verication timer to operate as the main oscillator will verify the internal oscillator. Returns: None.

17.2.2.19 SysCtlLDOCongSet
Congures the LDO failure control. Prototype: void SysCtlLDOConfigSet(unsigned long ulConfig) Parameters: ulCong is the required LDO failure control setting; can be either SYSCTL_LDOCFG_ARST or SYSCTL_LDOCFG_NORST. Description: This function allows the LDO to be congured to cause a processor reset when the output voltage becomes unregulated. The LDO failure control is only available on Sandstorm-class devices. Returns: None.

17.2.2.20 SysCtlLDOGet
Gets the output voltage of the LDO. Prototype: unsigned long SysCtlLDOGet(void) Description: This function determines the output voltage of the LDO, as specied by the control register. Returns: Returns the current voltage of the LDO; will be one of SYSCTL_LDO_2_25V, SYSCTL_LDO_2_30V, SYSCTL_LDO_2_35V, SYSCTL_LDO_2_40V, SYSCTL_LDO_2_45V, SYSCTL_LDO_2_50V, SYSCTL_LDO_2_55V, SYSCTL_LDO_2_60V, SYSCTL_LDO_2_65V, SYSCTL_LDO_2_70V, or SYSCTL_LDO_2_75V.

17.2.2.21 SysCtlLDOSet
Sets the output voltage of the LDO.

210

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void SysCtlLDOSet(unsigned long ulVoltage) Parameters: ulVoltage is the required output voltage from the LDO. Must be one of SYSCTL_LDO_2_25V, SYSCTL_LDO_2_30V, SYSCTL_LDO_2_35V, SYSCTL_LDO_2_40V, SYSCTL_LDO_2_45V, SYSCTL_LDO_2_50V, SYSCTL_LDO_2_55V, SYSCTL_LDO_2_60V, SYSCTL_LDO_2_65V, SYSCTL_LDO_2_70V, or SYSCTL_LDO_2_75V. Description: This function sets the output voltage of the LDO. The default voltage is 2.5 V; it can be adjusted +/- 10%. Returns: None.

17.2.2.22 SysCtlMOSCVericationSet
Congures the main oscillator verication timer. Prototype: void SysCtlMOSCVerificationSet(tBoolean bEnable) Parameters: bEnable is a boolean that is true if the main oscillator verication timer should be enabled. Description: This function allows the main oscillator verication timer to be enabled or disabled. When enabled, an interrupt will be generated if the main oscillator ceases to operate. The main oscillator verication timer is only available on Sandstorm-class devices. Note: Both oscillators (main and internal) must be enabled for this verication timer to operate as the internal oscillator will verify the main oscillator. Returns: None.

17.2.2.23 SysCtlPeripheralClockGating
Controls peripheral clock gating in sleep and deep-sleep mode. Prototype: void SysCtlPeripheralClockGating(tBoolean bEnable) Parameters: bEnable is a boolean that is true if the sleep and deep-sleep peripheral conguration should be used and false if not.

October 30, 2008

211

System Control

Description: This function controls how peripherals are clocked when the processor goes into sleep or deepsleep mode. By default, the peripherals are clocked the same as in run mode; if peripheral clock gating is enabled they are clocked according to the conguration set by SysCtlPeripheralSleepEnable(), SysCtlPeripheralSleepDisable(), SysCtlPeripheralDeepSleepEnable(), and SysCtlPeripheralDeepSleepDisable(). Returns: None.

17.2.2.24 SysCtlPeripheralDeepSleepDisable
Disables a peripheral in deep-sleep mode. Prototype: void SysCtlPeripheralDeepSleepDisable(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral to disable in deep-sleep mode. Description: This function causes a peripheral to stop operating when the processor goes into deep-sleep mode. Disabling peripherals while in deep-sleep mode helps to lower the current draw of the device, and can keep peripherals that require a particular clock frequency from operating when the clock changes as a result of entering deep-sleep mode. If enabled (via SysCtlPeripheralEnable()), the peripheral will automatically resume operation when the processor leaves deep-sleep mode, maintaining its entire state from before deep-sleep mode was entered. Deep-sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating(); if disabled, the peripheral deep-sleep mode conguration is maintained but has no effect when deep-sleep mode is entered. The ulPeripheral parameter must be one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1, SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Returns: None.

17.2.2.25 SysCtlPeripheralDeepSleepEnable
Enables a peripheral in deep-sleep mode.

212

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void SysCtlPeripheralDeepSleepEnable(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral to enable in deep-sleep mode. Description: This function allows a peripheral to continue operating when the processor goes into deepsleep mode. Since the clocking conguration of the device may change, not all peripherals can safely continue operating while the processor is in sleep mode. Those that must run at a particular frequency (such as a UART) will not work as expected if the clock changes. It is the responsibility of the caller to make sensible choices. Deep-sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating(); if disabled, the peripheral deep-sleep mode conguration is maintained but has no effect when deep-sleep mode is entered. The ulPeripheral parameter must be one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1, SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Returns: None.

17.2.2.26 SysCtlPeripheralDisable
Disables a peripheral. Prototype: void SysCtlPeripheralDisable(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral to disable. Description: Peripherals are disabled with this function. Once disabled, they will not operate or respond to register reads/writes. The ulPeripheral parameter must be only one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE,

October 30, 2008

213

System Control

SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1, SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Returns: None.

17.2.2.27 SysCtlPeripheralEnable
Enables a peripheral. Prototype: void SysCtlPeripheralEnable(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral to enable. Description: Peripherals are enabled with this function. At power-up, all peripherals are disabled; they must be enabled in order to operate or respond to register reads/writes. The ulPeripheral parameter must be only one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1, SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Note: It takes ve clock cycles after the write to enable a peripheral before the the peripheral is actually enabled. During this time, attempts to access the peripheral will result in a bus fault. Care should be taken to ensure that the peripheral is not accessed during this brief time period. Returns: None.

17.2.2.28 SysCtlPeripheralPresent
Determines if a peripheral is present.

214

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: tBoolean SysCtlPeripheralPresent(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral in question. Description: Determines if a particular peripheral is present in the device. Each member of the Stellaris family has a different peripheral set; this will determine which are present on this device. The ulPeripheral parameter must be only one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_IEEE1588, SYSCTL_PERIPH_MPU, SYSCTL_PERIPH_PLL, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1, SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TEMP, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Returns: Returns true if the specied peripheral is present and false if it is not.

17.2.2.29 SysCtlPeripheralReset
Performs a software reset of a peripheral. Prototype: void SysCtlPeripheralReset(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral to reset. Description: This function performs a software reset of the specied peripheral. An individual peripheral reset signal is asserted for a brief period and then deasserted, leaving the peripheral in a operating state but in its reset condition. The ulPeripheral parameter must be only one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1,

October 30, 2008

215

System Control

SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Returns: None.

17.2.2.30 SysCtlPeripheralSleepDisable
Disables a peripheral in sleep mode. Prototype: void SysCtlPeripheralSleepDisable(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral to disable in sleep mode. Description: This function causes a peripheral to stop operating when the processor goes into sleep mode. Disabling peripherals while in sleep mode helps to lower the current draw of the device. If enabled (via SysCtlPeripheralEnable()), the peripheral will automatically resume operation when the processor leaves sleep mode, maintaining its entire state from before sleep mode was entered. Sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating(); if disabled, the peripheral sleep mode conguration is maintained but has no effect when sleep mode is entered. The ulPeripheral parameter must be only one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1, SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Returns: None.

17.2.2.31 SysCtlPeripheralSleepEnable
Enables a peripheral in sleep mode.

216

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void SysCtlPeripheralSleepEnable(unsigned long ulPeripheral) Parameters: ulPeripheral is the peripheral to enable in sleep mode. Description: This function allows a peripheral to continue operating when the processor goes into sleep mode. Since the clocking conguration of the device does not change, any peripheral can safely continue operating while the processor is in sleep mode, and can therefore wake the processor from sleep mode. Sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating(); if disabled, the peripheral sleep mode conguration is maintained but has no effect when sleep mode is entered. The ulPeripheral parameter must be only one of the following values: SYSCTL_PERIPH_ADC, SYSCTL_PERIPH_CAN0, SYSCTL_PERIPH_CAN1, SYSCTL_PERIPH_CAN2, SYSCTL_PERIPH_COMP0, SYSCTL_PERIPH_COMP1, SYSCTL_PERIPH_COMP2, SYSCTL_PERIPH_ETH, SYSCTL_PERIPH_GPIOA, SYSCTL_PERIPH_GPIOB, SYSCTL_PERIPH_GPIOC, SYSCTL_PERIPH_GPIOD, SYSCTL_PERIPH_GPIOE, SYSCTL_PERIPH_GPIOF, SYSCTL_PERIPH_GPIOG, SYSCTL_PERIPH_GPIOH, SYSCTL_PERIPH_HIBERNATE, SYSCTL_PERIPH_I2C0, SYSCTL_PERIPH_I2C1, SYSCTL_PERIPH_PWM, SYSCTL_PERIPH_QEI0, SYSCTL_PERIPH_QEI1, SYSCTL_PERIPH_SSI0, SYSCTL_PERIPH_SSI1, SYSCTL_PERIPH_TIMER0, SYSCTL_PERIPH_TIMER1, SYSCTL_PERIPH_TIMER2, SYSCTL_PERIPH_TIMER3, SYSCTL_PERIPH_UART0, SYSCTL_PERIPH_UART1, SYSCTL_PERIPH_UART2, SYSCTL_PERIPH_UDMA, SYSCTL_PERIPH_USB0, or SYSCTL_PERIPH_WDOG. Returns: None.

17.2.2.32 SysCtlPinPresent
Determines if a pin is present. Prototype: tBoolean SysCtlPinPresent(unsigned long ulPin) Parameters: ulPin is the pin in question. Description: Determines if a particular pin is present in the device. The PWM, analog comparators, ADC, and timers have a varying number of pins across members of the Stellaris family; this will determine which are present on this device. The ulPin argument must be only one of the following values: SYSCTL_PIN_PWM0, SYSCTL_PIN_PWM1, SYSCTL_PIN_PWM2, SYSCTL_PIN_PWM3, SYSCTL_PIN_PWM4, SYSCTL_PIN_PWM5, SYSCTL_PIN_C0MINUS, SYSCTL_PIN_C0PLUS, SYSCTL_PIN_C0O, SYSCTL_PIN_C1MINUS, SYSCTL_PIN_C1PLUS, SYSCTL_PIN_C1O, SYSCTL_PIN_C2MINUS, SYSCTL_PIN_C2PLUS, SYSCTL_PIN_C2O,

October 30, 2008

217

System Control

SYSCTL_PIN_ADC0, SYSCTL_PIN_ADC1, SYSCTL_PIN_ADC2, SYSCTL_PIN_ADC4, SYSCTL_PIN_ADC5, SYSCTL_PIN_ADC6, SYSCTL_PIN_CCP0, SYSCTL_PIN_CCP1, SYSCTL_PIN_CCP2, SYSCTL_PIN_CCP4, SYSCTL_PIN_CCP5, SYSCTL_PIN_CCP6, SYSCTL_PIN_32KHZ, or SYSCTL_PIN_MC_FAULT0. Returns: Returns true if the specied pin is present and false if it is not.

SYSCTL_PIN_ADC3, SYSCTL_PIN_ADC7, SYSCTL_PIN_CCP3, SYSCTL_PIN_CCP7,

17.2.2.33 SysCtlPLLVericationSet
Congures the PLL verication timer. Prototype: void SysCtlPLLVerificationSet(tBoolean bEnable) Parameters: bEnable is a boolean that is true if the PLL verication timer should be enabled. Description: This function allows the PLL verication timer to be enabled or disabled. When enabled, an interrupt will be generated if the PLL ceases to operate. The PLL verication timer is only available on Sandstorm-class devices. Note: The main oscillator must be enabled for this verication timer to operate as it is used to check the PLL. Also, the verication timer should be disabled while the PLL is being recongured via SysCtlClockSet(). Returns: None.

17.2.2.34 SysCtlPWMClockGet
Gets the current PWM clock conguration. Prototype: unsigned long SysCtlPWMClockGet(void) Description: This function returns the current PWM clock conguration. Returns: Returns the current PWM clock conguration; will be one of SYSCTL_PWMDIV_1, SYSCTL_PWMDIV_2, SYSCTL_PWMDIV_4, SYSCTL_PWMDIV_8, SYSCTL_PWMDIV_16, SYSCTL_PWMDIV_32, or SYSCTL_PWMDIV_64.

218

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

17.2.2.35 SysCtlPWMClockSet
Sets the PWM clock conguration. Prototype: void SysCtlPWMClockSet(unsigned long ulConfig) Parameters: ulCong is the conguration for the PWM clock; it must be one of SYSCTL_PWMDIV_1, SYSCTL_PWMDIV_2, SYSCTL_PWMDIV_4, SYSCTL_PWMDIV_8, SYSCTL_PWMDIV_16, SYSCTL_PWMDIV_32, or SYSCTL_PWMDIV_64. Description: This function sets the rate of the clock provided to the PWM module as a ratio of the processor clock. This clock is used by the PWM module to generate PWM signals; its rate forms the basis for all PWM signals. Note: The clocking of the PWM is dependent upon the system clock rate as congured by SysCtlClockSet(). Returns: None.

17.2.2.36 SysCtlReset
Resets the device. Prototype: void SysCtlReset(void) Description: This function will perform a software reset of the entire device. The processor and all peripherals will be reset and all device registers will return to their default values (with the exception of the reset cause register, which will maintain its current value but have the software reset bit set as well). Returns: This function does not return.

17.2.2.37 SysCtlResetCauseClear
Clears reset reasons. Prototype: void SysCtlResetCauseClear(unsigned long ulCauses)

October 30, 2008

219

System Control

Parameters: ulCauses are the reset causes to be cleared; must be a logical OR of SYSCTL_CAUSE_LDO, SYSCTL_CAUSE_SW, SYSCTL_CAUSE_WDOG, SYSCTL_CAUSE_BOR, SYSCTL_CAUSE_POR, and/or SYSCTL_CAUSE_EXT. Description: This function clears the specied sticky reset reasons. Once cleared, another reset for the same reason can be detected, and a reset for a different reason can be distinguished (instead of having two reset causes set). If the reset reason is used by an application, all reset causes should be cleared after they are retrieved with SysCtlResetCauseGet(). Returns: None.

17.2.2.38 SysCtlResetCauseGet
Gets the reason for a reset. Prototype: unsigned long SysCtlResetCauseGet(void) Description: This function will return the reason(s) for a reset. Since the reset reasons are sticky until either cleared by software or an external reset, multiple reset reasons may be returned if multiple resets have occurred. The reset reason will be a logical OR of SYSCTL_CAUSE_LDO, SYSCTL_CAUSE_SW, SYSCTL_CAUSE_WDOG, SYSCTL_CAUSE_BOR, SYSCTL_CAUSE_POR, and/or SYSCTL_CAUSE_EXT. Returns: Returns the reason(s) for a reset.

17.2.2.39 SysCtlSleep
Puts the processor into sleep mode. Prototype: void SysCtlSleep(void) Description: This function places the processor into sleep mode; it will not return until the processor returns to run mode. The peripherals that are enabled via SysCtlPeripheralSleepEnable() continue to operate and can wake up the processor (if automatic clock gating is enabled with SysCtlPeripheralClockGating(), otherwise all peripherals continue to operate). Returns: None.

220

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

17.2.2.40 SysCtlSRAMSizeGet
Gets the size of the SRAM. Prototype: unsigned long SysCtlSRAMSizeGet(void) Description: This function determines the size of the SRAM on the Stellaris device. Returns: The total number of bytes of SRAM.

17.2.2.41 SysCtlUSBPLLDisable
Powers down the USB PLL. Prototype: void SysCtlUSBPLLDisable(void) Description: This function will disable the USB controllers PLL which is used by its physical layer. The USB registers are still accessible, but the physical layer will no longer function. Returns: None.

17.2.2.42 SysCtlUSBPLLEnable
Powers up the USB PLL. Prototype: void SysCtlUSBPLLEnable(void) Description: This function will enable the USB controllers PLL which is used by its physical layer. This call is necessary before connecting to any external devices. Returns: None.

17.3

Programming Example
The following example shows how to use the SysCtl API to congure the device for normal operation.

October 30, 2008

221

System Control

// // Configure the device to run at 20 MHz from the PLL using a 4 MHz crystal // as the input. // SysCtlClockSet(SYSCTL_SYSDIV_10 | SYSCTL_USE_PLL | SYSCTL_XTAL_4MHZ | SYSCTL_OSC_MAIN); // // Enable the GPIO blocks and the SSI. // SysCtlPeripheralEnable(SYSCTL_PERIPH_GPIOA); SysCtlPeripheralEnable(SYSCTL_PERIPH_GPIOB); SysCtlPeripheralEnable(SYSCTL_PERIPH_SSI); // // Enable the GPIO blocks and the SSI in sleep mode. // SysCtlPeripheralSleepEnable(SYSCTL_PERIPH_GPIOA); SysCtlPeripheralSleepEnable(SYSCTL_PERIPH_GPIOB); SysCtlPeripheralSleepEnable(SYSCTL_PERIPH_SSI); // // Enable peripheral clock gating. // SysCtlPeripheralClockGating(true);

222

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

18

System Tick (SysTick)

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227

18.1

Introduction
SysTick is a simple timer that is part of the NVIC controller in the Cortex-M3 microprocessor. Its intended purpose is to provide a periodic interrupt for a RTOS, but it can be used for other simple timing purposes. The SysTick interrupt handler does not need to clear the SysTick interrupt source. This will be done automatically by NVIC when the SysTick interrupt handler is called. This driver is contained in driverlib/systick.c, with driverlib/systick.h containing the API denitions for use by applications.

18.2

API Functions
Functions
void SysTickDisable (void) void SysTickEnable (void) void SysTickIntDisable (void) void SysTickIntEnable (void) void SysTickIntRegister (void (pfnHandler)(void)) void SysTickIntUnregister (void) unsigned long SysTickPeriodGet (void) void SysTickPeriodSet (unsigned long ulPeriod) unsigned long SysTickValueGet (void)

18.2.1 Detailed Description

The SysTick API is fairly simple, like SysTick itself. There are functions for conguring and enabling SysTick (SysTickEnable(), SysTickDisable(), SysTickPeriodSet(), SysTickPeriodGet(), and SysTickValueGet()) and functions for dealing with an interrupt handler for SysTick (SysTickIntRegister(), SysTickIntUnregister(), SysTickIntEnable(), and SysTickIntDisable()).

18.2.2 Function Documentation

18.2.2.1 SysTickDisable
Disables the SysTick counter.

October 30, 2008

223

System Tick (SysTick)

Prototype: void SysTickDisable(void) Description: This will stop the SysTick counter. If an interrupt handler has been registered, it will no longer be called until SysTick is restarted. Returns: None.

18.2.2.2 SysTickEnable
Enables the SysTick counter. Prototype: void SysTickEnable(void) Description: This will start the SysTick counter. If an interrupt handler has been registered, it will be called when the SysTick counter rolls over. Note: Calling this function will cause the SysTick counter to (re)commence counting from its current value. The counter is not automatically reloaded with the period as specied in a previous call to SysTickPeriodSet(). If an immediate reload is required, the NVIC_ST_CURRENT register must be written to force this. Any write to this register clears the SysTick counter to 0 and will cause a reload with the supplied period on the next clock. Returns: None.

18.2.2.3 SysTickIntDisable
Disables the SysTick interrupt. Prototype: void SysTickIntDisable(void) Description: This function will disable the SysTick interrupt, preventing it from being reected to the processor. Returns: None.

224

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

18.2.2.4 SysTickIntEnable
Enables the SysTick interrupt. Prototype: void SysTickIntEnable(void) Description: This function will enable the SysTick interrupt, allowing it to be reected to the processor. Note: The SysTick interrupt handler does not need to clear the SysTick interrupt source as this is done automatically by NVIC when the interrupt handler is called. Returns: None.

18.2.2.5 SysTickIntRegister
Registers an interrupt handler for the SysTick interrupt. Prototype: void SysTickIntRegister(void (*pfnHandler)(void)) Parameters: pfnHandler is a pointer to the function to be called when the SysTick interrupt occurs. Description: This sets the handler to be called when a SysTick interrupt occurs. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

18.2.2.6 SysTickIntUnregister
Unregisters the interrupt handler for the SysTick interrupt. Prototype: void SysTickIntUnregister(void) Description: This function will clear the handler to be called when a SysTick interrupt occurs. See also: IntRegister() for important information about registering interrupt handlers.

October 30, 2008

225

System Tick (SysTick)

Returns: None.

18.2.2.7 SysTickPeriodGet
Gets the period of the SysTick counter. Prototype: unsigned long SysTickPeriodGet(void) Description: This function returns the rate at which the SysTick counter wraps; this equates to the number of processor clocks between interrupts. Returns: Returns the period of the SysTick counter.

18.2.2.8 SysTickPeriodSet
Sets the period of the SysTick counter. Prototype: void SysTickPeriodSet(unsigned long ulPeriod) Parameters: ulPeriod is the number of clock ticks in each period of the SysTick counter; must be between 1 and 16,777,216, inclusive. Description: This function sets the rate at which the SysTick counter wraps; this equates to the number of processor clocks between interrupts. Note: Calling this function does not cause the SysTick counter to reload immediately. If an immediate reload is required, the NVIC_ST_CURRENT register must be written. Any write to this register clears the SysTick counter to 0 and will cause a reload with the ulPeriod supplied here on the next clock after the SysTick is enabled. Returns: None.

18.2.2.9 SysTickValueGet
Gets the current value of the SysTick counter. Prototype: unsigned long SysTickValueGet(void)

226

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function returns the current value of the SysTick counter; this will be a value between the period - 1 and zero, inclusive. Returns: Returns the current value of the SysTick counter.

18.3

Programming Example
The following example shows how to use the SysTick API to congure the SysTick counter and read its value.
unsigned long ulValue; // // Configure and enable the SysTick counter. // SysTickPeriodSet(1000); SysTickEnable(); // // Delay for some time... // // // Read the current SysTick value. // ulValue = SysTickValueGet();

October 30, 2008

227

System Tick (SysTick)

228

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

19

Timer
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241

19.1

Introduction
The timer API provides a set of functions for dealing with the timer module. Functions are provided to congure and control the timer, along with functions to modify timer/counter values, and to manage interrupt handling for the timer. The timer module provides two 16-bit timer/counters that can be congured to operate independently as timers or event counters, or they can be congured to operate as one 32-bit timer or one 32-bit Real Time Clock (RTC). For the purpose of this API, the two timers provided by the timer are referred to as TimerA and TimerB. When congured as either a 32-bit or 16-bit timer, a timer can be set up to run as a one-shot timer or a continuous timer. If congured as a one-shot timer, when it reaches zero the timer will cease counting. If congured as a continuous timer, when it reaches zero the timer will continue counting from a reloaded value. When congured as a 32-bit timer, the timer can also be congured to operate as an RTC. In that case, the timer expects to be driven by a 32 KHz external clock, which is divided down to produce 1 second clock ticks. When in 16-bit mode, the timer can also be congured for event capture or as a Pulse Width Modulation (PWM) generator. When congured for event capture, the timer acts as a counter. It can be congured to either count the time between events, or it can count the events themselves. The type of event being counted can be congured as a positive edge, a negative edge, or both edges. When a timer is congured as a PWM generator, the input line used to capture events becomes an output line, and the timer is used to drive an edge-aligned pulse onto that line. The timer module also provides the ability to control other functional parameters, such as output inversion, output triggers, and timer behavior during stalls. Control is also provided over interrupt sources and events. Interrupts can be generated to indicate that an event has been captured, or that a certain number of events have been captured. Interrupts can also be generated when the timer has counted down to zero, or when the RTC matches a certain value. This driver is contained in driverlib/timer.c, with driverlib/timer.h containing the API denitions for use by applications.

19.2

API Functions
Functions
void TimerCongure (unsigned long ulBase, unsigned long ulCong) void TimerControlEvent (unsigned long ulBase, unsigned long ulTimer, unsigned long ulEvent) void TimerControlLevel (unsigned long ulBase, unsigned long ulTimer, tBoolean bInvert)

October 30, 2008

229

Timer

void TimerControlStall (unsigned long ulBase, unsigned long ulTimer, tBoolean bStall) void TimerControlTrigger (unsigned long ulBase, unsigned long ulTimer, tBoolean bEnable) void TimerDisable (unsigned long ulBase, unsigned long ulTimer) void TimerEnable (unsigned long ulBase, unsigned long ulTimer) void TimerIntClear (unsigned long ulBase, unsigned long ulIntFlags) void TimerIntDisable (unsigned long ulBase, unsigned long ulIntFlags) void TimerIntEnable (unsigned long ulBase, unsigned long ulIntFlags) void TimerIntRegister (unsigned long ulBase, unsigned long ulTimer, void (pfnHandler)(void)) unsigned long TimerIntStatus (unsigned long ulBase, tBoolean bMasked) void TimerIntUnregister (unsigned long ulBase, unsigned long ulTimer) unsigned long TimerLoadGet (unsigned long ulBase, unsigned long ulTimer) void TimerLoadSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) unsigned long TimerMatchGet (unsigned long ulBase, unsigned long ulTimer) void TimerMatchSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) unsigned long TimerPrescaleGet (unsigned long ulBase, unsigned long ulTimer) void TimerPrescaleSet (unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) void TimerRTCDisable (unsigned long ulBase) void TimerRTCEnable (unsigned long ulBase) unsigned long TimerValueGet (unsigned long ulBase, unsigned long ulTimer)

19.2.1 Detailed Description

The timer API is broken into three groups of functions: those that deal with timer conguration and control, those that deal with timer contents, and those that deal with interrupt handling. Timer conguration is handled by TimerCongure(), which performs the high level setup of the timer module; that is, it is used to set up 32- or 16-bit modes, and to select between PWM, capture, and timer operations. Timer control is performed by TimerEnable(), TimerDisable(), TimerControlLevel(), TimerControlTrigger(), TimerControlEvent(), TimerControlStall(), TimerRTCEnable(), and TimerRTCDisable(). Timer content is managed with TimerLoadSet(), TimerLoadGet(), TimerPrescaleSet(), TimerPrescaleGet(), TimerMatchSet(), TimerMatchGet(), TimerPrescaleMatchSet(), TimerPrescaleMatchGet(), and TimerValueGet(). The interrupt handler for the Timer interrupt is managed with TimerIntRegister() and TimerIntUnregister(). The individual interrupt sources within the timer module are managed with TimerIntEnable(), TimerIntDisable(), TimerIntStatus(), and TimerIntClear(). The TimerQuiesce() API from previous versions of the peripheral driver library has been deprecated. SysCtlPeripheralReset() should be used instead to return the timer to its reset state.

19.2.2 Function Documentation

19.2.2.1 TimerCongure
Congures the timer(s).

230

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void TimerConfigure(unsigned long ulBase, unsigned long ulConfig) Parameters: ulBase is the base address of the timer module. ulCong is the conguration for the timer. Description: This function congures the operating mode of the timer(s). The timer module is disabled before being congured, and is left in the disabled state. The conguration is specied in ulCong as one of the following values: TIMER_CFG_32_BIT_OS - 32-bit one shot timer TIMER_CFG_32_BIT_PER - 32-bit periodic timer TIMER_CFG_32_RTC - 32-bit real time clock timer TIMER_CFG_16_BIT_PAIR - Two 16-bit timers When congured for a pair of 16-bit timers, each timer is separately congured. The rst timer is congured by setting ulCong to the result of a logical OR operation between one of the following values and ulCong: TIMER_CFG_A_ONE_SHOT - 16-bit one shot timer TIMER_CFG_A_PERIODIC - 16-bit periodic timer TIMER_CFG_A_CAP_COUNT - 16-bit edge count capture TIMER_CFG_A_CAP_TIME - 16-bit edge time capture TIMER_CFG_A_PWM - 16-bit PWM output Similarly, the second timer is congured by setting ulCong to the result of a logical OR operation between one of the corresponding TIMER_CFG_B_ values and ulCong. Returns: None.

19.2.2.2 TimerControlEvent
Controls the event type. Prototype: void TimerControlEvent(unsigned long ulBase, unsigned long ulTimer, unsigned long ulEvent) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to be adjusted; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. ulEvent species the type of event; must be one of TIMER_EVENT_POS_EDGE, TIMER_EVENT_NEG_EDGE, or TIMER_EVENT_BOTH_EDGES.

October 30, 2008

231

Timer

Description: This function sets the signal edge(s) that will trigger the timer when in capture mode. Returns: None.

19.2.2.3 TimerControlLevel
Controls the output level. Prototype: void TimerControlLevel(unsigned long ulBase, unsigned long ulTimer, tBoolean bInvert) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. bInvert species the output level. Description: This function sets the PWM output level for the specied timer. If the bInvert parameter is true, then the timers output will be made active low; otherwise, it will be made active high. Returns: None.

19.2.2.4 TimerControlStall
Controls the stall handling. Prototype: void TimerControlStall(unsigned long ulBase, unsigned long ulTimer, tBoolean bStall) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to be adjusted; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. bStall species the response to a stall signal. Description: This function controls the stall response for the specied timer. If the bStall parameter is true, then the timer will stop counting if the processor enters debug mode; otherwise the timer will keep running while in debug mode. Returns: None.

232

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

19.2.2.5 TimerControlTrigger
Enables or disables the trigger output. Prototype: void TimerControlTrigger(unsigned long ulBase, unsigned long ulTimer, tBoolean bEnable) Parameters: ulBase is the base address of the timer module. ulTimer species the timer to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. bEnable species the desired trigger state. Description: This function controls the trigger output for the specied timer. If the bEnable parameter is true, then the timers output trigger is enabled; otherwise it is disabled. Returns: None.

19.2.2.6 TimerDisable
Disables the timer(s). Prototype: void TimerDisable(unsigned long ulBase, unsigned long ulTimer) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to disable; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. Description: This will disable operation of the timer module. Returns: None.

19.2.2.7 TimerEnable
Enables the timer(s). Prototype: void TimerEnable(unsigned long ulBase, unsigned long ulTimer)

October 30, 2008

233

Timer

Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to enable; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. Description: This will enable operation of the timer module. The timer must be congured before it is enabled. Returns: None.

19.2.2.8 TimerIntClear
Clears timer interrupt sources. Prototype: void TimerIntClear(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the timer module. ulIntFlags is a bit mask of the interrupt sources to be cleared. Description: The specied timer interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to TimerIntEnable(). Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

19.2.2.9 TimerIntDisable
Disables individual timer interrupt sources. Prototype: void TimerIntDisable(unsigned long ulBase, unsigned long ulIntFlags)

234

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase is the base address of the timer module. ulIntFlags is the bit mask of the interrupt sources to be disabled. Description: Disables the indicated timer interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to TimerIntEnable(). Returns: None.

19.2.2.10 TimerIntEnable
Enables individual timer interrupt sources. Prototype: void TimerIntEnable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the timer module. ulIntFlags is the bit mask of the interrupt sources to be enabled. Description: Enables the indicated timer interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter must be the logical OR of any combination of the following: TIMER_CAPB_EVENT - Capture B event interrupt TIMER_CAPB_MATCH - Capture B match interrupt TIMER_TIMB_TIMEOUT - Timer B timeout interrupt TIMER_RTC_MATCH - RTC interrupt mask TIMER_CAPA_EVENT - Capture A event interrupt TIMER_CAPA_MATCH - Capture A match interrupt TIMER_TIMA_TIMEOUT - Timer A timeout interrupt Returns: None.

19.2.2.11 TimerIntRegister
Registers an interrupt handler for the timer interrupt. Prototype: void TimerIntRegister(unsigned long ulBase,

October 30, 2008

235

Timer

unsigned long ulTimer, void (*pfnHandler)(void)) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s); must be one of TIMER_A, TIMER_B, or TIMER_BOTH. pfnHandler is a pointer to the function to be called when the timer interrupt occurs. Description: This sets the handler to be called when a timer interrupt occurs. This will enable the global interrupt in the interrupt controller; specic timer interrupts must be enabled via TimerIntEnable(). It is the interrupt handlers responsibility to clear the interrupt source via TimerIntClear(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

19.2.2.12 TimerIntStatus
Gets the current interrupt status. Prototype: unsigned long TimerIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the timer module. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the timer module. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: The current interrupt status, enumerated as a bit eld of values described in TimerIntEnable().

19.2.2.13 TimerIntUnregister
Unregisters an interrupt handler for the timer interrupt. Prototype: void TimerIntUnregister(unsigned long ulBase, unsigned long ulTimer) Parameters: ulBase is the base address of the timer module.

236

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

ulTimer species the timer(s); must be one of TIMER_A, TIMER_B, or TIMER_BOTH. Description: This function will clear the handler to be called when a timer interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

19.2.2.14 TimerLoadGet
Gets the timer load value. Prototype: unsigned long TimerLoadGet(unsigned long ulBase, unsigned long ulTimer) Parameters: ulBase is the base address of the timer module. ulTimer species the timer; must be one of TIMER_A or TIMER_B. Only TIMER_A should be used when the timer is congured for 32-bit operation. Description: This function gets the currently programmed interval load value for the specied timer. Returns: Returns the load value for the timer.

19.2.2.15 TimerLoadSet
Sets the timer load value. Prototype: void TimerLoadSet(unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. Only TIMER_A should be used when the timer is congured for 32-bit operation. ulValue is the load value. Description: This function sets the timer load value; if the timer is running then the value will be immediately loaded into the timer.

October 30, 2008

237

Timer

Returns: None.

19.2.2.16 TimerMatchGet
Gets the timer match value. Prototype: unsigned long TimerMatchGet(unsigned long ulBase, unsigned long ulTimer) Parameters: ulBase is the base address of the timer module. ulTimer species the timer; must be one of TIMER_A or TIMER_B. Only TIMER_A should be used when the timer is congured for 32-bit operation. Description: This function gets the match value for the specied timer. Returns: Returns the match value for the timer.

19.2.2.17 TimerMatchSet
Sets the timer match value. Prototype: void TimerMatchSet(unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. Only TIMER_A should be used when the timer is congured for 32-bit operation. ulValue is the match value. Description: This function sets the match value for a timer. This is used in capture count mode to determine when to interrupt the processor and in PWM mode to determine the duty cycle of the output signal. Returns: None.

238

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

19.2.2.18 TimerPrescaleGet
Get the timer prescale value. Prototype: unsigned long TimerPrescaleGet(unsigned long ulBase, unsigned long ulTimer) Parameters: ulBase is the base address of the timer module. ulTimer species the timer; must be one of TIMER_A or TIMER_B. Description: This function gets the value of the input clock prescaler. The prescaler is only operational when in 16-bit mode and is used to extend the range of the 16-bit timer modes. Returns: The value of the timer prescaler.

19.2.2.19 TimerPrescaleSet
Set the timer prescale value. Prototype: void TimerPrescaleSet(unsigned long ulBase, unsigned long ulTimer, unsigned long ulValue) Parameters: ulBase is the base address of the timer module. ulTimer species the timer(s) to adjust; must be one of TIMER_A, TIMER_B, or TIMER_BOTH. ulValue is the timer prescale value; must be between 0 and 255, inclusive. Description: This function sets the value of the input clock prescaler. The prescaler is only operational when in 16-bit mode and is used to extend the range of the 16-bit timer modes. Returns: None.

19.2.2.20 TimerRTCDisable
Disable RTC counting. Prototype: void TimerRTCDisable(unsigned long ulBase)

October 30, 2008

239

Timer

Parameters: ulBase is the base address of the timer module. Description: This function causes the timer to stop counting when in RTC mode. Returns: None.

19.2.2.21 TimerRTCEnable
Enable RTC counting. Prototype: void TimerRTCEnable(unsigned long ulBase) Parameters: ulBase is the base address of the timer module. Description: This function causes the timer to start counting when in RTC mode. If not congured for RTC mode, this will do nothing. Returns: None.

19.2.2.22 TimerValueGet
Gets the current timer value. Prototype: unsigned long TimerValueGet(unsigned long ulBase, unsigned long ulTimer) Parameters: ulBase is the base address of the timer module. ulTimer species the timer; must be one of TIMER_A or TIMER_B. Only TIMER_A should be used when the timer is congured for 32-bit operation. Description: This function reads the current value of the specied timer. Returns: Returns the current value of the timer.

240

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

19.3

Programming Example
The following example shows how to use the timer API to congure the timer as a 16-bit one shot timer and a 16-bit edge capture counter.
// // Configure TimerA as a 16-bit one shot timer, and TimerB as a 16-bit edge // capture counter. // TimerConfigure(TIMER0_BASE, (TIMER_CFG_16_BIT_PAIR | TIMER_CFG_A_ONE_SHOT | TIMER_CFG_B_CAP_COUNT)); // // Configure the counter (TimerB) to count both edges. // TimerControlEvent(TIMER0_BASE, TIMER_B, TIMER_EVENT_BOTH_EDGES); // // Enable the timers. // TimerEnable(TIMER0_BASE, TIMER_BOTH);

October 30, 2008

241

Timer

242

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

20

UART
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257

20.1

Introduction
The Universal Asynchronous Receiver/Transmitter (UART) API provides a set of functions for using the Stellaris UART modules. Functions are provided to congure and control the UART modules, to send and receive data, and to manage interrupts for the UART modules. The Stellaris UART performs the functions of parallel-to-serial and serial-to-parallel conversions. It is very similar in functionality to a 16C550 UART, but is not register-compatible. Some of the features of the Stellaris UART are: A 16x12 bit receive FIFO and a 16x8 bit transmit FIFO. Programmable baud rate generator. Automatic generation and stripping of start, stop, and parity bits. Line break generation and detection. Programmable serial interface 5, 6, 7, or 8 data bits even, odd, stick, or no parity bit generation and detection 1 or 2 stop bit generation baud rate generation, from DC to processor clock/16

IrDA serial-IR (SIR) encoder/decoder. DMA interface This driver is contained in driverlib/uart.c, with driverlib/uart.h containing the API denitions for use by applications.

20.2

API Functions
Functions
void UARTBreakCtl (unsigned long ulBase, tBoolean bBreakState) tBoolean UARTBusy (unsigned long ulBase) long UARTCharGet (unsigned long ulBase) long UARTCharGetNonBlocking (unsigned long ulBase) void UARTCharPut (unsigned long ulBase, unsigned char ucData) tBoolean UARTCharPutNonBlocking (unsigned long ulBase, unsigned char ucData) tBoolean UARTCharsAvail (unsigned long ulBase) void UARTCongGetExpClk (unsigned long ulBase, unsigned long ulUARTClk, unsigned long pulBaud, unsigned long pulCong)

October 30, 2008

243

UART

void UARTCongSetExpClk (unsigned long ulBase, unsigned long ulUARTClk, unsigned long ulBaud, unsigned long ulCong) void UARTDisable (unsigned long ulBase) void UARTDisableSIR (unsigned long ulBase) void UARTDMADisable (unsigned long ulBase, unsigned long ulDMAFlags) void UARTDMAEnable (unsigned long ulBase, unsigned long ulDMAFlags) void UARTEnable (unsigned long ulBase) void UARTEnableSIR (unsigned long ulBase, tBoolean bLowPower) void UARTFIFOLevelGet (unsigned long ulBase, unsigned long pulTxLevel, unsigned long pulRxLevel) void UARTFIFOLevelSet (unsigned long ulBase, unsigned long ulTxLevel, unsigned long ulRxLevel) void UARTIntClear (unsigned long ulBase, unsigned long ulIntFlags) void UARTIntDisable (unsigned long ulBase, unsigned long ulIntFlags) void UARTIntEnable (unsigned long ulBase, unsigned long ulIntFlags) void UARTIntRegister (unsigned long ulBase, void (pfnHandler)(void)) unsigned long UARTIntStatus (unsigned long ulBase, tBoolean bMasked) void UARTIntUnregister (unsigned long ulBase) unsigned long UARTParityModeGet (unsigned long ulBase) void UARTParityModeSet (unsigned long ulBase, unsigned long ulParity) void UARTRxErrorClear (unsigned long ulBase) unsigned long UARTRxErrorGet (unsigned long ulBase) tBoolean UARTSpaceAvail (unsigned long ulBase)

20.2.1 Detailed Description

The UART API provides the set of functions required to implement an interrupt driven UART driver. These functions may be used to control any of the available UART ports on a Stellaris microcontroller, and can be used with one port without causing conicts with the other port. The UART API is broken into three groups of functions: those that deal with conguration and control of the UART modules, those used to send and receive data, and those that deal with interrupt handling. Conguration and control of the UART are handled by the UARTCongGetExpClk(), UARTCongSetExpClk(), UARTDisable(), UARTEnable(), UARTParityModeGet(), and UARTParityModeSet() functions. The DMA interface can be enabled or disabled by the UARTDMAEnable() and UARTDMADisable() functions. Sending and receiving data via the UART is handled by the UARTCharGet(), UARTCharGetNonBlocking(), UARTCharPut(), UARTCharPutNonBlocking(), UARTBreakCtl(), UARTCharsAvail(), and UARTSpaceAvail() functions. Managing the UART interrupts is handled by the UARTIntClear(), UARTIntDisable(), UARTIntEnable(), UARTIntRegister(), UARTIntStatus(), and UARTIntUnregister() functions. The UARTCongSet(), UARTCongGet(), UARTCharNonBlockingGet(), and UARTCharNonBlockingPut() APIs from previous versions of the peripheral driver library have been replaced by the UARTCongSetExpClk(), UARTCongGetExpClk(), UARTCharGetNonBlocking(), and UARTCharPutNonBlocking() APIs, respectively. Macros have been provided in uart.h to map the old APIs to the new APIs, allowing existing applications to link and run with the new APIs. It is recommended that new applications utilize the new APIs in favor of the old ones.

244

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

20.2.2 Function Documentation

20.2.2.1 UARTBreakCtl
Causes a BREAK to be sent. Prototype: void UARTBreakCtl(unsigned long ulBase, tBoolean bBreakState) Parameters: ulBase is the base address of the UART port. bBreakState controls the output level. Description: Calling this function with bBreakState set to true will assert a break condition on the UART. Calling this function with bBreakState set to false will remove the break condition. For proper transmission of a break command, the break must be asserted for at least two complete frames. Returns: None.

20.2.2.2 UARTBusy
Determines whether the UART transmitter is busy or not. Prototype: tBoolean UARTBusy(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: Allows the caller to determine whether all transmitted bytes have cleared the transmitter hardware. If false is returned, the transmit FIFO is empty and all bits of the last transmitted character, including all stop bits, have left the hardware shift register. Returns: Returns true if the UART is transmitting or false if all transmissions are complete.

20.2.2.3 UARTCharGet
Waits for a character from the specied port. Prototype: long UARTCharGet(unsigned long ulBase)

October 30, 2008

245

UART

Parameters: ulBase is the base address of the UART port. Description: Gets a character from the receive FIFO for the specied port. If there are no characters available, this function will wait until a character is received before returning. Returns: Returns the character read from the specied port, cast as an long.

20.2.2.4 UARTCharGetNonBlocking
Receives a character from the specied port. Prototype: long UARTCharGetNonBlocking(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: Gets a character from the receive FIFO for the specied port. This function replaces the original UARTCharNonBlockingGet() API and performs the same actions. A macro is provided in uart.h to map the original API to this API. Returns: Returns the character read from the specied port, cast as a long. A -1 will be returned if there are no characters present in the receive FIFO. The UARTCharsAvail() function should be called before attempting to call this function.

20.2.2.5 UARTCharPut
Waits to send a character from the specied port. Prototype: void UARTCharPut(unsigned long ulBase, unsigned char ucData) Parameters: ulBase is the base address of the UART port. ucData is the character to be transmitted. Description: Sends the character ucData to the transmit FIFO for the specied port. If there is no space available in the transmit FIFO, this function will wait until there is space available before returning. Returns: None.

246

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

20.2.2.6 UARTCharPutNonBlocking
Sends a character to the specied port. Prototype: tBoolean UARTCharPutNonBlocking(unsigned long ulBase, unsigned char ucData) Parameters: ulBase is the base address of the UART port. ucData is the character to be transmitted. Description: Writes the character ucData to the transmit FIFO for the specied port. This function does not block, so if there is no space available, then a false is returned, and the application will have to retry the function later. This function replaces the original UARTCharNonBlockingPut() API and performs the same actions. A macro is provided in uart.h to map the original API to this API. Returns: Returns true if the character was successfully placed in the transmit FIFO, and false if there was no space available in the transmit FIFO.

20.2.2.7 UARTCharsAvail
Determines if there are any characters in the receive FIFO. Prototype: tBoolean UARTCharsAvail(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: This function returns a ag indicating whether or not there is data available in the receive FIFO. Returns: Returns true if there is data in the receive FIFO, and false if there is no data in the receive FIFO.

20.2.2.8 UARTCongGetExpClk
Gets the current conguration of a UART. Prototype: void UARTConfigGetExpClk(unsigned long ulBase, unsigned long ulUARTClk,

October 30, 2008

247

UART

unsigned long *pulBaud, unsigned long *pulConfig) Parameters: ulBase is the base address of the UART port. ulUARTClk is the rate of the clock supplied to the UART module. pulBaud is a pointer to storage for the baud rate. pulCong is a pointer to storage for the data format. Description: The baud rate and data format for the UART is determined, given an explicitly provided peripheral clock (hence the ExpClk sufx). The returned baud rate is the actual baud rate; it may not be the exact baud rate requested or an ofcial baud rate. The data format returned in pulCong is enumerated the same as the ulCong parameter of UARTCongSetExpClk(). The peripheral clock will be the same as the processor clock. This will be the value returned by SysCtlClockGet(), or it can be explicitly hard coded if it is constant and known (to save the code/execution overhead of a call to SysCtlClockGet()). This function replaces the original UARTCongGet() API and performs the same actions. A macro is provided in uart.h to map the original API to this API. Returns: None.

20.2.2.9 UARTCongSetExpClk
Sets the conguration of a UART. Prototype: void UARTConfigSetExpClk(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulUARTClk, ulBaud, ulConfig)

Parameters: ulBase is the base address of the UART port. ulUARTClk is the rate of the clock supplied to the UART module. ulBaud is the desired baud rate. ulCong is the data format for the port (number of data bits, number of stop bits, and parity). Description: This function will congure the UART for operation in the specied data format. The baud rate is provided in the ulBaud parameter and the data format in the ulCong parameter. The ulCong parameter is the logical OR of three values: the number of data bits, the number of stop bits, and the parity. UART_CONFIG_WLEN_8, UART_CONFIG_WLEN_7, UART_CONFIG_WLEN_6, and UART_CONFIG_WLEN_5 select from eight to ve data bits per byte (respectively). UART_CONFIG_STOP_ONE and UART_CONFIG_STOP_TWO select one or two stop bits (respectively). UART_CONFIG_PAR_NONE, UART_CONFIG_PAR_EVEN, UART_CONFIG_PAR_ODD, UART_CONFIG_PAR_ONE,

248

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

and UART_CONFIG_PAR_ZERO select the parity mode (no parity bit, even parity bit, odd parity bit, parity bit always one, and parity bit always zero, respectively). The peripheral clock will be the same as the processor clock. This will be the value returned by SysCtlClockGet(), or it can be explicitly hard coded if it is constant and known (to save the code/execution overhead of a call to SysCtlClockGet()). This function replaces the original UARTCongSet() API and performs the same actions. A macro is provided in uart.h to map the original API to this API. Returns: None.

20.2.2.10 UARTDisable
Disables transmitting and receiving. Prototype: void UARTDisable(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: Clears the UARTEN, TXE, and RXE bits, then waits for the end of transmission of the current character, and ushes the transmit FIFO. Returns: None.

20.2.2.11 UARTDisableSIR
Disables SIR (IrDA) mode on the specied UART. Prototype: void UARTDisableSIR(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: Clears the SIREN (IrDA) and SIRLP (Low Power) bits. Note: SIR (IrDA) operation is not supported on Sandstorm-class devices. Returns: None.

October 30, 2008

249

UART

20.2.2.12 UARTDMADisable
Disable UART DMA operation. Prototype: void UARTDMADisable(unsigned long ulBase, unsigned long ulDMAFlags) Parameters: ulBase is the base address of the UART port. ulDMAFlags is a bit mask of the DMA features to disable. Description: This function is used to disable UART DMA features that were enabled by UARTDMAEnable(). The specied UART DMA features are disabled. The ulDMAFlags parameter is the logical OR of any of the following values: UART_DMA_RX - disable DMA for receive UART_DMA_TX - disable DMA for transmit UART_DMA_ERR_RXSTOP - do not disable DMA receive on UART error Returns: None.

20.2.2.13 UARTDMAEnable
Enable UART DMA operation. Prototype: void UARTDMAEnable(unsigned long ulBase, unsigned long ulDMAFlags) Parameters: ulBase is the base address of the UART port. ulDMAFlags is a bit mask of the DMA features to enable. Description: The specied UART DMA features are enabled. The UART can be congured to use DMA for transmit or receive, and to disable receive if an error occurs. The ulDMAFlags parameter is the logical OR of any of the following values: UART_DMA_RX - enable DMA for receive UART_DMA_TX - enable DMA for transmit UART_DMA_ERR_RXSTOP - disable DMA receive on UART error Note: The uDMA controller must also be set up before DMA can be used with the UART. Returns: None.

250

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

20.2.2.14 UARTEnable
Enables transmitting and receiving. Prototype: void UARTEnable(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: Sets the UARTEN, TXE, and RXE bits, and enables the transmit and receive FIFOs. Returns: None.

20.2.2.15 UARTEnableSIR
Enables SIR (IrDA) mode on the specied UART. Prototype: void UARTEnableSIR(unsigned long ulBase, tBoolean bLowPower) Parameters: ulBase is the base address of the UART port. bLowPower indicates if SIR Low Power Mode is to be used. Description: Enables the SIREN control bit for IrDA mode on the UART. If the bLowPower ag is set, then SIRLP bit will also be set. Note: SIR (IrDA) operation is not supported on Sandstorm-class devices. Returns: None.

20.2.2.16 UARTFIFOLevelGet
Gets the FIFO level at which interrupts are generated. Prototype: void UARTFIFOLevelGet(unsigned long ulBase, unsigned long *pulTxLevel, unsigned long *pulRxLevel) Parameters: ulBase is the base address of the UART port.

October 30, 2008

251

UART

pulTxLevel is a pointer to storage for the transmit FIFO level, returned as one of UART_FIFO_TX1_8, UART_FIFO_TX2_8, UART_FIFO_TX4_8, UART_FIFO_TX6_8, or UART_FIFO_TX7_8. pulRxLevel is a pointer to storage for the receive FIFO level, returned as one of UART_FIFO_RX1_8, UART_FIFO_RX2_8, UART_FIFO_RX4_8, UART_FIFO_RX6_8, or UART_FIFO_RX7_8. Description: This function gets the FIFO level at which transmit and receive interrupts will be generated. Returns: None.

20.2.2.17 UARTFIFOLevelSet
Sets the FIFO level at which interrupts are generated. Prototype: void UARTFIFOLevelSet(unsigned long ulBase, unsigned long ulTxLevel, unsigned long ulRxLevel) Parameters: ulBase is the base address of the UART port. ulTxLevel is the transmit FIFO interrupt level, specied as one of UART_FIFO_TX1_8, UART_FIFO_TX2_8, UART_FIFO_TX4_8, UART_FIFO_TX6_8, or UART_FIFO_TX7_8. ulRxLevel is the receive FIFO interrupt level, specied as one of UART_FIFO_RX1_8, UART_FIFO_RX2_8, UART_FIFO_RX4_8, UART_FIFO_RX6_8, or UART_FIFO_RX7_8. Description: This function sets the FIFO level at which transmit and receive interrupts will be generated. Returns: None.

20.2.2.18 UARTIntClear
Clears UART interrupt sources. Prototype: void UARTIntClear(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the UART port. ulIntFlags is a bit mask of the interrupt sources to be cleared.

252

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: The specied UART interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to UARTIntEnable(). Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

20.2.2.19 UARTIntDisable
Disables individual UART interrupt sources. Prototype: void UARTIntDisable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the UART port. ulIntFlags is the bit mask of the interrupt sources to be disabled. Description: Disables the indicated UART interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter has the same denition as the ulIntFlags parameter to UARTIntEnable(). Returns: None.

20.2.2.20 UARTIntEnable
Enables individual UART interrupt sources. Prototype: void UARTIntEnable(unsigned long ulBase, unsigned long ulIntFlags) Parameters: ulBase is the base address of the UART port.

October 30, 2008

253

UART

ulIntFlags is the bit mask of the interrupt sources to be enabled. Description: Enables the indicated UART interrupt sources. Only the sources that are enabled can be reected to the processor interrupt; disabled sources have no effect on the processor. The ulIntFlags parameter is the logical OR of any of the following: UART_INT_OE - Overrun Error interrupt UART_INT_BE - Break Error interrupt UART_INT_PE - Parity Error interrupt UART_INT_FE - Framing Error interrupt UART_INT_RT - Receive Timeout interrupt UART_INT_TX - Transmit interrupt UART_INT_RX - Receive interrupt Returns: None.

20.2.2.21 UARTIntRegister
Registers an interrupt handler for a UART interrupt. Prototype: void UARTIntRegister(unsigned long ulBase, void (*pfnHandler)(void)) Parameters: ulBase is the base address of the UART port. pfnHandler is a pointer to the function to be called when the UART interrupt occurs. Description: This function does the actual registering of the interrupt handler. This will enable the global interrupt in the interrupt controller; specic UART interrupts must be enabled via UARTIntEnable(). It is the interrupt handlers responsibility to clear the interrupt source. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

20.2.2.22 UARTIntStatus
Gets the current interrupt status. Prototype: unsigned long UARTIntStatus(unsigned long ulBase, tBoolean bMasked)

254

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase is the base address of the UART port. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the specied UART. Either the raw interrupt status or the status of interrupts that are allowed to reect to the processor can be returned. Returns: Returns the current interrupt status, enumerated as a bit eld of values described in UARTIntEnable().

20.2.2.23 UARTIntUnregister
Unregisters an interrupt handler for a UART interrupt. Prototype: void UARTIntUnregister(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: This function does the actual unregistering of the interrupt handler. It will clear the handler to be called when a UART interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

20.2.2.24 UARTParityModeGet
Gets the type of parity currently being used. Prototype: unsigned long UARTParityModeGet(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: This function gets the type of parity used for transmitting data, and expected when receiving data.

October 30, 2008

255

UART

Returns: Returns the current parity settings, specied as one of UART_CONFIG_PAR_NONE, UART_CONFIG_PAR_EVEN, UART_CONFIG_PAR_ODD, UART_CONFIG_PAR_ONE, or UART_CONFIG_PAR_ZERO.

20.2.2.25 UARTParityModeSet
Sets the type of parity. Prototype: void UARTParityModeSet(unsigned long ulBase, unsigned long ulParity) Parameters: ulBase is the base address of the UART port. ulParity species the type of parity to use. Description: Sets the type of parity to use for transmitting and expect when receiving. The ulParity parameter must be one of UART_CONFIG_PAR_NONE, UART_CONFIG_PAR_EVEN, UART_CONFIG_PAR_ODD, UART_CONFIG_PAR_ONE, or UART_CONFIG_PAR_ZERO. The last two allow direct control of the parity bit; it will always be either be one or zero based on the mode. Returns: None.

20.2.2.26 UARTRxErrorClear
Clears all reported receiver errors. Prototype: void UARTRxErrorClear(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: This function is used to clear all receiver error conditions reported via UARTRxErrorGet(). If using the overrun, framing error, parity error or break interrupts, this function must be called after clearing the interrupt to ensure that later errors of the same type trigger another interrupt. Returns: None.

256

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

20.2.2.27 UARTRxErrorGet
Gets current receiver errors. Prototype: unsigned long UARTRxErrorGet(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: This function returns the current state of each of the 4 receiver error sources. The returned errors are equivalent to the four error bits returned via the previous call to UARTCharGet() or UARTCharGetNonBlocking() with the exception that the overrun error is set immediately the overrun occurs rather than when a character is next read. Returns: Returns a logical OR combination of the receiver error ags, UART_RXERROR_FRAMING, UART_RXERROR_PARITY, UART_RXERROR_BREAK and UART_RXERROR_OVERRUN.

20.2.2.28 UARTSpaceAvail
Determines if there is any space in the transmit FIFO. Prototype: tBoolean UARTSpaceAvail(unsigned long ulBase) Parameters: ulBase is the base address of the UART port. Description: This function returns a ag indicating whether or not there is space available in the transmit FIFO. Returns: Returns true if there is space available in the transmit FIFO, and false if there is no space available in the transmit FIFO.

20.3

Programming Example
The following example shows how to use the UART API to initialize the UART, transmit characters, and receive characters.
// // Initialize the UART. Set the baud rate, number of data bits, turn off // parity, number of stop bits, and stick mode. // UARTConfigSetExpClk(UART0_BASE, SysCtlClockGet(), 38400, (UART_CONFIG_WLEN_8 | UART_CONFIG_STOP_ONE |

October 30, 2008

257

UART

UART_CONFIG_PAR_NONE)); // // Enable the UART. // UARTEnable(UART0_BASE); // // Check for characters. This will spin here until a character is placed // into the receive FIFO. // while(!UARTCharsAvail(UART0_BASE)) { } // // Get the character(s) in the receive FIFO. // while(UARTCharGetNonBlocking(UART0_BASE)) { } // // Put a character in the output buffer. // UARTCharPut(UART0_BASE, c)); // // Disable the UART. // UARTDisable(UART0_BASE);

258

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

21

uDMA Controller
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .274

21.1

Introduction
The microDMA (uDMA) API provides functions to congure the Stellaris uDMA (Direct Memory Access) controller. The uDMA controller is designed to work with the the ARM Cortex-M3 processor and provides an efcient and low-overhead means of transferring blocks of data in the system. The uDMA controller has the following features: dedicated channels for supported peripherals one channel each for receive and transmit for devices with receive and transmit paths dedicated channel for software initiated data transfers channels can be independently congured and operated an arbitration scheme that is congurable per channel two levels of priority subordinate to Cortex-M3 processor bus usage data sizes of 8, 16, or 32 bits address increment of byte, half-word, word, or none maskable device requests optional software initiated transfers on any channel interrupt on transfer completion The uDMA controller supports several different transfer modes, allowing for complex transfer schemes. The following transfer modes are provided: Basic mode performs a simple transfer when request is asserted by a device. This is appropriate to use with peripherals where the peripheral asserts the request line whenever data should be transferred. The transfer will stop if request is de-asserted, even if the transfer is not complete. Auto-request mode performs a simple transfer that is started by a request, but will always complete the entire transfer, even if request is de-asserted. This is appropriate to use with software initiated transfers. Ping-Pong mode is used to transfer data to or from two buffers, switching from one buffer to the other as each buffer lls. This mode is appropriate to use with peripherals as a way to ensure a continuous ow of data to or from the peripheral. However, it is more complex to set up and requires code to manage the ping-pong buffers in the interrupt handler. Memory scatter/gather mode is a complex mode that provides a way to set up a list of transfer "tasks" for the uDMA controller. Blocks of data can be transferred to and from arbitrary locations in memory.

October 30, 2008

259

uDMA Controller

Peripheral scatter/gather mode is similar to memory scatter/gather mode except that it is controlled by a peripheral request. Detailed explanation of the various transfer modes is beyond the scope of this document. Please refer to the device data sheet for more information on the operation of the uDMA controller. The naming convention for the microDMA controller is to use the Greek letter "mu" to represent "micro". For the purposes of this document, and in the software library function names, a lower case "u" will be used in place of "mu" when the controller is referred to as "uDMA". This driver is contained in driverlib/udma.c, with driverlib/udma.h containing the API denitions for use by applications.

21.2

API Functions
Functions
void uDMAChannelAttributeDisable (unsigned long ulChannel, unsigned long ulAttr) void uDMAChannelAttributeEnable (unsigned long ulChannel, unsigned long ulAttr) unsigned long uDMAChannelAttributeGet (unsigned long ulChannel) void uDMAChannelControlSet (unsigned long ulChannel, unsigned long ulControl) void uDMAChannelDisable (unsigned long ulChannel) void uDMAChannelEnable (unsigned long ulChannel) tBoolean uDMAChannelIsEnabled (unsigned long ulChannel) unsigned long uDMAChannelModeGet (unsigned long ulChannel) void uDMAChannelRequest (unsigned long ulChannel) unsigned long uDMAChannelSizeGet (unsigned long ulChannel) void uDMAChannelTransferSet (unsigned long ulChannel, unsigned long ulMode, void pvSrcAddr, void pvDstAddr, unsigned long ulTransferSize) void uDMAControlBaseGet (void) void uDMAControlBaseSet (void pControlTable) void uDMADisable (void) void uDMAEnable (void) void uDMAErrorStatusClear (void) unsigned long uDMAErrorStatusGet (void) void uDMAIntRegister (unsigned long ulIntChannel, void (pfnHandler)(void)) void uDMAIntUnregister (unsigned long ulIntChannel)

21.2.1 Detailed Description

The uDMA APIs provide a means to enable and congure the Stellaris microDMA controller to perform DMA transfers. The general order of function calls to set up and perform a uDMA transfer is the following: uDMAEnable() is called once to enable the controller. uDMAControlBaseSet() is called once to set the channel control table.

260

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

uDMAChannelAttributeEnable() is called once or infrequently to congure the behavior of the channel. uDMAChannelControlSet() is used to set up characteristics of the data transfer. It only needs to be called once if the nature of the data transfer does not change. uDMAChannelTransferSet() is used to set the buffer pointers and size for a transfer. It is called before each new transfer. uDMAChannelEnable() enables a channel to perform data transfers. uDMAChannelRequest() is used to initiate a software based transfer. This is normally not used for peripheral based transfers. In order to use the uDMA controller, you must rst enable it by calling uDMAEnable(). You can later disable it, if no longer needed, by calling uDMADisable(). Once the uDMA controller is enabled, you must tell it where to nd the channel control structures in system memory. This is done by using the function uDMAControlBaseSet() and passing a pointer to the base of the channel control structure. The control structure must be allocated by the application. One way to do this is to declare an array of data type char or unsigned char. In order to support all channels and transfer modes, the control table array should be 1024 bytes, but it can be fewer depending on transfer modes used and number of channels actually used. Note: The control table must be aligned on a 1024 byte boundary. The uDMA controller supports multiple channels. Each channel has a set of attribute ags to control certain uDMA features and channel behavior. The attribute ags are set with the function uDMAChannelAttributeEnable() and cleared with uDMAChannelAttributeDisable(). The setting of the channel attribute ags can be queried by using the function uDMAChannelAttributeGet(). Next, the control parameters of the DMA transfer must be set. These parameters control the size and address increment of the data items to be transferred. The function uDMAChannelControlSet() is used to set up these control parameters. All of the functions mentioned so far are used only once or infrequently to set up the uDMA channel and transfer. In order to set the transfer addresses, transfer size, and transfer mode, use the function uDMAChannelTransferSet(). This function must be called for each new transfer. Once everything is set up, then channel is enabled by calling uDMAChannelEnable(), which must be done before each new transfer. The uDMA controller will automatically disable the channel at the completion of a transfer. A channel can be manually disabled by using uDMAChannelDisable(). There are additional functions that can be used to query the status of a channel, either from an interrupt handler or in polling fashion. The function uDMAChannelSizeGet() is used to nd the amount of data remaining to transfer on a channel. This will be zero when a transfer is complete. The function uDMAChannelModeGet() can be used to nd the transfer mode of a uDMA channel. This is usually used to see if the mode indicates stopped which means that a transfer has completed on a channel that was previously running. The function uDMAChannelIsEnabled() can be used to determine if a particular channel is enabled. If the application is using run-time interrupt registration (see IntRegister()), then the function uDMAIntRegister() can be used to install an interrupt handler for the uDMA controller. This function will also enable the interrupt on the system interrupt controller. If compile-time interrupt registration is used, then call the function IntEnable() to enable uDMA interrupts. When an interrupt handler has been installed with uDMAIntRegister(), it can be removed by calling uDMAIntUnregister(). This interrupt handler is only for software initiated transfers or errors. uDMA interrupts for a peripheral occur on the peripherals dedicated interrupt channel, and should be handled by the peripheral

October 30, 2008

261

uDMA Controller

interrupt handler. It is not necessary to acknowledge or clear uDMA interrupt sources. They are cleared automatically when they are serviced. The uDMA interrupt handler should use the function uDMAErrorStatusGet() to test if a uDMA error occurred. If so, the interrupt must be cleared by calling uDMAErrorStatusClear(). Note: Many of the API functions take a channel parameter that includes the logical OR of one of the values UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose the primary or alternate control structure. For Basic and Auto transfer modes, only the primary control structure is needed. The alternate control structure is only needed for complex transfer modes of Pingpong or Scatter/gather. Refer to the device data sheet for detailed information about transfer modes.

21.2.2 Function Documentation

21.2.2.1 uDMAChannelAttributeDisable
Disables attributes of a uDMA channel. Prototype: void uDMAChannelAttributeDisable(unsigned long ulChannel, unsigned long ulAttr) Parameters: ulChannel is the channel to congure. ulAttr is a combination of attributes for the channel. Description: This function is used to disable attributes of a uDMA channel. The ulChannel parameter must be one of the following: UDMA_CHANNEL_UART0RX for UART 0 receive channel UDMA_CHANNEL_UART0TX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSI0RX for SSI 0 receive channel UDMA_CHANNEL_SSI0TX for SSI 0 transmit channel UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_SW for the software dedicated uDMA channel And for microcontrollers that have a USB peripheral: UDMA_CHANNEL_USBEP1RX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBEP2RX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEP3RX for USB endpoint 3 receive

262

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

UDMA_CHANNEL_USBEP3TX for USB endpoint 3 transmit The ulAttr parameter is the logical OR of any of the following: UDMA_ATTR_USEBURST is used to restrict transfers to use only a burst mode. UDMA_ATTR_ALTSELECT is used to select the alternate control structure for this channel. UDMA_ATTR_HIGH_PRIORITY is used to set this channel to high priority. UDMA_ATTR_REQMASK is used to mask the hardware request signal from the peripheral for this channel. Returns: None.

21.2.2.2 uDMAChannelAttributeEnable
Enables attributes of a uDMA channel. Prototype: void uDMAChannelAttributeEnable(unsigned long ulChannel, unsigned long ulAttr) Parameters: ulChannel is the channel to congure. ulAttr is a combination of attributes for the channel. Description: The ulChannel parameter must be one of the following: UDMA_CHANNEL_UART0RX for UART 0 receive channel UDMA_CHANNEL_UART0TX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSI0RX for SSI 0 receive channel UDMA_CHANNEL_SSI0TX for SSI 0 transmit channel UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_SW for the software dedicated uDMA channel And for microcontrollers that have a USB peripheral: UDMA_CHANNEL_USBEP1RX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBEP2RX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEP3RX for USB endpoint 3 receive UDMA_CHANNEL_USBEP3TX for USB endpoint 3 transmit The ulAttr parameter is the logical OR of any of the following: UDMA_ATTR_USEBURST is used to restrict transfers to use only a burst mode.

October 30, 2008

263

uDMA Controller

UDMA_ATTR_ALTSELECT is used to select the alternate control structure for this channel. UDMA_ATTR_HIGH_PRIORITY is used to set this channel to high priority. UDMA_ATTR_REQMASK is used to mask the hardware request signal from the peripheral for this channel. Returns: None.

21.2.2.3 uDMAChannelAttributeGet
Gets the enabled attributes of a uDMA channel. Prototype: unsigned long uDMAChannelAttributeGet(unsigned long ulChannel) Parameters: ulChannel is the channel to congure. Description: This function returns a combination of ags representing the attributes of the uDMA channel. The ulChannel parameter must be one of the following: UDMA_CHANNEL_UART0RX for UART 0 receive channel UDMA_CHANNEL_UART0TX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSI0RX for SSI 0 receive channel UDMA_CHANNEL_SSI0TX for SSI 0 transmit channel UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_SW for the software dedicated uDMA channel And for microcontrollers that have a USB peripheral: UDMA_CHANNEL_USBEP1RX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBEP2RX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEP3RX for USB endpoint 3 receive UDMA_CHANNEL_USBEP3TX for USB endpoint 3 transmit Returns: Returns the logical OR of the attributes of the uDMA channel, which can be any of the following: UDMA_ATTR_USEBURST is used to restrict transfers to use only a burst mode. UDMA_ATTR_ALTSELECT is used to select the alternate control structure for this channel. UDMA_ATTR_HIGH_PRIORITY is used to set this channel to high priority. UDMA_ATTR_REQMASK is used to mask the hardware request signal from the peripheral for this channel.

264

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

21.2.2.4 uDMAChannelControlSet
Sets the control parameters for a uDMA channel. Prototype: void uDMAChannelControlSet(unsigned long ulChannel, unsigned long ulControl) Parameters: ulChannel is the logical OR of the uDMA channel number with UDMA_PRI_SELECT or UDMA_ALT_SELECT. ulControl is logical OR of several control values to set the control parameters for the channel. Description: This function is used to set control parameters for a uDMA transfer. These are typically parameters that are not changed often. The ulChannel parameter is one of the choices documented in the uDMAChannelEnable() function. It should be the logical OR of the channel with one of UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose whether the primary or alternate data structure is used. The ulControl parameter is the logical OR of ve values: the data size, the source address increment, the destination address increment, the arbitration size, and the use burst ag. The choices available for each of these values is described below. Choose the data size from one of UDMA_SIZE_8, UDMA_SIZE_16, or UDMA_SIZE_32 to select a data size of 8, 16, or 32 bits. Choose the source address increment from one of UDMA_SRC_INC_8, UDMA_SRC_INC_16, UDMA_SRC_INC_32, or UDMA_SRC_INC_NONE to select an address increment of 8-bit bytes, 16-bit halfwords, 32-bit words, or to select non-incrementing. Choose the destination address increment from one of UDMA_DST_INC_8, UDMA_DST_INC_16, UDMA_DST_INC_32, or UDMA_DST_INC_NONE to select an address increment of 8-bit bytes, 16-bit halfwords, 32-bit words, or to select non-incrementing. The arbitration size determines how many items are transferred before the uDMA controller rearbitrates for the bus. Choose the arbitration size from one of UDMA_ARB_1, UDMA_ARB_2, UDMA_ARB_4, UDMA_ARB_8, through UDMA_ARB_1024 to select the arbitration size from 1 to 1024 items, in powers of 2. The value UDMA_NEXT_USEBURST is used to force the channel to only respond to burst requests at the tail end of a scatter-gather transfer. Note: The address increment cannot be smaller than the data size. Returns: None.

21.2.2.5 uDMAChannelDisable
Disables a uDMA channel for operation.

October 30, 2008

265

uDMA Controller

Prototype: void uDMAChannelDisable(unsigned long ulChannel) Parameters: ulChannel is the channel number to disable. Description: This function disables a specic uDMA channel. Once disabled, a channel will not respond to uDMA transfer requests until re-enabled via uDMAChannelEnable(). The ulChannel parameter must be one of the following: UDMA_CHANNEL_UART0RX for UART 0 receive channel UDMA_CHANNEL_UART0TX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSI0RX for SSI 0 receive channel UDMA_CHANNEL_SSI0TX for SSI 0 transmit channel UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_SW for the software dedicated uDMA channel And for microcontrollers that have a USB peripheral: UDMA_CHANNEL_USBEP1RX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBEP2RX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEP3RX for USB endpoint 3 receive UDMA_CHANNEL_USBEP3TX for USB endpoint 3 transmit Returns: None.

21.2.2.6 uDMAChannelEnable
Enables a uDMA channel for operation. Prototype: void uDMAChannelEnable(unsigned long ulChannel) Parameters: ulChannel is the channel number to enable. Description: This function enables a specic uDMA channel for use. This function must be used to enable a channel before it can be used to perform a uDMA transfer. When a uDMA transfer is completed, the channel will be automatically disabled by the uDMA controller. Therefore, this function should be called prior to starting up any new transfer. The ulChannel parameter must be one of the following:

266

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

UDMA_CHANNEL_UART0RX for UART 0 receive channel UDMA_CHANNEL_UART0TX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSI0RX for SSI 0 receive channel UDMA_CHANNEL_SSI0TX for SSI 0 transmit channel UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_SW for the software dedicated uDMA channel And for microcontrollers that have a USB peripheral: UDMA_CHANNEL_USBEP1RX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBEP2RX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEP3RX for USB endpoint 3 receive UDMA_CHANNEL_USBEP3TX for USB endpoint 3 transmit Returns: None.

21.2.2.7 uDMAChannelIsEnabled
Checks if a uDMA channel is enabled for operation. Prototype: tBoolean uDMAChannelIsEnabled(unsigned long ulChannel) Parameters: ulChannel is the channel number to check. Description: This function checks to see if a specic uDMA channel is enabled. This can be used to check the status of a transfer, since the channel will be automatically disabled at the end of a transfer. The ulChannel parameter must be one of the following: UDMA_CHANNEL_UART0RX for UART 0 receive channel UDMA_CHANNEL_UART0TX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSI0RX for SSI 0 receive channel UDMA_CHANNEL_SSI0TX for SSI 0 transmit channel UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_SW for the software dedicated uDMA channel And for microcontrollers that have a USB peripheral:

October 30, 2008

267

uDMA Controller

UDMA_CHANNEL_USBEP1RX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBEP2RX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEP3RX for USB endpoint 3 receive UDMA_CHANNEL_USBEP3TX for USB endpoint 3 transmit Returns: Returns true if the channel is enabled, false if disabled.

21.2.2.8 uDMAChannelModeGet
Gets the transfer mode for a uDMA channel. Prototype: unsigned long uDMAChannelModeGet(unsigned long ulChannel) Parameters: ulChannel is the logical or of the uDMA channel number with either UDMA_PRI_SELECT or UDMA_ALT_SELECT. Description: This function is used to get the transfer mode for the uDMA channel. It can be used to query the status of a transfer on a channel. When the transfer is complete the mode will be UDMA_MODE_STOP. The ulChannel parameter is one of the choices documented in the uDMAChannelEnable() function. It should be the logical OR of the channel with either UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose whether the primary or alternate data structure is used. Returns: Returns the transfer mode of the specied channel and control structure, which will be one of the following values: UDMA_MODE_STOP, UDMA_MODE_BASIC, UDMA_MODE_AUTO, UDMA_MODE_PINGPONG, UDMA_MODE_MEM_SCATTER_GATHER, or UDMA_MODE_PER_SCATTER_GATHER.

21.2.2.9 uDMAChannelRequest
Requests a uDMA channel to start a transfer. Prototype: void uDMAChannelRequest(unsigned long ulChannel) Parameters: ulChannel is the channel number on which to request a uDMA transfer.

268

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function allows software to request a uDMA channel to begin a transfer. This could be used for performing a memory to memory transfer, or if for some reason a transfer needs to be initiated by software instead of the peripheral associated with that channel. The ulChannel parameter must be one of the following: UDMA_CHANNEL_UART0RX for UART 0 receive channel UDMA_CHANNEL_UART0TX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSI0RX for SSI 0 receive channel UDMA_CHANNEL_SSI0TX for SSI 0 transmit channel UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_SW for the software dedicated uDMA channel And for microcontrollers that have a USB peripheral: UDMA_CHANNEL_USBEP1RX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBEP2RX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEP3RX for USB endpoint 3 receive UDMA_CHANNEL_USBEP3TX for USB endpoint 3 transmit Note: If the channel is UDMA_CHANNEL_SW and interrupts are used, then the completion will be signaled on the uDMA dedicated interrupt. If a peripheral channel is used, then the completion will be signaled on the peripherals interrupt. Returns: None.

21.2.2.10 uDMAChannelSizeGet
Gets the current transfer size for a uDMA channel. Prototype: unsigned long uDMAChannelSizeGet(unsigned long ulChannel) Parameters: ulChannel is the logical or of the uDMA channel number with either UDMA_PRI_SELECT or UDMA_ALT_SELECT. Description: This function is used to get the uDMA transfer size for a channel. The transfer size is the number of items to transfer, where the size of an item might be 8, 16, or 32 bits. If a partial transfer has already occurred, then the number of remaining items will be returned. If the transfer is complete, then 0 will be returned.

October 30, 2008

269

uDMA Controller

The ulChannel parameter is one of the choices documented in the uDMAChannelEnable() function. It should be the logical OR of the channel with either UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose whether the primary or alternate data structure is used. Returns: Returns the number of items remaining to transfer.

21.2.2.11 uDMAChannelTransferSet
Sets the transfer parameters for a uDMA channel. Prototype: void uDMAChannelTransferSet(unsigned long ulChannel, unsigned long ulMode, void *pvSrcAddr, void *pvDstAddr, unsigned long ulTransferSize) Parameters: ulChannel is the logical or of the uDMA channel number with either UDMA_PRI_SELECT or UDMA_ALT_SELECT. ulMode is the type of uDMA transfer. pvSrcAddr is the source address for the transfer. pvDstAddr is the destination address for the transfer. ulTransferSize is the number of data items to transfer. Description: This function is used to set the parameters for a uDMA transfer. These are typically parameters that are changed often. The function uDMAChannelControlSet() MUST be called at least once for this channel prior to calling this function. The ulChannel parameter is one of the choices documented in the uDMAChannelEnable() function. It should be the logical OR of the channel with either UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose whether the primary or alternate data structure is used. The ulMode parameter should be one of the following values: UDMA_MODE_STOP stops the uDMA transfer. The controller sets the mode to this value at the end of a transfer. UDMA_MODE_BASIC to perform a basic transfer based on request. UDMA_MODE_AUTO to perform a transfer that will always complete once started even if request is removed. UDMA_MODE_PINGPONG to set up a transfer that switches between the primary and alternate control structures for the channel. This allows use of ping-pong buffering for uDMA transfers. UDMA_MODE_MEM_SCATTER_GATHER to set up a memory scatter-gather transfer. UDMA_MODE_PER_SCATTER_GATHER to set up a peripheral scatter-gather transfer. The pvSrcAddr and pvDstAddr parameters are pointers to the rst location of the data to be transferred. These addresses should be aligned according to the item size. The compiler will take care of this if the pointers are pointing to storage of the appropriate data type.

270

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

The ulTransferSize parameter is the number of data items, not the number of bytes. The two scatter/gather modes, memory and peripheral, are actually different depending on whether the primary or alternate control structure is selected. This function will look for the UDMA_PRI_SELECT and UDMA_ALT_SELECT ag along with the channel number and will set the scatter/gather mode as appropriate for the primary or alternate control structure. The channel must also be enabled using uDMAChannelEnable() after calling this function. The transfer will not begin until the channel has been set up and enabled. Note that the channel is automatically disabled after the transfer is completed, meaning that uDMAChannelEnable() must be called again after setting up the next transfer. Note: Great care must be taken to not modify a channel control structure that is in use or else the results will be unpredictable, including the possibility of undesired data transfers to or from memory or peripherals. For BASIC and AUTO modes, it is safe to make changes when the channel is disabled, or the uDMAChannelModeGet() returns UDMA_MODE_STOP. For PINGPONG or one of the SCATTER_GATHER modes, it is safe to modify the primary or alternate control structure only when the other is being used. The uDMAChannelModeGet() function will return UDMA_MODE_STOP when a channel control structure is inactive and safe to modify. Returns: None.

21.2.2.12 uDMAControlBaseGet
Gets the base address for the channel control table. Prototype: void * uDMAControlBaseGet(void) Description: This function gets the base address of the channel control table. This table resides in system memory and holds control information for each uDMA channel. Returns: Returns a pointer to the base address of the channel control table.

21.2.2.13 uDMAControlBaseSet
Sets the base address for the channel control table. Prototype: void uDMAControlBaseSet(void *pControlTable) Parameters: pControlTable is a pointer to the 1024 byte aligned base address of the uDMA channel control table.

October 30, 2008

271

uDMA Controller

Description: This function sets the base address of the channel control table. This table resides in system memory and holds control information for each uDMA channel. The table must be aligned on a 1024 byte boundary. The base address must be set before any of the channel functions can be used. The size of the channel control table depends on the number of uDMA channels, and which transfer modes are used. Refer to the introductory text and the microcontroller datasheet for more information about the channel control table. Returns: None.

21.2.2.14 uDMADisable
Disables the uDMA controller for use. Prototype: void uDMADisable(void) Description: This function disables the uDMA controller. Once disabled, the uDMA controller will not operate until re-enabled with uDMAEnable(). Returns: None.

21.2.2.15 uDMAEnable
Enables the uDMA controller for use. Prototype: void uDMAEnable(void) Description: This function enables the uDMA controller. The uDMA controller must be enabled before it can be congured and used. Returns: None.

21.2.2.16 uDMAErrorStatusClear
Clears the uDMA error interrupt. Prototype: void uDMAErrorStatusClear(void)

272

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function clears a pending uDMA error interrupt. It should be called from within the uDMA error interrupt handler to clear the interrupt. Returns: None.

21.2.2.17 uDMAErrorStatusGet
Gets the uDMA error status. Prototype: unsigned long uDMAErrorStatusGet(void) Description: This function returns the uDMA error status. It should be called from within the uDMA error interrupt handler to determine if a uDMA error occurred. Returns: Returns non-zero if a uDMA error is pending.

21.2.2.18 uDMAIntRegister
Registers an interrupt handler for the uDMA controller. Prototype: void uDMAIntRegister(unsigned long ulIntChannel, void (*pfnHandler)(void)) Parameters: ulIntChannel identies which uDMA interrupt is to be registered. pfnHandler is a pointer to the function to be called when the interrupt is activated. Description: This sets and enables the handler to be called when the uDMA controller generates an interrupt. The ulIntChannel parameter should be one of the following: UDMA_INT_SW to register an interrupt handler to process interrupts from the uDMA software channel (UDMA_CHANNEL_SW) UDMA_INT_ERR to register an interrupt handler to process uDMA error interrupts See also: IntRegister() for important information about registering interrupt handlers. Note: The interrupt handler for uDMA is for transfer completion when the channel UDMA_CHANNEL_SW is used, and for error interrupts. The interrupts for each peripheral channel are handled through the individual peripheral interrupt handlers. Returns: None.

October 30, 2008

273

uDMA Controller

21.2.2.19 uDMAIntUnregister
Unregisters an interrupt handler for the uDMA controller. Prototype: void uDMAIntUnregister(unsigned long ulIntChannel) Parameters: ulIntChannel identies which uDMA interrupt to unregister. Description: This function will disable and clear the handler to be called for the specied uDMA interrupt. The ulIntChannel parameter should be one of UDMA_INT_SW or UDMA_INT_ERR as documented for the function uDMAIntRegister(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

21.3

Programming Example
The following example sets up the uDMA controller to perform a software initiated memory-tomemory transfer:
// // The application must allocate the channel control table. // This one is a full table for all modes and channels. // NOTE: This table must be 1024 byte aligned. // unsigned char ucDMAControlTable[1024]; // // Source and destination buffers used for the DMA transfer. // unsigned char ucSourceBuffer[256]; unsigned char ucDestBuffer[256]; // // Enable the uDMA controller. // uDMAEnable(); // // Set the base for the channel control table. // uDMAControlBaseSet(&ucDMAControlTable[0]); // // No attributes need to be set for a software based transfer. // They will be cleared by default, but are explicitly cleared // here, in case they were set elsewhere. // uDMAChannelAttributeDisable(UDMA_CONFIG_ALL);

274

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

// // Now set up the characteristics of the transfer. It will // be 8 bit data size, with source and destination increments // in bytes, to perform a byte-wise buffer copy. A bus arbitration // size of 8 is used. // uDMAChannelControlSet(UDMA_CHANNEL_SW | UDMA_PRI_SELECT, UDMA_SIZE_8 | UDMA_SRC_INC_8 | UDMA_DST_INC_8 | UDMA_ARB_8); // // The transfer buffers and transfer size will now be configured. // The transfer will use AUTO mode, which means that the // transfer will automatically run to completion after the first // request. // uDMAChannelTransferSet(UDMA_CHANNEL_SW | UDMA_PRI_SELECT, UDMA_MODE_AUTO, ucSourceBuffer, ucDestBuffer, sizeof(ucDestBuffer)); // // Finally, the channel must be enabled. Since this is a software // initiated transfer, a request must also be made. This will // start the transfer running. // uDMAChannelEnable(UDMA_CHANNEL_SW); uDMAChannelRequest(UDMA_CHANNEL_SW);

October 30, 2008

275

uDMA Controller

276

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

22

USB Controller
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 Using uDMA with USB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .309

22.1

Introduction
The USB APIs provide a set of functions that are used to access the Stellaris USB device or host controllers. The APIs are split into groups according to the functionality provided by the USB controller present in the microcontroller. Because of this, the driver has to handle microcontrollers that have only a USB device interface, a host and/or device interface, or microcontrollers that have an OTG interface, The groups are the following: USBDev, USBHost, USBOTG, USBEndpoint, and USBFIFO. The APIs in the USBDev group are only used with microcontrollers that have a USB device controller. The APIs in the USBHost group can only be used with microcontrollers that have a USB host controller. The USBOTG APIs are used by microcontrollers with an OTG interface. With USB OTG controllers, once the mode of the USB controller is congured, the device or host APIs should be used. The remainder of the APIs are used for both USB host and USB device controllers. The USBEndpoint APIs are used to congure and access the endpoints while the USBFIFO APIs are used to congure the size and location of the FIFOs.

22.2

Using USB with the uDMA Controller

The USB controller can be used with the uDMA for either sending or receiving data with both host and device controllers. The uDMA controller cannot be used to access endpoint 0, however all other endpoints are capable of using the uDMA controller. The uDMA channel numbers for USB are dened by the following values: DMA_CHANNEL_USBEP1RX DMA_CHANNEL_USBEP1TX DMA_CHANNEL_USBEP2RX DMA_CHANNEL_USBEP2TX DMA_CHANNEL_USBEP3RX DMA_CHANNEL_USBEP3TX Since the uDMA controller views transfers as either transmit or receive, and the USB controller operates on IN/OUT transactions, some care must be taken to use the correct uDMA channel with the correct endpoint. USB host IN and USB device OUT endpoints both use receive uDMA channels while USB host OUT and USB device IN endpoints will use transmit uDMA channels. When conguring the endpoint there are additional DMA settings needed. When calling USBDevEndpointCong() for an endpoint that will use uDMA, extra ags need to be added to the ulFlags parameter. These ags are one of USB_EP_DMA_MODE_0 or USB_EP_DMA_MODE_1 to control the mode of the DMA transaction, and likely USB_EP_AUTO_SET to allow the data to be

October 30, 2008

277

USB Controller

transmitted automatically once a packet is ready. USB_EP_DMA_MODE_0 will generate an interrupt whenever there is more space available in the FIFO. This allows the application code to perform operations between each packet.USB_EP_DMA_MODE_1 will only interrupt when the DMA transfer complete or there is some type of error condition. This can be used for larger transmissions that require no interaction between packets. USB_EP_AUTO_SET should normally be specied when using uDMA to prevent the need for application code to start the actual transfer of data. Example: Endpoint conguration for a device IN endpoint:
// // Endpoint 1 is a device mode BULK IN endpoint using DMA. // USBDevEndpointConfig( USB0_BASE, USB_EP_1, 64, USB_EP_MODE_BULK | USB_EP_DEV_IN | USB_EP_DMA_MODE_0 | USB_EP_AUTO_SET);

The application must provide the conguration of the actual uDMA controller. First, to clear out any previous settings, the application should call DMAChannelAttributeClear(). Then the application should call DMAChannelAttributeSet() for the uDMA channel that corresponds to the endpoint, and specify the DMA_CONFIG_USEBURST ag. Note: All uDMA transfers used by the USB controller must enable burst mode. The application needs to indicate the size of each DMA transactions, combined with the source and destination increments and the arbitration level for the uDMA controller. Example: Congure endpoint 1 transmit channel.
// // Set up the DMA for USB transmit. // DMAChannelAttributeClear( DMA_CHANNEL_USBEP1TX, DMA_CONFIG_ALL); // // Enable uDMA burst mode. // DMAChannelAttributeSet( DMA_CHANNEL_USBEP1TX, DMA_CONFIG_USEBURST); // // Data size is 8 bits and the source has a one byte increment. // Destination has no increment as it is a FIFO. // DMAChannelControlSet( DMA_CHANNEL_USBEP1TX, DMA_DATA_SIZE_8, DMA_ADDR_INC_8, DMA_ADDR_INC_NONE, DMA_ARB_64, 0);

The next step is to actually start the uDMA transfer once the data is ready to be sent. There are the only two calls that the application needs to call to start a new transfer. Normally all of the previous

278

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

uDMA conguration can stay the same. The rst call, DMAChannelTransferSet(), resets the source and destination addresses for the DMA transfer and species how much data will be sent. The next call, DMAChannelEnable() actually allows the DMA controller to begin requesting data. Example: Start the transfer of data on endpoint 1.
// // Configure the address and size of the data to transfer. // DMAChannelTransferSet( DMA_CHANNEL_USBEP1TX, DMA_MODE_BASIC, pData, USBFIFOAddr(USB0_BASE, USB_EP_1), 64); // // Start the transfer. // DMAChannelEnable(DMA_CHANNEL_USBEP1TX);

Because the uDMA interrupt occurs on the same interrupt vector as any other USB interrupt, the application must perform an extra check to determine what was the actual source of the interrupt. It is important to note that this DMA interrupt does not mean that the USB transfer is complete, but that the data has been transferred to the USB controllers FIFO. There will also be an interrupt indicating that the USB transfer is complete. However, both events need to be handled in the same interrupt routine. This because if other code in the system holds off the USB interrupt routine, both the uDMA complete and transfer complete can occur before the USB interrupt handler is called. The USB has no status bit indicating that the interrupt was due to a DMA complete, which means that the application must remember if a DMA transaction was in progress. The example below shows the g_ulFlags global variable being used to remember that a DMA transfer was pending. Example: Interrupt handling with uDMA.
if((g_ulFlags & EP1_DMA_IN_PEND) && (DMAChannelModeGet(DMA_CHANNEL_USBEP1TX) == DMA_MODE_STOP)) { // // Handle the DMA complete case. // ... } // // Get the interrupt status. // ulStatus = USBIntStatus(USB0_BASE); if(ulStatus & USB_INT_DEV_IN_EP1) { // // Handler the transfer complete case. // ... }

To use the USB device controller with an OUT endpoint, the application must use a receive uDMA channel. When calling USBDevEndpointCong() for an endpoint that uses uDMA, the application must set extra ags in the ulFlags parameter. The USB_EP_DMA_MODE_0 and USB_EP_DMA_MODE_1 control the mode of the transaction, USB_EP_AUTO_CLEAR allows the data to be received automatically without needing to manually acknowledge that the data has been

October 30, 2008

279

USB Controller

read. USB_EP_DMA_MODE_0 will not generate an interrupt when each packet is sent over USB and will only interrupt when the DMA transfer is complete. USB_EP_DMA_MODE_1 will interrupt when the DMA transfer complete or a short packet is received. This is useful for BULK endpoints that may not have prior knowledge of how much data is being received. USB_EP_AUTO_CLEAR should normally be specied when using uDMA to prevent the need for application code to acknowledge that the data has been read from the FIFO. The example below congures endpoint 1 as a Device mode Bulk OUT endpoint using DMA mode 1 with a max packet size of 64 bytes. Example: Congure endpoint 1 receive channel:
// // Endpoint 1 is a device mode BULK OUT endpoint using DMA. // USBDevEndpointConfig( USB0_BASE, USB_EP_1, 64, USB_EP_DEV_OUT | USB_EP_MODE_BULK | USB_EP_DMA_MODE_1 | USB_EP_AUTO_CLEAR);

Next the conguration of the actual uDMA controller is needed. Like the transmit case, the rst a call to DMAChannelAttributeClear() is made to clear any previous settings. This is followed by a call to DMAChannelAttributeSet() with the DMA_CONFIG_USEBURST value. Note: All uDMA transfers used by the USB controller must use burst mode. The nal call sets the read access size to 8 bits wide, the source address increment to 0, the destination address increment to 8 bits and the uDMA arbitration size to 64 bytes. Example: Congure endpoint 1 transmit channel.
// // Clear out any uDMA settings. // DMAChannelAttributeClear( DMA_CHANNEL_USBEP1RX, DMA_CONFIG_ALL); DMAChannelAttributeSet( DMA_CHANNEL_USBEP1RX, DMA_CONFIG_USEBURST); DMAChannelControlSet( DMA_CHANNEL_USBEP1RX, DMA_DATA_SIZE_8, DMA_ADDR_INC_NONE, DMA_ADDR_INC_8, DMA_ARB_64, 0);

The next step is to actually start the uDMA transfer. Unlike the transfer side, if the application is ready, this can be set up right away to wait for incoming data. Like the transmit case, these are the only calls needed to start a new transfer, normally all of the previous uDMA conguration can remain the same. Example: Start requesting of data on endpoint 1.
//

280

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

// Configure the address and size of the data to transfer. // is from the USB FIFO for endpoint 0 to g_DataBufferIn. // DMAChannelTransferSet( DMA_CHANNEL_USBEP1RX, DMA_MODE_BASIC, USBFIFOAddr(USB0_BASE, USB_EP_1), g_DataBufferIn, 64); // // Enable the uDMA channel and wait for data. // DMAChannelEnable(DMA_CHANNEL_USBEP1RX);

The transfer

The uDMA interrupt occurs on the same interrupt vector as any other USB interrupt, this means that the application needs to check to see what was the actual source of the interrupt. It is possible that the USB interrupt does not indicate that the USB transfer was complete. The interrupt could also have been caused by a short packet, error, or even a transmit complete. This requires that the application check both receive cases to determine if this is related to receiving data on the endpoint. Because the USB has no status bit indicating that the interrupt was due to a DMA complete, the application must remember if a DMA transaction was in progress. Example: Interrupt handling with uDMA.
// // Get the current interrupt status. // ulStatus = USBIntStatus(USB0_BASE); if(ulStatus & USB_INT_DEV_OUT_EP1) { // // Handle a short packet. // ... } else if((g_ulFlags & EP1_DMA_OUT_PEND) && (DMAChannelModeGet(DMA_CHANNEL_USBEP1RX) == DMA_MODE_STOP) { // // Handle the DMA complete case. // ... // // Restart receive DMA if desired. // ... }

22.3

API Functions
Functions
unsigned long USBDevAddrGet (unsigned long ulBase) void USBDevAddrSet (unsigned long ulBase, unsigned long ulAddress) void USBDevConnect (unsigned long ulBase)

October 30, 2008

281

USB Controller

void USBDevDisconnect (unsigned long ulBase) void USBDevEndpointCong (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulMaxPacketSize, unsigned long ulFlags) void USBDevEndpointCongGet (unsigned long ulBase, unsigned long ulEndpoint, unsigned long pulMaxPacketSize, unsigned long pulFlags) void USBDevEndpointDataAck (unsigned long ulBase, unsigned long ulEndpoint, tBoolean bIsLastPacket) void USBDevEndpointStall (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) void USBDevEndpointStallClear (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) void USBDevEndpointStatusClear (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) unsigned long USBEndpointDataAvail (unsigned long ulBase, unsigned long ulEndpoint) long USBEndpointDataGet (unsigned long ulBase, unsigned long ulEndpoint, unsigned char pucData, unsigned long pulSize) long USBEndpointDataPut (unsigned long ulBase, unsigned long ulEndpoint, unsigned char pucData, unsigned long ulSize) long USBEndpointDataSend (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulTransType) void USBEndpointDataToggleClear (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) unsigned long USBEndpointStatus (unsigned long ulBase, unsigned long ulEndpoint) unsigned long USBFIFOAddrGet (unsigned long ulBase, unsigned long ulEndpoint) void USBFIFOCongGet (unsigned long ulBase, unsigned long ulEndpoint, unsigned long pulFIFOAddress, unsigned long pulFIFOSize, unsigned long ulFlags) void USBFIFOCongSet (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFIFOAddress, unsigned long ulFIFOSize, unsigned long ulFlags) void USBFIFOFlush (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) unsigned long USBFrameNumberGet (unsigned long ulBase) unsigned long USBHostAddrGet (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) void USBHostAddrSet (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulAddr, unsigned long ulFlags) void USBHostEndpointCong (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulMaxPayload, unsigned long ulNAKPollInterval, unsigned long ulTargetEndpoint, unsigned long ulFlags) void USBHostEndpointDataAck (unsigned long ulBase, unsigned long ulEndpoint) void USBHostEndpointDataToggle (unsigned long ulBase, unsigned long ulEndpoint, tBoolean bDataToggle, unsigned long ulFlags) void USBHostEndpointStatusClear (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) unsigned long USBHostHubAddrGet (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) void USBHostHubAddrSet (unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulAddr, unsigned long ulFlags) void USBHostPwrDisable (unsigned long ulBase) void USBHostPwrEnable (unsigned long ulBase)

282

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

void USBHostPwrFaultCong (unsigned long ulBase, unsigned long ulFlags) void USBHostPwrFaultDisable (unsigned long ulBase) void USBHostPwrFaultEnable (unsigned long ulBase) void USBHostRequestIN (unsigned long ulBase, unsigned long ulEndpoint) void USBHostRequestStatus (unsigned long ulBase) void USBHostReset (unsigned long ulBase, tBoolean bStart) void USBHostResume (unsigned long ulBase, tBoolean bStart) unsigned long USBHostSpeedGet (unsigned long ulBase) void USBHostSuspend (unsigned long ulBase) void USBIntDisable (unsigned long ulBase, unsigned long ulFlags) void USBIntEnable (unsigned long ulBase, unsigned long ulFlags) void USBIntRegister (unsigned long ulBase, void (pfnHandler)(void)) unsigned long USBIntStatus (unsigned long ulBase) void USBIntUnregister (unsigned long ulBase) void USBOTGSessionRequest (unsigned long ulBase, tBoolean bStart)

22.3.1 Detailed Description

The USB APIs provide all of the functions needed by an application to implement a USB device or USB host stack. The APIs abstract the IN/OUT nature of endpoints based on the type of USB controller that is in use. Any API that uses the IN/OUT terminology will comply with the standard USB interpretation of these terms. For example, an OUT endpoint on a microcontroller that has only a device interface will actually receive data on this endpoint, while a microcontroller that has a host interface will actually transmit data on an OUT endpoint. Another important fact to understand is that all endpoints in the USB controller, whether host or device, have two "sides" to them. This allows each endpoint to both transmit and receive data. An application can use a single endpoint for both and IN and OUT transactions. For example: In device mode, endpoint 1 could be congured to have BULK IN and BULK OUT handled by endpoint 1. It is important to note that the endpoint number used is the endpoint number reported to the host. For microcontrollers with host controllers, the application can use an endpoint communicate with both IN and OUT endpoints of different types as well. For example: Endpoint 2 could be used to communicate with one devices interrupt IN endpoint and another devices bulk OUT endpoint at the same time. This effectively gives the application one dedicated control endpoint for IN or OUT control transactions on endpoint 0, and three IN endpoints and three OUT endpoints. The USB controller has a congurable FIFOs in devices that have a USB device controller as well as those that have a host controller. The overall size of the FIFO RAM is 4096 bytes. It is important to note that the rst 64 bytes of this memory are dedicated to endpoint 0 for control transactions. The remaining 4032 bytes are congurable however the application desires. The FIFO conguration is usually set at the beginning of the application and not modied once the USB controller is in use. The FIFO conguration uses the USBFIFOCong() API to set the starting address and the size of the FIFOs that are dedicated to each endpoint. Example: FIFO Conguration 0-64 - endpoint 0 IN/OUT (64 bytes). 64-576 - endpoint 1 IN (512 bytes). 576-1088 - endpoint 1 OUT (512 bytes). 1088-1600 - endpoint 2 IN (512 bytes).

October 30, 2008

283

USB Controller

// // FIFO for endpoint 1 IN starts at address 64 and is 512 bytes in size. // USBFIFOConfig(USB0_BASE, USB_EP_1, 64, USB_FIFO_SZ_512, USB_EP_DEV_IN); // // FIFO for endpoint 1 OUT starts at address 576 and is 512 bytes in size. // USBFIFOConfig(USB0_BASE, USB_EP_1, 576, USB_FIFO_SZ_512, USB_EP_DEV_OUT); // // FIFO for endpoint 2 IN starts at address 1088 and is 512 bytes in size. // USBFIFOConfig(USB0_BASE, USB_EP_2, 1088, USB_FIFO_SZ_512, USB_EP_DEV_IN);

22.3.2 Function Documentation

22.3.2.1 USBDevAddrGet
Returns the current device address in device mode. Prototype: unsigned long USBDevAddrGet(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function will return the current device address. This address was set by a call to USBDevAddrSet(). Note: This function should only be called in device mode. Returns: The current device address.

22.3.2.2 USBDevAddrSet
Sets the address in device mode. Prototype: void USBDevAddrSet(unsigned long ulBase, unsigned long ulAddress) Parameters: ulBase species the USB module base address. ulAddress is the address to use for a device. Description: This function will set the device address on the USB bus. This address was likely received via a SET ADDRESS command from the host controller.

284

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Note: This function should only be called in device mode. Returns: None.

22.3.2.3 USBDevConnect
Connects the USB controller to the bus in device mode. Prototype: void USBDevConnect(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function will cause the soft connect feature of the USB controller to be enabled. Call USBDisconnect() to remove the USB device from the bus. Note: This function should only be called in device mode. Returns: None.

22.3.2.4 USBDevDisconnect
Removes the USB controller from the bus in device mode. Prototype: void USBDevDisconnect(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function will cause the soft connect feature of the USB controller to remove the device from the USB bus. A call to USBDevConnect() is needed to reconnect to the bus. Note: This function should only be called in device mode. Returns: None.

October 30, 2008

285

USB Controller

22.3.2.5 USBDevEndpointCong
Sets the conguration for an endpoint. Prototype: void USBDevEndpointConfig(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulEndpoint, ulMaxPacketSize, ulFlags)

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulMaxPacketSize is the maximum packet size for this endpoint. ulFlags are used to congure other endpoint settings. Description: This function will set the basic conguration for an endpoint in device mode. Endpoint zero does not have a dynamic conguration, so this function should not be called for endpoint zero. The ulFlags parameter determines some of the conguration while the other parameters provide the rest. The USB_EP_MODE_ ags dene what the type is for the given endpoint. USB_EP_MODE_CTRL is a control endpoint. USB_EP_MODE_ISOC is an isochronous endpoint. USB_EP_MODE_BULK is a bulk endpoint. USB_EP_MODE_INT is an interrupt endpoint. The USB_EP_DMA_MODE_ ags determines the type of DMA access to the endpoint data FIFOs. The choice of the DMA mode depends on how the DMA controller is congured and how it is being used. See the Using USB with the uDMA Controller section for more information on DMA conguration. When conguring an IN endpoint, the USB_EP_AUTO_SET bit can be specied to cause the automatic transmission of data on the USB bus as soon as ulMaxPacketSize bytes of data are written into the FIFO for this endpoint. This is commonly used with DMA as no interaction is required to start the transmission of data. When conguring an OUT endpoint, the USB_EP_AUTO_REQUEST bit is specied to trigger the request for more data once the FIFO has been drained enough to receive ulMaxPacketSize more bytes of data. Also for OUT endpoints, the USB_EP_AUTO_CLEAR bit can be used to clear the data packet ready ag automatically once the data has been read from the FIFO. If this is not used, this ag must be manually cleared via a call to USBDevEndpointStatusClear(). Both of these settings can be used to remove the need for extra calls when using the controller in DMA mode. Note: This function should only be called in device mode. Returns: None.

286

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

22.3.2.6 USBDevEndpointCongGet
Gets the current conguration for an endpoint. Prototype: void USBDevEndpointConfigGet(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulEndpoint, *pulMaxPacketSize, *pulFlags)

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. pulMaxPacketSize is a pointer which will be written with the maximum packet size for this endpoint. pulFlags is a pointer which will be written with the current endpoint settings. On entry to the function, this pointer must contain either USB_EP_DEV_IN or USB_EP_DEV_OUT to indicate whether the IN or OUT endpoint is to be queried. Description: This function will return the basic conguration for an endpoint in device mode. The values returned in pulMaxPacketSize and pulFlags are equivalent to the ulMaxPacketSize and ulFlags previously passed to USBDevEndpointCong for this endpoint. Note: This function should only be called in device mode. Returns: None.

22.3.2.7 USBDevEndpointDataAck
Acknowledge that data was read from the given endpoints FIFO in device mode. Prototype: void USBDevEndpointDataAck(unsigned long ulBase, unsigned long ulEndpoint, tBoolean bIsLastPacket) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. bIsLastPacket indicates if this is the last packet. Description: This function acknowledges that the data was read from the endpoints FIFO. The bIsLastPacket parameter is set to a true value if this is the last in a series of data packets on endpoint zero. The bIsLastPacket parameter is not used for endpoints other than endpoint zero. This call can be used if processing is required between reading the data and acknowledging that the data has been read.

October 30, 2008

287

USB Controller

Note: This function should only be called in device mode. Returns: None.

22.3.2.8 USBDevEndpointStall
Stalls the specied endpoint in device mode. Prototype: void USBDevEndpointStall(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint species the endpoint to stall. ulFlags species whether to stall the IN or OUT endpoint. Description: This function will cause to endpoint number passed in to go into a stall condition. If the ulFlags parameter is USB_EP_DEV_IN then the stall will be issued on the IN portion of this endpoint. If the ulFlags parameter is USB_EP_DEV_OUT then the stall will be issued on the OUT portion of this endpoint. Note: This function should only be called in device mode. Returns: None.

22.3.2.9 USBDevEndpointStallClear
Clears the stall condition on the specied endpoint in device mode. Prototype: void USBDevEndpointStallClear(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint species which endpoint to remove the stall condition. ulFlags species whether to remove the stall condition from the IN or the OUT portion of this endpoint.

288

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function will cause the endpoint number passed in to exit the stall condition. If the ulFlags parameter is USB_EP_DEV_IN then the stall will be cleared on the IN portion of this endpoint. If the ulFlags parameter is USB_EP_DEV_OUT then the stall will be cleared on the OUT portion of this endpoint. Note: This function should only be called in device mode. Returns: None.

22.3.2.10 USBDevEndpointStatusClear
Clears the status bits in this endpoint in device mode. Prototype: void USBDevEndpointStatusClear(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulFlags are the status bits that will be cleared. Description: This function will clear the status of any bits that are passed in the ulFlags parameter. The ulFlags parameter can take the value returned from the USBEndpointStatus() call. Note: This function should only be called in device mode. Returns: None.

22.3.2.11 USBEndpointDataAvail
Determine the number of bytes of data available in a given endpoints FIFO. Prototype: unsigned long USBEndpointDataAvail(unsigned long ulBase, unsigned long ulEndpoint) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access.

October 30, 2008

289

USB Controller

Description: This function will return the number of bytes of data currently available in the FIFO for the given receive (OUT) endpoint. It may be used prior to calling USBEndpointDataGet() to determine the size of buffer required to hold the newly-received packet. Returns: This call will return the number of bytes available in a given endpoint FIFO.

22.3.2.12 USBEndpointDataGet
Retrieves data from the given endpoints FIFO. Prototype: long USBEndpointDataGet(unsigned unsigned unsigned unsigned

long long char long

ulBase, ulEndpoint, *pucData, *pulSize)

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. pucData is a pointer to the data area used to return the data from the FIFO. pulSize is initially the size of the buffer passed into this call via the pucData parameter. It will be set to the amount of data returned in the buffer. Description: This function will return the data from the FIFO for the given endpoint. The pulSize parameter should indicate the size of the buffer passed in the pulData parameter. The data in the pulSize parameter will be changed to match the amount of data returned in the pucData parameter. If a zero byte packet was received this call will not return a error but will instead just return a zero in the pulSize parameter. The only error case occurs when there is no data packet available. Returns: This call will return 0, or -1 if no packet was received.

22.3.2.13 USBEndpointDataPut
Puts data into the given endpoints FIFO. Prototype: long USBEndpointDataPut(unsigned unsigned unsigned unsigned

long long char long

ulBase, ulEndpoint, *pucData, ulSize)

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access.

290

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

pucData is a pointer to the data area used as the source for the data to put into the FIFO. ulSize is the amount of data to put into the FIFO. Description: This function will put the data from the pucData parameter into the FIFO for this endpoint. If a packet is already pending for transmission then this call will not put any of the data into the FIFO and will return -1. Care should be taken to not write more data than can t into the FIFO allocated by the call to USBFIFOCong(). Returns: This call will return 0 on success, or -1 to indicate that the FIFO is in use and cannot be written.

22.3.2.14 USBEndpointDataSend
Starts the transfer of data from an endpoints FIFO. Prototype: long USBEndpointDataSend(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulTransType) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulTransType is set to indicate what type of data is being sent. Description: This function will start the transfer of data from the FIFO for a given endpoint. This is necessary if the USB_EP_AUTO_SET bit was not enabled for the endpoint. Setting the ulTransType parameter will allow the appropriate signaling on the USB bus for the type of transaction being requested. The ulTransType parameter should be one of the following: USB_TRANS_OUT for OUT transaction on any endpoint in host mode. USB_TRANS_IN for IN transaction on any endpoint in device mode. USB_TRANS_IN_LAST for the last IN transactions on endpoint zero in a sequence of IN transactions. USB_TRANS_SETUP for setup transactions on endpoint zero. USB_TRANS_STATUS for status results on endpoint zero. Returns: This call will return 0 on success, or -1 if a transmission is already in progress.

22.3.2.15 USBEndpointDataToggleClear
Sets the Data toggle on an endpoint to zero. Prototype: void USBEndpointDataToggleClear(unsigned long ulBase,

October 30, 2008

291

USB Controller

unsigned long ulEndpoint, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint species the endpoint to reset the data toggle. ulFlags species whether to access the IN or OUT endpoint. Description: This function will cause the controller to clear the data toggle for an endpoint. This call is not valid for endpoint zero and can be made with host or device controllers. The ulFlags parameter should be one of USB_EP_HOST_OUT, USB_EP_HOST_IN, USB_EP_DEV_OUT, or USB_EP_DEV_IN. Returns: None.

22.3.2.16 USBEndpointStatus
Returns the current status of an endpoint. Prototype: unsigned long USBEndpointStatus(unsigned long ulBase, unsigned long ulEndpoint) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. Description: This function will return the status of a given endpoint. If any of these status bits need to be cleared, then these these values must be cleared by calling the USBDevEndpointStatusClear() or USBHostEndpointStatusClear() functions. The following are the status ags for host mode: USB_HOST_IN_PID_ERROR - PID error on the given endpoint. USB_HOST_IN_NOT_COMP - The device failed to respond to an IN request. USB_HOST_IN_STALL - A stall was received on an IN endpoint. USB_HOST_IN_DATA_ERROR - There was a CRC or bit-stuff error on an IN endpoint in Isochronous mode. USB_HOST_IN_NAK_TO - NAKs received on this IN endpoint for more than the specied timeout period. USB_HOST_IN_ERROR - Failed to communicate with a device using this IN endpoint. USB_HOST_IN_FIFO_FULL - This IN endpoints FIFO is full. USB_HOST_IN_PKTRDY - Data packet ready on this IN endpoint. USB_HOST_OUT_NAK_TO - NAKs received on this OUT endpoint for more than the specied timeout period. USB_HOST_OUT_NOT_COMP - The device failed to respond to an OUT request.

292

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

USB_HOST_OUT_STALL - A stall was received on this OUT endpoint. USB_HOST_OUT_ERROR - Failed to communicate with a device using this OUT endpoint. USB_HOST_OUT_FIFO_NE - This endpoints OUT FIFO is not empty. USB_HOST_OUT_PKTPEND - The data transfer on this OUT endpoint has not completed. USB_HOST_EP0_NAK_TO - NAKs received on endpoint zero for more than the specied timeout period. USB_HOST_EP0_ERROR - The device failed to respond to a request on endpoint zero. USB_HOST_EP0_IN_STALL - A stall was received on endpoint zero for an IN transaction. USB_HOST_EP0_IN_PKTRDY - Data packet ready on endpoint zero for an IN transaction. The following are the status ags for device mode: USB_DEV_OUT_SENT_STALL - A stall was sent on this OUT endpoint. USB_DEV_OUT_DATA_ERROR - There was a CRC or bit-stuff error on an OUT endpoint. USB_DEV_OUT_OVERRUN - An OUT packet was not loaded due to a full FIFO. USB_DEV_OUT_FIFO_FULL - The OUT endpoints FIFO is full. USB_DEV_OUT_PKTRDY - There is a data packet ready in the OUT endpoints FIFO. USB_DEV_IN_NOT_COMP - A larger packet was split up, more data to come. USB_DEV_IN_SENT_STALL - A stall was sent on this IN endpoint. USB_DEV_IN_UNDERRUN - Data was requested on the IN endpoint and no data was ready. USB_DEV_IN_FIFO_NE - The IN endpoints FIFO is not empty. USB_DEV_IN_PKTPEND - The data transfer on this IN endpoint has not completed. USB_DEV_EP0_SETUP_END - A control transaction ended before Data End condition was sent. USB_DEV_EP0_SENT_STALL - A stall was sent on endpoint zero. USB_DEV_EP0_IN_PKTPEND - The data transfer on endpoint zero has not completed. USB_DEV_EP0_OUT_PKTRDY - There is a data packet ready in endpoint zeros OUT FIFO. Returns: The current status ags for the endpoint depending on mode.

22.3.2.17 USBFIFOAddrGet
Returns the absolute FIFO address for a given endpoint. Prototype: unsigned long USBFIFOAddrGet(unsigned long ulBase, unsigned long ulEndpoint) Parameters: ulBase species the USB module base address. ulEndpoint species which endpoints FIFO address to return.

October 30, 2008

293

USB Controller

Description: This function returns the actual physical address of the FIFO. This is needed when the USB is going to be used with the uDMA controller and the source or destination address needs to be set to the physical FIFO address for a given endpoint. Returns: None.

22.3.2.18 USBFIFOCongGet
Returns the FIFO conguration for an endpoint. Prototype: void USBFIFOConfigGet(unsigned unsigned unsigned unsigned unsigned

long long long long long

ulBase, ulEndpoint, *pulFIFOAddress, *pulFIFOSize, ulFlags)

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. pulFIFOAddress is the starting address for the FIFO. pulFIFOSize is the size of the FIFO in bytes. ulFlags species what information to retrieve from the FIFO conguration. Description: This function will return the starting address and size of the FIFO for a given endpoint. Endpoint zero does not have a dynamically congurable FIFO so this function should not be called for endpoint zero. The ulFlags parameter species whether the endpoints OUT or IN FIFO should be read. If in host mode, the ulFlags parameter should be USB_EP_HOST_OUT or USB_EP_HOST_IN, and if in device mode the ulFlags parameter should be either USB_EP_DEV_OUT or USB_EP_DEV_IN. Returns: None.

22.3.2.19 USBFIFOCongSet
Sets the FIFO conguration for an endpoint. Prototype: void USBFIFOConfigSet(unsigned unsigned unsigned unsigned unsigned

long long long long long

ulBase, ulEndpoint, ulFIFOAddress, ulFIFOSize, ulFlags)

294

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulFIFOAddress is the starting address for the FIFO. ulFIFOSize is the size of the FIFO in bytes. ulFlags species what information to set in the FIFO conguration. Description: This function will set the starting FIFO RAM address and size of the FIFO for a given endpoint. Endpoint zero does not have a dynamically congurable FIFO so this function should not be called for endpoint zero. The ulFIFOSize parameter should be one of the values in the USB_FIFO_SZ_ values. If the endpoint is going to use double buffering it should use the values with the _DB at the end of the value. For example, use USB_FIFO_SZ_16_DB to congure an endpoint to have a 16 byte double buffered FIFO. If a double buffered FIFO is used, then the actual size of the FIFO will be twice the size indicated by the ulFIFOSize parameter. This means that the USB_FIFO_SZ_16_DB value will use 32 bytes of the USB controllers FIFO memory. The ulFIFOAddress value should be a multiple of 8 bytes and directly indicates the starting address in the USB controllers FIFO RAM. For example, a value of 64 indicates that the FIFO should start 64 bytes into the USB controllers FIFO memory. The ulFlags value species whether the endpoints OUT or IN FIFO should be congured. If in host mode, use USB_EP_HOST_OUT or USB_EP_HOST_IN, and if in device mode use USB_EP_DEV_OUT or USB_EP_DEV_IN. Returns: None.

22.3.2.20 USBFIFOFlush
Forces a ush of an endpoints FIFO. Prototype: void USBFIFOFlush(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulFlags species if the IN or OUT endpoint should be accessed. Description: This function will force the controller to ush out the data in the FIFO. The function can be called with either host or device controllers and requires the ulFlags parameter be one of USB_EP_HOST_OUT, USB_EP_HOST_IN, USB_EP_DEV_OUT, or USB_EP_DEV_IN. Returns: None.

October 30, 2008

295

USB Controller

22.3.2.21 USBFrameNumberGet
Get the current frame number. Prototype: unsigned long USBFrameNumberGet(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function returns the last frame number received. Returns: The last frame number received.

22.3.2.22 USBHostAddrGet
Gets the current functional device address for an endpoint. Prototype: unsigned long USBHostAddrGet(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulFlags determines if this is an IN or an OUT endpoint. Description: This function returns the current functional address that an endpoint is using to communicate with a device. The ulFlags parameter determines if the IN or OUT endpoints device address is returned. Note: This function should only be called in host mode. Returns: Returns the current function address being used by an endpoint.

22.3.2.23 USBHostAddrSet
Sets the functional address for the device that is connected to an endpoint in host mode. Prototype: void USBHostAddrSet(unsigned long ulBase, unsigned long ulEndpoint,

296

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

unsigned long ulAddr, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulAddr is the functional address for the controller to use for this endpoint. ulFlags determines if this is an IN or an OUT endpoint. Description: This function will set the functional address for a device that is using this endpoint for communication. This ulAddr parameter is the address of the target device that this endpoint will be used to communicate with. The ulFlags parameter indicates if the IN or OUT endpoint should be set. Note: This function should only be called in host mode. Returns: None.

22.3.2.24 USBHostEndpointCong
Sets the base conguration for a host endpoint. Prototype: void USBHostEndpointConfig(unsigned unsigned unsigned unsigned unsigned unsigned

long long long long long long

ulBase, ulEndpoint, ulMaxPayload, ulNAKPollInterval, ulTargetEndpoint, ulFlags)

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulMaxPayload is the maximum payload for this endpoint. ulNAKPollInterval is the either the NAK timeout limit or the polling interval depending on the type of endpoint. ulTargetEndpoint is the endpoint that the host endpoint is targeting. ulFlags are used to congure other endpoint settings. Description: This function will set the basic conguration for the transmit or receive portion of an endpoint in host mode. The ulFlags parameter determines some of the conguration while the other parameters provide the rest. The ulFlags parameter determines whether this is an IN endpoint (USB_EP_HOST_IN or USB_EP_DEV_IN) or an OUT endpoint (USB_EP_HOST_OUT or USB_EP_DEV_OUT), whether this is a Full speed endpoint (USB_EP_SPEED_FULL) or a Low speed endpoint (USB_EP_SPEED_LOW). The USB_EP_MODE_ ags control the type of the endpoint.

October 30, 2008

297

USB Controller

USB_EP_MODE_CTRL is a control endpoint. USB_EP_MODE_ISOC is an isochronous endpoint. USB_EP_MODE_BULK is a bulk endpoint. USB_EP_MODE_INT is an interrupt endpoint. The ulNAKPollInterval parameter has different meanings based on the USB_EP_MODE value and whether or not this call is being made for endpoint zero or another endpoint. For endpoint zero or any Bulk endpoints, this value always indicates the number of frames to allow a device to NAK before considering it a timeout. If this endpoint is an isochronous or interrupt endpoint, this value is the polling interval for this endpoint. For interrupt endpoints the polling interval is simply the number of frames between polling an interrupt endpoint. For isochronous endpoints this value represents a polling interval of 2 (ulNAKPollInterval - 1) frames. When used as a NAK timeout, the ulNAKPollInterval value species 2 (ulNAKPollInterval - 1) frames before issuing a time out. There are two special time out values that can be specied when setting the ulNAKPollInterval value. The rst is MAX_NAK_LIMIT which is the maximum value that can be passed in this variable. The other is DISABLE_NAK_LIMIT which indicates that there should be no limit on the number of NAKs. The USB_EP_DMA_MODE_ ags enables the type of DMA used to access the endpoints data FIFOs. The choice of the DMA mode depends on how the DMA controller is congured and how it is being used. See the Using USB with the uDMA Controller section for more information on DMA conguration. When conguring the OUT portion of an endpoint, the USB_EP_AUTO_SET bit is specied to cause the transmission of data on the USB bus to start as soon as the number of bytes specied by ulMaxPayload have been written into the OUT FIFO for this endpoint. When conguring the IN portion of an endpoint, the USB_EP_AUTO_REQUEST bit can be specied to trigger the request for more data once the FIFO has been drained enough to t ulMaxPayload bytes. The USB_EP_AUTO_CLEAR bit can be used to clear the data packet ready ag automatically once the data has been read from the FIFO. If this is not used, this ag must be manually cleared via a call to USBDevEndpointStatusClear() or USBHostEndpointStatusClear(). Note: This function should only be called in host mode. Returns: None.

22.3.2.25 USBHostEndpointDataAck
Acknowledge that data was read from the given endpoints FIFO in host mode. Prototype: void USBHostEndpointDataAck(unsigned long ulBase, unsigned long ulEndpoint) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access.

298

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function acknowledges that the data was read from the endpoints FIFO. This call is used if processing is required between reading the data and acknowledging that the data has been read. Note: This function should only be called in host mode. Returns: None.

22.3.2.26 USBHostEndpointDataToggle
Sets the value data toggle on an endpoint in host mode. Prototype: void USBHostEndpointDataToggle(unsigned unsigned tBoolean unsigned

long ulBase, long ulEndpoint, bDataToggle, long ulFlags)

Parameters: ulBase species the USB module base address. ulEndpoint species the endpoint to reset the data toggle. bDataToggle species whether to set the state to DATA0 or DATA1. ulFlags species whether to set the IN or OUT endpoint. Description: This function is used to force the state of the data toggle in host mode. If the value passed in the bDataToggle parameter is false, then the data toggle will be set to the DATA0 state, and if it is true it will be set to the DATA1 state. The ulFlags parameter can be USB_EP_HOST_IN or USB_EP_HOST_OUT to access the desired portion of this endpoint. The ulFlags parameter is ignored for endpoint zero. Note: This function should only be called in host mode. Returns: None.

22.3.2.27 USBHostEndpointStatusClear
Clears the status bits in this endpoint in host mode. Prototype: void USBHostEndpointStatusClear(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags)

October 30, 2008

299

USB Controller

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulFlags are the status bits that will be cleared. Description: This function will clear the status of any bits that are passed in the ulFlags parameter. The ulFlags parameter can take the value returned from the USBEndpointStatus() call. Note: This function should only be called in host mode. Returns: None.

22.3.2.28 USBHostHubAddrGet
Get the current device hub address for this endpoint. Prototype: unsigned long USBHostHubAddrGet(unsigned long ulBase, unsigned long ulEndpoint, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulFlags determines if this is an IN or an OUT endpoint. Description: This function will return the current hub address that an endpoint is using to communicate with a device. The ulFlags parameter determines if the device address for the IN or OUT endpoint is returned. Note: This function should only be called in host mode. Returns: This function returns the current hub address being used by an endpoint.

22.3.2.29 USBHostHubAddrSet
Set the hub address for the device that is connected to an endpoint. Prototype: void USBHostHubAddrSet(unsigned unsigned unsigned unsigned

long long long long

ulBase, ulEndpoint, ulAddr, ulFlags)

300

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase species the USB module base address. ulEndpoint is the endpoint to access. ulAddr is the hub address for the device using this endpoint. ulFlags determines if this is an IN or an OUT endpoint. Description: This function will set the hub address for a device that is using this endpoint for communication. The ulFlags parameter determines if the device address for the IN or the OUT endpoint is set by this call. Note: This function should only be called in host mode. Returns: None.

22.3.2.30 USBHostPwrDisable
Disables the external power pin. Prototype: void USBHostPwrDisable(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function disables the USBEPEN signal to disable an external power supply in host mode operation. Note: This function should only be called in host mode. Returns: None.

22.3.2.31 USBHostPwrEnable
Enables the external power pin. Prototype: void USBHostPwrEnable(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function enables the USBEPEN signal to enable an external power supply in host mode operation.

October 30, 2008

301

USB Controller

Note: This function should only be called in host mode. Returns: None.

22.3.2.32 USBHostPwrFaultCong
Sets the conguration for USB power fault. Prototype: void USBHostPwrFaultConfig(unsigned long ulBase, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulFlags species the conguration of the power fault. Description: This function will set the behavior of the USB controller during a power fault and the behavior of the USBPEN pin. The ags specify the power fault level sensitivity, the power fault action, and the power enable level and source. One of the following can be selected as the power fault level sensitivity: USB_HOST_PWRFLT_LOW - Power fault is indicated by the pin being driven low. USB_HOST_PWRFLT_HIGH - Power fault is indicated by the pin being driven! high. One of the following can be selected as the power fault action: USB_HOST_PWRFLT_EP_NONE - No automatic action when power fault detected. USB_HOST_PWRFLT_EP_TRI - Automatically Tri-state the USBEPEN pin on a power fault. USB_HOST_PWRFLT_EP_LOW - Automatically drive USBEPEN pin low on a power fault. USB_HOST_PWRFLT_EP_HIGH - Automatically drive USBEPEN pin high on a power fault. One of the following can be selected as the power enable level and source: USB_HOST_PWREN_LOW - USBEPEN is driven low when power is enabled. USB_HOST_PWREN_HIGH - USBEPEN is driven high when power is enabled. USB_HOST_PWREN_VBLOW - USBEPEN is driven high when VBUS is low. USB_HOST_PWREN_VBHIGH - USBEPEN is driven high when VBUS is high. Note: This function should only be called in host mode. Returns: None.

302

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

22.3.2.33 USBHostPwrFaultDisable
Disables power fault detection. Prototype: void USBHostPwrFaultDisable(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function disables power fault detection in the USB controller. Note: This function should only be called in host mode. Returns: None.

22.3.2.34 USBHostPwrFaultEnable
Enables power fault detection. Prototype: void USBHostPwrFaultEnable(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function enables power fault detection in the USB controller. If the USBPFLT pin is not in use this function should not be used. Note: This function should only be called in host mode. Returns: None.

22.3.2.35 USBHostRequestIN
Schedules a request for an IN transaction on an endpoint in host mode. Prototype: void USBHostRequestIN(unsigned long ulBase, unsigned long ulEndpoint) Parameters: ulBase species the USB module base address.

October 30, 2008

303

USB Controller

ulEndpoint is the endpoint to access. Description: This function will schedule a request for an IN transaction. When the USB device being communicated with responds the data, the data can be retrieved by calling USBEndpointDataGet() or via a DMA transfer. Note: This function should only be called in host mode. Returns: None.

22.3.2.36 USBHostRequestStatus
Issues a request for a status IN transaction on endpoint zero. Prototype: void USBHostRequestStatus(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function is used to cause a request for an status IN transaction from a device on endpoint zero. This function can only be used with endpoint zero as that is the only control endpoint that supports this ability. This is used to complete the last phase of a control transaction to a device and an interrupt will be signaled when the status packet has been received. Returns: None.

22.3.2.37 USBHostReset
Handles the USB bus reset condition. Prototype: void USBHostReset(unsigned long ulBase, tBoolean bStart) Parameters: ulBase species the USB module base address. bStart species whether to start or stop signaling reset on the USB bus. Description: When this function is called with the bStart parameter set to true, this function will cause the start of a reset condition on the USB bus. The caller should then delay at least 20ms before calling this function again with the bStart parameter set to false.

304

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Note: This function should only be called in host mode. Returns: None.

22.3.2.38 USBHostResume
Handles the USB bus resume condition. Prototype: void USBHostResume(unsigned long ulBase, tBoolean bStart) Parameters: ulBase species the USB module base address. bStart species if the USB controller is entering or leaving the resume signaling state. Description: When in device mode this function will bring the USB controller out of the suspend state. This call should rst be made with the bStart parameter set to true to start resume signaling. The device application should then delay at least 10ms but not more than 15ms before calling this function with the bStart parameter set to false. When in host mode this function will signal devices to leave the suspend state. This call should rst be made with the bStart parameter set to true to start resume signaling. The host application should then delay at least 20ms before calling this function with the bStart parameter set to false. This will cause the controller to complete the resume signaling on the USB bus. Returns: None.

22.3.2.39 USBHostSpeedGet
Returns the current speed of the USB device connected. Prototype: unsigned long USBHostSpeedGet(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function will return the current speed of the USB bus. Note: This function should only be called in host mode. Returns: Returns either USB_LOW_SPEED, USB_FULL_SPEED, or USB_UNDEF_SPEED.

October 30, 2008

305

USB Controller

22.3.2.40 USBHostSuspend
Puts the USB bus in a suspended state. Prototype: void USBHostSuspend(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: When used in host mode, this function will put the USB bus in the suspended state. Note: This function should only be called in host mode. Returns: None.

22.3.2.41 USBIntDisable
Disables the sources for USB interrupts. Prototype: void USBIntDisable(unsigned long ulBase, unsigned long ulFlags) Parameters: ulBase species the USB module base address. ulFlags species which interrupts to disable. Description: This function will disable the USB controller from generating the interrupts indicated by the ulFlags parameter. There are three groups of interrupt sources, IN Endpoints, OUT Endpoints, and general status changes, specied by USB_INT_HOST_IN, USB_INT_HOST_OUT, USB_INT_DEV_IN, USB_INT_DEV_OUT, and USB_INT_STATUS. If USB_INT_ALL is specied then all interrupts will be disabled. Returns: None.

22.3.2.42 USBIntEnable
Enables the sources for USB interrupts. Prototype: void USBIntEnable(unsigned long ulBase, unsigned long ulFlags)

306

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase species the USB module base address. ulFlags species which interrupts to enable. Description: This function will enable the USB controllers ability to generate the interrupts indicated by the ulFlags parameter. There are three groups of interrupt sources, IN Endpoints, OUT Endpoints, and general status changes, specied by USB_INT_HOST_IN, USB_INT_HOST_OUT, USB_INT_DEV_IN, USB_INT_DEV_OUT, and USB_STATUS. If USB_INT_ALL is specied then all interrupts will be enabled. Note: A call must be made to enable the interrupt in the main interrupt controller to receive interrupts. The USBIntRegister() API performs this controller level interrupt enable. However if static interrupt handlers are used then then a call to IntEnable() must be made in order to allow any USB interrupts to occur. Returns: None.

22.3.2.43 USBIntRegister
Registers an interrupt handler for the USB controller. Prototype: void USBIntRegister(unsigned long ulBase, void (*pfnHandler)(void)) Parameters: ulBase species the USB module base address. pfnHandler is a pointer to the function to be called when a USB interrupt occurs. Description: This sets the handler to be called when a USB interrupt occurs. This will also enable the global USB interrupt in the interrupt controller. The specic desired USB interrupts must be enabled via a separate call to USBIntEnable(). It is the interrupt handlers responsibility to clear the interrupt sources via a call to USBIntStatus(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

22.3.2.44 USBIntStatus
Returns the status of the USB interrupts. Prototype: unsigned long USBIntStatus(unsigned long ulBase)

October 30, 2008

307

USB Controller

Parameters: ulBase species the USB module base address. Description: This function will read the source of the interrupt for the USB controller. There are three groups of interrupt sources, IN Endpoints, OUT Endpoints, and general status changes. This call will return the current status for all of these interrupts. The bit values returned should be compared against the USB_HOST_IN, USB_HOST_OUT, USB_HOST_EP0, USB_DEV_IN, USB_DEV_OUT, and USB_DEV_EP0 values. Note: This call will clear the source of all of the general status interrupts. Returns: Returns the status of the sources for the USB controllers interrupt.

22.3.2.45 USBIntUnregister
Unregisters an interrupt handler for the USB controller. Prototype: void USBIntUnregister(unsigned long ulBase) Parameters: ulBase species the USB module base address. Description: This function unregister the interrupt handler. This function will also disable the USB interrupt in the interrupt controller. See also: IntRegister() for important information about registering or unregistering interrupt handlers. Returns: None.

22.3.2.46 USBOTGSessionRequest
Starts or ends a session. Prototype: void USBOTGSessionRequest(unsigned long ulBase, tBoolean bStart) Parameters: ulBase species the USB module base address. bStart species if this call starts or ends a session.

308

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function is used in OTG mode to start a session request or end a session. If the bStart parameter is set to true, then this function start a session and if it is false it will end a session. Returns: None.

22.4

Programming Example
This example code makes the calls necessary to congure end point 1, in device mode, as a bulk IN end point. The rst call congures end point 1 to have a maximum packet size of 64 bytes and makes it a bulk IN end point. The call to USBFIFOCong() sets the starting address to 64 bytes in and 64 bytes long. It species USB_EP_DEV_IN to indicate that this is a device mode IN endpoint. The next two calls demonstrate how to ll the data FIFO for this endpoint and then have it scheduled for transmission on the USB bus. The USBEndpointDataPut() call puts data into the FIFO but does not actually start the data transmission. The USBEndpointDataSend() call will schedule the transmission to go out the next time the host controller requests data on this endpoint.
// // Configure Endpoint 1. // USBDevEndpointConfig(USB0_BASE, USB_EP_1, 64, DISABLE_NAK_LIMIT, USB_EP_MODE_BULK | USB_EP_DEV_IN); // // Configure FIFO as a device IN endpoint FIFO starting at address 64 // and is 64 bytes in size. // USBFIFOConfig(USB0_BASE, USB_EP_1, 64, USB_FIFO_SZ_64, USB_EP_DEV_IN); ... // // Put the data in the FIFO. // USBEndpointDataPut(USB0_BASE, USB_EP_1, pucData, 64); // // Start the transmission of data. // USBEndpointDataSend(USB0_BASE, USB_EP_1, USB_TRANS_IN);

October 30, 2008

309

USB Controller

310

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

23

Watchdog Timer
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .319

23.1

Introduction
The Watchdog Timer API provides a set of functions for using the Stellaris watchdog timer modules. Functions are provided to deal with the watchdog timer interrupts, and to handle status and conguration of the watchdog timer. The watchdog timer modules function is to prevent system hangs. The watchdog timer module consists of a 32-bit down counter, a programmable load register, interrupt generation logic, and a locking register. Once the watchdog timer has been congured, the lock register can be written to prevent the timer conguration from being inadvertently altered. The watchdog timer can be congured to generate an interrupt to the processor upon its rst timeout, and to generate a reset signal upon its second timeout. The watchdog timer module generates the rst timeout signal when the 32-bit counter reaches the zero state after being enabled; enabling the counter also enables the watchdog timer interrupt. After the rst timeout event, the 32-bit counter is reloaded with the value of the watchdog timer load register, and the timer resumes counting down from that value. If the timer counts down to its zero state again before the rst timeout interrupt is cleared, and the reset signal has been enabled, the watchdog timer asserts its reset signal to the system. If the interrupt is cleared before the 32-bit counter reaches its second timeout, the 32-bit counter is loaded with the value in the load register, and counting resumes from that value. If the load register is written with a new value while the watchdog timer counter is counting, then the counter is loaded with the new value and continues counting. This driver is contained in driverlib/watchdog.c, with driverlib/watchdog.h containing the API denitions for use by applications.

23.2

API Functions
Functions
void WatchdogEnable (unsigned long ulBase) void WatchdogIntClear (unsigned long ulBase) void WatchdogIntEnable (unsigned long ulBase) void WatchdogIntRegister (unsigned long ulBase, void (pfnHandler)(void)) unsigned long WatchdogIntStatus (unsigned long ulBase, tBoolean bMasked) void WatchdogIntUnregister (unsigned long ulBase) void WatchdogLock (unsigned long ulBase) tBoolean WatchdogLockState (unsigned long ulBase) unsigned long WatchdogReloadGet (unsigned long ulBase) void WatchdogReloadSet (unsigned long ulBase, unsigned long ulLoadVal) void WatchdogResetDisable (unsigned long ulBase)

October 30, 2008

311

Watchdog Timer

void WatchdogResetEnable (unsigned long ulBase) tBoolean WatchdogRunning (unsigned long ulBase) void WatchdogStallDisable (unsigned long ulBase) void WatchdogStallEnable (unsigned long ulBase) void WatchdogUnlock (unsigned long ulBase) unsigned long WatchdogValueGet (unsigned long ulBase)

23.2.1 Detailed Description

The Watchdog Timer API is broken into two groups of functions: those that deal with interrupts, and those that handle status and conguration. The Watchdog Timer interrupts are handled by the WatchdogIntRegister(), WatchdogIntUnregister(), WatchdogIntEnable(), WatchdogIntClear(), and WatchdogIntStatus() functions. Status and conguration functions for the Watchdog Timer module are WatchdogEnable(), WatchdogRunning(), WatchdogLock(), WatchdogUnlock(), WatchdogLockState(), WatchdogReloadSet(), WatchdogReloadGet(), WatchdogValueGet(), WatchdogResetEnable(), WatchdogResetDisable(), WatchdogStallEnable(), and WatchdogStallDisable().

23.2.2 Function Documentation

23.2.2.1 WatchdogEnable
Enables the watchdog timer. Prototype: void WatchdogEnable(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: This will enable the watchdog timer counter and interrupt. Note: This function will have no effect if the watchdog timer has been locked. See also: WatchdogLock(), WatchdogUnlock() Returns: None.

23.2.2.2 WatchdogIntClear
Clears the watchdog timer interrupt.

312

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void WatchdogIntClear(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: The watchdog timer interrupt source is cleared, so that it no longer asserts. Note: Since there is a write buffer in the Cortex-M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted). Returns: None.

23.2.2.3 WatchdogIntEnable
Enables the watchdog timer interrupt. Prototype: void WatchdogIntEnable(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: Enables the watchdog timer interrupt. Note: This function will have no effect if the watchdog timer has been locked. See also: WatchdogLock(), WatchdogUnlock(), WatchdogEnable() Returns: None.

23.2.2.4 WatchdogIntRegister
Registers an interrupt handler for watchdog timer interrupt. Prototype: void WatchdogIntRegister(unsigned long ulBase, void (*pfnHandler)(void))

October 30, 2008

313

Watchdog Timer

Parameters: ulBase is the base address of the watchdog timer module. pfnHandler is a pointer to the function to be called when the watchdog timer interrupt occurs. Description: This function does the actual registering of the interrupt handler. This will enable the global interrupt in the interrupt controller; the watchdog timer interrupt must be enabled via WatchdogEnable(). It is the interrupt handlers responsibility to clear the interrupt source via WatchdogIntClear(). See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

23.2.2.5 WatchdogIntStatus
Gets the current watchdog timer interrupt status. Prototype: unsigned long WatchdogIntStatus(unsigned long ulBase, tBoolean bMasked) Parameters: ulBase is the base address of the watchdog timer module. bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required. Description: This returns the interrupt status for the watchdog timer module. Either the raw interrupt status or the status of interrupt that is allowed to reect to the processor can be returned. Returns: Returns the current interrupt status, where a 1 indicates that the watchdog interrupt is active, and a 0 indicates that it is not active.

23.2.2.6 WatchdogIntUnregister
Unregisters an interrupt handler for the watchdog timer interrupt. Prototype: void WatchdogIntUnregister(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module.

314

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Description: This function does the actual unregistering of the interrupt handler. This function will clear the handler to be called when a watchdog timer interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called. See also: IntRegister() for important information about registering interrupt handlers. Returns: None.

23.2.2.7 WatchdogLock
Enables the watchdog timer lock mechanism. Prototype: void WatchdogLock(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: Locks out write access to the watchdog timer conguration registers. Returns: None.

23.2.2.8 WatchdogLockState
Gets the state of the watchdog timer lock mechanism. Prototype: tBoolean WatchdogLockState(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: Returns the lock state of the watchdog timer registers. Returns: Returns true if the watchdog timer registers are locked, and false if they are not locked.

23.2.2.9 WatchdogReloadGet
Gets the watchdog timer reload value.

October 30, 2008

315

Watchdog Timer

Prototype: unsigned long WatchdogReloadGet(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: This function gets the value that is loaded into the watchdog timer when the count reaches zero for the rst time. See also: WatchdogReloadSet() Returns: None.

23.2.2.10 WatchdogReloadSet
Sets the watchdog timer reload value. Prototype: void WatchdogReloadSet(unsigned long ulBase, unsigned long ulLoadVal) Parameters: ulBase is the base address of the watchdog timer module. ulLoadVal is the load value for the watchdog timer. Description: This function sets the value to load into the watchdog timer when the count reaches zero for the rst time; if the watchdog timer is running when this function is called, then the value will be immediately loaded into the watchdog timer counter. If the ulLoadVal parameter is 0, then an interrupt is immediately generated. Note: This function will have no effect if the watchdog timer has been locked. See also: WatchdogLock(), WatchdogUnlock(), WatchdogReloadGet() Returns: None.

23.2.2.11 WatchdogResetDisable
Disables the watchdog timer reset. Prototype: void WatchdogResetDisable(unsigned long ulBase)

316

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Parameters: ulBase is the base address of the watchdog timer module. Description: Disables the capability of the watchdog timer to issue a reset to the processor upon a second timeout condition. Note: This function will have no effect if the watchdog timer has been locked. See also: WatchdogLock(), WatchdogUnlock() Returns: None.

23.2.2.12 WatchdogResetEnable
Enables the watchdog timer reset. Prototype: void WatchdogResetEnable(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: Enables the capability of the watchdog timer to issue a reset to the processor upon a second timeout condition. Note: This function will have no effect if the watchdog timer has been locked. See also: WatchdogLock(), WatchdogUnlock() Returns: None.

23.2.2.13 WatchdogRunning
Determines if the watchdog timer is enabled. Prototype: tBoolean WatchdogRunning(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module.

October 30, 2008

317

Watchdog Timer

Description: This will check to see if the watchdog timer is enabled. Returns: Returns true if the watchdog timer is enabled, and false if it is not.

23.2.2.14 WatchdogStallDisable
Disables stalling of the watchdog timer during debug events. Prototype: void WatchdogStallDisable(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: This function disables the debug mode stall of the watchdog timer. By doing so, the watchdog timer continues to count regardless of the processor debug state. Returns: None.

23.2.2.15 WatchdogStallEnable
Enables stalling of the watchdog timer during debug events. Prototype: void WatchdogStallEnable(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: This function allows the watchdog timer to stop counting when the processor is stopped by the debugger. By doing so, the watchdog is prevented from expiring (typically almost immediately from a human time perspective) and resetting the system (if reset is enabled). The watchdog will instead expired after the appropriate number of processor cycles have been executed while debugging (or at the appropriate time after the processor has been restarted). Returns: None.

23.2.2.16 WatchdogUnlock
Disables the watchdog timer lock mechanism.

318

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

Prototype: void WatchdogUnlock(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: Enables write access to the watchdog timer conguration registers. Returns: None.

23.2.2.17 WatchdogValueGet
Gets the current watchdog timer value. Prototype: unsigned long WatchdogValueGet(unsigned long ulBase) Parameters: ulBase is the base address of the watchdog timer module. Description: This function reads the current value of the watchdog timer. Returns: Returns the current value of the watchdog timer.

23.3

Programming Example
The following example shows how to set up the watchdog timer API to reset the processor after two timeouts.
// // Check to see if the registers are locked, and if so, unlock them. // if(WatchdogLockState(WATCHDOG_BASE) == true) { WatchdogUnlock(WATCHDOG_BASE); } // // Initialize the watchdog timer. // WatchdogReloadSet(WATCHDOG_BASE, 0xFEEFEE); // // Enable the reset. // WatchdogResetEnable(WATCHDOG_BASE); //

October 30, 2008

319

Watchdog Timer

// Enable the watchdog timer. // WatchdogEnable(WATCHDOG_BASE); // // Wait for the reset to occur. // while(1) { }

320

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

24

Using the ROM

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321 Direct ROM Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321 Mapped ROM Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322 Firmware Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

24.1

Introduction
Stellaris DustDevil-class devices have portions of the peripheral driver library stored in an on-chip ROM. By utilizing the code in the on-chip ROM, more ash is available for use by the application. The boot loader is also contained within the ROM, which can be called by an application in order to start a rmware update.

24.2

Direct ROM Calls

In order to call the ROM, the following steps must be performed: The device on which the application will be run must be dened. This is done by dening a preprocessor symbol, which can be done either within the source code or in the project that builds the application. The later is more exible if code is shared between projects. driverlib/rom.h is included by the source code desiring to call the ROM. The ROM version of a peripheral driver library function is called. For example, if GPIODirModeSet() is to be called in the ROM, ROM_GPIODirModeSet() is used instead. A dene is used to to select the device being used since the set of functions available in the ROM must be a compile-time decision; checking at run-time does not provide any ash savings since both the ROM call and the ash version of the API would be in the application ash image. The following dene is recognized by driverlib/rom.h: TARGET_IS_DUSTDEVIL_RA0 The application is being built to run on a DustDevil-class device, silicon revision A0. By using ROM_Function(), the ROM will be explicitly called. If the function in question is not available in the ROM, a compiler error will be produced. See the Stellaris ROM Users Guide for details of the APIs available in the ROM. The following is an example of calling a function in the ROM, dening the device in question using a #define in the source instead of in the project le:
#define TARGET_IS_DUSTDEVIL_RA0 #include "../driverlib/rom.h" #include "../driverlib/systick.h" int

October 30, 2008

321

Using the ROM

main(void) { ROM_SysTickPeriodSet(0x1000); ROM_SysTickEnable(); // ... }

24.3

Mapped ROM Calls

When code is intended to be shared between projects, and some of the projects run on devices with a ROM and some run on devices without a ROM, it is convenient to have the code automatically call the ROM or the ash version of the API without having #ifdef-s in the code. rom_map.h provides an automatic mapping feature for accessing the ROM. Similar to the ROM_Function() APIs provided by rom.h, a set of MAP_Function() APIs are provided. If the function is available in ROM, MAP_Function() will simply call ROM_Function(); otherwise it will call Function(). In order to use the mapped ROM calls, the following steps must be performed: Follow the above steps for including and using driverlib/rom.h. Include driverlib/rom_map.h. Continuing the above example, call MAP_GPIODirModeSet() in the source code. As in the direct ROM call method, the choice of calling ROM versus the ash version is made at compile-time. The only APIs that are provided via the ROM mapping feature are ones that are available in the ROM, which is not every API available in the peripheral driver library. The following is an example of calling a function in shared code, where the device in question is dened in the project le:
#include "../driverlib/rom.h" #include "../driverlib/rom_map.h" #include "../driverlib/systick.h" void SetupSysTick(void) { MAP_SysTickPeriodSet(0x1000); Map_SysTickEnable(); }

When built for a device that does not have a ROM, this is equivalent to:
#include "../driverlib/systick.h" void SetupSysTick(void) { SysTickPeriodSet(0x1000); SysTickEnable(); }

When built for a device that has a ROM, however, this is equivalent to:

322

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

#include "../driverlib/rom.h" #include "../driverlib/systick.h" void SetupSysTick(void) { ROM_SysTickPeriodSet(0x1000); ROM_SysTickEnable(); }

24.4

Firmware Update
Functions
void ROM_UpdateI2C (void) void ROM_UpdateSSI (void) void ROM_UpdateUART (void)

24.4.1 Detailed Description

There are a set of APIs in the ROM for restarting the boot loader in order to commence a rmware update. Multiple calls are provided since each selects a particular interface to be used for the update process, bypassing the interface selection step of the normal boot loader (including the auto-bauding in the UART interface). See the Stellaris ROM Users Guide for details of the rmware update APIs in the ROM.

24.4.2 Function Documentation

24.4.2.1 ROM_UpdateI2C
Starts an update over the I2C0 interface. Prototype: void ROM_UpdateI2C(void) Description: Calling this function commences an update of the rmware via the I2C0 interface. This function assumes that the I2C0 interface has already been congured and is currently operational. The I2C0 slave is used for data transfer, and the I2C0 master is used to monitor bus busy conditions (therefore, both must be enabled). Returns: Never returns.

October 30, 2008

323

Using the ROM

24.4.2.2 ROM_UpdateSSI
Starts an update over the SSI0 interface. Prototype: void ROM_UpdateSSI(void) Description: Calling this function commences an update of the rmware via the SSI0 interface. This function assumes that the SSI0 interface has already been congured and is currently operational. Returns: Never returns.

24.4.2.3 ROM_UpdateUART
Starts an update over the UART0 interface. Prototype: void ROM_UpdateUART(void) Description: Calling this function commences an update of the rmware via the UART0 interface. This function assumes that the UART0 interface has already been congured and is currently operational. Returns: Never returns.

324

October 30, 2008

Stellaris Peripheral Driver Library Users Guide

25

Error Handling
Invalid arguments and error conditions are handled in a non-traditional manner in the peripheral driver library. Typically, a function would check its arguments to make sure that they are valid (if required; some may be unconditionally valid such as a 32-bit value used as the load value for a 32-bit timer). If an invalid argument is provided, it would return an error code. The caller then has to check the return code from each invocation of the function to make sure that it succeeded. This results in a sizable amount of argument checking code in each function and return code checking code at each call site. For a self-contained application, this extra code becomes an unneeded burden once the application is debugged. Having a means of removing it allows the nal code to be smaller and therefore run faster. In the peripheral driver library, most functions do not return errors (FlashProgram(), FlashErase(), FlashProtectSet(), and FlashProtectSave() are the notable exceptions). Argument checking is done via a call to the ASSERT macro (provided in driverlib/debug.h). This macro has the usual denition of an assert macro; it takes an expression that must be true. By making this macro be empty, the argument checking is removed from the code. There are two denitions of the ASSERT macro provided in driverlib/debug.h; one that is empty (used for normal situations) and one that evaluates the expression (used when the library is built with debugging). The debug version will call the __error__ function whenever the expression is not true, passing the le name and line number of the ASSERT macro invocation. The __error__ function is prototyped in driverlib/debug.h and must be provided by the application since it is the applications responsibility to deal with error conditions. By setting a breakpoint on the __error__ function, the debugger will immediately stop whenever an error occurs anywhere in the application (something that would be very difcult to do with other error checking methods). When the debugger stops, the arguments to the __error__ function and the backtrace of the stack will pinpoint the function that found an error, what it found to be a problem, and where it was called from. As an example:
void UARTParityModeSet(unsigned long ulBase, unsigned long ulParity) { // // Check the arguments. // ASSERT((ulBase == UART0_BASE) || (ulBase == UART1_BASE) || (ulBase == UART2_BASE)); ASSERT((ulParity == UART_CONFIG_PAR_NONE) || (ulParity == UART_CONFIG_PAR_EVEN) || (ulParity == UART_CONFIG_PAR_ODD) || (ulParity == UART_CONFIG_PAR_ONE) || (ulParity == UART_CONFIG_PAR_ZERO));

Each argument is individually checked, so the line number of the failing ASSERT will indicate the argument that is invalid. The debugger will be able to display the values of the arguments (from the stack backtrace) as well as the caller of the function that had the argument error. This allows the problem to be quickly identied at the cost of a small amount of code.

October 30, 2008

325

Company Information
Founded in 2004, Luminary Micro, Inc. designs, markets, and sells ARM Cortex-M3-based microcontrollers (MCUs). Austin, Texas-based Luminary Micro is the lead partner for the Cortex-M3 processor, delivering the worlds rst silicon implementation of the Cortex-M3 processor. Luminary Micros introduction of the Stellaris family of products provides 32-bit performance for the same price as current 8- and 16-bit microcontroller designs. With entry-level pricing at $1.00 for an ARM technology-based MCU, Luminary Micros Stellaris product line allows for standardization that eliminates future architectural upgrades or software tool changes. Luminary Micro, Inc. 108 Wild Basin, Suite 350 Austin, TX 78746 Main: +1-512-279-8800 Fax: +1-512-279-8879 http://www.luminarymicro.com sales@luminarymicro.com

Support Information
For support on Luminary Micro products, contact: support@luminarymicro.com +1-512-279-8800, ext 3

326

October 30, 2008