Z3 Technology DM816 Series User manual

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
1
RTC Firmware for the DM81xx-MOD Family
DOC-USR-0016-02
September 6, 2013

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
2
Revision History
Version
Date
Change Note
Author
1.0
3/7/12
Initial version
BM
1.1
9/6/13
Updated programming procedure
RC

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
3
CONTENTS
1!Introduction ..................................................................................................................................................................4!
2!The RTC .......................................................................................................................................................................4!
3.1 RTC Battery .............................................................................................................................................................4!
3.1 RTC Power...............................................................................................................................................................4!
3!Loading the RTC Firmware..........................................................................................................................................5!
3.1 Installing the programming software .......................................................................................................................5!
3.2 Preparing the board ..................................................................................................................................................6!
3.3 Running the programming software ........................................................................................................................6!
4!Verifying the Firmware Programmed Successfully – Quick Test..............................................................................10!
5!Verifying the Firmware Programmed Successfully – Running the Linux Apps........................................................11!
5.1 Building the software.............................................................................................................................................11!
5.2 Running the software .............................................................................................................................................12!
6!Inserting the Battery ...................................................................................................................................................13!
7!Programming Other Modules .....................................................................................................................................13!
LIST OF FIGURES
Figure 1 TI MSP-430 Debugger.........................................................................................................................................5!
Figure 2 Elprotronic Download Page – MSP430 Portion ..................................................................................................5!
Figure 3 Connecting the Debugger to the Z3-DM8168-APP-02 .......................................................................................6!
Figure 4 Elprotronic Main Menu........................................................................................................................................7!
Figure 5 Elprotronic Target Connection / Reset Options Menu ........................................................................................8!
Figure 6 Elprotronic Main Menu After Successful Programming.....................................................................................9!
Figure 7 Example of Checking Registers Programmed in u-boot....................................................................................10!
Figure 8 Sample i2cdump Results....................................................................................................................................12!

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
4
1Introduction
The DM8148, DM8168, and DM8169 modules from Z3 Technology contain a real time clock circuit that can be used to
keep the time and date even when power is removed. The RTC uses a CR1220 or CR1225 lithium battery connected to
the module (the CR1225 will provide slightly more power).
In order for this hardware real time clock to function, the proper firmware needs to be loaded into the MSP430. The
modules do NOT have this firmware loaded prior to leaving the factory. In order to enable the RTC function, the RTC
firmware needs to be uploaded to the module. This document describes how to do this.
2The RTC
3.1 RTC Battery
The RTC firmware controls the power drain on the RTC battery. Without the proper RTC firmware loaded, the RTC
battery will be drained very quickly -- in a matter of minutes.
Do not insert a battery in the battery holder before the RTC firmware is loaded, or the battery will be lost. Please
wait until after the RTC software is installed before inserting the battery in the battery holder. The battery should last for
3 to 5 years in normal conditions.
3.1 RTC Power
The RTC can receive power from the main module power, the RTC battery, or from the expansion connector J5 pin 83.
Regardless of a battery being present, the RTC circuit will receive power from the main module any time the +12V
power is applied. This is true even if the power switch is OFF on modules that have a power switch. Whenever there is
no +12V power applied to the module, then either the RTC battery or J5 pin 83 will be able to power the RTC.
J5 pin 83 can be used to connect a battery with longer life than the CR1220/1225 or if the battery needs to be assembled
on the application board.

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
5
3Loading the RTC Firmware
An MSP-430 debugger is needed for programming (Figure 1). This can be purchased at:
http://www.ti.com/tool/msp-fet430uif
To load the RTC firmware, perform the following steps:
3.1 Installing the programming software
(1) Download the Elprotronic FET-Pro430 Lite programming software. This can be found at the following site:
http://www.elprotronic.com/download.html
Find the “Flash Programmers for TI’s MSP430 MCU uses TI’s FET Adapter” at the very bottom of the page, and
click on the link that says “(FREE)”:
(2) Install the downloaded software (could take some time, depending on your system).
Figure 1TI MSP-430 Debugger
Figure 2Elprotronic Download Page – MSP430 Portion

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
6
3.2 Preparing the board
(3) Mount the MOD to be programmed on the Z3-DM8168-APP-02.
(4) Connect the MSP-430 debugger to the Z3-DM8168-APP-02 board using jumper J10 on the right edge of the board.
Make sure that the red edge of the ribbon cable is facing the bottom (connected to pins 1/2) (Figure 3):
(5) Connect the 12V power to the Z3-DM8168-APP-02 and turn on the power. Make sure the board is running
normally.
(6) Connect the USB end of the MSP430 debugger to the PC with the Elprotronic Software installed.Once you do so,
the power light on the MSP430 debugger should turn green.
3.3 Running the programming software
(7) Make a directory in the C:\ drive of your PC called “Z3-MSP430”.
(8) Copy the “MSP_DM81xx_v2.2.txt” file received from Z3 into this directory.
(9) Run the Elprotronic FET-Pro430 Lite software (version 3.1-0 was used in Z3’s testing). The opening menu
should appear (Figure 4).
(10) Click on “Open Code File ->” and select the MSP_DM81xx_v2.2.txt file in c:\Z3-MSP430 from step (8) (Figure 4).
(11) Under Microcontroller Type, select group “MSP430F2xx.” Then in the Microcontroller type below that select
“MSP430F2012” (Figure 4).
Figure 3Connecting the Debugger to the Z3-DM8168-APP-02
Red line
facing
bottom

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
7
Figure 4Elprotronic Main Menu
Red line
facing
bottom
(1) Click here and open “MSP_DM81xx_v2.2.txt”
(2) Select Group
“MSP430F2xx”
and then
“MSP430F2012”
(3) Select “Setup – Connection /
Device Reset”

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
8
(12) Select “Setup – Connection / Device Reset”. This should open the Connection / Reset Options menu:
(13) Select “Spy Bi Wire” as the method of Communication with the Target Device
(14) Under “Final Target Device action” select “Reset and start the application program”
(15) Ensure COM Port is set to “USB !Automatic”
(16) Click “Ok”
Figure 5Elprotronic Target Connection / Reset Options Menu
(1) Select “Spy Bi Wire”
(2) Select “Reset and
start the application
program”

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
9
(17) In the main menu, click on the “AUTO PROG” key. The Status should change to “Active” and the software
should automatically go through the Verify Security Fuse, Erase Flash, Write Flash, and Verify Flash stages.
Figure 6 shows what the screen should look like after a successful program.
(17) The Firmware should now be programmed!
Figure 6Elprotronic Main Menu After Successful Programming
Click here to start
programming

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
10
4Verifying the Firmware Programmed Successfully – Quick Test
(1) Connect the serial port of the board to a PC and bring up a terminal window (for instructions on how to do this,
please see the corresponding User’s Guide for the module).
(2) Turn on the board. Press the space bar before u-boot ends so that you are in the u-boot prompt.
(3) Within the u-boot prompt, type:
Z3-DM8168-MOD# i2c md 42 0 20
You should see a row of register values followed by a row of “dd”’s (Figure 7). Note that the value at 0000 will
likely be different from “01”.
(4) Again type:
Z3-DM8168-MOD# i2c md 42 0 20
You should see the same thing – except the very first value at 0000 should gradually increment (this is the seconds
counter). Figure 7 shows an example run. Once you’ve confirmed you can read the registers and the first byte
increments, you have confirmed that the firmware has been successfully programmed.
Figure 7Example of Checking Registers Programmed in u-boot

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
11
5Verifying the Firmware Programmed Successfully – Running the Linux Apps
The RTC software provided by Z3 includes a portion that runs on the ARM processor of the module. This software
allows the user to verify the RTC is working and to set the date and time. The software is packaged in the “rtc.tar.gz”
file provided in this release. The steps below detail where to copy these files and how to build and use it.
5.1 Building the software
(1) Go to the project directory and type “source z3-env” (make sure “z3-env” and “z3apps” are in this directory)
# ls {note: actual contents may be slightly different}
build-tools factory images makeall.sh sysapps u-boot z3-env
dvr-rdk filesys kernels Makefile toolchain z3apps
# source ./z3-env
(2) Go to the z3apps/app directory and copy the rtc.tar.gz file there.
# cd z3apps/app
# cp {wherever rtc.tar.gz currently is} .
(3) Untar the rtc.tar.gz file
# gzip –d rtc.tar.gz
# tar –xvf rtc.tar
(4) Go into the rtc directory just created
# cd rtc
(5) Type “make clean all install”
# make clean all install
(6) The RTC files should now be at $ROOTFS/fs/usr/local/bin and ready to use when the board is rebooted.

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
12
5.2 Running the software
(8) Boot up the MOD using TFTP and NFS accessing the PC where you just created the RTC files. Please see the
appropriate User’s Guide for details on how to do this.
(9) If any demo menus come up, exit the menus to reach the Linux prompt.
(10) At the prompt, type “/usr/local/bin/rtc_test”
# /usr/local/bin/rtc_test
RTC version : 2.2
Date (YYYY-MM-DD): 2013-08-27
Time (HH:MM:SS): 08:32:44
Date (YYYY-MM-DD): 2013-08-27
Time (HH:MM:SS): 08:32:45
You should see the version of the RTC software and date/time each time you press enter. Press Ctl-C to exit.
(11) Type “/usr/local/bin/hwclock2 –r” to print the time and date from the RTC
# /usr/local/bin/hwclock2 -r
Date (YYYY-MM-DD): 2013-08-27
Time (HH:MM:SS): 08:34:00
(12) Type “/usr/local/bin/hwclock2 –-set –-date=”m/d/y h:m:s” to set the RTC time/date.
# /usr/local/bin/hwclock2 –-set --date=”8/27/13 08:34:00”
Date (YYYY-MM-DD): 2013-08-27
Time (HH:MM:SS): 08:34:00
(13) Finally, you can use “/usr/local/sbin/i2cdump –y 1 0x42 b” to look directly at the MSP430 register values:
(14) “/usr/local/bin/hwclock2 –s” can be used to set the system time from the RTC time/date. By placing this
command on a script at boot time, the system time will always be correct.
Figure 8Sample i2cdump Results

