xref: /linux/arch/mips/include/asm/octeon/cvmx-helper.h (revision 03ab8e6297acd1bc0eedaa050e2a1635c576fd11)
1 /***********************license start***************
2  * Author: Cavium Networks
3  *
4  * Contact: support@caviumnetworks.com
5  * This file is part of the OCTEON SDK
6  *
7  * Copyright (c) 2003-2008 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  ***********************license end**************************************/
27 
28 /*
29  *
30  * Helper functions for common, but complicated tasks.
31  *
32  */
33 
34 #ifndef __CVMX_HELPER_H__
35 #define __CVMX_HELPER_H__
36 
37 #include <asm/octeon/cvmx-config.h>
38 #include <asm/octeon/cvmx-fpa.h>
39 #include <asm/octeon/cvmx-wqe.h>
40 
41 typedef enum {
42 	CVMX_HELPER_INTERFACE_MODE_DISABLED,
43 	CVMX_HELPER_INTERFACE_MODE_RGMII,
44 	CVMX_HELPER_INTERFACE_MODE_GMII,
45 	CVMX_HELPER_INTERFACE_MODE_SPI,
46 	CVMX_HELPER_INTERFACE_MODE_PCIE,
47 	CVMX_HELPER_INTERFACE_MODE_XAUI,
48 	CVMX_HELPER_INTERFACE_MODE_SGMII,
49 	CVMX_HELPER_INTERFACE_MODE_PICMG,
50 	CVMX_HELPER_INTERFACE_MODE_NPI,
51 	CVMX_HELPER_INTERFACE_MODE_LOOP,
52 } cvmx_helper_interface_mode_t;
53 
54 union cvmx_helper_link_info {
55 	uint64_t u64;
56 	struct {
57 		uint64_t reserved_20_63:44;
58 		uint64_t link_up:1;	    /**< Is the physical link up? */
59 		uint64_t full_duplex:1;	    /**< 1 if the link is full duplex */
60 		uint64_t speed:18;	    /**< Speed of the link in Mbps */
61 	} s;
62 };
63 
64 #include <asm/octeon/cvmx-helper-errata.h>
65 #include <asm/octeon/cvmx-helper-loop.h>
66 #include <asm/octeon/cvmx-helper-npi.h>
67 #include <asm/octeon/cvmx-helper-rgmii.h>
68 #include <asm/octeon/cvmx-helper-sgmii.h>
69 #include <asm/octeon/cvmx-helper-spi.h>
70 #include <asm/octeon/cvmx-helper-util.h>
71 #include <asm/octeon/cvmx-helper-xaui.h>
72 
73 /**
74  * This function enables the IPD and also enables the packet interfaces.
75  * The packet interfaces (RGMII and SPI) must be enabled after the
76  * IPD.	 This should be called by the user program after any additional
77  * IPD configuration changes are made if CVMX_HELPER_ENABLE_IPD
78  * is not set in the executive-config.h file.
79  *
80  * Returns 0 on success
81  *	   -1 on failure
82  */
83 extern int cvmx_helper_ipd_and_packet_input_enable(void);
84 
85 /**
86  * Initialize the PIP, IPD, and PKO hardware to support
87  * simple priority based queues for the ethernet ports. Each
88  * port is configured with a number of priority queues based
89  * on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower
90  * priority than the previous.
91  *
92  * Returns Zero on success, non-zero on failure
93  */
94 extern int cvmx_helper_initialize_packet_io_global(void);
95 
96 /**
97  * Returns the number of ports on the given interface.
98  * The interface must be initialized before the port count
99  * can be returned.
100  *
101  * @interface: Which interface to return port count for.
102  *
103  * Returns Port count for interface
104  *	   -1 for uninitialized interface
105  */
106 extern int cvmx_helper_ports_on_interface(int interface);
107 
108 /**
109  * Return the number of interfaces the chip has. Each interface
110  * may have multiple ports. Most chips support two interfaces,
111  * but the CNX0XX and CNX1XX are exceptions. These only support
112  * one interface.
113  *
114  * Returns Number of interfaces on chip
115  */
116 extern int cvmx_helper_get_number_of_interfaces(void);
117 
118 /**
119  * Get the operating mode of an interface. Depending on the Octeon
120  * chip and configuration, this function returns an enumeration
121  * of the type of packet I/O supported by an interface.
122  *
123  * @interface: Interface to probe
124  *
125  * Returns Mode of the interface. Unknown or unsupported interfaces return
126  *	   DISABLED.
127  */
128 extern cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int
129 								   interface);
130 
131 /**
132  * Return the link state of an IPD/PKO port as returned by
133  * auto negotiation. The result of this function may not match
134  * Octeon's link config if auto negotiation has changed since
135  * the last call to cvmx_helper_link_set().
136  *
137  * @ipd_port: IPD/PKO port to query
138  *
139  * Returns Link state
140  */
141 extern union cvmx_helper_link_info cvmx_helper_link_get(int ipd_port);
142 
143 /**
144  * Configure an IPD/PKO port for the specified link state. This
145  * function does not influence auto negotiation at the PHY level.
146  * The passed link state must always match the link state returned
147  * by cvmx_helper_link_get().
148  *
149  * @ipd_port:  IPD/PKO port to configure
150  * @link_info: The new link state
151  *
152  * Returns Zero on success, negative on failure
153  */
154 extern int cvmx_helper_link_set(int ipd_port,
155 				union cvmx_helper_link_info link_info);
156 
157 /**
158  * This function probes an interface to determine the actual
159  * number of hardware ports connected to it. It doesn't setup the
160  * ports or enable them. The main goal here is to set the global
161  * interface_port_count[interface] correctly. Hardware setup of the
162  * ports will be performed later.
163  *
164  * @interface: Interface to probe
165  *
166  * Returns Zero on success, negative on failure
167  */
168 extern int cvmx_helper_interface_probe(int interface);
169 extern int cvmx_helper_interface_enumerate(int interface);
170 
171 #endif /* __CVMX_HELPER_H__ */
172