MSP430 DriverLib For MSP430F5xx_6xx Devices MSP430F5xx 6xx Driver Lib Users Guide 2 91 10 06

User Manual:

Open the PDF directly: View PDF .
Page Count: 631 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Copyright
Revision Information
1 Introduction
2 Navigating to driverlib through CCS Resource Explorer
- 2.1 Introduction
3 How to create a new CCS project that uses Driverlib
- 3.1 Introduction
4 How to include driverlib into your existing CCS project
- 4.1 Introduction
5 How to create a new IAR project that uses Driverlib
- 5.1 Introduction
6 How to include driverlib into your existing IAR project
- 6.1 Introduction
7 10-Bit Analog-to-Digital Converter (ADC10_A)
- 7.1 Introduction
- 7.2 API Functions
- 7.3 Programming Example
8 12-Bit Analog-to-Digital Converter (ADC12_A)
- 8.1 Introduction
- 8.2 API Functions
- 8.3 Programming Example
9 Advanced Encryption Standard (AES)
- 9.1 Introduction
- 9.2 API Functions
- 9.3 Programming Example
10 Battery Backup System
- 10.1 Introduction
- 10.2 API Functions
11 Comparator (COMP_B)
- 11.1 Introduction
- 11.2 API Functions
- 11.3 Programming Example
12 Cyclical Redundancy Check (CRC)
- 12.1 Introduction
- 12.2 API Functions
- 12.3 Programming Example
13 16-Bit Sigma Delta Converter (CTSD16)
- 13.1 Introduction
- 13.2 API Functions
- 13.3 Programming Example
14 12-bit Digital-to-Analog Converter (DAC12_A)
- 14.1 Introduction
- 14.2 API Functions
- 14.3 Programming Example
15 Direct Memory Access (DMA)
- 15.1 Introduction
- 15.2 API Functions
- 15.3 Programming Example
16 EUSCI Universal Asynchronous Receiver/Transmitter (EUSCI_A_UART)
- 16.1 Introduction
- 16.2 API Functions
- 16.3 Programming Example
17 EUSCI Synchronous Peripheral Interface (EUSCI_A_SPI)
- 17.1 Introduction
- 17.2 Functions
- 17.3 Programming Example
18 EUSCI Synchronous Peripheral Interface (EUSCI_B_SPI)
- 18.1 Introduction
- 18.2 Functions
- 18.3 Programming Example
19 EUSCI Inter-Integrated Circuit (EUSCI_B_I2C)
- 19.1 Introduction
- 19.2 Master Operations
- 19.3 Slave Operations
- 19.4 API Functions
- 19.5 Programming Example
20 FlashCtl - Flash Memory Controller
- 20.1 Introduction
- 20.2 API Functions
- 20.3 Programming Example
21 GPIO
- 21.1 Introduction
- 21.2 API Functions
- 21.3 Programming Example
22 LCDB Controller
- 22.1 Introduction
- 22.2 API Functions
- 22.3 Programming Example
23 LDO-PWR
- 23.1 Introduction
- 23.2 API Functions
- 23.3 Programming Example
24 32-Bit Hardware Multiplier (MPY32)
- 24.1 Introduction
- 24.2 API Functions
- 24.3 Programming Example
25 Operational Amplifier (OA)
- 25.1 Introduction
- 25.2 API Functions
- 25.3 Programming Example
26 Port Mapping Controller
- 26.1 Introduction
- 26.2 API Functions
- 26.3 Programming Example
27 Power Management Module (PMM)
- 27.1 Introduction
- 27.2 API Functions
- 27.3 Programming Example
28 RAM Controller
- 28.1 Introduction
- 28.2 API Functions
- 28.3 Programming Example
29 Internal Reference (REF)
- 29.1 Introduction
- 29.2 API Functions
- 29.3 Programming Example
30 Real-Time Clock (RTC_A)
- 30.1 Introduction
- 30.2 API Functions
- 30.3 Programming Example
31 Real-Time Clock (RTC_B)
- 31.1 Introduction
- 31.2 API Functions
- 31.3 Programming Example
32 Real-Time Clock (RTC_C)
- 32.1 Introduction
- 32.2 API Functions
- 32.3 Programming Example
33 24-Bit Sigma Delta Converter (SD24_B)
- 33.1 Introduction
- 33.2 API Functions
- 33.3 Programming Example
34 SFR Module
- 34.1 Introduction
- 34.2 API Functions
- 34.3 Programming Example
35 System Control Module
- 35.1 Introduction
- 35.2 API Functions
- 35.3 Programming Example
36 Timer Event Control (TEC)
- 36.1 Introduction
- 36.2 API Functions
- 36.3 Programming Example
37 16-Bit Timer_A (TIMER_A)
- 37.1 Introduction
- 37.2 API Functions
- 37.3 Programming Example
38 16-Bit Timer_B (TIMER_B)
- 38.1 Introduction
- 38.2 API Functions
- 38.3 Programming Example
39 TIMER_D
- 39.1 Introduction
- 39.2 API Functions
- 39.3 Programming Example
40 Tag Length Value
- 40.1 Introduction
- 40.2 API Functions
- 40.3 Programming Example
41 Unified Clock System (UCS)
- 41.1 Introduction
- 41.2 API Functions
- 41.3 Programming Example
42 USCI Universal Asynchronous Receiver/Transmitter (USCI_A_UART)
- 42.1 Introduction
- 42.2 API Functions
- 42.3 Programming Example
43 USCI Synchronous Peripheral Interface (USCI_A_SPI)
- 43.1 Introduction
- 43.2 API Functions
- 43.3 Programming Example
44 USCI Synchronous Peripheral Interface (USCI_B_SPI)
- 44.1 Introduction
- 44.2 API Functions
- 44.3 Programming Example
45 USCI Inter-Integrated Circuit (USCI_B_I2C)
- 45.1 Introduction
- 45.2 Master Operations
- 45.3 Slave Operations
- 45.4 API Functions
- 45.5 Programming Example
46 WatchDog Timer (WDT_A)
- 46.1 Introduction
- 46.2 API Functions
- 46.3 Programming Example
47 Data Structure Documentation
- 47.1 Data Structures
- 47.2 Timer_D_initCompareModeParam Struct Reference
- 47.3 Timer_B_initContinuousModeParam Struct Reference
- 47.4 Timer_D_outputPWMParam Struct Reference
- 47.5 SD24_B_initParam Struct Reference
- 47.6 USCI_B_SPI_changeMasterClockParam Struct Reference
- 47.7 Timer_A_initUpModeParam Struct Reference
- 47.8 USCI_B_I2C_initMasterParam Struct Reference
- 47.9 EUSCI_B_SPI_initSlaveParam Struct Reference
- 47.10 Timer_A_initCompareModeParam Struct Reference
- 47.11 EUSCI_B_SPI_changeMasterClockParam Struct Reference
- 47.12 Timer_B_initUpDownModeParam Struct Reference
- 47.13 Timer_D_initUpModeParam Struct Reference
- 47.14 Timer_A_initContinuousModeParam Struct Reference
- 47.15 EUSCI_B_I2C_initSlaveParam Struct Reference
- 47.16 Comp_B_configureReferenceVoltageParam Struct Reference
- 47.17 Timer_A_initCaptureModeParam Struct Reference
- 47.18 USCI_A_UART_initParam Struct Reference
- 47.19 RTC_C_configureCalendarAlarmParam Struct Reference
- 47.20 USCI_A_SPI_initMasterParam Struct Reference
- 47.21 USCI_B_SPI_initMasterParam Struct Reference
- 47.22 TEC_initExternalFaultInputParam Struct Reference
- 47.23 USCI_A_SPI_changeMasterClockParam Struct Reference
- 47.24 SD24_B_initConverterParam Struct Reference
- 47.25 EUSCI_A_UART_initParam Struct Reference
- 47.26 Timer_B_outputPWMParam Struct Reference
- 47.27 EUSCI_B_I2C_initMasterParam Struct Reference
- 47.28 EUSCI_A_SPI_changeMasterClockParam Struct Reference
- 47.29 Timer_B_initUpModeParam Struct Reference
- 47.30 Timer_B_initCompareModeParam Struct Reference
- 47.31 EUSCI_A_SPI_initMasterParam Struct Reference
- 47.32 DAC12_A_initParam Struct Reference
- 47.33 Timer_D_initCaptureModeParam Struct Reference
- 47.34 Timer_B_initCaptureModeParam Struct Reference
- 47.35 EUSCI_B_SPI_initMasterParam Struct Reference
- 47.36 SD24_B_initConverterAdvancedParam Struct Reference
- 47.37 Timer_D_combineTDCCRToOutputPWMParam Struct Reference
- 47.38 Timer_D_initContinuousModeParam Struct Reference
- 47.39 DMA_initParam Struct Reference
- 47.40 ADC12_A_configureMemoryParam Struct Reference
- 47.41 Timer_D_initHighResGeneratorInRegulatedModeParam Struct Reference
- 47.42 Calendar Struct Reference
- 47.43 Timer_A_initUpDownModeParam Struct Reference
- 47.44 Comp_B_initParam Struct Reference
- 47.45 RTC_A_configureCalendarAlarmParam Struct Reference
- 47.46 EUSCI_A_SPI_initSlaveParam Struct Reference
- 47.47 Timer_D_initUpDownModeParam Struct Reference
- 47.48 PMAP_initPortsParam Struct Reference
- 47.49 RTC_B_configureCalendarAlarmParam Struct Reference
- 47.50 Timer_A_outputPWMParam Struct Reference
IMPORTANT NOTICE

User’s Guide

MSP430 DriverLib for MSP430F5xx 6xx Devices

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.

