treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 13
[linux-2.6-block.git] / drivers / net / ethernet / ibm / ibmveth.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * IBM Power Virtual Ethernet Device Driver
4  *
5  * Copyright (C) IBM Corporation, 2003, 2010
6  *
7  * Authors: Dave Larson <larson1@us.ibm.com>
8  *          Santiago Leon <santil@linux.vnet.ibm.com>
9  *          Brian King <brking@linux.vnet.ibm.com>
10  *          Robert Jennings <rcj@linux.vnet.ibm.com>
11  *          Anton Blanchard <anton@au.ibm.com>
12  */
13
14 #ifndef _IBMVETH_H
15 #define _IBMVETH_H
16
17 /* constants for H_MULTICAST_CTRL */
18 #define IbmVethMcastReceptionModifyBit     0x80000UL
19 #define IbmVethMcastReceptionEnableBit     0x20000UL
20 #define IbmVethMcastFilterModifyBit        0x40000UL
21 #define IbmVethMcastFilterEnableBit        0x10000UL
22
23 #define IbmVethMcastEnableRecv       (IbmVethMcastReceptionModifyBit | IbmVethMcastReceptionEnableBit)
24 #define IbmVethMcastDisableRecv      (IbmVethMcastReceptionModifyBit)
25 #define IbmVethMcastEnableFiltering  (IbmVethMcastFilterModifyBit | IbmVethMcastFilterEnableBit)
26 #define IbmVethMcastDisableFiltering (IbmVethMcastFilterModifyBit)
27 #define IbmVethMcastAddFilter        0x1UL
28 #define IbmVethMcastRemoveFilter     0x2UL
29 #define IbmVethMcastClearFilterTable 0x3UL
30
31 #define IBMVETH_ILLAN_LRG_SR_ENABLED    0x0000000000010000UL
32 #define IBMVETH_ILLAN_LRG_SND_SUPPORT   0x0000000000008000UL
33 #define IBMVETH_ILLAN_PADDED_PKT_CSUM   0x0000000000002000UL
34 #define IBMVETH_ILLAN_TRUNK_PRI_MASK    0x0000000000000F00UL
35 #define IBMVETH_ILLAN_IPV6_TCP_CSUM             0x0000000000000004UL
36 #define IBMVETH_ILLAN_IPV4_TCP_CSUM             0x0000000000000002UL
37 #define IBMVETH_ILLAN_ACTIVE_TRUNK              0x0000000000000001UL
38
39 /* hcall macros */
40 #define h_register_logical_lan(ua, buflst, rxq, fltlst, mac) \
41   plpar_hcall_norets(H_REGISTER_LOGICAL_LAN, ua, buflst, rxq, fltlst, mac)
42
43 #define h_free_logical_lan(ua) \
44   plpar_hcall_norets(H_FREE_LOGICAL_LAN, ua)
45
46 #define h_add_logical_lan_buffer(ua, buf) \
47   plpar_hcall_norets(H_ADD_LOGICAL_LAN_BUFFER, ua, buf)
48
49 static inline long h_send_logical_lan(unsigned long unit_address,
50                 unsigned long desc1, unsigned long desc2, unsigned long desc3,
51                 unsigned long desc4, unsigned long desc5, unsigned long desc6,
52                 unsigned long corellator_in, unsigned long *corellator_out,
53                 unsigned long mss, unsigned long large_send_support)
54 {
55         long rc;
56         unsigned long retbuf[PLPAR_HCALL9_BUFSIZE];
57
58         if (large_send_support)
59                 rc = plpar_hcall9(H_SEND_LOGICAL_LAN, retbuf, unit_address,
60                                   desc1, desc2, desc3, desc4, desc5, desc6,
61                                   corellator_in, mss);
62         else
63                 rc = plpar_hcall9(H_SEND_LOGICAL_LAN, retbuf, unit_address,
64                                   desc1, desc2, desc3, desc4, desc5, desc6,
65                                   corellator_in);
66
67         *corellator_out = retbuf[0];
68
69         return rc;
70 }
71
72 static inline long h_illan_attributes(unsigned long unit_address,
73                                       unsigned long reset_mask, unsigned long set_mask,
74                                       unsigned long *ret_attributes)
75 {
76         long rc;
77         unsigned long retbuf[PLPAR_HCALL_BUFSIZE];
78
79         rc = plpar_hcall(H_ILLAN_ATTRIBUTES, retbuf, unit_address,
80                          reset_mask, set_mask);
81
82         *ret_attributes = retbuf[0];
83
84         return rc;
85 }
86
87 #define h_multicast_ctrl(ua, cmd, mac) \
88   plpar_hcall_norets(H_MULTICAST_CTRL, ua, cmd, mac)
89
90 #define h_change_logical_lan_mac(ua, mac) \
91   plpar_hcall_norets(H_CHANGE_LOGICAL_LAN_MAC, ua, mac)
92
93 #define IBMVETH_NUM_BUFF_POOLS 5
94 #define IBMVETH_IO_ENTITLEMENT_DEFAULT 4243456 /* MTU of 1500 needs 4.2Mb */
95 #define IBMVETH_BUFF_OH 22 /* Overhead: 14 ethernet header + 8 opaque handle */
96 #define IBMVETH_MIN_MTU 68
97 #define IBMVETH_MAX_POOL_COUNT 4096
98 #define IBMVETH_BUFF_LIST_SIZE 4096
99 #define IBMVETH_FILT_LIST_SIZE 4096
100 #define IBMVETH_MAX_BUF_SIZE (1024 * 128)
101
102 static int pool_size[] = { 512, 1024 * 2, 1024 * 16, 1024 * 32, 1024 * 64 };
103 static int pool_count[] = { 256, 512, 256, 256, 256 };
104 static int pool_count_cmo[] = { 256, 512, 256, 256, 64 };
105 static int pool_active[] = { 1, 1, 0, 0, 1};
106
107 #define IBM_VETH_INVALID_MAP ((u16)0xffff)
108
109 struct ibmveth_buff_pool {
110     u32 size;
111     u32 index;
112     u32 buff_size;
113     u32 threshold;
114     atomic_t available;
115     u32 consumer_index;
116     u32 producer_index;
117     u16 *free_map;
118     dma_addr_t *dma_addr;
119     struct sk_buff **skbuff;
120     int active;
121     struct kobject kobj;
122 };
123
124 struct ibmveth_rx_q {
125     u64        index;
126     u64        num_slots;
127     u64        toggle;
128     dma_addr_t queue_dma;
129     u32        queue_len;
130     struct ibmveth_rx_q_entry *queue_addr;
131 };
132
133 struct ibmveth_adapter {
134     struct vio_dev *vdev;
135     struct net_device *netdev;
136     struct napi_struct napi;
137     unsigned int mcastFilterSize;
138     void * buffer_list_addr;
139     void * filter_list_addr;
140     dma_addr_t buffer_list_dma;
141     dma_addr_t filter_list_dma;
142     struct ibmveth_buff_pool rx_buff_pool[IBMVETH_NUM_BUFF_POOLS];
143     struct ibmveth_rx_q rx_queue;
144     int pool_config;
145     int rx_csum;
146     int large_send;
147     bool is_active_trunk;
148     void *bounce_buffer;
149     dma_addr_t bounce_buffer_dma;
150
151     u64 fw_ipv6_csum_support;
152     u64 fw_ipv4_csum_support;
153     u64 fw_large_send_support;
154     /* adapter specific stats */
155     u64 replenish_task_cycles;
156     u64 replenish_no_mem;
157     u64 replenish_add_buff_failure;
158     u64 replenish_add_buff_success;
159     u64 rx_invalid_buffer;
160     u64 rx_no_buffer;
161     u64 tx_map_failed;
162     u64 tx_send_failed;
163     u64 tx_large_packets;
164     u64 rx_large_packets;
165 };
166
167 /*
168  * We pass struct ibmveth_buf_desc_fields to the hypervisor in registers,
169  * so we don't need to byteswap the two elements. However since we use
170  * a union (ibmveth_buf_desc) to convert from the struct to a u64 we
171  * do end up with endian specific ordering of the elements and that
172  * needs correcting.
173  */
174 struct ibmveth_buf_desc_fields {
175 #ifdef __BIG_ENDIAN
176         u32 flags_len;
177         u32 address;
178 #else
179         u32 address;
180         u32 flags_len;
181 #endif
182 #define IBMVETH_BUF_VALID       0x80000000
183 #define IBMVETH_BUF_TOGGLE      0x40000000
184 #define IBMVETH_BUF_LRG_SND     0x04000000
185 #define IBMVETH_BUF_NO_CSUM     0x02000000
186 #define IBMVETH_BUF_CSUM_GOOD   0x01000000
187 #define IBMVETH_BUF_LEN_MASK    0x00FFFFFF
188 };
189
190 union ibmveth_buf_desc {
191     u64 desc;
192     struct ibmveth_buf_desc_fields fields;
193 };
194
195 struct ibmveth_rx_q_entry {
196         __be32 flags_off;
197 #define IBMVETH_RXQ_TOGGLE              0x80000000
198 #define IBMVETH_RXQ_TOGGLE_SHIFT        31
199 #define IBMVETH_RXQ_VALID               0x40000000
200 #define IBMVETH_RXQ_LRG_PKT             0x04000000
201 #define IBMVETH_RXQ_NO_CSUM             0x02000000
202 #define IBMVETH_RXQ_CSUM_GOOD           0x01000000
203 #define IBMVETH_RXQ_OFF_MASK            0x0000FFFF
204
205         __be32 length;
206         /* correlator is only used by the OS, no need to byte swap */
207         u64 correlator;
208 };
209
210 #endif /* _IBMVETH_H */