Introduction

Table of Contents

• Introduction
• Source Code Overview
• Pre-compiled Driver Library
• Programming Model
  • Direct Register Access Model
  • Software Driver Model
  • Combining the Models
• HAPI Functions
• Error Checking
• Device Setup
• Customer Configuration (CCFG)
• RTOS (Real-Time Operating System)

Introduction

The CC23x0R5 Driver Library from Texas Instruments®  (also referred to as "DriverLib") is a set of low-level drivers for accessing the registers found on the CC23x0R5 family of ARM® Cortex™-M based devices. The DriverLib functions are grouped in APIs based on either specific on-chip peripheral module (e.g. SPI, UART, etc ) or more general functionality (e.g. system control, oscillator settings, etc). Each API uses a unique pre-fix for all the DriverLib functions in that API to indicate which module or type of functionality being accessed (with a few exceptions).

A few things to note about DriverLib:

• The functions are written entirely in C language except where absolutely not possible.
• The functions are not necessarily the most efficient way to perform a given task from a code size and/or execution speed point of view. Some functions, typically used for configuration/initialization, prioritize usability and might perform a few run-time checks which are not essential for a given application. However, DriverLib functions are relatively small thus optimization potential of individual functions is limited.
• The functions do not always support the full capabilities of the hardware. Some of the peripherals provide complex capabilities which cannot be used by the DriverLib.
• The APIs have a means of removing all error-checking code. Because the error checking is usually useful only during initial program development, it can be removed to significantly reduce code size and increase speed.

For most applications the drivers can be used as is. But in some cases the drivers must be enhanced or rewritten 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.

Source Code Overview

A brief overview of the organization of the driver library source code follows:

driverlib/

• This directory contains the source code for the drivers. The API of each module consists of a .c file and a .h file.

inc/

• This directory contains the header files used for the direct register access programming model. The hw_*.h header files, one per peripheral, describe all the registers and the bit fields within those registers for each peripheral. These header files are used by the drivers to directly access a peripheral, and can be used by application code to bypass the driver library API if necessary.

Currently, DriverLib source code supports the following toolchains:

• TICLANG
• IAR
• GCC

Pre-compiled Driver Library

Besides the source code for the driver library, Texas Instruments also provides pre-compiled libraries of the driver library. These libraries are found in driverlib/lib/.

Currently, pre-compiled libraries are provided for the following toolchains:

• TICLANG
• IAR
• GCC

Programming Model

DriverLib provides support for two programming models:

• Direct register access model: Access registers and bit fields directly.
• Software driver model: Use the provided APIs to indirectly access registers and bit fields.

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 generally results in smaller and more efficient code than using the software driver model. However, the direct register access model requires detailed knowledge of the operation of each register and bit field, as well as their interactions and any sequencing required for proper operation of the peripheral; the software driver model insulates the developer from these details, thus generally requiring less time to develop applications.

Direct Register Access Model

In the direct register access model, the peripherals are programmed by the application by writing values directly into the registers in the peripheral. A set of defines, that simplify this process, is provided.

These defines are located in the inc/ directory and there is a single hw_<module>.h header file for each peripheral type. For example, the defines for UART are located in the hw_uart.h header file.

The defines 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:

• All register name macros start with the module name (for example, UART for the UART module) and are followed by the name of the register as it appears in the data sheet.
• The register defines are offset values relative to the base address of a peripheral instance. If an offset is used, this will be identified in the register name using _O_ (for example, the UART CTL register in the data sheet results in UART_O_CTL). The base address of each peripheral is defined in the memory map header file, hw_memmap.h, located in the inc/ directory.
• All register defines for a given peripheral are listed in the first section of the corresponding header file (for example, in the first section of the hw_uart.h file for the UART registers).
• All register bit fields start with the module name, followed by the register name, and then followed by the bit field name as it appears in the data sheet. For example, the UARTEN bit field in the CTL register in the UART module is identified by UART_CTL_UARTEN.
• Defines that end in _M represent the mask for a bit field in a register.
• Defines that end in _S represent the number of bits to shift a value in order to align it with a bit field.
• Defines that end in _W represent the width of the bit field.
• If a bit field has enumerated values the enumeration names are appended to the name of the bit field define. For example, the UART_LCRH_WLEN bit field has a set of enumerations that specify the UART word length. E.g. the enumeration "BITL7" can be set using the define UART_LCRH_WLEN_BITL7. This improves readability and also helps the programmer select valid values for specific bit fields.

A set of macros is provided in hw_types.h to use together with the register defines to read and write the corresponding addresses:

• HWREG(x) : Access (read or write) a full word (32 bits) at address x in the memory map.
• HWREGH(x) : Access a halfword (16 bits) at address x in the memory map.
• HWREGB(x) : Access a byte (8 bits) at address x in the memory map.

Given these defines and macros, the CTL register, in the first instance of the UART peripheral (UART0), can be programmed as follows:

HWREG(UART0_BASE + UART_O_CTL) &= ~(UART_CTL_UARTEN | UART_CTL_TXE | UART_CTL_RXE);

