Wiki

This version (25 Jan 2021 05:41) was approved by Robin Getz.The Previously approved version (25 Jan 2021 05:24) is available.Diff

AD7291 - Microcontroller No-OS Driver

Supported Devices

Evaluation Boards

Overview

The AD7291 is a 12-bit, low power, 8-channel, successive approximation analog-to-digital converter (ADC) with an internal temperature sensor.

The part operates from a single 3.3 V power supply and features an I2C-compatible interface. The part contains a 9-channel multiplexer and a track-and-hold amplifier than can handle frequencies up to 30 MHz. The device has an on-chip 2.5 V reference that can be disabled to allow the use of an external reference.

The AD7291 provides a 2-wire serial interface compatible with I2C interfaces. The I2C interface supports standard and fast I2C interface modes. The AD7291 normally remains in a partial power-down state while not converting and powers up for conversions. The conversion process can be controlled by a command mode where conversions occur across I2C write operations or an autocycle mode selected through software control.

The AD7291 includes a high accuracy band gap temperature sensor, which is monitored and digitized by the 12-bit ADC to give a resolution of 0.25°C.

The AD7291 offers a programmable sequencer, which enables the selection of a preprogrammable sequence of channels for conversion.

On-chip limit registers can be programmed with high and low limits for the conversion results; an out-of-range indicator output (ALERT) becomes active when the programmed high or low limits are violated by the conversion result. This output can be used as an interrupt.

The goal of this project (Microcontroller No-OS) is to be able to provide reference projects for lower end processors, which can't run Linux, or aren't running a specific operating system, to help those customers using microcontrollers with ADI parts. Here you can find a generic driver which can be used as a base for any microcontroller platform and also specific drivers for Renesas platforms.

HW Platform(s):

Driver Description

The driver contains two parts:

  • The driver for the AD7291 part, which may be used, without modifications, with any microcontroller.
  • The Communication Driver, where the specific communication functions for the desired type of processor and communication protocol have to be implemented. This driver implements the communication with the device and hides the actual details of the communication protocol to the ADI driver.

The Communication Driver has a standard interface, so the AD7291 driver can be used exactly as it is provided.

There are three functions which are called by the AD7291 driver:

  • I2C_Init() – initializes the communication peripheral.
  • I2C_Write() – writes data to the device.
  • I2C_Read() – reads data from the device.

I2C driver architecture

The following functions are implemented in this version of AD7291 driver:

Function Description
unsigned char AD7291_Init(void) Initializes the I2C communication peripheral and configures AD7291.
void AD7291_SetRegisterValue(unsigned char registerAddress, unsigned short registerValue) Writes data into a register.
void AD7291_GetRegisterValue(unsigned char registerAddress, unsigned short* registerValue, unsigned char readsNumber) Performs a number of reads from a register.
float AD7291_GetDegreesTemp(void) Reads the temperature data and converts the result in degrees Celsius.
void AD7291_GetVoltageConversionResults(unsigned short* data) Reads the voltage conversion results for the enabled channels.

Downloads

Renesas RL78G13 Quick Start Guide

This section contains a description of the steps required to run the AD7291 demonstration project on a Renesas RL78G13 platform.

Required Hardware

Required Software

Hardware Setup

An EVAL-AD7291SDZ has to be interfaced with the Renesas Demonstration Kit (RDK) for RL78G13:

  EVAL-AD7291SDZ test point T_SCLK         → YRDKRL78G13 J9 connector Pin 1
  EVAL-AD7291SDZ test point TDOUT          → YRDKRL78G13 J9 connector Pin 3
  EVAL-AD7291SDZ J16 connector Pin DGND    → YRDKRL78G13 J11 connector Pin 5
  EVAL-AD7291SDZ J16 connector Pin VDRIVE  → YRDKRL78G13 J11 connector Pin 6
  EVAL-AD7291SDZ J15 connector Pin AGND    → YRDKRL78G13 J11 connector Pin 5
  EVAL-AD7291SDZ J15 connector Pin EXT_VCC → YRDKRL78G13 J11 connector Pin 6

Software Setup

With the Applilet3 for RL78G13 tool the following peripherals have to be configured:

