RX Family Battery Backup Function Module Firmware Integration
Contents
1. Figure 4 2 Usage Example in Combination with the RTC FIT Module 2 3 R01AN2796EJ0101 Rev 1 01 Page 23 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology RTC callback function static void rtc_callback void event rte err t ret For confirming the return value from the API function For a periodic interrupt if rtc_cb evt_t event RTC EVT PERIODIC For a periodic interrupt Read out the current time information from the RTC clock counter I O register and store it in the data structure ret R_RTC Read amp rtc_ curr time NULL if RTC_SUCCESS ret KO 5 ee Each time a period interrupt occurs at 1 second intervals while 1 the current time is read out Display on the debugging console printf td d d 02d 02d 02d n rtc_curr time tm_year 1900 rtc_ curr time tm mon rtc_curr time tm_mday rtc_curr_time tm_hour rtc_curr time tm_min rte curr time tm_sec Figure 4 2 Usage Example in Combination with the RTC FIT Module 3 3 R01AN2796EJ0101 Rev 1 01 Page 24 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 5 Provided Modules The provided modules can be acquired from the Renesas Electronics web site 6 Reference Documents User s Manual Hardware The latest version can be downloaded from the Renesas Electronics web2. but RAM returns to its post reset values If necessary the RAM content should be restored here Restore RAM values and other operations 2 Stores the address of the callback function in the data structure If the RX231 is used set the following two BSP_CFG_OFS1_REG_VALUE items in the BSP configuration file r_bsp_config h Calls the R_VBATT_Open function Set b1 b0 to 10b This selects 2 51 V as the voltage detection 0 level Callback function Set b2 to 0 This enables the voltage monitoring 0 reset The factor that caused the callback function to be called can be determined from its arguments The callback function should perform processing appropriate to the factor by checking its arguments Reset the values in RAM if required VBATT_DROP_VOLTAGE When the battery backup supply voltage has fallen both the Battery backup voltage drop detection performed real time clock registers and RAM will return to their post reset values The application should initialize the real time clock here Initialize the real time clock Real time clock initialization and other operations VBATT_MASKABLE_INTERRUPT or This is called by the interrupt that occurs when the VBATT pin VBATT_NON_MASKABLE_INTERRUPT supply voltage external battery or other source falls VBATT pin voltage drop detection interrupt The application should perform operations such as displaying a dropped and perfo
3. 6 You should use the Renasas Electronics products described In this document within the range specified by Renesas Electronics espacially with respect to the maximum rating operating supply voltage Tange movement power voltage range heat radiation characteristics Installation and other product characteristics Renesas Electronics shall have no liability for malfunctions or damages arising out of the use of Renesas Electronics products beyond such specified ranges 7 Although Renesas Electronics endeavors to improve the quality and reliability of ita products semiconductor products have specific characteristics such as the occurrence of failure at a certain rate and malfunctions under certain use conditions Further Renesas Electronics products are not subject to radiation resistance design Please ba sure to implement safety measures to guard them against the possibility of physical injury and injury or damage caused by fire in the evant of the failura of a Renesas Electronics product such as safety design for hardware and software including but not limited to redundancy fire control and malfunction prevention appropriate treatment for aging degradation or any other appropriate measures Because the evaluation of microcomputer software alone is very difficult please evaluate the safety of the final products or systems manufactured by you 8 Please contact a Renesas Electronics sales office for details as to environmental matters such as the environme
4. a 13 A Sample Codes oani a Ea AE aa De a R S A ANENE 22 5 Provided Module Saaranen a A a A A ana vee VA N EAE 25 6 Reference D c UmMENS esnia a a a a a a a a i 25 R01AN2796EJ0101 Rev 1 01 Page 1 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 1 Overview When this module is used the VBATT pin voltage drop detection function can be set up and the state of the battery backup function can be read out Furthermore the following four states can be recognized using callback function arguments 1 No battery backup supply voltage drop detected 2 Battery backup supply voltage drop detected 3 A nonmaskable interrupt due to VBATT pin voltage drop detection occurred 4 A maskable interrupt due to VBATT pin voltage drop detection occurred Restrictions on this Module e The VBATT pin must be connected to a power supply independent from VCC e The voltage monitoring function 0 reset should be enabled and the voltage detection level for voltage detection 0 circuit should be set This is 2 51 V for RX231 Group microcontrollers 1 1 The Battery Backup Function FIT Module This module is embedded in projects as an API See section 2 10 FIT Module Addition Methods for embedding this module 1 2 API Overview Table 1 1 lists the API functions provided by this module Also table 1 2 lists the memory sizes required by this module Table 1 1 API Functions Function Functio
5. arguments Reentrant This function is not reentrant Example include r vbatt_rx if h void main void vba vba t return t ret E Ctrl info t vbatt_ctrl_info T Battery backup function enable vbatt_ctrl_info vbatt_ctrl bit func 1 VBATT drop detect function enable and maskable interrupt enable vbatt_ctrl_info vbatt_ctrl bit lvd_detect VBATT DTCT ENABLE INT ENABLE VBATT drop detect level is 2 00V CE ott E CE Gir oC Et vbatt_ctrl_info vbatt_ctrl bit lvd_level VBATT DTCT LEVEL 2 00 V interrupt priority level is 7 vbatt_ctrl_info vbatt_int priority 7 ret R_VBATT Control amp vbatt_ctrl_info if VBATT SUCCESS ret Please do the processing at the time of the error while 1 RO1AN2796EJ0101 Rev 1 01 Page 17 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology Special Notes The table below lists and describes the range of values the arguments may be set to and the meanings of those arguments Structure vbatt_ctrl_info_t Member Bit Allowable Range Meaning vbatt_ctrl func 0 to 1 The enabled or disabled state of the battery backup function can be changed 0 The battery backup function is disabled 1 The battery backup function is enabled Ivd_detect Selected from Selects whether or not the VBATT pin voltage drop detection
6. with the RTC FIT Module 1 3 R01AN2796EJ0101 Rev 1 01 Page 22 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology Discriminate based on the argument switch vbatt_cb event If no battery backup supply voltage drop is detected case VBATT NOT_DROP_VOLTAGE Set up the RTC data structure again rtc_info output_freq RTC_OUTPUT_OFF Stop RTCOUT output rtc_info periodic freq RTC PERIODIC 1 HZ RTC periodic interrupt generation period 1 second rtc_info periodic priority 8 Interrupt priority level rtc_info set_time false Do not update the RTC clock counter I O register rtc_info p_ callback rtc_callback Callback function setup RTC re setup ret R_RTC Open amp rtc_info amp rtc_ curr _ time if RTC SUCCESS ret Although the RTC I O register is saved RAM and other registers are reset while 1 Therefore the RTC FIT module is setup again Read out the current time information from the RTC clock counter I O register and store it in the data structure ret R_RTC Read amp rtc curr time NULL LE l i A ores since the RTC 1 0 register is saved the current while 1 time information is read from the RTC I O register by the R_LRTC_Read function and stored again in the data structure break When a battery backup supply voltage drop was detected case VBATT DROP_VOLTAG
7. 2rRENESAS APPLICATION NOTE z R01AN2796EJ0101 RX Family Rev 1 01 Aug 31 2015 Battery Backup Function Module Firmware Integration Technology Introduction This application note describes a battery backup function module that uses Firmware Integration Technology FIT This module reports to the user whether or not a voltage drop has occurred in either the battery backup supply voltage or the VBATT pin voltage Based on the content reported the user can determine whether or not the value of the real time clock can be guaranteed and whether or not the VBATT pin voltage has fallen This module is referred to as the battery backup function FIT module in the remainder of this document Target Device e RX230 Group e RX231 Group When using this application note with other Renesas MCUs careful evaluation is recommended after making modifications to comply with the alternate MCU Related Documents e Firmware Integration Technology User s Manual ROIAN1833EU e RX Family Board Support Package Module Using Firmware Integration Technology RO1AN1685EU e RX Family Adding Firmware Integration Technology Modules to Projects RO1AN1723EU e RX Family Adding Firmware Integration Technology Modules to CS Projects RO1AN1826EJ Contents Ta SOWEIVIGW sisirin ra a r aden leah ey a r a dala vedeod aataadadabadad nated eden a a N 2 2 JAPWINTOMAON eenen a Wie ee hs ins et ee A er 8 Bo APHFUNCIOMS oo cticce stat eee hee EEEE T EAE OEA ETA A E
8. E RTC data structure setup rtc_info output_freq RTC_OUTPUT_OFF Stop RTCOUT output rtc_info periodic freq RTC PERIODIC 1 HZ RTC periodic interrupt generation period 1 second rtc_info periodic priority 8 Interrupt priority level rtc_info set_time true Update the RTC clock counter I O register rtc_info p callback rtc_callback Callback function setup Set the current time information structure time setting to 2015 06 30 12 34 56 rtc_curr_time tm_sec 56 Seconds 0 59 rtc_curr time tm_min 34 Minutes 0 59 rte curr time tm_hour 12 Hours 0 23 rtc_curr_time tm_mday 30 j Day 1 31 rtc_curr_time tm_mon 6 Month 0 11 0 January rte curr time tm_year 115 Year referenced to 1900 rtc curr time tm_wday 0 Day of week 0 6 0 Sunday rte curr time tm_yday 0 Day in year 0 3165 rte curr time tm_isdst 0 Daylight saving time in effect gt 0 not in effect 0 rtc_curr time if RIC_SUCCESS ret KS If a battery backup supply voltage drop was detected while 1 the microcontroller is in a state where RTC operation is not guaranteed Therefore the RTC is reinitialized break Interrupt due to VBATT pin voltage drop case VBATT_MASKABLE INTERRUPT case VBATT NON_MASKABLE INTERRUPT Unused in this sample code break default No processing break
9. N_MASKABLE_INTERRUPT detection not performed detection performed VBATT pin voltage drop detection interrupt Processing that Reset the RAM and RTC registers The real time clock must be Operations such as displaying a warning Should be as required initialized that the external battery level is low and Performed backing up data should be performed Reason When the battery backup supply When the battery backup This interrupt occurs when the supply voltage has not dropped the value supply voltage drops the voltage on the VBATT pin falls Processing of the RTC register will be saved real time clock registers and to handle the situation where the VBATT pin but RAM and the RTC interrupt RAM go to their values after supply voltage has fallen can be performed registers will be set to their post a reset Therefore reset values Therefore the RAM initialization is required and RTC interrupt register values must be set again The following two items must be set up independently 1 The VBATT pin must be connected to a power supply that is independent of VCC Enable the voltage monitoring 0 reset and set the voltage detection 0 circuit s voltage detection level Reset start Set up data structure Battery backup function setup function R_VBATT_Open VBATT_NOT_DROP_VOLTAGE When the battery backup supply voltage has not fallen the Battery backup voltage drop detection not performed real time clock registers will be saved
10. This setting is only valid when VBATT_DTCT_ENABLE_INT_ENABLE is selected by VBATT_CFG_DETECT_FUNCTION RO1AN2796EJ0101 Rev 1 01 Page 9 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 2 7 Arguments This section presents the structures used as arguments to the API functions These structures are included in the file r_vbatt_rx_if h along with the API function prototype declarations Battery backup function data structure typedef volatile struct vbatt_callback t callbackfunc vbatt_info t Structure used to set up the V again typedef volatile struct uint8 t rsv2 uint8 t rsvl uint8 t vbatt_int priority union uint8 t byte struct uint8 t xrsv 3 uint8 t lvd_level 2 uint8 t lvd_detect 2 ainte t funce 1 pa bit vbatt_ctrl vbatt_ctrl_info t Structure used union uints_ uint ad otc uints_ bit vbatt_ status vbatt_status t Callback function BATT pin voltage drop detection function Reserved area Reserved area Interrupt priority level for the VBATT pin voltage drop detection interrupt maskable interrupt Reserved area VBATT pin voltage drop detection level VBATT pin voltage drop detection function Enabled disabled state of the battery backup function to hold the state of typedef v
11. X Family Battery Backup Function Module Firmware Integration Technology When the R_ VBATT_Control function is called it checks whether or not the argument values are correct and and if there is a problem it returns an error and terminates function execution If the argument settings are valid it sets the VBATT pin voltage drop detection function enabled disabled state and the detection level and it sets up the interrupt according to the values set in the arguments Figure 1 2 shows the flowchart of the R VBATT_Control function Argument vbatt_ctrl_info_t p _vbatt_ctrl_info VBATT pin voltage drop detection function setting information R_VBATT_Control Argument values OK No The argument values are incorrect Yes The argument values are allowable return VBATT_ERR_INVALID_ARG Set up VBATT pin voltage drop detection function Performs the follow settings according to the values set in the argument e Enables or disables the battery backup function according to the p_vbatt_ctrl_info gt vbatt_ctrl bit func value e Enables or disables VBATT pin voltage drop detection according to the p_vbatt_ctrl_info gt vbatt_ctrl bit lvd_detect value e Sets the VBATT pin voltage drop detection level according to the p_vbatt_ctrl_info gt vbatt_ctrl bit lvd_level value e Sets up the VBATT pin voltage drop detection interrupt according to the p_vbatt_ctrl_info gt vbatt_ctrl bit lvd_detect
12. _return_t ret vbatt_status_t vbatt_status vbatt_ctrl_info t vbatt_ctrl_info VBATT drop detect function enable vbatt_ctrl_info vbatt_ctrl bit func 1 vbatt_ctrl_info vbatt_ctrl bit lvd_detect VBATT DTCT ENABLE INT DISABLE vbatt_ctrl_ info vbatt_ctrl bit lvd_level VBATT DTCT LEVEL 2 20 V vbatt_ctrl_info vbatt_int priority 5 ret R_VBATT Control amp vbatt_ctrl_info if VBATT_SUCCESS ret Please do the processing at the time of the error gets the state of the battery backup function ret R_VBATT GetStatus amp vbatt_status if VBATT SUCCESS ret Please do the processing at the time of the error while 1 Special Notes The table below shows the layout of the status flags Bit b7 to b2 b1 b0 Bit Name Reserved area VBATT pin voltage monitor flag Battery backup supply voltage drop detection flag Symbol rsv vbatt_mon pwr_drp_dtct Function Undefined 0 VBATT lt Vdetvbt 0 Battery backup supply voltage 1 VBATT gt Vdetvbt or the VBATT drop not detected detection function was disabled 1 Battery backup supply voltage drop detected R01AN2796EJ0101 Rev 1 01 Page 20 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 3 4 R_VBATT_GetVersion This function returns the version number of the API Format uint32_ t R_VBATT GetVersion void Par
13. ameters None Return Values Version number Properties A prototype declaration for this function appears in r_vbatt_rx_ifth Description This function returns the version number of this API Reentrant This function is reentrant Example uint32 t version version R_VBATT GetVersion Special Notes This function can be compiled in line by using the pragma inline directive RO1AN2796EJ0101 Rev 1 01 Page 21 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 4 Sample Code 4 1 Example of Use Combined with the RTC FIT Module This sample code shows the use of the battery backup function FIT module in combination with the RTF FIT module which is used for real time clock settings The configuration options are set as follows e The BSP FIT module BSP_CFG_OFSI REG VALUE is set to OXFFFFFFFA e The default values are used for the RTC FIT module and the VBATT FIT module settings This sample code operates in the sequence 1 to 3 shown below 1 The R_VBATT_Open function is called The callback function is called when the R_VBATT_Open function is called 2 The callback function for the battery backup function sets up the RTC according to whether or not a battery backup supply voltage drop is detected Whether or not there is a battery backup supply voltage drop is recognized from the arguments to the callback function 2 A Ifthe callback functi
14. and p_vbatt_ctrl_info gt vbatt_int_priority values return VBATT_SUCCESS Figure 1 2 R_VBATT_Control Function Flowchart When the R_VBATT_GetStatus function is called it determines if VBATT pin voltage drop detection is enabled and if whether or not the argument values are correct and and if there is a problem it returns an error and terminates function execution If the argument settings are valid it reads out the value of the VBATT status register VBATTSR The read out value is stored at the address received as an argument Figure 1 3 shows the flowchart of the R VBATT_GetStatus function Argument vbatt_status_t p_vbatt_status Battery backup function status information R_VBATT_GetStatus Battery backup function enabled No The VBATTCR register VBTLVDEN bit is 0 return VBATT_ERR_FUNC_INVALID Yes The VBATTCR register VBTLVDEN bit is 1 Read VBATT status register return VBATT_SUCCESS Stores the value read from the VBATT status register in the address p_vbatt_status passed as an argument Figure 1 3 R_VBATT_GetStatus Function Flowchart RO1AN2796EJ0101 Rev 1 01 Page 5 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 1 3 2 Interrupt Specifications When the interrupt used when a VBATT pin voltage drop is set to be a maskable interrupt when this maskable interrupt occurs the callback fun
15. ction is called with VBATT MASKABLE INTERRUPT as the argument Figure 1 4 shows the flowchart of the r_vbatt_isr function Argument i Callback function i VBATT_MASKABLE_INTERRUPT When a maskable interrupt occurred Figure 1 4 r_vbatt_isr Function Flowchart When the interrupt used when a VBATT pin voltage drop is set to be a nonmaskable interrupt when this nonmaskable interrupt occurs the callback function is called with VBATT_ NON MASKABLE INTERRUPT as the argument Figure 1 5 shows the flowchart of the r_vbatt_nmi_isr function Argument i Callback function al VBATT_NON_MASKABLE_INTERRUPT When a nonmaskable interrupt occurred return Figure 1 5 r_vbatt_nmi_isr Function Flowchart RO1AN2796EJ0101 Rev 1 01 Page 6 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 1 4 Usage Example Call the R_ VBATT_Open function immediately after the reset start The callback function should perform processing based on the value of its arguments Table 1 3 lists the callback function s arguments and processing that should be performed and figure 1 6 shows a usage example of the battery backup function FIT module Table 1 3 Callback Function s Arguments and Processing that Should be Performed Argument VBATT_NOT_DROP_VOLTAGE VBATT_DROP_VOLTAGE VBATT_MASKABLE_INTERRUPT Battery backup voltage drop Battery backup voltage drop YVBATT_NO
16. ection 0 level 2 51 V Yes The OFS1 LVDAS bit is 0 and turn VBATT_ERR_LVD0_SETTING No No callback function was specified Is a callback function specified in the argument Yes A callback function was set up return VBATT_ERR_INVALID_ARG Set up VBATT pin voltage drop The follow settings are performed according to the settings in the configuration file detection function r_vbatt_rx_config h configuration options e The VBATT pin voltage drop detection level is set according to the VBATT_CFG_DETECT_LEVEL setting e The VBATT pin voltage drop detection is enabled or disabled according to the VBATT_CFG_DETECT_FUNCTION setting e The VBATT pin voltage drop detection interrupt is set up according to the VBATT_CFG_DETECT_FUNCTION and VBATT_CFG_INT_PRIORITY settings No The VBATTSR register VBATRLVDETF bit is 0 Battery backup voltage drop detected Yes The VBATTSR register VBATRLVDETF bit is 1 il Callback function Hy Set battery backup voltage drop detection flag to 0 return VBATT_SUCCESS Note For the RX231 microcontroller Argument Argument VBATT_DROP_VOLTAGE Callback function VBATT_NOT_DROP_VOLTAGE Battery backup voltage drop Battery backup voltage drop detection performed detection not performed Sets the VBATTSR register VBATRLVDETF bit to 0 Figure 1 1 R_VBATT_Open Function Flowchart RO1AN2796EJ0101 Rev 1 01 Page 4 of 26 Aug 31 2015 RENESAS R
17. erwise misappropriation of Renesas Electronics product 5 Renesas Electronics products are classified according to the following two quallty grades Standard and High Quallty The recommended applications for each Renesas Electronics product depends on the product s quality grade as indicated below Standard Computers offica equipment communications equipment test and measurement equipment audio and visual equipment home electronic appliances machine tools personal electronic equipment and industrial robots etc High Quality Transportation equipment automobiles trains ships etc traffic control systems anti disaster systems anti crime systems and safety equipment ete Renesas Electronics products are neither intended nor authorized for use in products or systems that may pose a direct threat to human life or bodily injury artificial life support devices or systems surgical implantations etc or may cause serious property damages nuclear reactor control systems military equipment etc You must check the quality grade of each Renesas Electronics product before using it in a particular application You may not use any Renesas Electronics product for any application for which it is not intended Renesas Electronics shall not be in any way liable for any damages or losses Incurred by you or third partles arising from the use of any Renesas Electronics product for which the product ls not Intended by Renesas Electronics
18. g 100191 P R China Tel 86 10 8235 1155 Fax 86 10 8235 7679 Renesas Electronics Shanghal Co Ltd Unit 301 Tower A Central Towers 555 Langao Road Putuo District Shanghai P R China 200333 Tel 86 21 2226 0888 Fax 86 21 2226 0999 Renesas Electronics Hong Kong Limited Unit 1601 1611 16 F Tower 2 Grand Century Place 193 Prince Edward Road West Mongkok Kowloon Hong Kong Tel 852 2265 6688 Fax 852 2886 9022 Renesas Electronics Taiwan Co Ltd 13F No 363 Fu Shing North Road Taipei 10543 Taiwan Tel 886 2 8175 9800 Fax 886 2 8175 9670 Renesas Electronics Singapore Pte Ltd 80 Bendemeer Road Unit 06 02 Hyflux Innovation Centre Singapore 339949 Tel 65 6213 0200 Fax 65 6213 0300 Renesas Electronics Malaysia Sdn Bhd Unit 1207 Block B Menara Amcorp Amcorp Trade Centre No 18 Jin Persiaran Barat 46050 Petaling Jaya Selangor Darul Ehsan Malaysia Tel 60 3 7955 9380 Fax 60 3 7955 9510 Renesas Electronics India Pvt Ltd No 777C 100 Feat Road HAL II Stage Indiranagar Bangalore India Tel 91 80 67208700 Fax 91 80 67208777 Renesas Electronics Korea Co Ltd 12F 234 Teheran ro Gangnam Gu Seoul 135 080 Korea Tel 82 2 558 3737 Fax 82 2 558 5141 2015 Renesas Electronics Corporation All rights reserved Colophon 5 0
19. is function acquires the status for the battery backup function This function is used to check the status of the battery backup function Format vbatt_return_t R_VBATT GetStatus vbatt_status_ t p_vbatt_status Parameters p_vbatt_status Pointer to a variable to hold the battery backup function status The following members are used by this function See section 2 7 Arguments for details on this structure typedef volatile struct union uinte t byte struct uint8 t rsv 6 Reserved area uint8 t vbatt_mon 1 VBATT pin voltage monitor flag uint8 t pwr drp dtct 1 Battery backup supply voltage drop detection flag bit vbatt_status vbatt status t Return Values VBATT SUCCESS Processing completed without problem VBATT ERR INVALID ARG Invalid argument VBATT ERR _FUNC_INVALID R_VBATT GetStatus was called when VBATT pin voltage drop detection was invalid Properties A prototype declaration for this function appears in r_vbatt_rx_if h Description This function reads out the VBATT status register VBATTSR to acquire the status of the battery backup function It then stores that information at the address passed as an argument Reentrant This function is reentrant RO1AN2796EJ0101 Rev 1 01 Page 19 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology Example include r vbatt_rx if h void main void vbatt
20. macro definitions for function is used This also selects the interrupt generated the corresponding when a voltage drop is detected meaning For VBATT_DTCT_DISABLE The VBATT pin voltage drop detection function is set to invalid and the interrupt is disabled For VBATT_DTCT_ENABLE_INT_DISABLE The VBATT pin voltage drop detection function is enabled and the interrupt is disabled For VBATT_DTCT_ENABLE_NMI_ENABLE The VBATT pin voltage drop detection function is enabled and the nonmaskable interrupt is enabled as the interrupt For VBATT_DTCT_ENABLE_INT_ENABLE The VBATT pin voltage drop detection function is enabled and the maskable interrupt is enabled as the interrupt Ivd_level Selected from The VBATT pin voltage drop detection level can be selected macro definitions for For VBATT_DTCT_LEVEL 2 20 V the detection level is the corresponding set to 2 20 V meaning For VBATT_DTCT_LEVEL_2_00_V the detection level is set to 2 00 V vbatt_int_priority 1to15 The interrupt priority level can be selected when a maskable interrupt is used as the VBATT pin voltage drop detection interrupt The value selected by a value from 1 to 15 is set as the interrupt level Note This setting is only valid when VBATT_DTCT_ENABLE_INT_ENABLE is selected by Ivd_detect R01AN2796EJ0101 Rev 1 01 Page 18 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 3 3 R_VBATT_GetStatus Th
21. n description R_VBATT_Open Sets the VBATT pin voltage drop detection enabled disabled state and the detection level and sets up the interrupt according to the configuration option settings After that it discriminates whether or not a battery backup supply voltage drop has occurred and calls the callback function R_VBATT_Control Sets the VBATT pin voltage drop detection enabled disabled state and the detection level and sets up the interrupt according to the settings specified in the arguments R_VBATT_GetStatus Acquires the status of the battery backup function R_VBATT_GetVersion Returns the version number of this module Table 1 2 Required Memory Sizes Memory Size Remarks ROM 588 bytes RAM 4 bytes Maximum user stack usage 52 bytes Maximum interrupt stack usage 44 bytes Note The configuration specifies the defaults as also the values when an RX231 Group microcontroller is used Note that the required memory sizes may differ with the C compiler used and the compiler options specified RO1AN2796EJ0101 Rev 1 01 Page 2 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 1 3 Battery Backup Function FIT Module Overview 1 3 1 API Function Specifications When the R_VBATT_Open function is called it checks whether or not the voltage monitoring 0 settings are correct and whether or not a callback function was specified and if there is a problem it re
22. nt you should comply with the applicable export control laws and of the buyer or distributor of Renesas Electronics products who distributes disposes of or otherwise places the product with a third party to notify such third party in advance of the contents and conditions set forth in this document Renesas Electronics assumes no responsibility for any losses incurred by you or third parties as a result of unauthorized use of Renesas Electronica 12 Please contact a Renesas Electronics sales office if you have any questions regarding the information contained in this document or Renesas Electronics products or if you have any ather inquiries 2tENESAS SALES OFFICES Renesas Electronics Corporation http Avww renesas com Refer to http Avww renesas com for the latest and detailed information Renesas Electronics America Inc 2801 Scott Boulevard Santa Clara CA 95050 2549 U S A Tel 1 408 588 6000 Fax 1 408 588 6130 Renesas Electronics Canada Limited 9251 Yonge Street Sulte 8309 Richmond HIII Ontarlo Canada L4C 9T3 Tel 1 905 237 2004 Renesas Electronics Europe Limited Dukes Meadow Millboard Road Bourne End Buckinghamshire SL8 5FH U K Tel 44 1628 585 100 Fax 44 1628 585 900 Renesas Electronics Europe GmbH Arcadiastrasse 10 40472 Dasseldorf Germany Tel 49 21 1 6503 0 Fax 49 211 6503 1327 Renesas Electronics China Co Ltd Room 1709 Quantum Plaza No 27 ZhiChunLu Haldlan District Belin
23. ntal compatibility of each Renesas Electronics product Please use Renesas Electronics products in compliance with all applicable laws and regulations that regulate the inclusion or use of controlled substances including without limitation the EU RoHS Directive Renesas Electronics assumes no liability for damages or losses occurring as a result of your noncompliance with applicable laws and regulations 9 Renesas Electronics products and technology may not be used for or incorporated into any products or systems whose manufacture uss or sale is prohibited under any applicable domestic or foreign laws or regulations You should not use Renesas Electronics products or technology described In this document for any purpose relating to military applications or use by the military Including but not Ilmited to the regulations and follow the procedures required by such laws and regulations 10 It is the responsil products 11 This document may not be reproduced or duplicated in any form in whole or in part without prior written consent of Renesas Electronics Nota 1 Renesas Electronics as used in this document means Renesas Electronics Corporation and also includes its majority owned subsidiaries Note 2 Renesas Electronics product s means any product developed or manufactured by or for Renesas Electronics development of weapons of mass destruction When exporting the Renesas Electronics products or technology deseribed In this docume
24. olatile struct RO1AN2796EJ0101 Rev 1 01 Aug 31 2015 the battery backup function byte rsv 6 Reserved area vbatt_mon 1 VBATT pin voltage monitor flag pwr_drp_ dtct 1 Battery backup supply voltage drop detection flag Page 10 of 26 7tENESAS RX Family Battery Backup Function Module Firmware Integration Technology 2 8 Return Values This section presents the return values from the API functions This enumeration type is defined in the file r_vbatt_rx_if h along with the API function prototype declarations typedef enum Return value used for calls to battery backup API functions VBATT SUCCESS Processing completed without problem VBATT ERR LOCK FUNC The function was called multiple times Not implemented VBATT_ERR_LVDO SETTING Illegal voltage monitoring 0 settings in option function selection register 1 OFS1 RR INVALID ARG Invalid argument RR_FUNC_INVALID R_VBATT GetStatus was called when VBATT pin voltage drop detection was invalid VBATT_ERR_OTHER Other error vbatt_return t VBATT VBATT 2 9 Callback Function In this module a callback function is called when the R VBATT_Open function is called or when an interrupt occurs The callback function takes an argument whose set value determines whether a battery backup voltage drop was detected or whether it was called from an interrupt handle
25. on argument is VBATT_ NOT DROP VOLTAGE the RTC FIT module is set up again using the R RTC _Open and R_RTC_Read functions 2 B Ifthe callback function argument is VBATT_DROP_VOLTAGE the R_RTC_Open function is used to initialize the RTC 3 In the RTC periodic interrupt callback function the R RTC Read function is used to read out the current time The read out time is displayed on the debugging console include lt stdio h gt This is required because printf is used for debugging display include r rtc rx if h include r vbatt_rx_if h static void vbatt_callback vbatt_cb evt_t vbatt_cb_event static void rtc_callback void event static tm t rtc_curr time Data structure used to store the current time from the RTC void main void vbatt_return_t ret For confirming the return value from the API function vbatt_info_ t vbatt_info Data structure for the battery backup function vbatt_info callbackfunc vbatt_callback Callback function setup if VBATT SUCCESS ret Executing this function results in the set up callback function while 1 vbatt_callback being called while 1 Battery backup function callback function static void vbatt_callback vbatt_cb_evt_t vbatt_cb_event Fte err t ret For confirming the return value from the API function fte init t t info RTC data structure Figure 4 1 Usage Example in Combination
26. r when the VBATT pin voltage fell Table 2 1 lists the constant definitions enum vbatt_cb_evt_t for the argument passed to the callback function For callback function setup the address of the callback function to be registered should be stored in callbackfunc member in the structure described in section 2 7 Arguments Table 2 1 Definitions of Constants Passed as an Argument to the Callback Function enum vbatt_cb_evt_t Defined Constant Conditions for Passing as an Argument VBATT_NOT_DROP_VOLTAGE When R_VBATT_Open was called in the state where a battery backup supply voltage drop was not detected the VBATTSR register VBATRLVDETF bit was 0 VBATT_DROP_VOLTAGE When R_VBATT_Open was called in the state where a battery backup supply voltage drop was detected the VBATTSR register VBATRLVDETF bit was 1 VBATT_MASKABLE_INTERRUPT When a maskable interrupt due to a voltage drop on the VBATT pin occurred VBATT_NON_MASKABLE_INTERRUPT When a nonmaskable interrupt due to a voltage drop on the VBATT pin occurred RO1AN2796EJ0101 Rev 1 01 Page 11 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 2 10 Fit Module Addition Methods This module must be added to each project used in e studio There are two methods for adding to a project using the FIT plug in and adding manually When the FIT plug in is used FIT modules can be added to projects easily and the incl
27. resses are provided for the possible future expansion of functions Do not access these addresses the correct operation of LSI is not guaranteed if they are accessed Clock Signals After applying a reset only release the reset line after the operating clock signal has become stable When switching the clock signal during program execution wait until the target clock signal has stabilized When the clock signal is generated with an external resonator or from an external oscillator during a reset ensure that the reset line is only released after full stabilization of the clock signal Moreover when switching to a clock signal produced with an external resonator or by an external oscillator while program execution is in progress wait until the target clock signal is stable Differences between Products Before changing from one product to another i e to a product with a different type number confirm that the change will not lead to problems The characteristics of an MPU or MCU in the same group but having a different part number may differ in terms of the internal memory capacity layout pattern and other factors which can affect the ranges of electrical characteristics such as characteristic values operating margins immunity to noise and amount of radiated noise When changing to a product with a different part number implement a system evaluation test for the given product Notice 1 Descriptions of circ
28. rm any other warning that the battery level is low and backing up data A A Note Ont when ee ts are enabled re VBATT pin voltage drop warning display y P 4 and other operations appropriate operations Display a warning that the VBATT pin voltage has Figure 1 6 Usage Example of the Battery Backup Function FIT Module RO1AN2796EJ0101 Rev 1 01 Page 7 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 2 API Information The sample code provided with this application note has been confirmed to operate under the following conditions 2 1 Hardware Requirements The microcontroller used must support the following function e Battery backup function 2 2 Software Requirements This driver depends on the following packages e r bsp 2 3 Supported Tool Chain This driver has been confirmed to operate under the following tool chain e Renesas RX Toolchain v 2 03 00 RX231 RX230 2 4 Header Files All the AP calls and the interface definitions required to support those calls are coded in the file r_vbatt_rx_if h 2 5 Integer Types This project is coded in ANSI C99 These types are defined in stdint h RO1AN2796EJ0101 Rev 1 01 Page 8 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 2 6 Compile Time Settings This module configuration options are set in r_vbat
29. ructure for the battery backup information The following members are used by this function See section 2 7 Arguments for details on this structure vbatt_callback t callbackfunc Address of the callback function Return Values VBATT SUCCESS Processing completed without problem VBATT ERR_LVDO_SETTING Illegal voltage monitoring 0 settings in option function selection register 1 OFS1 VBATT ERR INVALID ARG Invalid argument Properties A prototype declaration for this function appears in r_vbatt_rx_if h Description This function sets the enabled or disabled state of the VBATT pin voltage drop detection function the detection level and the interrupts according to settings in the configuration options After that it determines whether or not the battery backup supply voltage has dropped and calls the callback function When calling the callback function e Ifa battery backup supply voltage drop has not been detected A pointer to a variable that has been set to VBATT_NOT DROP VOLTAGE is passed as an argument e Ifa battery backup supply voltage drop has been detected A pointer to a variable that has been set to VBATT_DROP_ VOLTAGE is passed as an argument Reentrant This function is not reentrant RO1AN2796EJ0101 Rev 1 01 Page 13 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology Example include r vbatt_rx if h void vbatt_callback vbatt_cb_ev
30. site Technical Update Technical News The latest version can be downloaded from the Renesas Electronics website User s Manual Development Tools RX Family C C Compiler CC RX V2 03 00 User s Manual R20UT3248EJ The latest version can be downloaded from the Renesas Electronics website RO1AN2796EJ0101 Rev 1 01 Page 25 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology Related Technical Updates This module reflects the content of the following technical updates None Website and Support Renesas Electronics Website http www renesas com Inquiries http www renesas com contact All trademarks and registered trademarks are the property of their respective owners RO1AN2796EJ0101 Rev 1 01 Page 26 of 26 Aug 31 2015 RENESAS Revision History Description Rev Date Page Summary 1 00 Aug 24 2015 First edition issued 1 01 Aug 31 2015 Program Modified the battery backup function FIT module due to the iodefine h V1 0C is updated Description Compilations error occurs when the iodefine h V0 9E is used Workaround Please use rev 1 01 or a later version of the battery backup function FIT module General Precautions in the Handling of MPU MCU Products The following usage notes are applicable to all MPU MCU products from Renesas For detailed usage notes on the products covered by this document refer to the relevant sections of the doc
31. t_rx_config h The table below lists the option names and set values Configuration options in r_vbatt_rx_config h define VBATT_CFG_DETECT_FUNCTION Selects whether or not the VBATT pin voltage drop detection Note The default value is function is used This also selects the interrupt generated when VBATT_DTCT_DISABLE a voltage drop is detected For VBATT_DTCT_DISABLE The VBATT pin voltage drop detection function is set to invalid and the interrupt is disabled For VBATT_DTCT_ENABLE_INT_DISABLE The VBATT pin voltage drop detection function is enabled and the interrupt is disabled For VBATT_DTCT_ENABLE_NMI_ENABLE The VBATT pin voltage drop detection function is enabled and the nonmaskable interrupt is enabled as the interrupt For VBATT_DTCT_ENABLE_INT_ENABLE The VBATT pin voltage drop detection function is enabled and the maskable interrupt is enabled as the interrupt define VBATT_CFG_DETECT_LEVEL The VBATT pin voltage drop detection level can be selected Note The default value is For VBATT_DTCT_LEVEL_2_20_V the detection level is VBATT_DTCT_LEVEL_2 20 V set to 2 20 V For VBATT_DTCT_LEVEL_2_00_V the detection level is set to 2 00 V define VBATT_CFG_INT_PRIORITY The interrupt priority level can be selected when a maskable Note The default value is 5 interrupt is used as the VBATT pin voltage drop detection interrupt The value selected by a value from 1 to 15 is set as the interrupt level Note
32. t_t vbatt_cb event void main void vbatt_return_t ret vbatt_info t vbatt_info vbatt_info callbackfunc vbatt_callback ret R_VBATT Open amp vbatt_info if VBATT SUCCESS l ret Please do the processing at the time of the error while 1 void vbatt_callback vbatt_cb_evt_t vbatt_cb event switch vbatt_cb event Battery backup power voltage drop not detected case VBATT NOT DROP_VOLTAGE Please set RAM again as needed break Battery backup power voltage drop detected case VBATT DROP_VOLTAGE Please initialize the Realtime Clock break VBATT voltage drop detected interrupt case VBATT MASKABLE INTERRUPT case VBATT NON MASKABLE INTERRUPT Please process warning indication backup etc break default Do nothing break RO1AN2796EJ0101 Rev 1 01 Page 14 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology Special Notes None RO1AN2796EJ0101 Rev 1 01 Page 15 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 3 2 R_VBATT_Control This function sets the enabled or disabled state of the battery backup function and sets up the VBATT pin voltage drop detection function This function is used when changing the content of these settings from those made with the R_VBATT_Open func
33. tion Format vbatt_return_t R_VBATT Control vbatt_ctrl_info t p vbatt ctrl info Parameters p_vbatt_ctrl_info Pointer to the data structure used by the VBATT pin voltage drop detection function The following members are used by this function See section 2 7 Arguments for details on this structure typedef volatile struct uint8 trsv2 Reserved area uint8 trsvl Reserved area uint8 tvbatt_int priority Interrupt priority level for the VBATT pin voltage drop detection interrupt maskable interrupt union uint8 t byte struct uint8 t rsv 3 Reserved area uint8 t Ivd_level 2 VBATT pin voltage drop detection level uint8 t Ilvd_detect 2 VBATT pin voltage drop detection function uint8 t func 1 Enabled disabled state of the battery backup function bit vbatt_ctrl vbatt_ctrl_info t Return Values VBATT SUCCESS Processing completed without problem VBATT_ ERR INVALID ARG Invalid argument Properties A prototype declaration for this function appears in r_vbatt_rx_if h RO1AN2796EJ0101 Rev 1 01 Page 16 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology Description This function sets the enabled or disabled state of the battery backup function the enabled or disabled state of the VBATT pin voltage drop detection function the detection level and the interrupts according to the settings of the
34. turns an error and terminates function execution If the argument settings are valid it sets up the VBATT pin voltage drop detection function according to the settings in the configuration file r_vbatt_rx_config h configuration options After that it checks if the battery backup voltages the VCC and VBATT pins have fallen the VBATTSR register VBATRLVDETF bits and performs the following processing according to that result If a battery backup voltage drop has been detected it calls the callback function with VBATT_ DROP VOLTAGE as the argument After calling the callback function it sets the battery backup voltage drop detection flag to 0 battery backup voltage drop not detected If no battery backup voltage drop was detected it calls the callback function with VBATT_NOT DROP VOLTAGE as the argument Figure 1 1 shows the flowchart of the R_VBATT_OpenQ function See section 2 6 Compile Time Settings and section 2 9 Callback Functions for details on the configuration file options and macro definitions used as callback function arguments RO1AN2796EJ0101 Rev 1 01 Page 3 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology R_VBATT_Open Argument vbatt_info_t p_vbatt_info Battery backup function callback function information No The OFS1 LVDAS bit is 1 or the OFS1 VDSEL 1 0 field is a value other than 10b Is voltage monitoring 0 reset enabled and voltage det
35. ude file path will be updated automatically Therefore we recommend using the FIT plug in when adding FIT modules to a project For details on the method for addition FIT modules using the FIT plug in see section 2 Adding FIT Modules to e studio Projects Using FIT Plug In in the Adding Firmware Integration Technology Modules to Projects ROLAN1723EU application note See section 3 Adding FIT Modules to e studio Projects Manually for adding the FIT module by hand without using the FIT plugin When this FIT module is used the Board Support Package FIT module BSP module must also be added to the project See the Board Support Package Module Using Firmware Integration Technology RO1AN1685EU application note for the methods for adding the BSP module RO1AN2796EJ0101 Rev 1 01 Page 12 of 26 Aug 31 2015 RENESAS RX Family Battery Backup Function Module Firmware Integration Technology 3 API Functions 3 14 R_VBATT_Open This function sets up the VBATT pin voltage drop detection function and determines whether or not the battery backup supply voltage has fallen This function is called once and only once after a reset start The processing performed when a drop in the battery backup supply voltage is detected and when no drop is detected are performed by a callback function called by this function Format vbatt_return_t R_VBATT Open vbatt_info t p_vbatt_info Parameters p_vbatt_info Pointer to a data st
36. uits software and other related information in this document are provided only to illustrate the operation of semiconductor products and application examples You are fully responsible for the incorporation of these circuits software and information in the design of your equipment Renesas Electronics assumes no responsibility for any losses incurred by you or third parties arising from the use of these circuits software or information 2 Renesas Electronics has used reasonable care in preparing the information included in this document but Renesas Electronics does not warrant that such information is error free Renesas Electronics assumes na liability whatsoever for any damages incurred by you resulting from errors in or omissions from the information included herein 3 Renesas Electronics does not assume any liability for infringement of patents copyrights or other intellectual property rights of third parties by or arising from the use of Renesas Electronics products or technical information described in this document No license express implied or otherwise is grantad heraby under any patents copyrights or other intellectual proparty rights of Renesas Electronics or others 4 You should not alter modify copy or othenvise misappropriate any Renesas Electronics product whether In whole or In part Renesas Electronics assumes no responsiblity for any losses Incurred by you or third partes arising from such alteration modification copy or oth
37. ument as well as any technical updates that have been issued for the products 1 Handling of Unused Pins Handle unused pins in accord with the directions given under Handling of Unused Pins in the manual The input pins of CMOS products are generally in the high impedance state In operation with an unused pin in the open circuit state extra electromagnetic noise is induced in the vicinity of LSI an associated shoot through current flows internally and malfunctions occur due to the false recognition of the pin state as an input signal become possible Unused pins should be handled as described under Handling of Unused Pins in the manual Processing at Power on The state of the product is undefined at the moment when power is supplied The states of internal circuits in the LSI are indeterminate and the states of register settings and pins are undefined at the moment when power is supplied In a finished product where the reset signal is applied to the external reset pin the states of pins are not guaranteed from the moment when power is supplied until the reset process is completed In a similar way the states of pins in a product that is reset by an on chip power on reset function are not guaranteed from the moment when power is supplied until the power reaches the level at which resetting has been specified Prohibition of Access to Reserved Addresses Access to reserved addresses is prohibited The reserved add
Download Pdf Manuals
Related Search