1/***********************license start***************
2 * Copyright (c) 2003-2010  Cavium Inc. (support@cavium.com). All rights
3 * reserved.
4 *
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 *   * Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 *
13 *   * Redistributions in binary form must reproduce the above
14 *     copyright notice, this list of conditions and the following
15 *     disclaimer in the documentation and/or other materials provided
16 *     with the distribution.
17
18 *   * Neither the name of Cavium Inc. nor the names of
19 *     its contributors may be used to endorse or promote products
20 *     derived from this software without specific prior written
21 *     permission.
22
23 * This Software, including technical data, may be subject to U.S. export  control
24 * laws, including the U.S. Export Administration Act and its  associated
25 * regulations, and may be subject to export or import  regulations in other
26 * countries.
27
28 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
29 * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
30 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
31 * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
32 * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
33 * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
34 * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
35 * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
36 * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK ARISING OUT OF USE OR
37 * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
38 ***********************license end**************************************/
39
40
41
42/**
43 * @file
44 *
45 * Main Octeon executive header file (This should be the second header
46 * file included by an application).
47 *
48 * <hr>$Revision: 70030 $<hr>
49*/
50#ifndef __CVMX_H__
51#define __CVMX_H__
52
53/* Control whether simple executive applications use 1-1 TLB mappings to access physical
54** memory addresses.  This must be disabled to allow large programs that use more than
55** the 0x10000000 - 0x20000000 virtual address range.
56**
57** The FreeBSD kernel ifdefs elsewhere should mean that this is never even checked,
58** and so does not need to be defined.
59*/
60#if !defined(__FreeBSD__) || !defined(_KERNEL)
61#ifndef CVMX_USE_1_TO_1_TLB_MAPPINGS
62#define CVMX_USE_1_TO_1_TLB_MAPPINGS 1
63#endif
64#endif
65
66#if defined(__FreeBSD__) && defined(_KERNEL)
67    #ifndef CVMX_ENABLE_PARAMETER_CHECKING
68        #ifdef INVARIANTS
69            #define CVMX_ENABLE_PARAMETER_CHECKING 1
70        #else
71            #define CVMX_ENABLE_PARAMETER_CHECKING 0
72        #endif
73    #endif
74#else
75    #ifndef CVMX_ENABLE_PARAMETER_CHECKING
76        #define CVMX_ENABLE_PARAMETER_CHECKING 1
77    #endif
78#endif
79
80#ifndef CVMX_ENABLE_DEBUG_PRINTS
81#define CVMX_ENABLE_DEBUG_PRINTS 1
82#endif
83
84#ifdef	__cplusplus
85extern "C" {
86#endif
87
88#include "cvmx-platform.h"
89#include "cvmx-access.h"
90#include "cvmx-address.h"
91#include "cvmx-asm.h"
92#include "cvmx-packet.h"
93#include "cvmx-warn.h"
94#include "cvmx-sysinfo.h"
95#include "octeon-model.h"
96#include "cvmx-csr.h"
97#include "cvmx-utils.h"
98#include "cvmx-clock.h"
99#include "octeon-feature.h"
100
101#if defined(__mips__) && !defined(CVMX_BUILD_FOR_LINUX_HOST)
102#include "cvmx-access-native.h"
103#endif
104
105#ifdef	__cplusplus
106}
107#endif
108
109#endif  /*  __CVMX_H__  */
110