CONFIDENTIAL DM816x RTC User Guide v1.1
___________________________________________________________________________________________
Z3 Technology, LLC ♦100 N. 8th St., Suite 250 ♦Lincoln, NE 68508 USA ♦+1.402.323.0702
13
6Inserting the Battery
Once you have confirmed the firmware is successfully programmed, you can insert a battery on the board. This battery
can be used to retain power to the RTC even when the MOD is not powered.
To do this, simply insert a CR1225 or CR1220 battery into the RTC battery slot on the right edge of the MOD. Make
sure the “+” is on the top.
Note: You will likely need to remove the MOD from the APP board when you do this. When you put the MOD back
onto the APP board, make sure that all 5 connectors are firmly snapped in place. It is a common error to not snap the
5th connector into place. When this happens, it will seem like the MOD is operating correctly in that it might boot up,
but then unexpected behavior can happen later. It is therefore a good idea to make doubly sure that the MOD and APP
boards are firmly connected at this stage (you should hear a slight “snap” when that fifth connector is firmly in).
7Programming Other Modules
Once you have programmed one module, you can program other modules by doing the following steps:
(1) Connect the module to be programmed on the DM8168-APP-02.
(2) Power on the DM8168-APP-02
(3) Connect the MSP430 emulator to the DM8168-APP-02
(4) Click on the “AUTO PROG” button on the Elprotronic screen.
(5) [The steps to check programming was successful using u-boot or the linux software are the same as before]
(6) Once complete, power the system off, remove the power plug, and disconnect the emulator from J10.