Watchdog.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, 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.
 */
#ifndef ti_drivers_Watchdog__include
#define ti_drivers_Watchdog__include

#ifdef __cplusplus
extern "C" {
#endif


#include <stdint.h>

#define Watchdog_CMD_RESERVED            32

#define Watchdog_STATUS_RESERVED        -32

#define Watchdog_STATUS_SUCCESS         0

#define Watchdog_STATUS_ERROR          -1

#define Watchdog_STATUS_UNDEFINEDCMD   -2

/* Add Watchdog_CMD_<commands> here */

typedef struct Watchdog_Config *Watchdog_Handle;

typedef enum Watchdog_DebugMode {
    Watchdog_DEBUG_STALL_ON, 
    Watchdog_DEBUG_STALL_OFF 
} Watchdog_DebugMode;

typedef enum Watchdog_ResetMode {
    Watchdog_RESET_OFF, 
    Watchdog_RESET_ON   
} Watchdog_ResetMode;

typedef void (*Watchdog_Callback)(uintptr_t);

typedef struct Watchdog_Params {
    Watchdog_Callback   callbackFxn;    
    Watchdog_ResetMode  resetMode;      
    Watchdog_DebugMode  debugStallMode; 
    uintptr_t           custom;         
} Watchdog_Params;

typedef void (*Watchdog_ClearFxn)       (Watchdog_Handle handle);

typedef void (*Watchdog_CloseFxn)       (Watchdog_Handle handle);

typedef int  (*Watchdog_ControlFxn)     (Watchdog_Handle handle,
                                         unsigned int cmd,
                                         void *arg);

typedef void (*Watchdog_InitFxn)        (Watchdog_Handle handle);

typedef Watchdog_Handle (*Watchdog_OpenFxn)  (Watchdog_Handle handle,
                                              Watchdog_Params *params);

typedef void (*Watchdog_SetReloadFxn)   (Watchdog_Handle handle, uint32_t ticks);

typedef uint32_t (*Watchdog_ConvertMsToTicksFxn)   (uint32_t milliseconds);

typedef struct Watchdog_FxnTable {
    Watchdog_ClearFxn             watchdogClear;
    Watchdog_CloseFxn             watchdogClose;
    Watchdog_ControlFxn           watchdogControl;
    Watchdog_InitFxn              watchdogInit;
    Watchdog_OpenFxn              watchdogOpen;
    Watchdog_SetReloadFxn         watchdogSetReload;
    Watchdog_ConvertMsToTicksFxn  watchdogConvertMsToTicks;
} Watchdog_FxnTable;

typedef struct Watchdog_Config {
    Watchdog_FxnTable const *fxnTablePtr;

    void                    *object;

    void              const *hwAttrs;
} Watchdog_Config;

extern void Watchdog_clear(Watchdog_Handle handle);

extern void Watchdog_close(Watchdog_Handle handle);

extern int Watchdog_control(Watchdog_Handle handle,
                            unsigned int cmd,
                            void *arg);

extern void Watchdog_init(void);

extern Watchdog_Handle Watchdog_open(unsigned int index, Watchdog_Params *params);

extern void Watchdog_Params_init(Watchdog_Params *params);

extern void Watchdog_setReload(Watchdog_Handle handle, uint32_t ticks);

extern uint32_t Watchdog_convertMsToTicks(Watchdog_Handle handle, uint32_t milliseconds);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_Watchdog__include */