Please be aware that an important notice concerning availability, standard warranty, and use in critical applications of Texas Instruments semi-

conductor products and disclaimers thereto appears at the end of this document.

Texas Instruments

13532 N. Central Expressway MS3810

Dallas, TX 75243

www.ti.com/

Revision Information

This is version 2.91.10.06 of this document, last updated on Wed Jan 23 2019 17:54:26.

Table of Contents 2

Table of Contents

Revision Information ............................................... 1

1 Introduction ................................................. 7

2 Navigating to driverlib through CCS Resource Explorer ....................... 9

2.1 Introduction .................................................. 9

3 How to create a new CCS project that uses Driverlib ......................... 21

3.1 Introduction .................................................. 21

4 How to include driverlib into your existing CCS project ....................... 23

4.1 Introduction .................................................. 23

5 How to create a new IAR project that uses Driverlib ......................... 25

5.1 Introduction .................................................. 25

6 How to include driverlib into your existing IAR project ........................ 28

6.1 Introduction .................................................. 28

7 10-Bit Analog-to-Digital Converter (ADC10 A) ............................. 31

7.1 Introduction .................................................. 31

7.2 API Functions ................................................ 31

7.3 Programming Example ........................................... 49

8 12-Bit Analog-to-Digital Converter (ADC12 A) ............................. 51

8.1 Introduction .................................................. 51

8.2 API Functions ................................................ 51

8.3 Programming Example ........................................... 70

9 Advanced Encryption Standard (AES) ................................. 72

9.1 Introduction .................................................. 72

9.2 API Functions ................................................ 72

9.3 Programming Example ........................................... 82

10 Battery Backup System .......................................... 83

10.1 Introduction .................................................. 83

10.2 API Functions ................................................ 83

11 Comparator (COMP B) ........................................... 84

11.1 Introduction .................................................. 84

11.2 API Functions ................................................ 84

11.3 Programming Example ........................................... 95

12 Cyclical Redundancy Check (CRC) ................................... 97

12.1 Introduction .................................................. 97

12.2 API Functions ................................................ 97

12.3 Programming Example ........................................... 101

13 16-Bit Sigma Delta Converter (CTSD16) ................................ 102

13.1 Introduction .................................................. 102

13.2 API Functions ................................................ 102

13.3 Programming Example ........................................... 103

14 12-bit Digital-to-Analog Converter (DAC12 A) ............................. 104

14.1 Introduction .................................................. 104

14.2 API Functions ................................................ 104

14.3 Programming Example ........................................... 116

Table of Contents 3

15 Direct Memory Access (DMA) ...................................... 117

15.1 Introduction .................................................. 117

15.2 API Functions ................................................ 117

15.3 Programming Example ........................................... 130

16 EUSCI Universal Asynchronous Receiver/Transmitter (EUSCI A UART) ............. 131

16.1 Introduction .................................................. 131

16.2 API Functions ................................................ 131

16.3 Programming Example ........................................... 142

17 EUSCI Synchronous Peripheral Interface (EUSCI A SPI) ...................... 143

17.1 Introduction .................................................. 143

17.2 Functions ................................................... 143

17.3 Programming Example ........................................... 152

18 EUSCI Synchronous Peripheral Interface (EUSCI B SPI) ...................... 153

18.1 Introduction .................................................. 153

18.2 Functions ................................................... 153

18.3 Programming Example ........................................... 162

19 EUSCI Inter-Integrated Circuit (EUSCI B I2C) ............................. 163

19.1 Introduction .................................................. 163

19.2 Master Operations .............................................. 163

19.3 Slave Operations .............................................. 164

19.4 API Functions ................................................ 165

19.5 Programming Example ........................................... 186

20 FlashCtl - Flash Memory Controller ................................... 187

20.1 Introduction .................................................. 187

20.2 API Functions ................................................ 187

20.3 Programming Example ........................................... 193

21 GPIO ..................................................... 194

21.1 Introduction .................................................. 194

21.2 API Functions ................................................ 195

21.3 Programming Example ........................................... 228

22 LCDBController ............................................... 230

22.1 Introduction .................................................. 230

22.2 API Functions ................................................ 230

22.3 Programming Example ........................................... 231

23 LDO-PWR .................................................. 232

23.1 Introduction .................................................. 232

23.2 API Functions ................................................ 232

23.3 Programming Example ........................................... 243

24 32-Bit Hardware Multiplier (MPY32) ................................... 245

24.1 Introduction .................................................. 245

24.2 API Functions ................................................ 245

24.3 Programming Example ........................................... 254

25 Operational Ampliﬁer (OA) ........................................ 255

25.1 Introduction .................................................. 255

25.2 API Functions ................................................ 255

25.3 Programming Example ........................................... 256

26 Port Mapping Controller .......................................... 257

26.1 Introduction .................................................. 257

26.2 API Functions ................................................ 257

Table of Contents 4

26.3 Programming Example ........................................... 258

27 Power Management Module (PMM) ................................... 259

27.1 Introduction .................................................. 259

27.2 API Functions ................................................ 261

27.3 Programming Example ........................................... 273

28 RAM Controller ............................................... 275

28.1 Introduction .................................................. 275

28.2 API Functions ................................................ 275

28.3 Programming Example ........................................... 277

29 Internal Reference (REF) ......................................... 279

29.1 Introduction .................................................. 279

29.2 API Functions ................................................ 279

29.3 Programming Example ........................................... 285

30 Real-Time Clock (RTC A) ......................................... 287

30.1 Introduction .................................................. 287

30.2 API Functions ................................................ 287

30.3 Programming Example ........................................... 302

31 Real-Time Clock (RTC B) ......................................... 304

31.1 Introduction .................................................. 304

31.2 API Functions ................................................ 304

31.3 Programming Example ........................................... 316

32 Real-Time Clock (RTC C) ......................................... 317

32.1 Introduction .................................................. 317

32.2 API Functions ................................................ 317

32.3 Programming Example ........................................... 334

33 24-Bit Sigma Delta Converter (SD24 B) ................................. 336

33.1 Introduction .................................................. 336

33.2 API Functions ................................................ 336

33.3 Programming Example ........................................... 352

34 SFR Module ................................................. 353

34.1 Introduction .................................................. 353

34.2 API Functions ................................................ 353

34.3 Programming Example ........................................... 359

35 System Control Module .......................................... 360

35.1 Introduction .................................................. 360

35.2 API Functions ................................................ 360

35.3 Programming Example ........................................... 368

36 Timer Event Control (TEC) ........................................ 369

36.1 Introduction .................................................. 369

36.2 API Functions ................................................ 369

36.3 Programming Example ........................................... 379

37 16-Bit Timer A (TIMER A) ......................................... 380

37.1 Introduction .................................................. 380

37.2 API Functions ................................................ 381

37.3 Programming Example ........................................... 396

38 16-Bit Timer B (TIMER B) ......................................... 398

38.1 Introduction .................................................. 398

38.2 API Functions ................................................ 399

Table of Contents 5

38.3 Programming Example ........................................... 417

39 TIMER D ................................................... 418

39.1 Introduction .................................................. 418

39.2 API Functions ................................................ 419

39.3 Programming Example ........................................... 446

40 Tag Length Value .............................................. 448

40.1 Introduction .................................................. 448

40.2 API Functions ................................................ 448

40.3 Programming Example ........................................... 455

41 Uniﬁed Clock System (UCS) ....................................... 456

41.1 Introduction .................................................. 456

41.2 API Functions ................................................ 457

41.3 Programming Example ........................................... 473

42 USCI Universal Asynchronous Receiver/Transmitter (USCI A UART) ............... 474

42.1 Introduction .................................................. 474

42.2 API Functions ................................................ 474

42.3 Programming Example ........................................... 484

43 USCI Synchronous Peripheral Interface (USCI A SPI) ........................ 486

43.1 Introduction .................................................. 486

43.2 API Functions ................................................ 486

43.3 Programming Example ........................................... 495

44 USCI Synchronous Peripheral Interface (USCI B SPI) ........................ 497

44.1 Introduction .................................................. 497

44.2 API Functions ................................................ 497

44.3 Programming Example ........................................... 506

45 USCI Inter-Integrated Circuit (USCI B I2C) ............................... 508

45.1 Introduction .................................................. 508

45.2 Master Operations .............................................. 508

45.3 Slave Operations .............................................. 509

45.4 API Functions ................................................ 510

45.5 Programming Example ........................................... 529

46 WatchDog Timer (WDT A) ......................................... 531

46.1 Introduction .................................................. 531

46.2 API Functions ................................................ 531

46.3 Programming Example ........................................... 535

47 Data Structure Documentation ...................................... 536

47.1 Data Structures ............................................... 536

47.2 Timer D initCompareModeParam Struct Reference ........................... 538

47.3 Timer B initContinuousModeParam Struct Reference .......................... 539

47.4 Timer D outputPWMParam Struct Reference ............................... 541

47.5 SD24 B initParam Struct Reference .................................... 544

47.6 USCI B SPI changeMasterClockParam Struct Reference ........................ 546

47.7 Timer A initUpModeParam Struct Reference ............................... 547

47.8 USCI B I2C initMasterParam Struct Reference .............................. 549

47.9 EUSCI B SPI initSlaveParam Struct Reference .............................. 550

47.10Timer A initCompareModeParam Struct Reference ........................... 552

47.11EUSCI B SPI changeMasterClockParam Struct Reference ....................... 553

47.12Timer B initUpDownModeParam Struct Reference ............................ 554

47.13Timer D initUpModeParam Struct Reference ............................... 556

Table of Contents 6

47.14Timer A initContinuousModeParam Struct Reference .......................... 559