CSI10 (Clocked Serial Interface 10) – For the ST7579 LCD

Choose to generate the Transmit/receive function for the CSI10 and configure the interface with the following settings:

  • Transfer mode setting: Single transfer mode
  • Data length setting : 8 bits
  • Transfer direction setting: MSB
  • Specification of data timing: Type 1
  • Transfer rate setting – Clock mode: Internal clock (master)
  • Transfer rate setting – Baudrate: 1000000 (bps)
  • Interrupt setting – Transfer interrupt priority (INTCSI10): Low
  • Uncheck the callback functions.

TM00 (Timer 00) – For the DelayMs() function

Configure TM00 as an interval timer:

  • Interval timer setting - Interval value(16 bits): 1 ms
  • Interval timer setting - Uncheck Generates INTM00 when counting is started
  • Interrupt setting - Uncheck End of timer channel 0 count, generate an interrupt (INTM00)

Watchdog Timer

Disable the watchdog timer:

  • Choose for the Watchdog timer operation setting: Unused option.

Reference Project Overview

The reference project initializes the I2C communication peripheral and configures AD7291 to perform readings from analog inputs CH1 and CH7. The temperature is also read and displayed on the screen in degrees Celsius.

Software Project Setup

This section presents the steps for developing a software application that will run on the Renesas Demo Kit for RL78G13 for controlling and monitoring the operation of the ADI part.

Two software applications have to be used: Applilet3 for RL78G13 (a tool that automatically generates device drivers for MCU peripheral functions) and IAR Embedded Workbench for Renesas RL78 (the integrated development environment).

Step 1 - Applilet3 for RL78G13

  • Run the Applilet3 for RL78G13 tool and create a new project for R5F100LE processor. Select IAR Compiler build tool, a project name, a location for the new project and press OK.

  • Keep the default Pin assignment setting and click Fix settings.

  • Now the desired peripherals can be configured and the code can be generated. For example, if the clocked serial interface 10 (CSI10) has to be configured, select the Serial peripheral, choose for the Channel 2 of Serial Array Unit 0 (SAU0) the CSI10 interface, Transmit/receive function option and then go to CSI10 tab.

  • To configure the CSI10 interface for serial transmissions of 8 bits, with MSB first, with the data captured on clock's rising edge, with a frequency of the clock of 1 MHz and the idle state high, the settings from the following image have to be made.

  • After all the desired peripherals are configured click on the Generate Code button and a new workspace and a new project for the IAR Embedded Workbench will be generated. After the code was generated close the Applilet3 for RL78G13 tool.

Step 2 - IAR Embedded Workbench for Renesas RL78

  • Run the IAR Embedded Workbench and open the workspace created with the Applilet3 tool.

  • Copy the files extracted from the zip file into the user_src folder, located in the project’s folder.

  • The new source files have to be included into the project. Add in the user_src group the files from the corresponding folder (Right click on the group and select Add – Add Files…). Because a new Main file was included the r_main.c file from the applilet_src group has to be deleted (Right click on the file and select Remove).

  • Now the debugger driver has to be selected from the project’s options. Right click on the project name and select Options. From the Debugger category choose the TK Debugger Driver.

  • Now, the project is ready to be compiled and downloaded on the board. Press the F7 key to compile it. Press CTRL + D to download and debug the project.

29 Feb 2012 17:01 · Dragos Bogdan

Renesas RX62N Quick Start Guide

This section contains a description of the steps required to run the AD7291 demonstration project on a Renesas RX62N platform.

Required Hardware

Required Software

Hardware Setup

An EVAL-AD7291SDZ has to be interfaced with the Renesas Demonstration Kit (RDK) for RX62N:

  EVAL-AD7291SDZ test point T_SCLK (SCL)   → YRDKRX62N J2  connector Pin 1
  EVAL-AD7291SDZ test point TDOUT (SDA)    → YRDKRX62N J2  connector Pin 3
  EVAL-AD7291SDZ J16 connector Pin DGND    → YRDKRX62N J8  connector Pin 4
  EVAL-AD7291SDZ J15 connector Pin AGND    → YRDKRX62N J8  connector Pin 4
  EVAL-AD7291SDZ J16 connector Pin VDRIVE  → YRDKRX62N J8  connector Pin 3
  EVAL-AD7291SDZ J15 connector Pin EXT_VCC → YRDKRX62N J8  connector Pin 3

