AppTimer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef _APPTIMER_H_
#define _APPTIMER_H_
 
#include <stdbool.h>
#include <SwTimer.h>
#include <ZW_basis_api.h>
#include <SwTimerLiaison.h>
 
#define MAX_NUM_APP_TIMERS           12 // Max number of timers total. I.e. the sum of normal timers and persistent timers
#define MAX_NUM_PERSISTENT_APP_TIMERS 6 // Max number of persistent timers.
#define APP_TIMER_RETENTION_REGISTER_RESERVED_COUNT (MAX_NUM_PERSISTENT_APP_TIMERS + 2) // Number of reserved retention registers.
 
typedef struct  SAppTimer
{
  SSwTimerLiaison TimerLiaison;                     
  SSwTimer* aTimerPointerArray[MAX_NUM_APP_TIMERS]; 
  bool DeepSleepPersistent[MAX_NUM_APP_TIMERS];           
  void (*pDeepSleepCallback[MAX_NUM_APP_TIMERS])(SSwTimer* pTimer); 
} SAppTimer;
 
void AppTimerInit(uint8_t iTaskNotificationBitNumber, void * ReceiverTask);
 
 
void AppTimerSetReceiverTask(void * ReceiverTask);
 
 
bool AppTimerRegister(
  SSwTimer* pTimer,
  bool bAutoReload,
  void(*pCallback)(SSwTimer* pTimer)
  );
 
 
bool AppTimerDeepSleepPersistentRegister(SSwTimer *pTimer,
                                   bool bAutoReload,
                                   void (*pCallback)(SSwTimer *pTimer));
 
 
ESwTimerStatus AppTimerDeepSleepPersistentStart(SSwTimer *pTimer, uint32_t iTimeout);
 
 
ESwTimerStatus AppTimerDeepSleepPersistentRestart(SSwTimer *pTimer);
 
 
ESwTimerStatus AppTimerDeepSleepPersistentStop(SSwTimer *pTimer);
 
 
void AppTimerNotificationHandler(void);
 
 
void AppTimerDeepSleepPersistentResetStorage(void);
 
 
void AppTimerDeepSleepPersistentSaveAll(void);
 
 
void AppTimerDeepSleepPersistentLoadAll(zpal_reset_reason_t resetReason);
 
 
uint32_t AppTimerDeepSleepGetFirstRetentionRegister(void);
 
 
uint32_t AppTimerDeepSleepGetLastRetentionRegister(void);
 
void AppTimerStopAll (void);
#endif /* _APPTIMER_H_ */