47.15EUSCI B I2C initSlaveParam Struct Reference .............................. 561

47.16Comp B conﬁgureReferenceVoltageParam Struct Reference ...................... 562

47.17Timer A initCaptureModeParam Struct Reference ............................ 563

47.18USCI A UART initParam Struct Reference ................................ 565

47.19RTC C conﬁgureCalendarAlarmParam Struct Reference ........................ 568

47.20USCI A SPI initMasterParam Struct Reference .............................. 569

47.21USCI B SPI initMasterParam Struct Reference .............................. 571

47.22TEC initExternalFaultInputParam Struct Reference ............................ 572

47.23USCI A SPI changeMasterClockParam Struct Reference ........................ 574

47.24SD24 B initConverterParam Struct Reference .............................. 574

47.25EUSCI A UART initParam Struct Reference ............................... 576

47.26Timer B outputPWMParam Struct Reference ............................... 579

47.27EUSCI B I2C initMasterParam Struct Reference ............................. 581

47.28EUSCI A SPI changeMasterClockParam Struct Reference ....................... 582

47.29Timer B initUpModeParam Struct Reference ............................... 583

47.30Timer B initCompareModeParam Struct Reference ........................... 585

47.31EUSCI A SPI initMasterParam Struct Reference ............................. 587

47.32DAC12 A initParam Struct Reference ................................... 589

47.33Timer D initCaptureModeParam Struct Reference ............................ 591

47.34Timer B initCaptureModeParam Struct Reference ............................ 594

47.35EUSCI B SPI initMasterParam Struct Reference ............................. 596

47.36SD24 B initConverterAdvancedParam Struct Reference ......................... 598

47.37Timer D combineTDCCRToOutputPWMParam Struct Reference .................... 601

47.38Timer D initContinuousModeParam Struct Reference .......................... 604

47.39DMA initParam Struct Reference ...................................... 606

47.40ADC12 A conﬁgureMemoryParam Struct Reference ........................... 609

47.41Timer D initHighResGeneratorInRegulatedModeParam Struct Reference ............... 612

47.42Calendar Struct Reference ......................................... 614

47.43Timer A initUpDownModeParam Struct Reference ............................ 615

47.44Comp B initParam Struct Reference .................................... 617

47.45RTC A conﬁgureCalendarAlarmParam Struct Reference ........................ 620

47.46EUSCI A SPI initSlaveParam Struct Reference .............................. 621

47.47Timer D initUpDownModeParam Struct Reference ............................ 622

47.48PMAP initPortsParam Struct Reference .................................. 625

47.49RTC B conﬁgureCalendarAlarmParam Struct Reference ........................ 626

47.50Timer A outputPWMParam Struct Reference ............................... 627

IMPORTANT NOTICE ............................................... 630

CHAPTER 1. INTRODUCTION 7

1 Introduction

The Texas Instruments® MSP430® Peripheral Driver Library is a set of drivers for accessing the

peripherals found on the MSP430 5xx/6xx family of 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 device's 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 efﬁcient 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 efﬁcient as they could be (from a code size and/or

execution speed point of view). While the most efﬁcient piece of code for operating a

peripheral would be written in assembly and custom tailored to the speciﬁc requirements of

the application, further size optimizations of the drivers would make them more difﬁcult to

understand.

The drivers do not support the full capabilities of the hardware. Some of the peripherals

provide complex capabilities which cannot 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. Because 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.

Each MSP430ware driverlib API takes in the base address of the corresponding peripheral as the

ﬁrst parameter. This base address is obtained from the msp430 device speciﬁc header ﬁles (or

from the device datasheet). The example code for the various peripherals show how base address

is used. When using CCS, the eclipse shortcut ”Ctrl + Space” helps. Type MSP430 and ”Ctrl +

Space”, and the list of base addresses from the included device speciﬁc header ﬁles is listed.

The following tool chains are supported:

IAR Embedded Workbench®

Texas Instruments Code Composer Studio™

Using assert statements to debug

CHAPTER 1. INTRODUCTION 8

Assert statements are disabled by default. To enable the assert statement edit the hw regaccess.h

ﬁle in the inc folder. Comment out the statement #deﬁne NDEBUG ->//#deﬁne NDEBUG Asserts

in CCS work only if the project is optimized for size.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 9

2 Navigating to driverlib through CCS

Resource Explorer

2.1 Introduction

In CCS, click View->TI Resource Explorer

In Resource Explorer View, click on MSP430ware

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 10

Clicking MSP430ware takes you to the introductory page. The version of the latest MSP430ware

installed is available in this page. In this screenshot the version is 1.30.00.15 The various

software, collateral, code examples, datasheets and user guides can be navigated by clicking the

different topics under MSP430ware. To proceed to driverlib, click on Libraries->Driverlib as shown

in the next two screenshots.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 11

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 12

Driverlib is designed per Family. If a common device family user's guide exists for a group of

devices, these devices belong to the same 'family'. Currently driverlib is available for the following

family of devices. MSP430F5xx 6xx MSP430FR57xx MSP430FR2xx 4xx MSP430FR5xx 6xx

MSP430i2xx

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 13

Click on the MSP430F5xx 6xx to navigate to the driverlib based example code for that family.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 14

The various peripherals are listed in alphabetical order. The names of peripherals are as in device

family user's guide. Clicking on a peripheral name lists the driverlib example code for that

peripheral. The screenshot below shows an example when the user clicks on GPIO peripheral.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 15

Now click on the speciﬁc example you are interested in. On the right side there are options to

Import/Build/Download and Debug. Import the project by clicking on the ”Import the example

project into CCS”

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 16

The imported project can be viewed on the left in the Project Explorer. All required driverlib source

and header ﬁles are included inside the driverlib folder. All driverlib source and header ﬁles are

linked to the example projects. So if the user modiﬁes any of these source or header ﬁles, the

original copy of the installed MSP430ware driverlib source and header ﬁles get modiﬁed.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 17

Now click on Build the imported project on the right to build the example project.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 18

Now click on Build the imported project on the right to build the example project.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 19

The COM port to download to can be changed using the Debugger Conﬁguration option on the

right if required.

To get started on a new project we recommend getting started on an empty project we provide.

This project has all the driverlib source ﬁles, header ﬁles, project paths are set by default.

CHAPTER 2. NAVIGATING TO DRIVERLIB THROUGH CCS RESOURCE EXPLORER 20

The main.c included with the empty project can be modiﬁed to include user code.

CHAPTER 3. HOW TO CREATE A NEW CCS PROJECT THAT USES DRIVERLIB 21

3 How to create a new CCS project that uses

Driverlib

3.1 Introduction

To get started on a new project we recommend using the new project wizard. For driver library to

work with the new project wizard CCS must have discovered the driver library RTSC product. For

more information refer to the installation steps of the release notes. The new project wizard adds

the needed driver library source ﬁles and adds the driver library include path.

To open the new project wizard go to File ->New ->CCS Project as seen in the screenshot below.

Once the new project wizard has been opened name your project and choose the device you

would like to create a Driver Library project for. The device must be supported by driver library.

Then under ”Project templates and examples” choose ”Empty Project with DriverLib Source” as

seen below.

CHAPTER 3. HOW TO CREATE A NEW CCS PROJECT THAT USES DRIVERLIB 22

Finally click ”Finish” and begin developing with your Driver Library enabled project.

We recommend -O4 compiler settings for more efﬁcient optimizations for projects using driverlib

CHAPTER 4. HOW TO INCLUDE DRIVERLIB INTO YOUR EXISTING CCS PROJECT 23

4 How to include driverlib into your existing

CCS project

4.1 Introduction

To add driver library to an existing project we recommend using CCS project templates. For driver

library to work with project templates CCS must have discovered the driver library RTSC product.

For more information refer to the installation steps of the release notes. CCS project templates

adds the needed driver library source ﬁles and adds the driver library include path.

To apply a project template right click on an existing project then go to Source ->Apply Project

Template as seen in the screenshot below.

In the ”Apply Project Template” dialog box under ”MSP430 DriverLib Additions” choose either ”Add

Local Copy” or ”Point to Installed DriverLib” as seen in the screenshot below. Most users will want

to add a local copy which copies the DriverLib source into the project and sets the compiler

settings needed.

Pointing to an installed DriverLib is for advandced users who are including a static library in their

project and want to add the DriverLib header ﬁles to their include path.

CHAPTER 4. HOW TO INCLUDE DRIVERLIB INTO YOUR EXISTING CCS PROJECT 24

Click ”Finish” and start developing with driver library in your project.

CHAPTER 5. HOW TO CREATE A NEW IAR PROJECT THAT USES DRIVERLIB 25

5 How to create a new IAR project that uses

Driverlib

5.1 Introduction

It is recommended to get started with an Empty Driverlib Project. Browse to the empty project in

your device's family. This is available in the driverlib instal folder\00 emptyProject

CHAPTER 5. HOW TO CREATE A NEW IAR PROJECT THAT USES DRIVERLIB 26

CHAPTER 5. HOW TO CREATE A NEW IAR PROJECT THAT USES DRIVERLIB 27

CHAPTER 6. HOW TO INCLUDE DRIVERLIB INTO YOUR EXISTING IAR PROJECT 28

6 How to include driverlib into your existing

IAR project

6.1 Introduction

To add driver library to an existing project, right click project click on Add Group - ”driverlib”

Now click Add ﬁles and browse through driverlib folder and add all source ﬁles of the family the

device belongs to.

CHAPTER 6. HOW TO INCLUDE DRIVERLIB INTO YOUR EXISTING IAR PROJECT 29

Add another group via ”Add Group” and add inc folder. Add all ﬁles in the same driverlib family inc

