Linux-libre 3.16.85-gnu
[librecmc/linux-libre.git] / drivers / net / ethernet / amd / xgbe / xgbe-desc.c
1 /*
2  * AMD 10Gb Ethernet driver
3  *
4  * This file is available to you under your choice of the following two
5  * licenses:
6  *
7  * License 1: GPLv2
8  *
9  * Copyright (c) 2014 Advanced Micro Devices, Inc.
10  *
11  * This file is free software; you may copy, redistribute and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 2 of the License, or (at
14  * your option) any later version.
15  *
16  * This file is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  *
24  * This file incorporates work covered by the following copyright and
25  * permission notice:
26  *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
27  *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
28  *     Inc. unless otherwise expressly agreed to in writing between Synopsys
29  *     and you.
30  *
31  *     The Software IS NOT an item of Licensed Software or Licensed Product
32  *     under any End User Software License Agreement or Agreement for Licensed
33  *     Product with Synopsys or any supplement thereto.  Permission is hereby
34  *     granted, free of charge, to any person obtaining a copy of this software
35  *     annotated with this license and the Software, to deal in the Software
36  *     without restriction, including without limitation the rights to use,
37  *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
38  *     of the Software, and to permit persons to whom the Software is furnished
39  *     to do so, subject to the following conditions:
40  *
41  *     The above copyright notice and this permission notice shall be included
42  *     in all copies or substantial portions of the Software.
43  *
44  *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
45  *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
46  *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
47  *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
48  *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
49  *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
50  *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
51  *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
52  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53  *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
54  *     THE POSSIBILITY OF SUCH DAMAGE.
55  *
56  *
57  * License 2: Modified BSD
58  *
59  * Copyright (c) 2014 Advanced Micro Devices, Inc.
60  * All rights reserved.
61  *
62  * Redistribution and use in source and binary forms, with or without
63  * modification, are permitted provided that the following conditions are met:
64  *     * Redistributions of source code must retain the above copyright
65  *       notice, this list of conditions and the following disclaimer.
66  *     * Redistributions in binary form must reproduce the above copyright
67  *       notice, this list of conditions and the following disclaimer in the
68  *       documentation and/or other materials provided with the distribution.
69  *     * Neither the name of Advanced Micro Devices, Inc. nor the
70  *       names of its contributors may be used to endorse or promote products
71  *       derived from this software without specific prior written permission.
72  *
73  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
74  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
76  * ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
77  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
78  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
79  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
80  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
81  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
82  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
83  *
84  * This file incorporates work covered by the following copyright and
85  * permission notice:
86  *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
87  *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
88  *     Inc. unless otherwise expressly agreed to in writing between Synopsys
89  *     and you.
90  *
91  *     The Software IS NOT an item of Licensed Software or Licensed Product
92  *     under any End User Software License Agreement or Agreement for Licensed
93  *     Product with Synopsys or any supplement thereto.  Permission is hereby
94  *     granted, free of charge, to any person obtaining a copy of this software
95  *     annotated with this license and the Software, to deal in the Software
96  *     without restriction, including without limitation the rights to use,
97  *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
98  *     of the Software, and to permit persons to whom the Software is furnished
99  *     to do so, subject to the following conditions:
100  *
101  *     The above copyright notice and this permission notice shall be included
102  *     in all copies or substantial portions of the Software.
103  *
104  *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
105  *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
106  *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
107  *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
108  *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
109  *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
110  *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
111  *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
112  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
113  *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
114  *     THE POSSIBILITY OF SUCH DAMAGE.
115  */
116
117 #include "xgbe.h"
118 #include "xgbe-common.h"
119
120
121 static void xgbe_unmap_skb(struct xgbe_prv_data *, struct xgbe_ring_data *);
122
123 static void xgbe_free_ring(struct xgbe_prv_data *pdata,
124                            struct xgbe_ring *ring)
125 {
126         struct xgbe_ring_data *rdata;
127         unsigned int i;
128
129         if (!ring)
130                 return;
131
132         if (ring->rdata) {
133                 for (i = 0; i < ring->rdesc_count; i++) {
134                         rdata = GET_DESC_DATA(ring, i);
135                         xgbe_unmap_skb(pdata, rdata);
136                 }
137
138                 kfree(ring->rdata);
139                 ring->rdata = NULL;
140         }
141
142         if (ring->rdesc) {
143                 dma_free_coherent(pdata->dev,
144                                   (sizeof(struct xgbe_ring_desc) *
145                                    ring->rdesc_count),
146                                   ring->rdesc, ring->rdesc_dma);
147                 ring->rdesc = NULL;
148         }
149 }
150
151 static void xgbe_free_ring_resources(struct xgbe_prv_data *pdata)
152 {
153         struct xgbe_channel *channel;
154         unsigned int i;
155
156         DBGPR("-->xgbe_free_ring_resources\n");
157
158         channel = pdata->channel;
159         for (i = 0; i < pdata->channel_count; i++, channel++) {
160                 xgbe_free_ring(pdata, channel->tx_ring);
161                 xgbe_free_ring(pdata, channel->rx_ring);
162         }
163
164         DBGPR("<--xgbe_free_ring_resources\n");
165 }
166
167 static int xgbe_init_ring(struct xgbe_prv_data *pdata,
168                           struct xgbe_ring *ring, unsigned int rdesc_count)
169 {
170         DBGPR("-->xgbe_init_ring\n");
171
172         if (!ring)
173                 return 0;
174
175         /* Descriptors */
176         ring->rdesc_count = rdesc_count;
177         ring->rdesc = dma_alloc_coherent(pdata->dev,
178                                          (sizeof(struct xgbe_ring_desc) *
179                                           rdesc_count), &ring->rdesc_dma,
180                                          GFP_KERNEL);
181         if (!ring->rdesc)
182                 return -ENOMEM;
183
184         /* Descriptor information */
185         ring->rdata = kcalloc(rdesc_count, sizeof(struct xgbe_ring_data),
186                               GFP_KERNEL);
187         if (!ring->rdata)
188                 return -ENOMEM;
189
190         DBGPR("    rdesc=0x%p, rdesc_dma=0x%llx, rdata=0x%p\n",
191               ring->rdesc, ring->rdesc_dma, ring->rdata);
192
193         DBGPR("<--xgbe_init_ring\n");
194
195         return 0;
196 }
197
198 static int xgbe_alloc_ring_resources(struct xgbe_prv_data *pdata)
199 {
200         struct xgbe_channel *channel;
201         unsigned int i;
202         int ret;
203
204         DBGPR("-->xgbe_alloc_ring_resources\n");
205
206         channel = pdata->channel;
207         for (i = 0; i < pdata->channel_count; i++, channel++) {
208                 DBGPR("  %s - tx_ring:\n", channel->name);
209                 ret = xgbe_init_ring(pdata, channel->tx_ring,
210                                      pdata->tx_desc_count);
211                 if (ret) {
212                         netdev_alert(pdata->netdev,
213                                      "error initializing Tx ring\n");
214                         goto err_ring;
215                 }
216
217                 DBGPR("  %s - rx_ring:\n", channel->name);
218                 ret = xgbe_init_ring(pdata, channel->rx_ring,
219                                      pdata->rx_desc_count);
220                 if (ret) {
221                         netdev_alert(pdata->netdev,
222                                      "error initializing Tx ring\n");
223                         goto err_ring;
224                 }
225         }
226
227         DBGPR("<--xgbe_alloc_ring_resources\n");
228
229         return 0;
230
231 err_ring:
232         xgbe_free_ring_resources(pdata);
233
234         return ret;
235 }
236
237 static void xgbe_wrapper_tx_descriptor_init(struct xgbe_prv_data *pdata)
238 {
239         struct xgbe_hw_if *hw_if = &pdata->hw_if;
240         struct xgbe_channel *channel;
241         struct xgbe_ring *ring;
242         struct xgbe_ring_data *rdata;
243         struct xgbe_ring_desc *rdesc;
244         dma_addr_t rdesc_dma;
245         unsigned int i, j;
246
247         DBGPR("-->xgbe_wrapper_tx_descriptor_init\n");
248
249         channel = pdata->channel;
250         for (i = 0; i < pdata->channel_count; i++, channel++) {
251                 ring = channel->tx_ring;
252                 if (!ring)
253                         break;
254
255                 rdesc = ring->rdesc;
256                 rdesc_dma = ring->rdesc_dma;
257
258                 for (j = 0; j < ring->rdesc_count; j++) {
259                         rdata = GET_DESC_DATA(ring, j);
260
261                         rdata->rdesc = rdesc;
262                         rdata->rdesc_dma = rdesc_dma;
263
264                         rdesc++;
265                         rdesc_dma += sizeof(struct xgbe_ring_desc);
266                 }
267
268                 ring->cur = 0;
269                 ring->dirty = 0;
270                 ring->tx.queue_stopped = 0;
271
272                 hw_if->tx_desc_init(channel);
273         }
274
275         DBGPR("<--xgbe_wrapper_tx_descriptor_init\n");
276 }
277
278 static void xgbe_wrapper_rx_descriptor_init(struct xgbe_prv_data *pdata)
279 {
280         struct xgbe_hw_if *hw_if = &pdata->hw_if;
281         struct xgbe_channel *channel;
282         struct xgbe_ring *ring;
283         struct xgbe_ring_desc *rdesc;
284         struct xgbe_ring_data *rdata;
285         dma_addr_t rdesc_dma, skb_dma;
286         struct sk_buff *skb = NULL;
287         unsigned int i, j;
288
289         DBGPR("-->xgbe_wrapper_rx_descriptor_init\n");
290
291         channel = pdata->channel;
292         for (i = 0; i < pdata->channel_count; i++, channel++) {
293                 ring = channel->rx_ring;
294                 if (!ring)
295                         break;
296
297                 rdesc = ring->rdesc;
298                 rdesc_dma = ring->rdesc_dma;
299
300                 for (j = 0; j < ring->rdesc_count; j++) {
301                         rdata = GET_DESC_DATA(ring, j);
302
303                         rdata->rdesc = rdesc;
304                         rdata->rdesc_dma = rdesc_dma;
305
306                         /* Allocate skb & assign to each rdesc */
307                         skb = dev_alloc_skb(pdata->rx_buf_size);
308                         if (skb == NULL)
309                                 break;
310                         skb_dma = dma_map_single(pdata->dev, skb->data,
311                                                  pdata->rx_buf_size,
312                                                  DMA_FROM_DEVICE);
313                         if (dma_mapping_error(pdata->dev, skb_dma)) {
314                                 netdev_alert(pdata->netdev,
315                                              "failed to do the dma map\n");
316                                 dev_kfree_skb_any(skb);
317                                 break;
318                         }
319                         rdata->skb = skb;
320                         rdata->skb_dma = skb_dma;
321                         rdata->skb_dma_len = pdata->rx_buf_size;
322
323                         rdesc++;
324                         rdesc_dma += sizeof(struct xgbe_ring_desc);
325                 }
326
327                 ring->cur = 0;
328                 ring->dirty = 0;
329                 ring->rx.realloc_index = 0;
330                 ring->rx.realloc_threshold = 0;
331
332                 hw_if->rx_desc_init(channel);
333         }
334
335         DBGPR("<--xgbe_wrapper_rx_descriptor_init\n");
336 }
337
338 static void xgbe_unmap_skb(struct xgbe_prv_data *pdata,
339                            struct xgbe_ring_data *rdata)
340 {
341         if (rdata->skb_dma) {
342                 if (rdata->mapped_as_page) {
343                         dma_unmap_page(pdata->dev, rdata->skb_dma,
344                                        rdata->skb_dma_len, DMA_TO_DEVICE);
345                 } else {
346                         dma_unmap_single(pdata->dev, rdata->skb_dma,
347                                          rdata->skb_dma_len, DMA_TO_DEVICE);
348                 }
349                 rdata->skb_dma = 0;
350                 rdata->skb_dma_len = 0;
351         }
352
353         if (rdata->skb) {
354                 dev_kfree_skb_any(rdata->skb);
355                 rdata->skb = NULL;
356         }
357
358         rdata->tso_header = 0;
359         rdata->len = 0;
360         rdata->interrupt = 0;
361         rdata->mapped_as_page = 0;
362 }
363
364 static int xgbe_map_tx_skb(struct xgbe_channel *channel, struct sk_buff *skb)
365 {
366         struct xgbe_prv_data *pdata = channel->pdata;
367         struct xgbe_ring *ring = channel->tx_ring;
368         struct xgbe_ring_data *rdata;
369         struct xgbe_packet_data *packet;
370         struct skb_frag_struct *frag;
371         dma_addr_t skb_dma;
372         unsigned int start_index, cur_index;
373         unsigned int offset, tso, vlan, datalen, len;
374         unsigned int i;
375
376         DBGPR("-->xgbe_map_tx_skb: cur = %d\n", ring->cur);
377
378         offset = 0;
379         start_index = ring->cur;
380         cur_index = ring->cur;
381
382         packet = &ring->packet_data;
383         packet->rdesc_count = 0;
384         packet->length = 0;
385
386         tso = XGMAC_GET_BITS(packet->attributes, TX_PACKET_ATTRIBUTES,
387                              TSO_ENABLE);
388         vlan = XGMAC_GET_BITS(packet->attributes, TX_PACKET_ATTRIBUTES,
389                               VLAN_CTAG);
390
391         /* Save space for a context descriptor if needed */
392         if ((tso && (packet->mss != ring->tx.cur_mss)) ||
393             (vlan && (packet->vlan_ctag != ring->tx.cur_vlan_ctag)))
394                 cur_index++;
395         rdata = GET_DESC_DATA(ring, cur_index);
396
397         if (tso) {
398                 DBGPR("  TSO packet\n");
399
400                 /* Map the TSO header */
401                 skb_dma = dma_map_single(pdata->dev, skb->data,
402                                          packet->header_len, DMA_TO_DEVICE);
403                 if (dma_mapping_error(pdata->dev, skb_dma)) {
404                         netdev_alert(pdata->netdev, "dma_map_single failed\n");
405                         goto err_out;
406                 }
407                 rdata->skb_dma = skb_dma;
408                 rdata->skb_dma_len = packet->header_len;
409                 rdata->tso_header = 1;
410
411                 offset = packet->header_len;
412
413                 packet->length += packet->header_len;
414
415                 cur_index++;
416                 rdata = GET_DESC_DATA(ring, cur_index);
417         }
418
419         /* Map the (remainder of the) packet */
420         for (datalen = skb_headlen(skb) - offset; datalen; ) {
421                 len = min_t(unsigned int, datalen, TX_MAX_BUF_SIZE);
422
423                 skb_dma = dma_map_single(pdata->dev, skb->data + offset, len,
424                                          DMA_TO_DEVICE);
425                 if (dma_mapping_error(pdata->dev, skb_dma)) {
426                         netdev_alert(pdata->netdev, "dma_map_single failed\n");
427                         goto err_out;
428                 }
429                 rdata->skb_dma = skb_dma;
430                 rdata->skb_dma_len = len;
431                 DBGPR("  skb data: index=%u, dma=0x%llx, len=%u\n",
432                       cur_index, skb_dma, len);
433
434                 datalen -= len;
435                 offset += len;
436
437                 packet->length += len;
438
439                 cur_index++;
440                 rdata = GET_DESC_DATA(ring, cur_index);
441         }
442
443         for (i = 0; i < skb_shinfo(skb)->nr_frags; i++) {
444                 DBGPR("  mapping frag %u\n", i);
445
446                 frag = &skb_shinfo(skb)->frags[i];
447                 offset = 0;
448
449                 for (datalen = skb_frag_size(frag); datalen; ) {
450                         len = min_t(unsigned int, datalen, TX_MAX_BUF_SIZE);
451
452                         skb_dma = skb_frag_dma_map(pdata->dev, frag, offset,
453                                                    len, DMA_TO_DEVICE);
454                         if (dma_mapping_error(pdata->dev, skb_dma)) {
455                                 netdev_alert(pdata->netdev,
456                                              "skb_frag_dma_map failed\n");
457                                 goto err_out;
458                         }
459                         rdata->skb_dma = skb_dma;
460                         rdata->skb_dma_len = len;
461                         rdata->mapped_as_page = 1;
462                         DBGPR("  skb data: index=%u, dma=0x%llx, len=%u\n",
463                               cur_index, skb_dma, len);
464
465                         datalen -= len;
466                         offset += len;
467
468                         packet->length += len;
469
470                         cur_index++;
471                         rdata = GET_DESC_DATA(ring, cur_index);
472                 }
473         }
474
475         /* Save the skb address in the last entry */
476         rdata->skb = skb;
477
478         /* Save the number of descriptor entries used */
479         packet->rdesc_count = cur_index - start_index;
480
481         DBGPR("<--xgbe_map_tx_skb: count=%u\n", packet->rdesc_count);
482
483         return packet->rdesc_count;
484
485 err_out:
486         while (start_index < cur_index) {
487                 rdata = GET_DESC_DATA(ring, start_index++);
488                 xgbe_unmap_skb(pdata, rdata);
489         }
490
491         DBGPR("<--xgbe_map_tx_skb: count=0\n");
492
493         return 0;
494 }
495
496 static void xgbe_realloc_skb(struct xgbe_channel *channel)
497 {
498         struct xgbe_prv_data *pdata = channel->pdata;
499         struct xgbe_hw_if *hw_if = &pdata->hw_if;
500         struct xgbe_ring *ring = channel->rx_ring;
501         struct xgbe_ring_data *rdata;
502         struct sk_buff *skb = NULL;
503         dma_addr_t skb_dma;
504         int i;
505
506         DBGPR("-->xgbe_realloc_skb: rx_ring->rx.realloc_index = %u\n",
507               ring->rx.realloc_index);
508
509         for (i = 0; i < ring->dirty; i++) {
510                 rdata = GET_DESC_DATA(ring, ring->rx.realloc_index);
511
512                 /* Reset rdata values */
513                 xgbe_unmap_skb(pdata, rdata);
514
515                 /* Allocate skb & assign to each rdesc */
516                 skb = dev_alloc_skb(pdata->rx_buf_size);
517                 if (skb == NULL) {
518                         netdev_alert(pdata->netdev,
519                                      "failed to allocate skb\n");
520                         break;
521                 }
522                 skb_dma = dma_map_single(pdata->dev, skb->data,
523                                          pdata->rx_buf_size, DMA_FROM_DEVICE);
524                 if (dma_mapping_error(pdata->dev, skb_dma)) {
525                         netdev_alert(pdata->netdev,
526                                      "failed to do the dma map\n");
527                         dev_kfree_skb_any(skb);
528                         break;
529                 }
530                 rdata->skb = skb;
531                 rdata->skb_dma = skb_dma;
532                 rdata->skb_dma_len = pdata->rx_buf_size;
533
534                 hw_if->rx_desc_reset(rdata);
535
536                 ring->rx.realloc_index++;
537         }
538         ring->dirty = 0;
539
540         DBGPR("<--xgbe_realloc_skb\n");
541 }
542
543 void xgbe_init_function_ptrs_desc(struct xgbe_desc_if *desc_if)
544 {
545         DBGPR("-->xgbe_init_function_ptrs_desc\n");
546
547         desc_if->alloc_ring_resources = xgbe_alloc_ring_resources;
548         desc_if->free_ring_resources = xgbe_free_ring_resources;
549         desc_if->map_tx_skb = xgbe_map_tx_skb;
550         desc_if->realloc_skb = xgbe_realloc_skb;
551         desc_if->unmap_skb = xgbe_unmap_skb;
552         desc_if->wrapper_tx_desc_init = xgbe_wrapper_tx_descriptor_init;
553         desc_if->wrapper_rx_desc_init = xgbe_wrapper_rx_descriptor_init;
554
555         DBGPR("<--xgbe_init_function_ptrs_desc\n");
556 }