diff --git a/drv/bkp.c b/drv/bkp.c index 457fa74..c6b93a4 100644 --- a/drv/bkp.c +++ b/drv/bkp.c @@ -1,6 +1,11 @@ /** @file bkp.c * Module handling the Backup (BKP) domain functionalities. * + * This module includes management of the Real Time Clock (RTC), Tamper + * protection system and a limited space (20 bytes) for persistent data storage + * + * All features present in this module stay running in standby mode / when + * no-longer powered, so long as VBAT is maintained */ //--includes-------------------------------------------------------------------- diff --git a/drv/bkp.h b/drv/bkp.h index c921897..b78994e 100644 --- a/drv/bkp.h +++ b/drv/bkp.h @@ -1,6 +1,11 @@ /** @file bkp.h * Module handling the Backup (BKP) domain functionalities. * + * This module includes management of the Real Time Clock (RTC), Tamper + * protection system and a limited space (20 bytes) for persistent data storage + * + * All features present in this module stay running in standby mode / when + * no-longer powered, so long as VBAT is maintained */ #ifndef _BKP_H_ @@ -60,6 +65,9 @@ typedef void (*BkpRtcCallback)(enum BkpRtcIrq src); * Mulitple IRQs can be enabled and redirected to single callback. The alarm * IRQ, triggered at the specified tick value can be rerouted to an exti line * for wakeup from stanby, in wich case it doesn't need to be enabled here. + * + * Ensure backup domain writes are enabled (see pwr_configure_bkp_write()) while + * calling this function */ void bkp_configure_rtc(uint32_t period_ms, enum BkpRtcClockSrc clock_src, enum BkpRtcIrq irq_mask, uint32_t alarm_tick, BkpRtcCallback callback);