/***********************************************************************
 *
<:copyright-BRCM:2019:DUAL/GPL:standard

   Copyright (c) 2019 Broadcom 
   All Rights Reserved

Unless you and Broadcom execute a separate written software license
agreement governing use of this software, this software is licensed
to you under the terms of the GNU General Public License version 2
(the "GPL"), available at http://www.broadcom.com/licenses/GPLv2.php,
with the following added to such license:

   As a special exception, the copyright holders of this software give
   you permission to link this software with independent modules, and
   to copy and distribute the resulting executable under terms of your
   choice, provided that you also meet, for each linked independent
   module, the terms and conditions of the license of that module.
   An independent module is a module which is not derived from this
   software.  The special exception does not apply to any modifications
   of the software.

Not withstanding the above, under no circumstances may you combine
this software in any way with any other Broadcom software provided
under a license other than the GPL, without Broadcom's express prior
written consent.

:>
 *
************************************************************************/

#ifndef __SYSUTIL_H__
#define __SYSUTIL_H__

/*!\file sysutil.h
 * \brief Header file for various system utility functions. 
 *
 */
#include "number_defs.h"
#include "bcm_retcodes.h"

/** Get the thread id of the calling process.  For single threaded processes,
 *  the thread id is the same as process id (pid).
 *
 * @return the thread id.
 */
int sysUtl_getThreadId();

/** Same as sysUtl_getThreadId().
 */
int sysUtl_gettid();


/** Return the number of CPU threads on system.
 *
 * @returns At least 1.
 */
UINT32 sysUtil_getNumCpuThreads(void);

/** Get frequency and architecture information of the given processor ID.
 *
 * @param index        (IN)  The 0-based processor index.
 * @param frequency    (OUT) The processor frequency in MHz
 * @param architecture (OUT) Caller must pass in buffer of at least 32 bytes.
 * 
 * Return BcmRet
 */
BcmRet sysUtil_getCpuInfo(UINT32 index, UINT32 *frequency, char *architecture);

#endif /* __SYSUTIL_H__ */