Staging: Add octeon-ethernet driver files.
[linux-2.6] / drivers / staging / octeon / ethernet-util.h
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 #define DEBUGPRINT(format, ...) do { if (printk_ratelimit())            \
29                                         printk(format, ##__VA_ARGS__);  \
30                                 } while (0)
31
32 /**
33  * Given a packet data address, return a pointer to the
34  * beginning of the packet buffer.
35  *
36  * @packet_ptr: Packet data hardware address
37  * Returns Packet buffer pointer
38  */
39 static inline void *cvm_oct_get_buffer_ptr(union cvmx_buf_ptr packet_ptr)
40 {
41         return cvmx_phys_to_ptr(((packet_ptr.s.addr >> 7) - packet_ptr.s.back)
42                                 << 7);
43 }
44
45 /**
46  * Given an IPD/PKO port number, return the logical interface it is
47  * on.
48  *
49  * @ipd_port: Port to check
50  *
51  * Returns Logical interface
52  */
53 static inline int INTERFACE(int ipd_port)
54 {
55         if (ipd_port < 32)      /* Interface 0 or 1 for RGMII,GMII,SPI, etc */
56                 return ipd_port >> 4;
57         else if (ipd_port < 36) /* Interface 2 for NPI */
58                 return 2;
59         else if (ipd_port < 40) /* Interface 3 for loopback */
60                 return 3;
61         else if (ipd_port == 40)        /* Non existant interface for POW0 */
62                 return 4;
63         else
64                 panic("Illegal ipd_port %d passed to INTERFACE\n", ipd_port);
65 }
66
67 /**
68  * Given an IPD/PKO port number, return the port's index on a
69  * logical interface.
70  *
71  * @ipd_port: Port to check
72  *
73  * Returns Index into interface port list
74  */
75 static inline int INDEX(int ipd_port)
76 {
77         if (ipd_port < 32)
78                 return ipd_port & 15;
79         else
80                 return ipd_port & 3;
81 }