Board.h File Reference

Detailed Description

Portable board-specific symbols.

---

The Board header file should be included in an application as follows:

#include "Board.h"

This header serves as device-independent interface for applications using peripherals connected to the device via standard digital interfaces; e.g, GPIO, SPI, I2C, UART, etc. Its purpose is to enable application code that references a peripheral to be portable to any device and board that supports the peripheral.

Usage

Synopsis

#include "Board.h"

void main(void)
{
    Board_init();
     :
}

Initializing the hardware

Board_init() must be called before any other driver API. This function calls the device specific initialization code that is required to as soon as possible after a device reset; e.g., to initialize clocks and power management functionality.

Portable peripheral usage

Each driver module declares symbols in Board.h that, if used, will improve code portability between both different devices and boards.

For example, the I2C driver adds Board.h symbol definitions of the form

• bus_name - the I2C bus instance ID,
• bus_name_MAXBITRATE - the maximum supported BITRATE for the bus bus_name, and
• Board_I2C_comp_name_ADDR - the slave address for the named I2C component where comp_name is the name given to an I2C peripheral by the board manufacturer, and bus_name is the user defined name of the I2C bus instance. These symbols enable applications to portably acquire an I2C bus handle and control an I2C slave on that bus.

  #include <ti/drivers/I2C.h>
  #include "Board.h"
  
  // portably open an I2C bus instance
  I2C_Params i2cParams;
  I2C_Params_init(&i2cParams);
  i2cParams.bitRate = Board_I2C0_MAXBITRATE;  // bus name == Board_I2C0
  i2cHandle = I2C_open(Board_I2C0, &i2cParams);
  
  // portably read from an I2C slave
  I2C_Transaction trans;
  trans.slaveAddress = Board_I2C_TMP006_ADDR; // component name = TMP006
  trans.readBuf = ...;
  trans.readCount = ...;
  trans.writeCount = 0;
  I2C_transfer(i2cHandle, &trans);

Go to the source code of this file.

Functions
void	Board_init (void)
	Performs "early" board-level initialization required by TI-DRIVERS. More...

Function Documentation

Board_init()

void Board_init

(

void

)

Performs "early" board-level initialization required by TI-DRIVERS.

Board_init() must be called before any other TI-DRIVER API. This function calls all device and board specific initialization functions needed by TI-DRIVERS; e.g., to initialize clocks and power management functionality.

This function should only be called once and as early in the application's startup as possible. In most applications, a call to Board_init() is the first statement in main().

Precondition

Board_init must be called after every CPU reset and prior to enabling any interrupts.