folder

CHAPTER 6. HOW TO INCLUDE DRIVERLIB INTO YOUR EXISTING IAR PROJECT 30

Right click on the project, select ”Options...”, add

”$PROJ DIR$\..\..\..\..\driverlib\MSP430FR5xx 6xx” under ”General Options->C/C++

Compiler->Additional include directories: (one per line)”. Click ”OK” and start developing with

driver library in your project.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 31

7 10-Bit Analog-to-Digital Converter

(ADC10 A)

Introduction ..............................................................................................31

API Functions ............................................................................................31

Programming Example ...................................................................................49

7.1 Introduction

The 10-Bit Analog-to-Digital (ADC10 A) API provides a set of functions for using the MSP430Ware

ADC10 A modules. Functions are provided to initialize the ADC10 A modules, setup signal

sources and reference voltages, and manage interrupts for the ADC10 A modules.

The ADC10 A module provides the ability to convert analog signals into a digital value in respect

to given reference voltages. The ADC10 A can generate digital values from 0 to Vcc with an 8- or

10-bit resolution. It operates in 2 different sampling modes, and 4 different conversion modes. The

sampling modes are extended sampling and pulse sampling, in extended sampling the

sample/hold signal must stay high for the duration of sampling, while in pulse mode a sampling

timer is setup to start on a rising edge of the sample/hold signal and sample for a speciﬁed

amount of clock cycles. The 4 conversion modes are single-channel single conversion, sequence

of channels single-conversion, repeated single channel conversions, and repeated sequence of

channels conversions.

The ADC10 A module can generate multiple interrupts. An interrupt can be asserted when a

conversion is complete, when a conversion is about to overwrite the converted data in the memory

buffer before it has been read out, and/or when a conversion is about to start before the last

conversion is complete. The ADC10 A also has a window comparator feature which asserts

interrupts when the input signal is above a high threshold, below a low threshold, or between the

two at any given moment.

7.2 API Functions

Functions

bool ADC10 A init (uint16 t baseAddress, uint16 t sampleHoldSignalSourceSelect, uint8 t

clockSourceSelect, uint16 t clockSourceDivider)

Initializes the ADC10 A Module.

void ADC10 A enable (uint16 t baseAddress)

Enables the ADC10 A block.

void ADC10 A disable (uint16 t baseAddress)

Disables the ADC10 A block.

void ADC10 A setupSamplingTimer (uint16 t baseAddress, uint16 t clockCycleHoldCount,

uint16 t multipleSamplesEnabled)

Sets up and enables the Sampling Timer Pulse Mode.

void ADC10 A disableSamplingTimer (uint16 t baseAddress)

Disables Sampling Timer Pulse Mode.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 32

void ADC10 A conﬁgureMemory (uint16 t baseAddress, uint8 t inputSourceSelect, uint8 t

positiveRefVoltageSourceSelect, uint8 t negativeRefVoltageSourceSelect)

Conﬁgures the controls of the selected memory buffer.

void ADC10 A enableInterrupt (uint16 t baseAddress, uint8 t interruptMask)

Enables selected ADC10 A interrupt sources.

void ADC10 A disableInterrupt (uint16 t baseAddress, uint8 t interruptMask)

Disables selected ADC10 A interrupt sources.

void ADC10 A clearInterrupt (uint16 t baseAddress, uint8 t interruptFlagMask)

Clears ADC10 A selected interrupt ﬂags.

uint16 t ADC10 A getInterruptStatus (uint16 t baseAddress, uint8 t interruptFlagMask)

Returns the status of the selected memory interrupt ﬂags.

void ADC10 A startConversion (uint16 t baseAddress, uint8 t

conversionSequenceModeSelect)

Enables/Starts an Analog-to-Digital Conversion.

void ADC10 A disableConversions (uint16 t baseAddress, bool preempt)

Disables the ADC from converting any more signals.

int16 t ADC10 A getResults (uint16 t baseAddress)

Returns the raw contents of the speciﬁed memory buffer.

void ADC10 A setResolution (uint16 t baseAddress, uint8 t resolutionSelect)

Use to change the resolution of the converted data.

void ADC10 A setSampleHoldSignalInversion (uint16 t baseAddress, uint16 t invertedSignal)

Use to invert or un-invert the sample/hold signal.

void ADC10 A setDataReadBackFormat (uint16 t baseAddress, uint16 t readBackFormat)

Use to set the read-back format of the converted data.

void ADC10 A enableReferenceBurst (uint16 t baseAddress)

Enables the reference buffer's burst ability.

void ADC10 A disableReferenceBurst (uint16 t baseAddress)

Disables the reference buffer's burst ability.

void ADC10 A setReferenceBufferSamplingRate (uint16 t baseAddress, uint16 t

samplingRateSelect)

Use to set the reference buffer's sampling rate.

void ADC10 A setWindowComp (uint16 t baseAddress, uint16 t highThreshold, uint16 t

lowThreshold)

Sets the high and low threshold for the window comparator feature.

uint32 t ADC10 A getMemoryAddressForDMA (uint16 t baseAddress)

Returns the address of the memory buffer for the DMA module.

uint16 t ADC10 A isBusy (uint16 t baseAddress)

Returns the busy status of the ADC10 A core.

7.2.1 Detailed Description

The ADC10 A API is broken into three groups of functions: those that deal with initialization and

conversions, those that handle interrupts, and those that handle auxiliary features of the ADC10 A.

The ADC10 A initialization and conversion functions are

ADC10 A init()

ADC10 A conﬁgureMemory()

ADC10 A setupSamplingTimer()

ADC10 A disableSamplingTimer()

ADC10 A setWindowComp()

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 33

ADC10 A startConversion()

ADC10 A disableConversions()

ADC10 A getResults()

ADC10 A isBusy()

The ADC10 A interrupts are handled by

ADC10 A enableInterrupt()

ADC10 A disableInterrupt()

ADC10 A clearInterrupt()

ADC10 A getInterruptStatus()

Auxiliary features of the ADC10 A are handled by

ADC10 A setResolution()

ADC10 A setSampleHoldSignalInversion()

ADC10 A setDataReadBackFormat()

ADC10 A enableReferenceBurst()

ADC10 A disableReferenceBurst()

ADC10 A setReferenceBufferSamplingRate()

ADC10 A getMemoryAddressForDMA()

ADC10 A enable()

ADC10 A disable()

7.2.2 Function Documentation

ADC10 A clearInterrupt()

void ADC10 A clearInterrupt (

uint16 t baseAddress,

uint8 t interruptFlagMask )

Clears ADC10 A selected interrupt ﬂags.

The selected ADC10 A interrupt ﬂags are cleared, so that it no longer asserts. The memory buffer

interrupt ﬂags are only cleared when the memory buffer is accessed.

Parameters

baseAddress is the base address of the ADC10 A module.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 34

Parameters

interruptFlagMask is a bit mask of the interrupt ﬂags to be cleared. Mask value is the logical

OR of any of the following:

ADC10 A TIMEOVERFLOW INTFLAG - Interrupts ﬂag when a new

conversion is starting before the previous one has ﬁnished

ADC10 A OVERFLOW INTFLAG - Interrupts ﬂag when a new

conversion is about to overwrite the previous one

ADC10 A ABOVETHRESHOLD INTFLAG - Interrupts ﬂag when the

input signal has gone above the high threshold of the window

comparator

ADC10 A BELOWTHRESHOLD INTFLAG - Interrupts ﬂag when the

input signal has gone below the low threshold of the low window

comparator

ADC10 A INSIDEWINDOW INTFLAG - Interrupts ﬂag when the

input signal is in between the high and low thresholds of the window

comparator

ADC10 A COMPLETED INTFLAG - Interrupt ﬂag for new

conversion data in the memory buffer

Modiﬁed bits of ADC10IFG register.

Returns

None

ADC10 A conﬁgureMemory()

void ADC10 A configureMemory (

uint16 t baseAddress,

uint8 t inputSourceSelect,

uint8 t positiveRefVoltageSourceSelect,

uint8 t negativeRefVoltageSourceSelect )

Conﬁgures the controls of the selected memory buffer.

Maps an input signal conversion into the memory buffer, as well as the positive and negative

reference voltages for each conversion being stored into the memory buffer. If the internal

reference is used for the positive reference voltage, the internal REF module has to control the

voltage level. Note that if a conversion has been started with the startConversion() function, then a

call to disableConversions() is required before this function may be called. If conversion is not

disabled, this function does nothing.

Parameters

baseAddress is the base address of the ADC10 A module.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 35

Parameters

inputSourceSelect is the input that will store the converted data into the

speciﬁed memory buffer. Valid values are:

ADC10 A INPUT A0 [Default]

ADC10 A INPUT A1

ADC10 A INPUT A2

ADC10 A INPUT A3

ADC10 A INPUT A4

ADC10 A INPUT A5

ADC10 A INPUT A6

ADC10 A INPUT A7

ADC10 A INPUT A8

ADC10 A INPUT A9

ADC10 A INPUT TEMPSENSOR

ADC10 A INPUT BATTERYMONITOR

ADC10 A INPUT A12

ADC10 A INPUT A13

ADC10 A INPUT A14

ADC10 A INPUT A15

Modiﬁed bits are ADC10INCHx of ADC10MCTL0

positiveRefVoltageSourceSelect is the reference voltage source to set as the upper limit for

the conversion that is to be stored in the speciﬁed memory

buffer. Valid values are:

ADC10 A VREFPOS AVCC [Default]

ADC10 A VREFPOS EXT

ADC10 A VREFPOS INT

Modiﬁed bits are ADC10SREF of ADC10MCTL0

