RX Family
ADC Module Using Firmware Integration Technology
R01AN1666EJ0220 Rev. 2.20
Page 4 of 74
Dec 01, 2016
2. API Information
This Driver API follows the Renesas API naming standards.
2.1
Hardware Requirements
This driver requires your MCU support the following features:
•
S12ADa, S12ADb, S12ADC, S12ADE or S12ADFa peripheral
2.2
Hardware Resource Requirements
This section details the hardware peripherals that this driver requires. Unless explicitly stated, these resources must be
reserved for the driver and the user cannot use them.
2.2.1
S12ADa/S12ADb/S12ADC/S12ADE/S12ADFa
This driver makes use of all features available on these peripherals.
2.2.2
GPIO
This driver utilizes port pins corresponding to each individual analog channel. These pins may not be used for GPIO.
2.3
Software Requirements
This driver is dependent upon the following packages:
•
Renesas Board Support Package (r_bsp)
2.4
Limitations
Registers, settings, or usage notes vary depending on the mode used in the 12-bit A/D converter. APIs in this
application note must be used according to the 12-bit A/D converter chapter in the User's Manual: Hardware for the
MCU used.
2.5
Supported Toolchains
This driver is tested and working with the following toolchains:
•
Renesas RX Toolchain v2.05.00
2.6
Header Files
Compile time configurable options are located in r_s12ad_rx\ref\r_s12ad_rx_config_reference.h. This file should be
copied into the r_config subdirectory of the project and renamed to r_s12ad_rx_config.h. It is this renamed file that
should be modified if needed and the original kept as a reference.
All API calls and their supporting interface definitions are located in r_s12ad_rx\r_s12ad_rx_if.h. Both this file and
r_s12ad_rx_config.h should be included by the User’s application.
2.7
Integer Types
This project uses ANSI C99 “Exact width integer types” in order to make the code clearer and more portable. These
types are defined in
stdint.h
.