This is an old revision of the document!
ADF4118 - Microcontroller No-OS Driver
The ADF4118 is a frequency synthesizer which can be used to implement local oscillators in the up-conversion and down-conversion sections of wireless receivers and transmitters. It consists of a low-noise digital PFD (Phase Frequency Detector), a precision charge pump, a programmable reference divider, programmable A and B counters and a dual-modulus prescaler (P/P+1). The A (5-bit) and B (13-bit) counters, in conjunction with the dual modulus prescaler (P/P+1), implement an N divider (N= BP+A). In addition, the 14-bit reference counter (R Counter), allows selectable REFIN frequencies at the PFD input. A complete PLL (Phase-Locked Loop) can be implemented if the synthesizer is used with an external loop filter and VCO (Voltage Controlled Oscillator).
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.
The driver contains two parts:
The driver for the ADF4118 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
The Communication Driver has a standard interface, so the ADF4118 driver can be used exactly as it is provided. There are three functions which are called by the ADF4118 driver:
_Init() – initializes the communication peripheral.
_Write() – writes data to the device.
_Read() – reads data from the device.
The implementation of these three functions depends on the used microcontroller.
The driver for ADF4118 contains functions for initializing the device and for writing data into each register.
The following functions are implemented in this version of ADF4118 driver:
| Function || Description
| unsigned char ADF4118_Init(void) || Initializes the device.
| void ADF4118_Write(unsigned long data) || Writes data into a register.
| void ADF4118_Power(unsigned char powerMode) || Powers down or powers up the device.
| unsigned long long ADF4118_SetFrequency(unsigned long long frequency) || Sets the ADF4118 frequency.
Renesas RL78G13 Quick Start Guide
This section contains a description of the steps required to run the ADF4118 demonstration project on a Renesas RL78G13 platform.
An EVAL-ADF4118EBZ1 board has to be interfaced with the Renesas Demonstration Kit (RDK) for RL78G13:
9 Way D-Type connector Pin 3 (CLK) → YRDKRL78G13 J11 connector Pin 4
9 Way D-Type connector Pin 5 (DATA) → YRDKRL78G13 J11 connector Pin 2
9 Way D-Type connector Pin 7 (LE) → YRDKRL78G13 J11 connector Pin 1
9 Way D-Type connector Pin 8 (GND) → YRDKRL78G13 J11 connector Pin 5
Reference Project Overview
In this example the output frequency of the device is set to 1950 MHz.
Software Project Tutorial
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.
Run the IAR Embedded Workbench for Renesas RL78 integrated development environment.
Choose to create a new project (Project – Create New Project).
Select the RL78 tool chain, the Empty project template and click OK.
At this moment, all the files are included into the project.
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.
A window will appear asking to configure the emulator. Keep the default settings and press OK.
Renesas RX62N Quick Start Guide
This section contains a description of the steps required to run the ADF4118 demonstration project on a Renesas RX62N platform.
An EVAL-ADF4118EBZ1 board has to be interfaced with the Renesas Demonstration Kit (RDK) for RX62N:
9 Way D-Type connector Pin 3 (CLK) → RDKRX62N J8 connector Pin 20
9 Way D-Type connector Pin 5 (DATA) → RDKRX62N J8 connector Pin 19
9 Way D-Type connector Pin 7 (LE) → RDKRX62N J8 connector Pin 26
9 Way D-Type connector Pin 8 (GND) → RDKRX62N J8 connector Pin 2
Reference Project Overview
In this example, two values are loaded into R and N Counters and the MUXOUT is configured to be connected to the R Divider output.
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.
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.
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.