WatchdogMSP432.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS 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.
 */
/*!****************************************************************************
 *  @file       WatchdogMSP432.h
 *
 *  @brief      Watchdog driver implementation for MSP432
 *
 *  The Watchdog header file for MSP432 should be included in an application
 *  as follows:
 *  @code
 *  #include <ti/drivers/Watchdog.h>
 *  #include <ti/drivers/watchdog/WatchdogMSP432.h>
 *  @endcode
 *
 *  Refer to @ref Watchdog.h for a complete description of APIs & example of
 *  use.
 *
 *  ## Overview #
 *  The MSP432 Watchdog Timer will cause resets at an interval based on the
 *  count calculated from the clock source and clock divider specified in the
 *  WatchdogMSP432_HWAttrs. By default the Watchdog driver has resets turned on.
 *  This means that if Watchdog_clear() is not called to reset the Watchdog
 *  timer before it times out, a reset will be generated. Watchdog_close() will
 *  stop the Watchdog timer. To restart it again, Watchdog_open() must be
 *  called.
 *
 *  Opening the Watchdog driver with resets turned off (Using the
 *  #Watchdog_Params.resetMode parameter) allows the Watchdog Timer to be used
 *  like another timer interrupt.  The callback fxn provided in the params will
 *  be executed when the timer expires.
 *
 *  @warning The watchdog peripheral does not support a Non-Maskable Interrupt (NMI).
 *
 *  ## Unsupported Functionality #
 *  1.  #Watchdog_Params.debugStallMode is not supported by this implementation.
 *  2.  #Watchdog_Params.callbackFxn is not supported when using
 *  #Watchdog_RESET_ON mode.
 *  3.  Watchdog_setReload() and Watchdog_convertMsToTicks() APIs are not
 *  supported by this implementation.
 ******************************************************************************
 */

#ifndef ti_drivers_watchdog_WatchdogMSP432__include
#define ti_drivers_watchdog_WatchdogMSP432__include

#include <stdint.h>
#include <stdbool.h>

#include <ti/drivers/Watchdog.h>

#include <ti/drivers/dpl/HwiP.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Add WatchdogMSP432_STATUS_* macros here */

/* Add WatchdogMSP432_CMD_* macros here */

extern const Watchdog_FxnTable WatchdogMSP432_fxnTable;

typedef struct {
    uint32_t baseAddr;     
    uint8_t  intNum;       
    uint8_t  intPriority;  
    uint8_t  clockSource;  
    uint8_t  clockDivider; 
} WatchdogMSP432_HWAttrs;

typedef struct {
    Watchdog_ResetMode resetMode;
    HwiP_Handle        hwiHandle;
    bool               isOpen; /* Flag for open/close status */
} WatchdogMSP432_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_watchdog_WatchdogMSP432__include */