negativeRefVoltageSourceSelect is the reference voltage source to set as the lower limit for

the conversion that is to be stored in the speciﬁed memory

buffer. Valid values are:

ADC10 A VREFNEG AVSS

ADC10 A VREFNEG EXT

Modiﬁed bits are ADC10SREF of ADC10CTL0

Returns

None

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 36

ADC10 A disable()

void ADC10 A disable (

uint16 t baseAddress )

Disables the ADC10 A block.

This will disable operation of the ADC10 A block.

Parameters

baseAddress is the base address of the ADC10 A module.

Modiﬁed bits are ADC10ON of ADC10CTL0 register.

Returns

None

ADC10 A disableConversions()

void ADC10 A disableConversions (

uint16 t baseAddress,

bool preempt )

Disables the ADC from converting any more signals.

Disables the ADC from converting any more signals. If there is a conversion in progress, this

function can stop it immediately if the preempt parameter is set as

ADC10 A PREEMPTCONVERSION, by changing the conversion mode to single-channel,

single-conversion and disabling conversions. If the conversion mode is set as single-channel,

single-conversion and this function is called without preemption, then the ADC core conversion

status is polled until the conversion is complete before disabling conversions to prevent

unpredictable data. If the ADC10 A startConversion() has been called, then this function has to be

called to re-initialize the ADC, reconﬁgure a memory buffer control, enable/disable the sampling

pulse mode, or change the internal reference voltage.

Parameters

baseAddress is the base address of the ADC10 A module.

preempt speciﬁes if the current conversion should be pre-empted before the end of the

conversion Valid values are:

ADC10 A COMPLETECONVERSION - Allows the ADC10 A to end the

current conversion before disabling conversions.

ADC10 A PREEMPTCONVERSION - Stops the ADC10 A immediately,

with unpredictable results of the current conversion. Cannot be used with

repeated conversion.

Modiﬁed bits of ADC10CTL1 register and bits of ADC10CTL0 register.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 37

Returns

None

ADC10 A disableInterrupt()

void ADC10 A disableInterrupt (

uint16 t baseAddress,

uint8 t interruptMask )

Disables selected ADC10 A interrupt sources.

Disables the indicated ADC10 A interrupt sources. Only the sources that are enabled can be

reﬂected to the processor interrupt; disabled sources have no effect on the processor.

Parameters

baseAddress is the base address of the ADC10 A module.

interruptMask is the bit mask of the memory buffer interrupt sources to be disabled. Mask

value is the logical OR of any of the following:

ADC10 A TIMEOVERFLOW INT - Interrupts when a new conversion is

starting before the previous one has ﬁnished

ADC10 A OVERFLOW INT - Interrupts when a new conversion is about

to overwrite the previous one

ADC10 A ABOVETHRESHOLD INT - Interrupts when the input signal

has gone above the high threshold of the window comparator

ADC10 A BELOWTHRESHOLD INT - Interrupts when the input signal

has gone below the low threshold of the low window comparator

ADC10 A INSIDEWINDOW INT - Interrupts when the input signal is in

between the high and low thresholds of the window comparator

ADC10 A COMPLETED INT - Interrupt for new conversion data in the

memory buffer

Modiﬁed bits of ADC10IE register.

Returns

None

ADC10 A disableReferenceBurst()

void ADC10 A disableReferenceBurst (

uint16 t baseAddress )

Disables the reference buffer's burst ability.

Disables the reference buffer's burst ability, forcing the reference buffer to remain on continuously.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 38

Parameters

baseAddress is the base address of the ADC10 A module.

Returns

None

ADC10 A disableSamplingTimer()

void ADC10 A disableSamplingTimer (

uint16 t baseAddress )

Disables Sampling Timer Pulse Mode.

Disables the Sampling Timer Pulse Mode. Note that if a conversion has been started with the

startConversion() function, then a call to disableConversions() is required before this function may

be called.

Parameters

baseAddress is the base address of the ADC10 A module.

Returns

None

ADC10 A enable()

void ADC10 A enable (

uint16 t baseAddress )

Enables the ADC10 A block.

This will enable operation of the ADC10 A block.

Parameters

baseAddress is the base address of the ADC10 A module.

Modiﬁed bits are ADC10ON of ADC10CTL0 register.

Returns

None

ADC10 A enableInterrupt()

void ADC10 A enableInterrupt (

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 39

uint16 t baseAddress,

uint8 t interruptMask )

Enables selected ADC10 A interrupt sources.

Enables the indicated ADC10 A interrupt sources. Only the sources that are enabled can be

reﬂected to the processor interrupt; disabled sources have no effect on the processor. Does not

clear interrupt ﬂags.

Parameters

baseAddress is the base address of the ADC10 A module.

interruptMask is the bit mask of the memory buffer interrupt sources to be enabled. Mask

value is the logical OR of any of the following:

ADC10 A TIMEOVERFLOW INT - Interrupts when a new conversion is

starting before the previous one has ﬁnished

ADC10 A OVERFLOW INT - Interrupts when a new conversion is about

to overwrite the previous one

ADC10 A ABOVETHRESHOLD INT - Interrupts when the input signal

has gone above the high threshold of the window comparator

ADC10 A BELOWTHRESHOLD INT - Interrupts when the input signal

has gone below the low threshold of the low window comparator

ADC10 A INSIDEWINDOW INT - Interrupts when the input signal is in

between the high and low thresholds of the window comparator

ADC10 A COMPLETED INT - Interrupt for new conversion data in the

memory buffer

Modiﬁed bits of ADC10IE register.

Returns

None

ADC10 A enableReferenceBurst()

void ADC10 A enableReferenceBurst (

uint16 t baseAddress )

Enables the reference buffer's burst ability.

Enables the reference buffer's burst ability, allowing the reference buffer to turn off while the ADC

is not converting, and automatically turning on when the ADC needs the generated reference

voltage for a conversion.

Parameters

baseAddress is the base address of the ADC10 A module.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 40

Returns

None

ADC10 A getInterruptStatus()

uint16 t ADC10 A getInterruptStatus (

uint16 t baseAddress,

uint8 t interruptFlagMask )

Returns the status of the selected memory interrupt ﬂags.

Returns the status of the selected interrupt ﬂags.

Parameters

baseAddress is the base address of the ADC10 A module.

interruptFlagMask is a bit mask of the interrupt ﬂags status to be returned. Mask value is the

logical OR of any of the following:

ADC10 A TIMEOVERFLOW INTFLAG - Interrupts ﬂag when a new

conversion is starting before the previous one has ﬁnished

ADC10 A OVERFLOW INTFLAG - Interrupts ﬂag when a new

conversion is about to overwrite the previous one

ADC10 A ABOVETHRESHOLD INTFLAG - Interrupts ﬂag when the

input signal has gone above the high threshold of the window

comparator

ADC10 A BELOWTHRESHOLD INTFLAG - Interrupts ﬂag when the

input signal has gone below the low threshold of the low window

comparator

ADC10 A INSIDEWINDOW INTFLAG - Interrupts ﬂag when the

input signal is in between the high and low thresholds of the window

comparator

ADC10 A COMPLETED INTFLAG - Interrupt ﬂag for new

conversion data in the memory buffer

Returns

The current interrupt ﬂag status for the corresponding mask.

ADC10 A getMemoryAddressForDMA()

uint32 t ADC10 A getMemoryAddressForDMA (

uint16 t baseAddress )

Returns the address of the memory buffer for the DMA module.

Returns the address of the memory buffer. This can be used in conjunction with the DMA to store

the converted data directly to memory.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 41

Parameters

baseAddress is the base address of the ADC10 A module.

Returns

The memory address of the memory buffer

ADC10 A getResults()

int16 t ADC10 A getResults (

uint16 t baseAddress )

Returns the raw contents of the speciﬁed memory buffer.

Returns the raw contents of the speciﬁed memory buffer. The format of the content depends on

the read-back format of the data: if the data is in signed 2's complement format then the contents

in the memory buffer will be left-justiﬁed with the least-signiﬁcant bits as 0's, whereas if the data is

in unsigned format then the contents in the memory buffer will be right- justiﬁed with the

most-signiﬁcant bits as 0's.

Parameters

baseAddress is the base address of the ADC10 A module.

Returns

A Signed Integer of the contents of the speciﬁed memory buffer.

ADC10 A init()

bool ADC10 A init (

uint16 t baseAddress,

uint16 t sampleHoldSignalSourceSelect,

uint8 t clockSourceSelect,

uint16 t clockSourceDivider )

Initializes the ADC10 A Module.

This function initializes the ADC module to allow for analog-to-digital conversions. Speciﬁcally this

function sets up the sample-and-hold signal and clock sources for the ADC core to use for

conversions. Upon successful completion of the initialization all of the ADC control registers will be

reset, excluding the memory controls and reference module bits, the given parameters will be set,

and the ADC core will be turned on (Note, that the ADC core only draws power during conversions

and remains off when not converting).Note that sample/hold signal sources are device dependent.

Note that if re-initializing the ADC after starting a conversion with the startConversion() function,

the disableConversion() must be called BEFORE this function can be called.

Parameters

baseAddress is the base address of the ADC10 A module.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 42

Parameters

sampleHoldSignalSourceSelect is the signal that will trigger a sample-and-hold for an input

signal to be converted. This parameter is device speciﬁc and

sources should be found in the device's datasheet Valid

values are:

ADC10 A SAMPLEHOLDSOURCE SC

ADC10 A SAMPLEHOLDSOURCE 1

ADC10 A SAMPLEHOLDSOURCE 2

ADC10 A SAMPLEHOLDSOURCE 3

Modiﬁed bits are ADC10SHSx of ADC10CTL1 register.

