1 /**********************************************************************
2  * Author: Cavium Networks
3  *
4  * Contact: support@caviumnetworks.com
5  * This file is part of the OCTEON SDK
6  *
7  * Copyright (c) 2003-2007 Cavium Networks
8  *
9  * This file is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License, Version 2, as
11  * published by the Free Software Foundation.
12  *
13  * This file is distributed in the hope that it will be useful, but
14  * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
16  * NONINFRINGEMENT.  See the GNU General Public License for more
17  * details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this file; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22  * or visit http://www.gnu.org/licenses/.
23  *
24  * This file may also be available under a different license from Cavium.
25  * Contact Cavium Networks for more information
26 **********************************************************************/
27 
28 /*
29  * A few defines are used to control the operation of this driver:
30  *  CONFIG_CAVIUM_RESERVE32
31  *      This kernel config options controls the amount of memory configured
32  *      in a wired TLB entry for all processes to share. If this is set, the
33  *      driver will use this memory instead of kernel memory for pools. This
34  *      allows 32bit userspace application to access the buffers, but also
35  *      requires all received packets to be copied.
36  *  CONFIG_CAVIUM_OCTEON_NUM_PACKET_BUFFERS
37  *      This kernel config option allows the user to control the number of
38  *      packet and work queue buffers allocated by the driver. If this is zero,
39  *      the driver uses the default from below.
40  *  USE_SKBUFFS_IN_HW
41  *      Tells the driver to populate the packet buffers with kernel skbuffs.
42  *      This allows the driver to receive packets without copying them. It also
43  *      means that 32bit userspace can't access the packet buffers.
44  *  USE_HW_TCPUDP_CHECKSUM
45  *      Controls if the Octeon TCP/UDP checksum engine is used for packet
46  *      output. If this is zero, the kernel will perform the checksum in
47  *      software.
48  *  USE_ASYNC_IOBDMA
49  *      Use asynchronous IO access to hardware. This uses Octeon's asynchronous
50  *      IOBDMAs to issue IO accesses without stalling. Set this to zero
51  *      to disable this. Note that IOBDMAs require CVMSEG.
52  *  REUSE_SKBUFFS_WITHOUT_FREE
53  *      Allows the TX path to free an skbuff into the FPA hardware pool. This
54  *      can significantly improve performance for forwarding and bridging, but
55  *      may be somewhat dangerous. Checks are made, but if any buffer is reused
56  *      without the proper Linux cleanup, the networking stack may have very
57  *      bizarre bugs.
58  */
59 #ifndef __ETHERNET_DEFINES_H__
60 #define __ETHERNET_DEFINES_H__
61 
62 #include "cvmx-config.h"
63 
64 
65 #define OCTEON_ETHERNET_VERSION "1.9"
66 
67 #ifndef CONFIG_CAVIUM_RESERVE32
68 #define CONFIG_CAVIUM_RESERVE32 0
69 #endif
70 
71 #define USE_SKBUFFS_IN_HW           1
72 #ifdef CONFIG_NETFILTER
73 #define REUSE_SKBUFFS_WITHOUT_FREE  0
74 #else
75 #define REUSE_SKBUFFS_WITHOUT_FREE  1
76 #endif
77 
78 #define USE_HW_TCPUDP_CHECKSUM      1
79 
80 /* Enable Random Early Dropping under load */
81 #define USE_RED                     1
82 #define USE_ASYNC_IOBDMA            (CONFIG_CAVIUM_OCTEON_CVMSEG_SIZE > 0)
83 
84 /*
85  * Allow SW based preamble removal at 10Mbps to workaround PHYs giving
86  * us bad preambles.
87  */
88 #define USE_10MBPS_PREAMBLE_WORKAROUND 1
89 /*
90  * Use this to have all FPA frees also tell the L2 not to write data
91  * to memory.
92  */
93 #define DONT_WRITEBACK(x)           (x)
94 /* Use this to not have FPA frees control L2 */
95 /*#define DONT_WRITEBACK(x)         0   */
96 
97 /* Maximum number of SKBs to try to free per xmit packet. */
98 #define MAX_OUT_QUEUE_DEPTH 1000
99 
100 #define FAU_TOTAL_TX_TO_CLEAN (CVMX_FAU_REG_END - sizeof(uint32_t))
101 #define FAU_NUM_PACKET_BUFFERS_TO_FREE (FAU_TOTAL_TX_TO_CLEAN - sizeof(uint32_t))
102 
103 #define TOTAL_NUMBER_OF_PORTS       (CVMX_PIP_NUM_INPUT_PORTS+1)
104 
105 
106 #endif /* __ETHERNET_DEFINES_H__ */
107