 |
MTB CAT1 Peripheral driver library
|
|
MTB CAT1 Peripheral driver library
|
The Watchdog timer (WDT) has a 16-bit free-running up-counter.
The functions and other declarations used in this driver are in cy_wdt.h. You can include cy_pdl.h to get access to all functions and declarations in the PDL.
The WDT can issue counter match interrupts, and a device reset if its interrupts are not handled. Use the Watchdog timer for two main purposes:
The First use case is recovering from a CPU or firmware failure. A timeout period is set up in the Watchdog timer, and if a timeout occurs, the device is reset (WRES).
The Second use case is to generate periodic interrupts. It is strongly recommended not to use the WDT for periodic interrupt generation. However, if absolutely required, see information below.
A "reset cause" register(RES_CAUSE, Part of SRSS IP) exists, and the firmware should check this register at a start-up. An appropriate action can be taken if a WRES reset is detected.
The user's firmware periodically resets the timeout period (clears or "feeds" the watchdog) before a timeout occurs. If the firmware fails to do so, that is considered to be a CPU crash or a firmware failure, and the reason for a device reset. The WDT can generate an interrupt instead of a device reset. The Interrupt Service Routine (ISR) can handle the interrupt either as a periodic interrupt, or as an early indication of a firmware failure and respond accordingly. However, it is not recommended to use the WDT for periodic interrupt generation. The Multi-counter Watchdog Timers (MCWDT) can be used to generate periodic interrupts if such are presented in the device.
Functional Description
The WDT generates an interrupt when the count value in the counter equals the configured match value.
Note that the counter is not reset on a match. In such case the WDT reset period is: WDT_Reset_Period = ILO_Period * (2*2^(16-IgnoreBits) + MatchValue); When the counter reaches a match value, it generates an interrupt and then keeps counting up until it overflows and rolls back to zero and reaches the match value again, at which point another interrupt is generated.
To use a WDT to generate a periodic interrupt, the match value should be incremented in the ISR. As a result, the next WDT interrupt is generated when the counter reaches a new match value.
You can also reduce the entire WDT counter period by specifying the number of most significant bits that are ignored in the WDT counter. For example, if the Cy_WDT_SetIgnoreBits() function is called with parameter 3, the WDT counter becomes a 13-bit free-running up-counter.
Power Modes
WDT can operate in all possible low power modes. Operation during Hibernate mode is possible because the logic and high-voltage internal low oscillator (ILO) are supplied by the external high-voltage supply (Vddd). The WDT can be configured to wake the device from Hibernate mode.
In CPU Active mode, an interrupt request from the WDT is sent to the CPU. In CPU Sleep, CPU Deep Sleep mode, the CPU subsystem is powered down, so the interrupt request from the WDT is sent directly to the WakeUp Interrupt Controller (WIC) which will then wake up the CPU. The CPU then acknowledges the interrupt request and executes the ISR. Clear the interrupt in the ISR. The Reset occurs on the 3rd WDT counter match.
In Hibernate mode, the entire device except a few peripherals (such as WDT and LPCOMP) are powered down. Any interrupt to wake up the device in this mode results in a device reset. Hence, there is no interrupt service routine or mechanism associated with this mode. The Reset occurs on the first WDT counter match.
Clock Source
The WDT is clocked by the ILO. The WDT must be disabled before disabling the ILO. According to the device datasheet, the ILO accuracy is +/-30% over voltage and temperature. This means that the timeout period may vary by 30% from the configured value. Appropriate margins should be added while configuring WDT intervals to make sure that unwanted device resets do not occur on some devices.
Refer to the device datasheet for more information on the oscillator accuracy.
Register Locking
You can prevent accidental corruption of the WDT configuration by calling the Cy_WDT_Lock() function. When the WDT is locked, any writing to the WDT_*, CLK_ILO_CONFIG, CLK_SELECT.LFCLK_SEL, and CLK_TRIM_ILO_CTL registers is ignored. Call the Cy_WDT_Unlock() function to allow registers modification, mentioned above.
Note that the WDT lock state is not retained during system Deep Sleep. After the wakeup from system Deep Sleep the WDT is locked.
Clearing WDT
The ILO clock is asynchronous to the SysClk. Therefore it generally takes three ILO cycles for WDT register changes to come into effect. It is important to remember that a WDT should be cleared at least four cycles (3 + 1 for sure) before a timeout occurs, especially when small match values / low-toggle bit numbers are used.
Reset Detection
Use the Cy_SysLib_GetResetReason() function to detect whether the WDT has triggered a device reset.
Interrupt Configuration
If the WDT is configured to generate an interrupt, pending interrupts must be cleared within the ISR (otherwise, the interrupt will be generated continuously). A pending interrupt to the WDT block must be cleared by calling the Cy_WDT_ClearInterrupt() function. The call to the function will clear the unhandled WDT interrupt counter.
Use the WDT ISR as a timer to trigger certain actions and to change a next WDT match value.
Ensure that the interrupts from the WDT are passed to the CPU to avoid unregistered interrupts. Unregistered WDT interrupts result in a continuous device reset. To avoid this, call Cy_WDT_UnmaskInterrupt(). After that, call the WDT API functions for interrupt handling/clearing.
To start the WDT, make sure that ILO is enabled. After the ILO is enabled, ensure that the WDT is unlocked and disabled by calling the Cy_WDT_Unlock() and Cy_WDT_Disable() functions. Set the WDT match value by calling Cy_WDT_SetMatch() with the required match value. If needed, set the ignore bits for reducing the WDT counter period by calling Cy_WDT_SetIgnoreBits() function. After the WDT configuration is set, call Cy_WDT_Enable().
When the WDT is used to protect against system crashes, the WDT interrupt should be cleared by a portion of the code that is not directly associated with the WDT interrupt. Otherwise, it is possible that the main firmware loop has crashed or is in an endless loop, but the WDT interrupt vector continues to operate and service the WDT. The user should:
For more information on the WDT peripheral, refer to the technical reference manual (TRM).
| Version | Changes | Reason for Change |
|---|---|---|
| 1.90 | Updated internal macro for parameter validation. | Code enhancement |
| 1.80 | Added support for TRAVEO™ II Body Entry devices. MXS40SRSS_VERSION compares now expect < or >= 2, previously 3. | Code enhancement and support for new devices. |
| 1.70 | Modified Cy_WDT_SetIgnoreBits() API to work correctly with CAT1B. Newly Added API : Cy_WDT_ResetCounter() for resetting counter to zero. | Code Enhancements for CAT1B. |
| Added Cy_WDT_ResetCounter new API and few macros. | Usability enhancement. | |
| 1.60 | Updated cy_en_wdt_clk_sources_t enum and added support for CAT1D. | Code Enhancement and new device support added. |
| 1.50 | Added WDT_B type support required for CAT1C devices. Newly added APIs: Cy_WDT_SetLowerLimit(), Cy_WDT_SetUpperLimit(), Cy_WDT_SetWarnLimit(), Cy_WDT_SetLowerAction(), Cy_WDT_SetUpperAction(), Cy_WDT_SetWarnAction(), Cy_WDT_SetAutoService(), Cy_WDT_SetDeepSleepPause(), Cy_WDT_SetHibernatePause(), Cy_WDT_SetDebugRun(), Cy_WDT_SetService(), | Support for new devices. |
| 1.40 | CAT1B, CAT1C devices support. Newly added API's Cy_WDT_SetClkSource() to configure the WDT clock source, Cy_WDT_GetClkSource() to get the WDT clock source configured, Cy_WDT_SetMatchBits() to configure the bit position above which the bits will be ignored for match, Cy_WDT_GetMatchBits() to get the bit position above which the bits will be ignored for match. | Support for new devices. |
| 1.30.1 | Minor documentation updates. | Removed MISRA 2004 compliance details and verified MISRA 2012 compliance. |
| 1.30 | Updated the following functions for the PSoC 64 devices: Cy_WDT_ClearInterrupt(), Cy_WDT_MaskInterrupt(), and Cy_WDT_UnmaskInterrupt(). | Added PSoC 64 device support. |
| Minor documentation updates. | Documentation enhancement. | |
| 1.20 | Added a new API function Cy_WDT_IsEnabled() | Enhancement based on usability feedback. |
| 1.10.1 | Added info that the WDT lock state is not retained during system Deep Sleep power mode. | Documentation updates. |
| 1.10 | Flattened the organization of the driver source code into the single source directory and the single include directory. | Driver library directory-structure simplification. |
| Removed critical section usage in the following functions: | Driver functions simplification | |
| Updated the Cy_WDT_Init(), Cy_WDT_Enable() to clear WDT interrupt. | Corner case reliability improvements | |
| Added register access layer. Use register access macros instead of direct register access using dereferenced pointers. | Makes register access device-independent, so that the PDL does not need to be recompiled for each supported part number. | |
| 1.0.2 | Minor documentation updates | Corrected info about a reset generation |
| 1.0.1 | General documentation updates | Added info about periodic interrupt generation use case |
| 1.0 | Initial version |
API Reference | |
| Macros | |
| Enums | |
| Functions | |