clockSourceSelect selects the clock that will be used by the ADC10 A core and

the sampling timer if a sampling pulse mode is enabled.

Valid values are:

ADC10 A CLOCKSOURCE ADC10OSC [Default] -

MODOSC 5 MHz oscillator from the UCS

ADC10 A CLOCKSOURCE ACLK - The Auxiliary

Clock

ADC10 A CLOCKSOURCE MCLK - The Master Clock

ADC10 A CLOCKSOURCE SMCLK - The Sub-Master

Clock

Modiﬁed bits are ADC10SSELx of ADC10CTL1

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 43

Parameters

clockSourceDivider selects the amount that the clock will be divided. Valid

values are:

ADC10 A CLOCKDIVIDER 1 [Default]

ADC10 A CLOCKDIVIDER 2

ADC10 A CLOCKDIVIDER 3

ADC10 A CLOCKDIVIDER 4

ADC10 A CLOCKDIVIDER 5

ADC10 A CLOCKDIVIDER 6

ADC10 A CLOCKDIVIDER 7

ADC10 A CLOCKDIVIDER 8

ADC10 A CLOCKDIVIDER 12

ADC10 A CLOCKDIVIDER 16

ADC10 A CLOCKDIVIDER 20

ADC10 A CLOCKDIVIDER 24

ADC10 A CLOCKDIVIDER 28

ADC10 A CLOCKDIVIDER 32

ADC10 A CLOCKDIVIDER 64

ADC10 A CLOCKDIVIDER 128

ADC10 A CLOCKDIVIDER 192

ADC10 A CLOCKDIVIDER 256

ADC10 A CLOCKDIVIDER 320

ADC10 A CLOCKDIVIDER 384

ADC10 A CLOCKDIVIDER 448

ADC10 A CLOCKDIVIDER 512

Modiﬁed bits are ADC10DIVx of ADC10CTL1 register;

bits ADC10PDIVx of ADC10CTL2 register.

Returns

STATUS SUCCESS or STATUS FAILURE of the initialization process.

ADC10 A isBusy()

uint16 t ADC10 A isBusy (

uint16 t baseAddress )

Returns the busy status of the ADC10 A core.

Returns the status of the ADC core if there is a conversion currently taking place.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 44

Parameters

baseAddress is the base address of the ADC10 A module.

Returns

One of the following:

ADC10 A BUSY

ADC10 A NOTBUSY

indicating if there is a conversion currently taking place

ADC10 A setDataReadBackFormat()

void ADC10 A setDataReadBackFormat (

uint16 t baseAddress,

uint16 t readBackFormat )

Use to set the read-back format of the converted data.

Sets the format of the converted data: how it will be stored into the memory buffer, and how it

should be read back. The format can be set as right-justiﬁed (default), which indicates that the

number will be unsigned, or left-justiﬁed, which indicates that the number will be signed in 2's

complement format. This change affects all memory buffers for subsequent conversions.

Parameters

baseAddress is the base address of the ADC10 A module.

readBackFormat is the speciﬁed format to store the conversions in the memory buffer. Valid

values are:

ADC10 A UNSIGNED BINARY [Default]

ADC10 A SIGNED 2SCOMPLEMENT

Modiﬁed bits are ADC10DF of ADC10CTL2 register.

Returns

None

ADC10 A setReferenceBufferSamplingRate()

void ADC10 A setReferenceBufferSamplingRate (

uint16 t baseAddress,

uint16 t samplingRateSelect )

Use to set the reference buffer's sampling rate.

Sets the reference buffer's sampling rate to the selected sampling rate. The default sampling rate

is maximum of 200-ksps, and can be reduced to a maximum of 50-ksps to conserve power.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 45

Parameters

baseAddress is the base address of the ADC10 A module.

samplingRateSelect is the speciﬁed maximum sampling rate. Valid values are:

ADC10 A MAXSAMPLINGRATE 200KSPS [Default]

ADC10 A MAXSAMPLINGRATE 50KSPS

Modiﬁed bits are ADC10SR of ADC10CTL2 register.

Returns

None

ADC10 A setResolution()

void ADC10 A setResolution (

uint16 t baseAddress,

uint8 t resolutionSelect )

Use to change the resolution of the converted data.

This function can be used to change the resolution of the converted data from the default of

12-bits.

Parameters

baseAddress is the base address of the ADC10 A module.

resolutionSelect determines the resolution of the converted data. Valid values

are:

ADC10 A RESOLUTION 8BIT

ADC10 A RESOLUTION 10BIT [Default]

Modiﬁed bits are ADC10RES of ADC10CTL2 register.

Returns

None

ADC10 A setSampleHoldSignalInversion()

void ADC10 A setSampleHoldSignalInversion (

uint16 t baseAddress,

uint16 t invertedSignal )

Use to invert or un-invert the sample/hold signal.

This function can be used to invert or un-invert the sample/hold signal. Note that if a conversion

has been started with the startConversion() function, then a call to disableConversions() is

required before this function may be called.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 46

Parameters

baseAddress is the base address of the ADC10 A module.

invertedSignal set if the sample/hold signal should be inverted Valid values are:

ADC10 A NONINVERTEDSIGNAL [Default] - a sample-and-hold of an

input signal for conversion will be started on a rising edge of the

sample/hold signal.

ADC10 A INVERTEDSIGNAL - a sample-and-hold of an input signal for

conversion will be started on a falling edge of the sample/hold signal.

Modiﬁed bits are ADC10ISSH of ADC10CTL1 register.

Returns

None

ADC10 A setupSamplingTimer()

void ADC10 A setupSamplingTimer (

uint16 t baseAddress,

uint16 t clockCycleHoldCount,

uint16 t multipleSamplesEnabled )

Sets up and enables the Sampling Timer Pulse Mode.

This function sets up the sampling timer pulse mode which allows the sample/hold signal to trigger

a sampling timer to sample-and-hold an input signal for a speciﬁed number of clock cycles without

having to hold the sample/hold signal for the entire period of sampling. Note that if a conversion

has been started with the startConversion() function, then a call to disableConversions() is

required before this function may be called.

Parameters

baseAddress is the base address of the ADC10 A module.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 47

Parameters

clockCycleHoldCount sets the amount of clock cycles to sample-and- hold for the memory

buffer. Valid values are:

ADC10 A CYCLEHOLD 4 CYCLES [Default]

ADC10 A CYCLEHOLD 8 CYCLES

ADC10 A CYCLEHOLD 16 CYCLES

ADC10 A CYCLEHOLD 32 CYCLES

ADC10 A CYCLEHOLD 64 CYCLES

ADC10 A CYCLEHOLD 96 CYCLES

ADC10 A CYCLEHOLD 128 CYCLES

ADC10 A CYCLEHOLD 192 CYCLES

ADC10 A CYCLEHOLD 256 CYCLES

ADC10 A CYCLEHOLD 384 CYCLES

ADC10 A CYCLEHOLD 512 CYCLES

ADC10 A CYCLEHOLD 768 CYCLES

ADC10 A CYCLEHOLD 1024 CYCLES

Modiﬁed bits are ADC10SHTx of ADC10CTL0 register.

multipleSamplesEnabled allows multiple conversions to start without a trigger signal from the

sample/hold signal Valid values are:

ADC10 A MULTIPLESAMPLESDISABLE - a timer trigger will

be needed to start every ADC conversion.

ADC10 A MULTIPLESAMPLESENABLE - during a

sequenced and/or repeated conversion mode, after the ﬁrst

conversion, no sample/hold signal is necessary to start

subsequent samples.

Modiﬁed bits are ADC10MSC of ADC10CTL0 register.

Returns

None

ADC10 A setWindowComp()

void ADC10 A setWindowComp (

uint16 t baseAddress,

uint16 t highThreshold,

uint16 t lowThreshold )

Sets the high and low threshold for the window comparator feature.

Sets the high and low threshold for the window comparator feature. Use the ADC10HIIE,

ADC10INIE, ADC10LOIE interrupts to utilize this feature.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 48

Parameters

baseAddress is the base address of the ADC10 A module.

highThreshold is the upper bound that could trip an interrupt for the window comparator.

lowThreshold is the lower bound that could trip on interrupt for the window comparator.

Returns

None

ADC10 A startConversion()

void ADC10 A startConversion (

uint16 t baseAddress,

uint8 t conversionSequenceModeSelect )

Enables/Starts an Analog-to-Digital Conversion.

This function enables/starts the conversion process of the ADC. If the sample/hold signal source

chosen during initialization was ADC10OSC, then the conversion is started immediately, otherwise

the chosen sample/hold signal source starts the conversion by a rising edge of the signal. Keep in

mind when selecting conversion modes, that for sequenced and/or repeated modes, to keep the

sample/hold-and-convert process continuing without a trigger from the sample/hold signal source,

the multiple samples must be enabled using the ADC10 A setupSamplingTimer() function. Also

note that when a sequence conversion mode is selected, the ﬁrst input channel is the one mapped

to the memory buffer, the next input channel selected for conversion is one less than the input

channel just converted (i.e. A1 comes after A2), until A0 is reached, and if in repeating mode, then

the next input channel will again be the one mapped to the memory buffer. Note that after this

function is called, the ADC10 A stopConversions() has to be called to re-initialize the ADC,

reconﬁgure a memory buffer control, enable/disable the sampling timer, or to change the internal

reference voltage.

Parameters

baseAddress is the base address of the ADC10 A module.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 49

Parameters

conversionSequenceModeSelect determines the ADC operating mode. Valid values are:

ADC10 A SINGLECHANNEL [Default] - one-time

conversion of a single channel into a single memory

buffer

ADC10 A SEQOFCHANNELS - one time conversion

