/*************************************************************************************************/
/*!
 *  \file
 *
 *  \brief  System hooks.
 *
 *  Copyright (c) 2016-2019 Arm Ltd. All Rights Reserved.
 *
 *  Copyright (c) 2019-2020 Packetcraft, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
/*************************************************************************************************/

#ifndef PAL_SYS_H
#define PAL_SYS_H

#include "pal_types.h"

#ifdef __cplusplus
extern "C" {
#endif

/*! \addtogroup PAL_SYS
 *  \{ */

/**************************************************************************************************
  Macros
**************************************************************************************************/

/*! \brief      Total size in bytes of free memory. */
#ifndef FREE_MEM_SIZE
#define FREE_MEM_SIZE (1024 * 6)
#endif

/* Common error handling routines; for use with PAL implementation only. */

#ifdef DEBUG

/*! \brief      Parameter check. */
#define PAL_SYS_ASSERT(expr)    \
    {                           \
        if (!(expr))            \
        {                       \
            PalSysAssertTrap(); \
        }                       \
    }

#else

/*! \brief      Parameter check (disabled). */
#define PAL_SYS_ASSERT(expr)

#endif

/**************************************************************************************************
  Function Declarations
**************************************************************************************************/

extern uint8_t *SystemHeapStart;
extern uint32_t SystemHeapSize;

/* Initialization */
void PalSysInit(void);

/* Diagnostics */
void PalSysAssertTrap(void);
void PalSysSetTrap(bool_t enable);
uint32_t PalSysGetAssertCount(void);
uint32_t PalSysGetStackUsage(void);

/* Power Management */
void PalSysSleep(void);
bool_t PalSysIsBusy(void);
void PalSysSetBusy(void);
void PalSysSetIdle(void);

/* Critical Section */
uint32_t PalEnterCs(void);
void PalExitCs(uint32_t lock);

uint32_t PalSysTickElapse(void);
uint32_t PalSysTickGet(void);
/*! \} */ /* PAL_SYS */

#ifdef __cplusplus
};
#endif

#endif /* PAL_SYS_H */