 /*
 * Copyright (c) 2013 - 2016, Freescale Semiconductor, Inc.
 * Copyright 2016-2017 NXP
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of the copyright holder 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 HOLDER 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 _NT_SAFETY_PRV_H_
#define _NT_SAFETY_PRV_H_

#include "nt_types.h"

/**
 * \defgroup safety_private safety
 * \ingroup ntapi_private
 * Safety represent the safety check layer in the NXP Touch system,
 * it is the layer that is tightly coupled to hardware available on
 * the NXP MCU device.
 *
 * Each safety implements a set of private functions contained in the nt_safety_prv.h
 * file.
 *
 * \{
 */

/**
 * \defgroup gsafety_private General API
 * \ingroup safety_private
 * General API and definition over all safety.
 *
 * \{
 */

/**
 *  safety interface structure; safety uses this structure to register the entry points
 *  to its algorithms. This approach enables a kind-of polymorphism in the touch System.
 *  Safety functions are processed the same way from the System layer, regardless of the specific
 *  implementation. 
 */
struct nt_module_safety_interface
{
  int32_t (* init)(struct nt_module_data *module);    /*!< The initialization of the safety functions */
  int32_t (* process)(struct nt_module_data *module); /*!< Process the safey functions */
  const char* name;                                   /*!< A name of the variable of this type, used for FreeMASTER support purposes. */
};
      
#ifdef __cplusplus
extern "C" {
#endif

/**
 * \brief Init the safety functions for the module.
 * \param module Pointer to the where the module safety to be initialized.
 * \return The result of the operation.
 */
int32_t _nt_module_safety_init(struct nt_module_data *module);
  
/**
 * \brief Process the safety on the module.
 * \param module Pointer to the where the module safety to be processed.
 * \return The result of the operation.
 */
int32_t _nt_module_safety_process(struct nt_module_data *module);  

#ifdef __cplusplus
}
#endif

/** \} */ /* end of nt_safety private  group */
#endif    /* _NT_SAFETY_PRV_H_ */