/*******************************************************************************
    Copyright (c) 2015 NVidia Corporation

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to
    deal in the Software without restriction, including without limitation the
    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
    sell copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*******************************************************************************/


#ifndef _NVLINK_COMMON_H_
#define _NVLINK_COMMON_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "nvtypes.h"

#ifndef NULL
#define NULL ((void *)0)
#endif

#define NVL_DBG_INFO       0x0
#define NVL_DBG_SETUP      0x1
#define NVL_DBG_USERERRORS 0x2
#define NVL_DBG_WARNINGS   0x3
#define NVL_DBG_ERRORS     0x4

#define NVL_FREE(x) nvl_free((void *)x)

typedef int                 NvlStatus;


void        nvl_print(int, const char *, ...);
void       *nvl_malloc(NvLength);
void        nvl_free(void *);
char       *nvl_strcpy(char *, const char *);
NvLength    nvl_strlen(const char *);
int         nvl_strcmp(const char *, const char *);
int         nvl_snprintf(char *, NvLength, const char *, ...);
void       *nvl_memset(void *, int, NvLength);
void       *nvl_memcpy(void *, void *, NvLength);
int         nvlMemRd32(const volatile void *);
int         nvlMemRd64(const volatile void *);
void        nvl_assert(int expression);
void        nvl_sleep(unsigned int ms);

/*
 * Initializes core lib and does all that is needed
 * to access NVLINK functionality on the current platform.
 */
NvlStatus nvlink_lib_initialize(void);

/*
 * Frees any related resources and then unloads core lib. 
 */
NvlStatus nvlink_lib_unload(void);


#ifdef __cplusplus
}
#endif

#endif //_NVLINK_COMMON_H_
