/*----------------------------------------------------------------------------
 * Copyright (c) <2013-2015>, <Huawei Technologies Co., Ltd>
 * All rights reserved.
 * 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. 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.
 *---------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
 * Notice of Export Control Law
 * ===============================================
 * Huawei LiteOS may be subject to applicable export control laws and regulations, which might
 * include those applicable to Huawei LiteOS of U.S. and the country in which you are located.
 * Import, export and usage of Huawei LiteOS in any manner by you shall be in compliance with such
 * applicable export control laws and regulations.
 *---------------------------------------------------------------------------*/

/**@defgroup los_err Error handling
 * @ingroup kernel
 */

#ifndef _LOS_ERR_H
#define _LOS_ERR_H

#include "los_base.h"

#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */


/**
 *@ingroup los_err
 *@brief Define the pointer to the error handling function.
 *
 *@par Description:
 *This API is used to define the pointer to the error handling function.
 *@attention
 *<ul>
 *<li>None.</li>
 *</ul>
 *
 *@param  pcFileName  [IN] Log file that stores error information.
 *@param  uwLineNo    [IN] Line number of the erroneous line.
 *@param  uwErrorNo   [IN] Error code.
 *@param  uwParaLen   [IN] Length of the input parameter pPara.
 *@param  pPara       [IN] User label of the error.
 *
 *@retval None.
 *@par Dependency:
 *<ul><li>los_err.h: the header file that contains the API declaration.</li></ul>
 *@see None.
 *@since Huawei LiteOS V100R001C00
 */
typedef VOID (*LOS_ERRORHANDLE_FUNC)(CHAR    *pcFileName,
                                     	UINT32   uwLineNo,		/**< Line number of the erroneous line.*/
                                     	UINT32   uwErrorNo,		/**< Error code. */
                                     	UINT32   uwParaLen,		/**< Length of the input parameter pPara.*/
                                     	VOID     *pPara);

/**
 *@ingroup los_err
 *@brief Error handling function.
 *
 *@par Description:
 *This API is used to perform different operations according to error types.
 *@attention
 *<ul>
 *<li>None</li>
 *</ul>
 *
 *@param  pcFileName  [IN] Log file that stores error information.
 *@param  uwLineNo    [IN] Line number of the erroneous line which should not be OS_ERR_MAGIC_WORD.
 *@param  uwErrorNo   [IN] Error code.
 *@param  uwParaLen   [IN] Length of the input parameter pPara.
 *@param  pPara       [IN] User label of the error.
 *
 *@retval LOS_OK The error is successfully processed.
 *@par Dependency:
 *<ul><li>los_err.h: the header file that contains the API declaration.</li></ul>
 *@see None
 *@since Huawei LiteOS V100R001C00
 */
extern UINT32 LOS_ErrHandle(CHAR *pcFileName, UINT32 uwLineNo,
                                UINT32 uwErrorNo, UINT32 uwParaLen,
                                VOID *pPara);

/**
 * @ingroup los_err
 * Error handling function structure.
 */
typedef struct tagUserErrFunc_S
{
    LOS_ERRORHANDLE_FUNC  pfnHook;  /**< Hook function for error handling.*/
} USER_ERR_FUNC_S;

/**
 * @ingroup los_err
 * Error handling function.
 */
extern USER_ERR_FUNC_S      g_stUserErrFunc;

enum LOS_MOUDLE_ID
{
    LOS_MOD_SYS              = 0x0,
    LOS_MOD_MEM              = 0x1,
    LOS_MOD_TSK              = 0x2,
    LOS_MOD_SWTMR            = 0x3,
    LOS_MOD_TICK             = 0x4,
    LOS_MOD_MSG              = 0x5,
    LOS_MOD_QUE              = 0x6,
    LOS_MOD_SEM              = 0x7,
    LOS_MOD_MBOX             = 0x8,
    LOS_MOD_HWI              = 0x9,
    LOS_MOD_HWWDG            = 0xa,
    LOS_MOD_CACHE            = 0xb,
    LOS_MOD_HWTMR            = 0xc,
    LOS_MOD_MMU              = 0xd,

    LOS_MOD_LOG              = 0xe,
    LOS_MOD_ERR              = 0xf,

    LOS_MOD_EXC              = 0x10,
    LOS_MOD_CSTK             = 0x11,

    LOS_MOD_MPU              = 0x12,
    LOS_MOD_NMHWI            = 0x13,
    LOS_MOD_TRACE            = 0x14,
    LOS_MOD_KNLSTAT          = 0x15,
    LOS_MOD_EVTTIME          = 0x16,
    LOS_MOD_THRDCPUP         = 0x17,
    LOS_MOD_IPC              = 0x18,
    LOS_MOD_STKMON           = 0x19,
    LOS_MOD_TIMER            = 0x1a,
    LOS_MOD_RESLEAKMON       = 0x1b,
    LOS_MOD_EVENT            = 0x1c,
    LOS_MOD_MUX              = 0X1d,
    LOS_MOD_CPUP             = 0x1e,
    LOS_MOD_RWLOCK           = 0x1f,
    LOS_MOD_SHELL            = 0x31,
    LOS_MOD_BUTT
};


#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */

#endif /* _LOS_ERR_H */