of multiple channels into the speciﬁed starting memory

buffer and each subsequent memory buffer up until the

conversion is stored in a memory buffer dedicated as

the end-of-sequence by the memory's control register

ADC10 A REPEATED SINGLECHANNEL - repeated

conversions of one channel into a single memory

buffer

ADC10 A REPEATED SEQOFCHANNELS -

repeated conversions of multiple channels into the

speciﬁed starting memory buffer and each subsequent

memory buffer up until the conversion is stored in a

memory buffer dedicated as the end-of-sequence by

the memory's control register

Modiﬁed bits are ADC10CONSEQx of ADC10CTL1

Returns

None

7.3 Programming Example

The following example shows how to initialize and use the ADC10 A API to start a single channel,

single conversion.

// Initialize ADC10 A with ADC10 A’s built-in oscillator

ADC10 A init (ADC10 A BASE,

ADC10 A SAMPLEHOLDSOURCE SC,

ADC10 A CLOCKSOURCE ADC10 AOSC,

ADC10 A CLOCKDIVIDEBY 1);

//Switch ON ADC10 A

ADC10 A enable(ADC10 A BASE);

// Setup sampling timer to sample-and-hold for 16 clock cycles

ADC10 A setupSamplingTimer (ADC10 A BASE,

ADC10 A CYCLEHOLD 16 CYCLES,

FALSE);

// Configure the Input to the Memory Buffer with the specified Reference Voltages

ADC10 A configureMemory (ADC10 A BASE,

ADC10 A INPUT A0,

ADC10 A VREF AVCC, // Vref+ = AVcc

ADC10 A VREF AVSS // Vref- = AVss

);

while (1)

{

// Start a single conversion, no repeating or sequences.

CHAPTER 7. 10-BIT ANALOG-TO-DIGITAL CONVERTER (ADC10 A) 50

ADC10 A startConversion (ADC10 A BASE,

ADC10 A SINGLECHANNEL);

// Wait for the Interrupt Flag to assert

while( !(ADC10 A getInterruptStatus(ADC10 A BASE,ADC10 AIFG0)) );

// Clear the Interrupt Flag and start another conversion

ADC10 A clearInterrupt(ADC10 A BASE,ADC10 AIFG0);

}

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 51

8 12-Bit Analog-to-Digital Converter

(ADC12 A)

Introduction ..............................................................................................51

API Functions ............................................................................................51

Programming Example ...................................................................................70

8.1 Introduction

The 12-Bit Analog-to-Digital (ADC12 A) API provides a set of functions for using the MSP430Ware

ADC12 A modules. Functions are provided to initialize the ADC12 A modules, setup signal

sources and reference voltages for each memory buffer, and manage interrupts for the ADC12 A

modules.

The ADC12 A module provides the ability to convert analog signals into a digital value in respect

to given reference voltages. The ADC12 A can generate digital values from 0 to Vcc with an 8-,

10- or 12-bit resolution, with 16 different memory buffers to store conversion results. It operates in

2 different sampling modes, and 4 different conversion modes. The sampling modes are extended

sampling and pulse sampling, in extended sampling the sample/hold signal must stay high for the

duration of sampling, while in pulse mode a sampling timer is setup to start on a rising edge of the

sample/hold signal and sample for a speciﬁed amount of clock cycles. The 4 conversion modes

are single-channel single conversion, sequence of channels single-conversion, repeated single

channel conversions, and repeated sequence of channels conversions.

The ADC12 A module can generate multiple interrupts. An interrupt can be asserted for each

memory buffer when a conversion is complete, or when a conversion is about to overwrite the

converted data in any of the memory buffers before it has been read out, and/or when a

conversion is about to start before the last conversion is complete.

8.2 API Functions

Functions

bool ADC12 A init (uint16 t baseAddress, uint16 t sampleHoldSignalSourceSelect, uint8 t

clockSourceSelect, uint16 t clockSourceDivider)

Initializes the ADC12 A Module.

void ADC12 A enable (uint16 t baseAddress)

Enables the ADC12 A block.

void ADC12 A disable (uint16 t baseAddress)

Disables the ADC12 A block.

void ADC12 A setupSamplingTimer (uint16 t baseAddress, uint16 t

clockCycleHoldCountLowMem, uint16 t clockCycleHoldCountHighMem, uint16 t

multipleSamplesEnabled)

Sets up and enables the Sampling Timer Pulse Mode.

void ADC12 A disableSamplingTimer (uint16 t baseAddress)

Disables Sampling Timer Pulse Mode.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 52

void ADC12 A conﬁgureMemory (uint16 t baseAddress, ADC12 A conﬁgureMemoryParam

∗param)

Conﬁgures the controls of the selected memory buffer.

void ADC12 A enableInterrupt (uint16 t baseAddress, uint32 t interruptMask)

Enables selected ADC12 A interrupt sources.

void ADC12 A disableInterrupt (uint16 t baseAddress, uint32 t interruptMask)

Disables selected ADC12 A interrupt sources.

void ADC12 A clearInterrupt (uint16 t baseAddress, uint16 t memoryInterruptFlagMask)

Clears ADC12 A selected interrupt ﬂags.

uint16 t ADC12 A getInterruptStatus (uint16 t baseAddress, uint16 t

memoryInterruptFlagMask)

Returns the status of the selected memory interrupt ﬂags.

void ADC12 A startConversion (uint16 t baseAddress, uint16 t startingMemoryBufferIndex,

uint8 t conversionSequenceModeSelect)

Enables/Starts an Analog-to-Digital Conversion.

void ADC12 A disableConversions (uint16 t baseAddress, bool preempt)

Disables the ADC from converting any more signals.

uint16 t ADC12 A getResults (uint16 t baseAddress, uint8 t memoryBufferIndex)

A Signed Integer of the contents of the speciﬁed memory buffer.

void ADC12 A setResolution (uint16 t baseAddress, uint8 t resolutionSelect)

Use to change the resolution of the converted data.

void ADC12 A setSampleHoldSignalInversion (uint16 t baseAddress, uint16 t invertedSignal)

Use to invert or un-invert the sample/hold signal.

void ADC12 A setDataReadBackFormat (uint16 t baseAddress, uint8 t readBackFormat)

Use to set the read-back format of the converted data.

void ADC12 A enableReferenceBurst (uint16 t baseAddress)

Enables the reference buffer's burst ability.

void ADC12 A disableReferenceBurst (uint16 t baseAddress)

Disables the reference buffer's burst ability.

void ADC12 A setReferenceBufferSamplingRate (uint16 t baseAddress, uint8 t

samplingRateSelect)

Use to set the reference buffer's sampling rate.

uint32 t ADC12 A getMemoryAddressForDMA (uint16 t baseAddress, uint8 t memoryIndex)

Returns the address of the speciﬁed memory buffer for the DMA module.

uint16 t ADC12 A isBusy (uint16 t baseAddress)

Returns the busy status of the ADC12 A core.

8.2.1 Detailed Description

The ADC12 A API is broken into three groups of functions: those that deal with initialization and

conversions, those that handle interrupts, and those that handle auxiliary features of the ADC12 A.

The ADC12 A initialization and conversion functions are

ADC12 A init()

ADC12 A conﬁgureMemory()

ADC12 A setupSamplingTimer()

ADC12 A disableSamplingTimer()

ADC12 A startConversion()

ADC12 A disableConversions()

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 53

ADC12 A readResults()

ADC12 A isBusy()

The ADC12 A interrupts are handled by

ADC12 A enableInterrupt()

ADC12 A disableInterrupt()

ADC12 A clearInterrupt()

ADC12 A getInterruptStatus()

Auxiliary features of the ADC12 A are handled by

ADC12 A setResolution()

ADC12 A setSampleHoldSignalInversion()

ADC12 A setDataReadBackFormat()

ADC12 A enableReferenceBurst()

ADC12 A disableReferenceBurst()

ADC12 A setReferenceBufferSamplingRate()

ADC12 A getMemoryAddressForDMA()

ADC12 A enable()

ADC12 A disable()

8.2.2 Function Documentation

ADC12 A clearInterrupt()

void ADC12 A clearInterrupt (

uint16 t baseAddress,

uint16 t memoryInterruptFlagMask )

Clears ADC12 A selected interrupt ﬂags.

The selected ADC12 A interrupt ﬂags are cleared, so that it no longer asserts. The memory buffer

interrupt ﬂags are only cleared when the memory buffer is accessed. Note that the overﬂow

interrupts do not have an interrupt ﬂag to clear; they must be accessed directly from the interrupt

vector.

Parameters

baseAddress is the base address of the ADC12 A module.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 54

Parameters

memoryInterruptFlagMask is a bit mask of the interrupt ﬂags to be cleared. Mask value is the

logical OR of any of the following:

ADC12 A IFG0

ADC12 A IFG1

ADC12 A IFG2

ADC12 A IFG3

ADC12 A IFG4

ADC12 A IFG5

ADC12 A IFG6

ADC12 A IFG7

ADC12 A IFG8

ADC12 A IFG9

ADC12 A IFG10

ADC12 A IFG11

ADC12 A IFG12

ADC12 A IFG13

ADC12 A IFG14

ADC12 A IFG15

Modiﬁed bits of ADC12IFG register.

Returns

None

ADC12 A conﬁgureMemory()

void ADC12 A configureMemory (

uint16 t baseAddress,

ADC12 A configureMemoryParam ∗param )

Conﬁgures the controls of the selected memory buffer.

Maps an input signal conversion into the selected memory buffer, as well as the positive and

negative reference voltages for each conversion being stored into this memory buffer. If the

internal reference is used for the positive reference voltage, the internal REF module must be used