Reference Project Overview

The reference project initializes the I2C communication peripheral and configures AD7291 to perform readings from analog inputs CH1 and CH7. The temperature is also read and displayed on the screen in degrees Celsius.

Software Project Setup

This section presents the steps for developing a software application that will run on the Renesas Demo Kit for RX62N for controlling and monitoring the operation of the ADI part.

  • Run the High-performance Embedded Workshop integrated development environment.
  • A window will appear asking to create or open project workspace. Choose “Create a new project workspace” option and press OK.
  • From “Project Types” option select “Application”, name the Workspace and the Project “ADIEvalBoard”, select the “RX” CPU family and “Renesas RX Standard” tool chain. Press OK.

  • A few windows will appear asking to configure the project:
    • In the “Select Target CPU” window, select “RX600” CPU series, “RX62N” CPU Type and press Next.
    • In the “Option Setting” windows keep default settings and press Next.
    • In the “Setting the Content of Files to be generated” window select “None” for the “Generate main() Function” option and press Next.
    • In the “Setting the Standard Library” window press “Disable all” and then Next.
    • In the “Setting the Stack Area” window check the “Use User Stack” option and press Next.
    • In the “Setting the Vector” window keep default settings and press Next.
    • In the “Setting the Target System for Debugging” window choose “RX600 Segger J-Link” target and press Next.
    • In the “Setting the Debugger Options” and “Changing the Files Name to be created” windows keep default settings, press Next and Finish.
  • The workspace is created.

  • The RPDL (Renesas Peripheral Driver Library) has to integrated in the project. Unzip the RPDL files (double-click on the file “RPDL_RX62N.exe”). Navigate to where the RPDL files were unpacked and double-click on the “Copy_RPDL_RX62N.bat” to start the copy process. Choose the LQFP package, type the full path where the project was created and after the files were copied, press any key to close the window.
  • The new source files have to be included in the project. Use the key sequence Alt, P, A to open the “Add files to project ‘ADIEvalBoard’” window. Double click on the RPDL folder. From the “Files of type” drop-down list, select “C source file (*.C)”. Select all of the files and press Add.

  • To avoid conflicts with standard project files remove the files “intprg.c” and “vecttbl.c” which are included in the project. Use the key sequence Alt, P, R to open the “Remove Project Files” window. Select the files, click on Remove and press OK.

  • Next the new directory has to be included in the project. Use the key sequence Alt, B, R to open the “RX Standard Toolchain” window. Select the C/C++ tab, select “Show entries for: Include file directories” and press Add. Select “Relative to: Project directory”, type “RPDL” as sub-directory and press OK.

  • The library file path has to be added in the project. Select the Link/Library tab, select “Show entries for: Library files” and press Add. Select “Relative to: Project directory”, type “RPDL\RX62N_library” as file path and press OK.

  • Because the “intprg.c” file was removed the “PIntPrg” specified in option “start” has to be removed. Change “Category” to “Section”. Press “Edit”, select “PIntPRG” and press “Remove”. From this window the address of each section can be also modified. After all the changes are made press OK two times.

  • At this point the files extracted from the zip file located in the “Software Tools” section have to be added into the project. Copy all the files from the archive into the project folder.

  • Now, the files have to be included in the project. Use the key sequence Alt, P, A to open the “Add files to project ‘ADIEvalBoard’” window. Navigate into ADI folder. From the “Files of type” drop-down list, select “Project Files”. Select all the copied files and press Add.

  • Now, the project is ready to be built. Press F7. The message after the Build Process is finished has to be “0 Errors, 0 Warnings”. To run the program on the board, you have to download the firmware into the microprocessor’s memory.
03 Feb 2012 15:32 · Dragos Bogdan

More information

01 Jun 2012 12:21
resources/tools-software/uc-drivers/renesas/ad7291.txt · Last modified: 25 Jan 2021 05:40 by Robin Getz