/**
* \file
*
* \brief SAM Watchdog Driver for SAMB
*
* Copyright (c) 2015 Atmel Corporation. All rights reserved.
*
* \asf_license_start
*
* \page License
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The name of Atmel may not be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 4. This software may only be redistributed and used in connection with an
* Atmel microcontroller product.
*
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* \asf_license_stop
*
*/
/*
* Support and FAQ: visit Atmel Support
*/
#ifndef WDT_SAM_B_H_INCLUDED
#define WDT_SAM_B_H_INCLUDED
/**
* \defgroup asfdoc_samb_wdt_group SAM Watchdog Driver (WDT)
*
* This driver for Atmel® | SMART SAM devices provides an interface for the configuration
* and management of the device's Watchdog Timer module, including the enabling,
* disabling, and kicking within the device.
*
* The following peripherals are used by this module:
* - WDT (Watchdog Timer)
*
* The following devices can use this module:
* - Atmel | SMART SAM B11
*
* The outline of this documentation is as follows:
* - \ref asfdoc_samb_wdt_prerequisites
* - \ref asfdoc_samb_wdt_module_overview
* - \ref asfdoc_samb_wdt_special_considerations
* - \ref asfdoc_samb_wdt_extra_info
* - \ref asfdoc_samb_wdt_examples
* - \ref asfdoc_samb_wdt_api_overview
*
*
* \section asfdoc_samb_wdt_prerequisites Prerequisites
*
* There are no prerequisites for this module.
*
*
* \section asfdoc_samb_wdt_module_overview Module Overview
* The watchdog module is based on a 32-bit down-counter that is initialized
* from the Reload Register. The watchdog module generates a regular interrupt,
* depending on a programmed value. The counter decrements by one on each
* positive clock edge of clock when the clock is enable. The watchdog monitors
* the interrupt and asserts a reset request signal when the counter reaches 0,
* and the counter is stopped. On the next enabled clock edge, the counter is
* reloaded from the WDT load Register and the countdown sequence continues. If
* the interrupt is not cleared by the time the counter next reaches 0, the
* watchdog module reasserts the reset signal.
*
* A simplified block diagram of the WDT can be seen in
* \ref asfdoc_samb_wdt_module_block_diagram "the figure below".
*
* \anchor asfdoc_samb_wdt_module_block_diagram
* \image html wdt_block_diagram.svg "WDT Block Diagram"
*
* \section asfdoc_samb_wdt_special_considerations Special Considerations
* There are no special considerations for this module.
*
* \section asfdoc_samb_wdt_extra_info Extra Information
*
* For extra information, see \ref asfdoc_samb_wdt_extra. This includes:
* - \ref asfdoc_samb_wdt_extra_acronyms
* - \ref asfdoc_samb_wdt_extra_dependencies
* - \ref asfdoc_samb_wdt_extra_errata
* - \ref asfdoc_samb_wdt_extra_history
*
*
* \section asfdoc_samb_wdt_examples Examples
*
* For a list of examples related to this driver, see
* \ref asfdoc_samb_wdt_exqsg.
*
* \section asfdoc_samb_wdt_api_overview API Overview
* @{
*/
#include
#include
#ifdef __cplusplus
extern "C" {
#endif
#define WDT_WRITE_ACCESS_KEY 0x1ACCE551
struct wdt_module;
/** Type definition for a WDT module callback function. */
typedef void (*wdt_callback_t)(void);
/** Enum for the possible callback types for the WDT module. */
enum wdt_callback
{
/**
* Callback type for when an early warning callback from the WDT module
* is issued
*/
WDT_CALLBACK_EARLY_WARNING,
/** Number of available callbacks */
WDT_CALLBACK_N,
};
/**
* \brief Watchdog Timer configuration structure.
*
* Configuration structure for a Watchdog Timer instance. This
* structure should be initialized by the \ref wdt_get_config_defaults()
* function before being modified by the user application.
*/
struct wdt_config {
/** Watchdog load value */
uint32_t load_value;
/** Enable reset output */
bool enable_reset;
/** Enable write access */
bool write_access;
};
/**
* \brief WDT driver software device instance structure.
*
* WDT driver software instance structure, used to retain software
* state information of an associated hardware module instance.
*
* \note The fields of this structure should not be altered by the user
* application; they are reserved for module-internal use only.
*/
struct wdt_module {
#if !defined(__DOXYGEN__)
/** Pointer to the hardware instance */
Wdt *hw;
/** Array to store callback function pointers in */
wdt_callback_t callback[WDT_CALLBACK_N];
/** Bit mask for callbacks registered */
uint8_t callback_reg_mask;
/** Bit mask for callbacks enabled */
uint8_t callback_enable_mask;
#endif
};
/**
* \name Configuration and Initialization
* @{
*/
void wdt_get_config_defaults(struct wdt_config *const config);
enum status_code wdt_set_config(struct wdt_module *const module, Wdt * const hw, \
const struct wdt_config *const config);
/** @} */
/**
* \name Reset
* @{
*/
void wdt_reset(struct wdt_module *const module);
/** @} */
/**
* \name Get and Clear status
* @{
*/
uint8_t wdt_get_interrupt_status(struct wdt_module *const module);
uint8_t wdt_get_status(struct wdt_module *const module);
void wdt_clear_status(struct wdt_module *const module);
/** @} */
/**
* \name Reload and get count value
* @{
*/
enum status_code wdt_set_reload_count(struct wdt_module *const module, \
uint32_t load_value);
void wdt_get_current_count(struct wdt_module *const module, \
uint32_t * count_value);
/** @} */
/**
* \name Callback
* @{
*/
void wdt_register_callback(struct wdt_module *const module,
wdt_callback_t callback_func,
enum wdt_callback callback_type);
void wdt_unregister_callback(struct wdt_module *module,
enum wdt_callback callback_type);
void wdt_enable_callback(struct wdt_module *module,
enum wdt_callback callback_type);
void wdt_disable_callback(struct wdt_module *const module,
enum wdt_callback callback_type);
/** @} */
/** @} */
#ifdef __cplusplus
}
#endif
/** @} */
/**
* \page asfdoc_samb_wdt_extra Extra Information for WDT Driver
*
* \section asfdoc_samb_wdt_extra_acronyms Acronyms
* The table below presents the acronyms used in this module:
*
*
*
* | Acronym |
* Description |
*
*
* | WDT |
* Watchdog Timer |
*
*
*
*
* \section asfdoc_samb_wdt_extra_dependencies Dependencies
* There are no dependencies related to this driver.
*
*
* \section asfdoc_samb_wdt_extra_errata Errata
* There are no errata related to this driver.
*
*
* \section asfdoc_samb_wdt_extra_history Module History
* An overview of the module history is presented in the table below, with
* details on the enhancements and fixes made to the module since its first
* release. The current version of this corresponds to the newest version in
* the table.
*
*
*
* | Changelog |
*
*
* | Initial Release |
*
*
*/
/**
* \page asfdoc_samb_wdt_exqsg Examples for WDT Driver
*
* This is a list of the available Quick Start guides (QSGs) and example
* applications for \ref asfdoc_samb_wdt_group. QSGs are simple examples with
* step-by-step instructions to configure and use this driver in a selection of
* use cases. Note that QSGs can be compiled as a standalone application or be
* added to the user application.
*
* - \subpage asfdoc_samb_wdt_basic_use_case
*
* \page asfdoc_samb_wdt_document_revision_history Document Revision History
*
*
*
* | Doc. Rev.
* | Date
* | Comments
* |
*
* | A |
* 09/2015 |
* Initial release |
*
*
*/
#endif /* WDT_H_INCLUDED */