Maxim Integrated 71M6534 Energy Meter IC Family Software - Manual (Page 67)

71M653X Software User’s Guide
The file OPTIONS.H controls entire features in the “all options” code set. When an option is 1, it means that the
feature is to be compiled and linked into the build. The idea is that by adding or subtracting features, a customer or
TSC application engineer can quickly tune the code to approximate a desired meter configuration. If the comments in
OPTIONS.H are not clear, feel free to use grep, or another code-searching tool to locate where the flags occur in the
code. While TERIDIAN has made a good-faith effort to test representative combinations of compile flags, there are too
many combinations to test exhaustively.
When OPTIONS.H is changed in the all-options code, there are three usual results. Either the build complains that it
needs some subroutines, or it complains that it has too many subroutines, or it is good. When it needs subroutines,
enable the option flags for the needed subroutines. When it has too many subroutines, try to disable the option flags
for the unneeded subroutines.
On smaller ICs, if the resulting build is too big to fit the available program memory, then more features must be
disabled. Usually this is not an issue on the 653x series.
Usually, the option flags are tested either right after options.h is included in a file, or around the subroutines.
5.11.2 Register Definitions
Register definitions can be found in the following files:
• REG80515.H - Register definition for the 80515 MPU core
• REG653X.H - Register definition of 653X SFRs and I/Os
• IO653X.H and IO653x.c - I/O RAM register definitions
• CE653X.H and CE653X.C - CE data and structure declarations
5.11.3 Other Include/Header Files
Other Include/Header files are:
• CLI.H - Result code and Common ASCII code definition used for CLI
• HELP.H - HELP message prototype declarations
• IO.H – I/O subroutines for CLI
• SER0CLI.H, SER1CLI.H – hardware access layer for UART0/UART1
• SERCLI.H – include definitions for UART 0/1 debug routines
• FLAG0.H, FLAG1.H, FLAG.H – shared logic for all FLAG interfaces
• EEPROM.H – EEPROM
• II2.H – I2C Interface
• LCD.H – LCD
• RTC.H – Real-Time clock
• SER0.H, SER1.H, SER.H – serial interface
• SERIAL.H – serial interface API prototypes and definitions
• TMR0.H, TMR1.H – timer routines
• UWR.H – microwire (µwire), or three-wire interface
• BATMODES.H – battery modes (BROWNLOUT, LCD, SLEEP)
• DEFAULTS.H – default values
• OPTIONS_GBL.H – global compile-time options
• OPTIONS.H – general compile-timeoptions, defining meter functionality
• CALIBRATION.H – calibration
• CE.H – compute engine interface includes
• FREQ.H – frequency and main-edge count
• METER.H – meter structures, enumerates and definitions
• PCNT.H – pulse counting
• PEAK_ALERTS.H – voltage/current peak alerts
v1.1v1.1 TERIDIAN Proprietary 67 of 116
© Copyright 2005-2008 TERIDIAN Semiconductor Corporation