Alternatively, the following has the same effect (although it is not as easy to understand):

HWREG(UART0_BASE + UART_O_CTL) &= ~(0x00000301);

The value of the BUSY field from the UART_O_FR register can be extracted as follows:

isBusy = (HWREG(UART0_BASE + UART_O_FR) & UART_FR_BUSY_M) >> UART_FR_BUSY_S;

Note

These examples all use constants (defines) as argument for the macro which means that the macro can be resolved at compile-time for very efficient memory accesses. If using variables (e.g. a count value for accessing continuous addresses) the macro can only be resolved at run-time thus resulting in more code and less efficient execution.

Software Driver Model

In the software driver model, the APIs provided in DriverLib are used by applications to control the peripherals. Because 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 registers. This method provides for rapid development of the application without requiring knowledge of how to program the peripheral registers.

Corresponding to the direct register access model example, the following call also programs the CTL register in the UART module (though the register name is hidden by the API):

UARTDisable(UART0_BASE);

Combining the Models

The direct register access model and software driver model can be used together in a single application, thus applying the most appropriate model as needed to any particular situation within the application. For example, the software driver model can be used to configure the peripherals (because this is not performance critical) and the direct register access model can be used to operate 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 can be used for performance critical peripherals.

HAPI Functions

A number of functions are available in a ROM-only version. These functions are called HAPI functions (Hard API) and are generally used by various tools. Source code is not available for the HAPI functions but the functions are available for users to call. The list of HAPI functions available can be found in hapi.h.

Error Checking

Invalid arguments and error conditions are handled in a non-traditional manner in DriverLib. 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, an error code would be returned. The caller then has to check the return code from each invocation of the function to make sure that it succeeded.

This method results in a significant 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 overhead once the application is debugged. Having a means of removing it allows the final code to be smaller and therefore run faster and consume less power.

In this driver library, most functions do not return error status. Argument checking is done via a call to the ASSERT macro (provided in debug.h). This macro has the usual definition of an assert macro; it takes an expression that must be true. By making this macro empty, the argument checking is completely removed from the code thus avoiding the error checking overhead.

There are two definitions of the ASSERT macro provided in debug.h; one that is empty (used for normal/release builds) and one that evaluates the expression (used when the library is built for debugging). The debug version calls the __error__ function whenever the expression is not true, passing the file name and line number of the ASSERT macro invocation. The __error__ function is prototyped in debug.h and must be provided by the application because it is the application's responsibility to deal with error conditions.

To enable the ASSERT macro define the symbol DRIVERLIB_DEBUG within your project and/or compiler setup.

Note

Defining DRIVERLIB_DEBUG for the entire project might result in a significant increase in code size depending on the number of modules used in the project. Defining DRIVERLIB_DEBUG for specific files is possible if a project-wide define results in an unacceptable code size increase.

By setting a breakpoint on the __error__ function, the debugger immediately stops whenever an error occurs anywhere in the application (something that would be very difficult to do with other error checking methods). When the debugger stops, the arguments to the __error__ function and the backtrace of the stack pinpoint the function that found an error, what it found to be a problem, and where it was called from. As an example:

GPIOWriteDio( uint32_t dioNumber, uint32_t value )
{
    // Check the arguments.
    ASSERT( dioNumberLegal( dioNumber ));
    ASSERT(( value == 0 ) || ( value == 1 ));

Each argument is individually checked, so the line number of the failing ASSERT indicates the argument that is invalid. The debugger is able to display the values of the arguments (from the stack trace) as well as the caller of the function that had the argument error. This method allows the problem to be quickly identified at the cost of a small amount of code.

Device Setup

DriverLib includes a special function called SetupTrimDevice() which must always be called right after the ROM boot sequence in order to apply trim settings and certain customer configurations (from CCFG) to the device.

Note

SetupTrimDevice() is called by the startup file provided as part of the CC23x0R5 Driverlib package.

Customer Configuration (CCFG)

The CC23x0R5 Driverlib package includes a customer configuration file (ccfg.c) which contains settings that are being applied mainly by ROM boot sequence, SetupTrimDevice() during startup, and radio SW. The configuration settings are stored in a specially allocated address range in flash referred to as "CCFG area". The user must edit the CCFG to fit the needs of the specific design and application.

Typically, a user application does not need to read the settings in CCFG; however, a few settings might be interesting for a user to read. These can be read using the "Direct Register Access Model" described earlier. Although located in flash, the CCFG settings are documented in the register descriptions as part of the CPU Domain Memory Map.

RTOS (Real-Time Operating System)

Higer-level software for CC23x0R5, for example FreeRTOS, uses DriverLib as the main interface to access the hardware registers thus minimizing the need for direct register accesses from the RTOS itself. The CC23x0R5 Product SDK package provides its own set of RTOS drivers that call DriverLib functions.

When using e.g. FreeRTOS and the included RTOS drivers it is important that a user application does not "bypass" RTOS drivers by calling DriverLib functions directly to configure any hardware that is controlled by the RTOS. Doing so can cause a conflict that may result in unexpected behavior by the RTOS.