to control the voltage level. Note that if a conversion has been started with the startConversion()

function, then a call to disableConversions() is required before this function may be called. If

conversion is not disabled, this function does nothing.

Parameters

baseAddress is the base address of the ADC12 A module.

param is the pointer to struct for memory conﬁguration.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 55

Returns

None

References ADC12 A conﬁgureMemoryParam::endOfSequence,

ADC12 A conﬁgureMemoryParam::inputSourceSelect,

ADC12 A conﬁgureMemoryParam::memoryBufferControlIndex,

ADC12 A conﬁgureMemoryParam::negativeRefVoltageSourceSelect, and

ADC12 A conﬁgureMemoryParam::positiveRefVoltageSourceSelect.

ADC12 A disable()

void ADC12 A disable (

uint16 t baseAddress )

Disables the ADC12 A block.

This will disable operation of the ADC12 A block.

Parameters

baseAddress is the base address of the ADC12 A module.

Modiﬁed bits are ADC12ON of ADC12CTL0 register.

Returns

None

ADC12 A disableConversions()

void ADC12 A disableConversions (

uint16 t baseAddress,

bool preempt )

Disables the ADC from converting any more signals.

Disables the ADC from converting any more signals. If there is a conversion in progress, this

function can stop it immediately if the preempt parameter is set as TRUE, by changing the

conversion mode to single-channel, single- conversion and disabling conversions. If the

conversion mode is set as single-channel, single-conversion and this function is called without

preemption, then the ADC core conversion status is polled until the conversion is complete before

disabling conversions to prevent unpredictable data. If the ADC12 A startConversion() has been

called, then this function has to be called to re-initialize the ADC, reconﬁgure a memory buffer

control, enable/disable the sampling pulse mode, or change the internal reference voltage.

Parameters

baseAddress is the base address of the ADC12 A module.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 56

Parameters

preempt speciﬁes if the current conversion should be pre-empted before the end of the

conversion. Valid values are:

ADC12 A COMPLETECONVERSION - Allows the ADC12 A to end the

current conversion before disabling conversions.

ADC12 A PREEMPTCONVERSION - Stops the ADC12 A immediately,

with unpredictable results of the current conversion.

Modiﬁed bits of ADC12CTL1 register and bits of ADC12CTL0 register.

Returns

None

References ADC12 A isBusy().

ADC12 A disableInterrupt()

void ADC12 A disableInterrupt (

uint16 t baseAddress,

uint32 t interruptMask )

Disables selected ADC12 A interrupt sources.

Disables the indicated ADC12 A interrupt sources. Only the sources that are enabled can be

reﬂected to the processor interrupt, disabled sources have no effect on the processor.

Parameters

baseAddress is the base address of the ADC12 A module.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 57

Parameters

interruptMask Mask value is the logical OR of any of the following:

ADC12 A IE0

ADC12 A IE1

ADC12 A IE2

ADC12 A IE3

ADC12 A IE4

ADC12 A IE5

ADC12 A IE6

ADC12 A IE7

ADC12 A IE8

ADC12 A IE9

ADC12 A IE10

ADC12 A IE11

ADC12 A IE12

ADC12 A IE13

ADC12 A IE14

ADC12 A IE15

ADC12 A OVERFLOW IE

ADC12 A CONVERSION TIME OVERFLOW IE

Modiﬁed bits of ADC12IE register and bits of ADC12CTL0 register.

Returns

None

ADC12 A disableReferenceBurst()

void ADC12 A disableReferenceBurst (

uint16 t baseAddress )

Disables the reference buffer's burst ability.

Disables the reference buffer's burst ability, forcing the reference buffer to remain on continuously.

Parameters

baseAddress is the base address of the ADC12 A module.

Returns

None

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 58

ADC12 A disableSamplingTimer()

void ADC12 A disableSamplingTimer (

uint16 t baseAddress )

Disables Sampling Timer Pulse Mode.

Disables the Sampling Timer Pulse Mode. Note that if a conversion has been started with the

startConversion() function, then a call to disableConversions() is required before this function may

be called.

Parameters

baseAddress is the base address of the ADC12 A module.

Modiﬁed bits are ADC12SHP of ADC12CTL0 register.

Returns

None

ADC12 A enable()

void ADC12 A enable (

uint16 t baseAddress )

Enables the ADC12 A block.

This will enable operation of the ADC12 A block.

Parameters

baseAddress is the base address of the ADC12 A module.

Modiﬁed bits are ADC12ON of ADC12CTL0 register.

Returns

None

ADC12 A enableInterrupt()

void ADC12 A enableInterrupt (

uint16 t baseAddress,

uint32 t interruptMask )

Enables selected ADC12 A interrupt sources.

Enables the indicated ADC12 A interrupt sources. Only the sources that are enabled can be

reﬂected to the processor interrupt, disabled sources have no effect on the processor. Does not

clear interrupt ﬂags.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 59

Parameters

baseAddress is the base address of the ADC12 A module.

interruptMask Mask value is the logical OR of any of the following:

ADC12 A IE0

ADC12 A IE1

ADC12 A IE2

ADC12 A IE3

ADC12 A IE4

ADC12 A IE5

ADC12 A IE6

ADC12 A IE7

ADC12 A IE8

ADC12 A IE9

ADC12 A IE10

ADC12 A IE11

ADC12 A IE12

ADC12 A IE13

ADC12 A IE14

ADC12 A IE15

ADC12 A OVERFLOW IE

ADC12 A CONVERSION TIME OVERFLOW IE

Modiﬁed bits of ADC12IE register and bits of ADC12CTL0 register.

Returns

None

ADC12 A enableReferenceBurst()

void ADC12 A enableReferenceBurst (

uint16 t baseAddress )

Enables the reference buffer's burst ability.

Enables the reference buffer's burst ability, allowing the reference buffer to turn off while the ADC

is not converting, and automatically turning on when the ADC needs the generated reference

voltage for a conversion.

Parameters

baseAddress is the base address of the ADC12 A module.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 60

Returns

None

ADC12 A getInterruptStatus()

uint16 t ADC12 A getInterruptStatus (

uint16 t baseAddress,

uint16 t memoryInterruptFlagMask )

Returns the status of the selected memory interrupt ﬂags.

Returns the status of the selected memory interrupt ﬂags. Note that the overﬂow interrupts do not

have an interrupt ﬂag to clear; they must be accessed directly from the interrupt vector.

Parameters

baseAddress is the base address of the ADC12 A module.

memoryInterruptFlagMask is a bit mask of the interrupt ﬂags status to be returned. Mask

value is the logical OR of any of the following:

ADC12 A IFG0

ADC12 A IFG1

ADC12 A IFG2

ADC12 A IFG3

ADC12 A IFG4

ADC12 A IFG5

ADC12 A IFG6

ADC12 A IFG7

ADC12 A IFG8

ADC12 A IFG9

ADC12 A IFG10

ADC12 A IFG11

ADC12 A IFG12

ADC12 A IFG13

ADC12 A IFG14

ADC12 A IFG15

Returns

The current interrupt ﬂag status for the corresponding mask.

ADC12 A getMemoryAddressForDMA()

uint32 t ADC12 A getMemoryAddressForDMA (

uint16 t baseAddress,

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 61

uint8 t memoryIndex )

Returns the address of the speciﬁed memory buffer for the DMA module.

Returns the address of the speciﬁed memory buffer. This can be used in conjunction with the

DMA to store the converted data directly to memory.

Parameters

baseAddress is the base address of the ADC12 A module.

memoryIndex is the memory buffer to return the address of. Valid values are:

ADC12 A MEMORY 0 [Default]

ADC12 A MEMORY 1

ADC12 A MEMORY 2

ADC12 A MEMORY 3

ADC12 A MEMORY 4

ADC12 A MEMORY 5

ADC12 A MEMORY 6

ADC12 A MEMORY 7

ADC12 A MEMORY 8

ADC12 A MEMORY 9

ADC12 A MEMORY 10

ADC12 A MEMORY 11

ADC12 A MEMORY 12

ADC12 A MEMORY 13

ADC12 A MEMORY 14

ADC12 A MEMORY 15

Returns

address of the speciﬁed memory buffer

ADC12 A getResults()

uint16 t ADC12 A getResults (

uint16 t baseAddress,

uint8 t memoryBufferIndex )

A Signed Integer of the contents of the speciﬁed memory buffer.

Returns the raw contents of the speciﬁed memory buffer. The format of the content depends on

the read-back format of the data: if the data is in signed 2's complement format then the contents

in the memory buffer will be left-justiﬁed with the least-signiﬁcant bits as 0's, whereas if the data is

in unsigned format then the contents in the memory buffer will be right- justiﬁed with the

most-signiﬁcant bits as 0's.

CHAPTER 8. 12-BIT ANALOG-TO-DIGITAL CONVERTER (ADC12 A) 62

Parameters

baseAddress is the base address of the ADC12 A module.

memoryBufferIndex is the speciﬁed Memory Buffer to read. Valid values

are:

ADC12 A MEMORY 0 [Default]

ADC12 A MEMORY 1

ADC12 A MEMORY 2

ADC12 A MEMORY 3

ADC12 A MEMORY 4

ADC12 A MEMORY 5

ADC12 A MEMORY 6

ADC12 A MEMORY 7

ADC12 A MEMORY 8

ADC12 A MEMORY 9

ADC12 A MEMORY 10

ADC12 A MEMORY 11

ADC12 A MEMORY 12

ADC12 A MEMORY 13

ADC12 A MEMORY 14

ADC12 A MEMORY 15

Returns

A signed integer of the contents of the speciﬁed memory buffer

ADC12 A init()

bool ADC12 A init (