freebsd-dev/sys/contrib/octeon-sdk/cvmx-platform.h
Juli Mallett cea2b8b915 Update the port of FreeBSD to Cavium Octeon to use the Cavium Simple Executive
library:
o) Increase inline unit / large function growth limits for MIPS to accommodate
   the needs of the Simple Executive, which uses a shocking amount of inlining.
o) Remove TARGET_OCTEON and use CPU_CNMIPS to do things required by cnMIPS and
   the Octeon SoC.
o) Add OCTEON_VENDOR_LANNER to use Lanner's allocation of vendor-specific
   board numbers, specifically to support the MR320.
o) Add OCTEON_BOARD_CAPK_0100ND to hard-wire configuration for the CAPK-0100nd,
   which improperly uses an evaluation board's board number and breaks board
   detection at runtime.  This board is sold by Portwell as the CAM-0100.
o) Add support for the RTC available on some Octeon boards.
o) Add support for the Octeon PCI bus.  Note that rman_[sg]et_virtual for IO
   ports can not work unless building for n64.
o) Clean up the CompactFlash driver to use Simple Executive macros and
   structures where possible (it would be advisable to use the Simple Executive
   API to set the PIO mode, too, but that is not done presently.)  Also use
   structures from FreeBSD's ATA layer rather than structures copied from
   Linux.
o) Print available Octeon SoC features on boot.
o) Add support for the Octeon timecounter.
o) Use the Simple Executive's routines rather than local copies for doing reads
   and writes to 64-bit addresses and use its macros for various device
   addresses rather than using local copies.
o) Rename octeon_board_real to octeon_is_simulation to reduce differences with
   Cavium-provided code originally written for Linux.  Also make it use the
   same simplified test that the Simple Executive and Linux both use rather
   than our complex one.
o) Add support for the Octeon CIU, which is the main interrupt unit, as a bus
   to use normal interrupt allocation and setup routines.
o) Use the Simple Executive's bootmem facility to allocate physical memory for
   the kernel, rather than assuming we know which addresses we can steal.
   NB: This may reduce the amount of RAM the kernel reports you as having if
       you are leaving large temporary allocations made by U-Boot allocated
       when starting FreeBSD.
o) Add a port of the Cavium-provided Ethernet driver for Linux.  This changes
   Ethernet interface naming from rgmxN to octeN.  The new driver has vast
   improvements over the old one, both in performance and functionality, but
   does still have some features which have not been ported entirely and there
   may be unimplemented code that can be hit in everyday use.  I will make
   every effort to correct those as they are reported.
o) Support loading the kernel on non-contiguous cores.
o) Add very conservative support for harvesting randomness from the Octeon
   random number device.
o) Turn SMP on by default.
o) Clean up the style of the Octeon kernel configurations a little and make
   them compile with -march=octeon.
o) Add support for the Lanner MR320 and the CAPK-0100nd to the Simple
   Executive.
o) Modify the Simple Executive to build on FreeBSD and to build without
   executive-config.h or cvmx-config.h.  In the future we may want to
   revert part of these changes and supply executive-config.h and
   cvmx-config.h and access to the options contained in those files via
   kernel configuration files.
o) Modify the Simple Executive USB routines to support getting and setting
   of the USB PID.
2010-07-20 19:25:11 +00:00

207 lines
6.1 KiB
C

/***********************license start***************
* Copyright (c) 2003-2008 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.
*
* 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.
*
*
* For any questions regarding licensing please contact marketing@caviumnetworks.com
*
***********************license end**************************************/
/**
* @file
*
* This file is resposible for including all system dependent
* headers for the cvmx-* files.
*
* <hr>$Revision: 41586 $<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
#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)
#define CVMX_SHARED
#else
#define CVMX_SHARED __attribute__ ((cvmx_shared))
#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>
#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)
#include <mips/cavium/cvmx_config.h>
#else
#error Unexpected CVMX_BUILD_FOR_* macro
#endif
#endif /* __CVMX_PLATFORM_H__ */