/***********************license start***************
 * Copyright (c) 2003-2010  Cavium Networks (support@cavium.com). All rights
 * reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * 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.

 *   * Neither the name of Cavium Networks 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, including technical data, may be subject to U.S. export  control
 * laws, including the U.S. Export Administration Act and its  associated
 * regulations, and may be subject to export or import  regulations in other
 * countries.

 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
 * AND WITH ALL FAULTS AND CAVIUM  NETWORKS MAKES NO PROMISES, REPRESENTATIONS OR
 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
 * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
 * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
 * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
 * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
 * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
 * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
 * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
 ***********************license end**************************************/







/**
 * @file
 *
 * This file is resposible for including all system dependent
 * headers for the cvmx-* files.
 *
 * <hr>$Revision: 49448 $<hr>
*/

#ifndef __CVMX_PLATFORM_H__
#define __CVMX_PLATFORM_H__

#include "cvmx-abi.h"

#ifdef __cplusplus
#define EXTERN_ASM extern "C"
#else
#define EXTERN_ASM extern
#endif

/* This file defines macros for use in determining the current
    building environment. It defines a single CVMX_BUILD_FOR_*
    macro representing the target of the build. The current
    possibilities are:
        CVMX_BUILD_FOR_UBOOT
        CVMX_BUILD_FOR_LINUX_KERNEL
        CVMX_BUILD_FOR_LINUX_USER
        CVMX_BUILD_FOR_LINUX_HOST
        CVMX_BUILD_FOR_VXWORKS
        CVMX_BUILD_FOR_STANDALONE */
#if defined(__U_BOOT__)
    /* We are being used inside of Uboot */
    #define CVMX_BUILD_FOR_UBOOT
#elif defined(__linux__)
    #if defined(__KERNEL__)
        /* We are in the Linux kernel on Octeon */
        #define CVMX_BUILD_FOR_LINUX_KERNEL
    #elif !defined(__mips__)
        /* We are being used under Linux but not on Octeon. Assume
            we are on a Linux host with an Octeon target over PCI/PCIe */
        #ifndef CVMX_BUILD_FOR_LINUX_HOST
        #define CVMX_BUILD_FOR_LINUX_HOST
        #endif
    #else
        #ifdef CVMX_BUILD_FOR_LINUX_HOST
            /* This is a manual special case. The host PCI utilities can
                be configured to run on Octeon. In this case it is impossible
                to tell the difference between the normal userspace setup
                and using cvmx_read/write_csr over the PCI bus. The host
                utilites force this define to fix this */
        #else
            /* We are in the Linux userspace on Octeon */
            #define CVMX_BUILD_FOR_LINUX_USER
        #endif
    #endif
#elif defined(_WRS_KERNEL) || defined(VXWORKS_USER_MAPPINGS)
    /* We are in VxWorks on Octeon */
    #define CVMX_BUILD_FOR_VXWORKS
#elif defined(_OCTEON_TOOLCHAIN_RUNTIME)
    /* To build the simple exec toolchain runtime (newlib) library. We
       should only use features available on all Octeon models.  */
    #define CVMX_BUILD_FOR_TOOLCHAIN
#elif defined(__FreeBSD__) && defined(_KERNEL)
    #define CVMX_BUILD_FOR_FREEBSD_KERNEL
#else
    /* We are building a simple exec standalone image for Octeon */
    #define CVMX_BUILD_FOR_STANDALONE
#endif


/* To have a global variable be shared among all cores,
 * declare with the CVMX_SHARED attribute.  Ex:
 * CVMX_SHARED int myglobal;
 * This will cause the variable to be placed in a special
 * section that the loader will map as shared for all cores
 * This is for data structures use by software ONLY,
 * as it is not 1-1 VA-PA mapped.
 */
#if defined(CVMX_BUILD_FOR_FREEBSD_KERNEL)
#define CVMX_SHARED
#else
#ifndef CVMX_BUILD_FOR_LINUX_HOST
#define CVMX_SHARED __attribute__ ((cvmx_shared))
#else
#define CVMX_SHARED
#endif
#endif

#if defined(CVMX_BUILD_FOR_UBOOT)

    #include <common.h>
    #include "cvmx-sysinfo.h"

#elif defined(CVMX_BUILD_FOR_LINUX_KERNEL)

    #include <linux/kernel.h>
    #include <linux/string.h>
    #include <linux/types.h>
    #include <stdarg.h>

#elif defined(CVMX_BUILD_FOR_LINUX_USER)

    #include <stddef.h>
    #include <stdint.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <stdarg.h>
    #include <string.h>
    #include <assert.h>
    #include <fcntl.h>
    #include <sys/mman.h>
    #include <unistd.h>
    #include <errno.h>
    #include <sys/sysmips.h>
    #define MIPS_CAVIUM_XKPHYS_READ	   2010	/* XKPHYS */
    #define MIPS_CAVIUM_XKPHYS_WRITE	   2011	/* XKPHYS */

/* Enable access to XKPHYS segments. Warning message is printed in case of
   error. If warn_count is set, the warning message is not displayed. */
static inline void cvmx_linux_enable_xkphys_access(int32_t warn_count)
{
    int ret;
    ret = sysmips(MIPS_CAVIUM_XKPHYS_WRITE, getpid(), 3, 0);
    if (ret != 0 && !warn_count) {
        switch(errno) {
            case EINVAL:
                perror("sysmips(MIPS_CAVIUM_XKPHYS_WRITE) failed.\n"
	             "  Did you configure your kernel with both:\n"
	             "     CONFIG_CAVIUM_OCTEON_USER_MEM_PER_PROCESS *and*\n"
	             "     CONFIG_CAVIUM_OCTEON_USER_IO_PER_PROCESS?");
                break;
            case EPERM:
                perror("sysmips(MIPS_CAVIUM_XKPHYS_WRITE) failed.\n"
	             "  Are you running as root?");
                break;
            default:
                perror("sysmips(MIPS_CAVIUM_XKPHYS_WRITE) failed");
                break;
        }
    }
}

#elif defined(CVMX_BUILD_FOR_LINUX_HOST)

    #include <stddef.h>
    #include <stdint.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <stdarg.h>
    #include <string.h>
    #include <assert.h>
    #include <fcntl.h>
    #include <sys/mman.h>
    #include <unistd.h>

#elif defined(CVMX_BUILD_FOR_VXWORKS)

    #include <stdint.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <stdarg.h>
    #include <string.h>
    #include <assert.h>

#elif defined(CVMX_BUILD_FOR_STANDALONE)

    #include <stddef.h>
    #include <stdint.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <stdarg.h>
    #include <string.h>
    #include <assert.h>

#elif defined(CVMX_BUILD_FOR_TOOLCHAIN)

    #include <stddef.h>
    #include <stdint.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <stdarg.h>
    #include <string.h>
    #include <assert.h>

#elif defined(CVMX_BUILD_FOR_FREEBSD_KERNEL)

    #include <mips/cavium/cvmx_config.h>

#else

    #error Unexpected CVMX_BUILD_FOR_* macro

#endif

#endif /* __CVMX_PLATFORM_H__ */