sys/contrib/octeon-sdk/cvmx-helper-check-defines.h

   1 /***********************license start***************
   2  *  Copyright (c) 2003-2008 Cavium Networks (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 Networks 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  *  TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
  24  *  AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
  25  *  OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
  26  *  RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
  27  *  REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
  28  *  DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
  29  *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
  30  *  PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
  31  *  POSSESSION OR CORRESPONDENCE TO DESCRIPTION.  THE ENTIRE RISK ARISING OUT
  32  *  OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
  33  *
  34  *
  35  *  For any questions regarding licensing please contact marketing@caviumnetworks.com
  36  *
  37  ***********************license end**************************************/
  38
  39
  40
  41
  42
  43
  44 /**
  45  * @file
  46  *
  47  * Validate defines required by cvmx-helper. This header file
  48  * validates a number of defines required for cvmx-helper to
  49  * function properly. It either supplies a default or fails
  50  * compile if a define is incorrect.
  51  *
  52  * <hr>$Revision: 41586 $<hr>
  53  */
  54 #ifndef __CVMX_HELPER_CHECK_DEFINES_H__
  55 #define __CVMX_HELPER_CHECK_DEFINES_H__
  56
  57 /* CVMX_HELPER_FIRST_MBUFF_SKIP is the number of bytes to reserve before
  58     the beginning of the packet. Override in executive-config.h */
  59 #ifndef CVMX_HELPER_FIRST_MBUFF_SKIP
  60 #define CVMX_HELPER_FIRST_MBUFF_SKIP 184
  61 #warning WARNING: default CVMX_HELPER_FIRST_MBUFF_SKIP used.  Defaults deprecated, please set in executive-config.h
  62 #endif
  63
  64 /* CVMX_HELPER_NOT_FIRST_MBUFF_SKIP is the number of bytes to reserve in each
  65     chained packet element. Override in executive-config.h */
  66 #ifndef CVMX_HELPER_NOT_FIRST_MBUFF_SKIP
  67 #define CVMX_HELPER_NOT_FIRST_MBUFF_SKIP 0
  68 #warning WARNING: default CVMX_HELPER_NOT_FIRST_MBUFF_SKIP used.  Defaults deprecated, please set in executive-config.h
  69 #endif
  70
  71 /* CVMX_HELPER_ENABLE_BACK_PRESSURE controls whether back pressure is enabled
  72     for all input ports. Override in executive-config.h */
  73 #ifndef CVMX_HELPER_ENABLE_BACK_PRESSURE
  74 #define CVMX_HELPER_ENABLE_BACK_PRESSURE 1
  75 #warning WARNING: default CVMX_HELPER_ENABLE_BACK_PRESSURE used.  Defaults deprecated, please set in executive-config.h
  76 #endif
  77
  78 /* CVMX_HELPER_ENABLE_IPD controls if the IPD is enabled in the helper
  79     function. Once it is enabled the hardware starts accepting packets. You
  80     might want to skip the IPD enable if configuration changes are need
  81     from the default helper setup. Override in executive-config.h */
  82 #ifndef CVMX_HELPER_ENABLE_IPD
  83 #define CVMX_HELPER_ENABLE_IPD 1
  84 #warning WARNING: default CVMX_HELPER_ENABLE_IPD used.  Defaults deprecated, please set in executive-config.h
  85 #endif
  86
  87 /* Set default (defaults are deprecated) input tag type */
  88 #ifndef  CVMX_HELPER_INPUT_TAG_TYPE
  89 #define  CVMX_HELPER_INPUT_TAG_TYPE CVMX_POW_TAG_TYPE_ORDERED
  90 #warning WARNING: default CVMX_HELPER_INPUT_TAG_TYPE used.  Defaults deprecated, please set in executive-config.h
  91 #endif
  92
  93 #ifndef CVMX_HELPER_INPUT_PORT_SKIP_MODE
  94 #define CVMX_HELPER_INPUT_PORT_SKIP_MODE        CVMX_PIP_PORT_CFG_MODE_SKIPL2
  95 #warning WARNING: default CVMX_HELPER_INPUT_PORT_SKIP_MODE used.  Defaults deprecated, please set in executive-config.h
  96 #endif
  97
  98 #if defined(CVMX_ENABLE_HELPER_FUNCTIONS) && !defined(CVMX_HELPER_INPUT_TAG_INPUT_PORT)
  99 #error CVMX_HELPER_INPUT_TAG_* values for determining tag hash inputs must be defined in executive-config.h
 100 #endif
 101
 102 #endif