1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  PS3 gelic network driver.
4  *
5  * Copyright (C) 2007 Sony Computer Entertainment Inc.
6  * Copyright 2006, 2007 Sony Corporation
7  *
8  * This file is based on: spider_net.c
9  *
10  * (C) Copyright IBM Corp. 2005
11  *
12  * Authors : Utz Bacher <utz.bacher@de.ibm.com>
13  *           Jens Osterkamp <Jens.Osterkamp@de.ibm.com>
14  */
15 
16 #undef DEBUG
17 
18 #include <linux/interrupt.h>
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/slab.h>
22 
23 #include <linux/etherdevice.h>
24 #include <linux/ethtool.h>
25 #include <linux/if_vlan.h>
26 
27 #include <linux/in.h>
28 #include <linux/ip.h>
29 #include <linux/tcp.h>
30 
31 #include <linux/dma-mapping.h>
32 #include <net/checksum.h>
33 #include <asm/firmware.h>
34 #include <asm/ps3.h>
35 #include <asm/lv1call.h>
36 
37 #include "ps3_gelic_net.h"
38 #include "ps3_gelic_wireless.h"
39 
40 #define DRV_NAME "Gelic Network Driver"
41 #define DRV_VERSION "2.0"
42 
43 MODULE_AUTHOR("SCE Inc.");
44 MODULE_DESCRIPTION("Gelic Network driver");
45 MODULE_LICENSE("GPL");
46 
47 
48 /* set irq_mask */
49 int gelic_card_set_irq_mask(struct gelic_card *card, u64 mask)
50 {
51 	int status;
52 
53 	status = lv1_net_set_interrupt_mask(bus_id(card), dev_id(card),
54 					    mask, 0);
55 	if (status)
56 		dev_info(ctodev(card),
57 			 "%s failed %d\n", __func__, status);
58 	return status;
59 }
60 
61 static void gelic_card_rx_irq_on(struct gelic_card *card)
62 {
63 	card->irq_mask |= GELIC_CARD_RXINT;
64 	gelic_card_set_irq_mask(card, card->irq_mask);
65 }
66 static void gelic_card_rx_irq_off(struct gelic_card *card)
67 {
68 	card->irq_mask &= ~GELIC_CARD_RXINT;
69 	gelic_card_set_irq_mask(card, card->irq_mask);
70 }
71 
72 static void gelic_card_get_ether_port_status(struct gelic_card *card,
73 					     int inform)
74 {
75 	u64 v2;
76 	struct net_device *ether_netdev;
77 
78 	lv1_net_control(bus_id(card), dev_id(card),
79 			GELIC_LV1_GET_ETH_PORT_STATUS,
80 			GELIC_LV1_VLAN_TX_ETHERNET_0, 0, 0,
81 			&card->ether_port_status, &v2);
82 
83 	if (inform) {
84 		ether_netdev = card->netdev[GELIC_PORT_ETHERNET_0];
85 		if (card->ether_port_status & GELIC_LV1_ETHER_LINK_UP)
86 			netif_carrier_on(ether_netdev);
87 		else
88 			netif_carrier_off(ether_netdev);
89 	}
90 }
91 
92 /**
93  * gelic_descr_get_status -- returns the status of a descriptor
94  * @descr: descriptor to look at
95  *
96  * returns the status as in the dmac_cmd_status field of the descriptor
97  */
98 static enum gelic_descr_dma_status
99 gelic_descr_get_status(struct gelic_descr *descr)
100 {
101 	return be32_to_cpu(descr->dmac_cmd_status) & GELIC_DESCR_DMA_STAT_MASK;
102 }
103 
104 static int gelic_card_set_link_mode(struct gelic_card *card, int mode)
105 {
106 	int status;
107 	u64 v1, v2;
108 
109 	status = lv1_net_control(bus_id(card), dev_id(card),
110 				 GELIC_LV1_SET_NEGOTIATION_MODE,
111 				 GELIC_LV1_PHY_ETHERNET_0, mode, 0, &v1, &v2);
112 	if (status) {
113 		pr_info("%s: failed setting negotiation mode %d\n", __func__,
114 			status);
115 		return -EBUSY;
116 	}
117 
118 	card->link_mode = mode;
119 	return 0;
120 }
121 
122 /**
123  * gelic_card_disable_txdmac - disables the transmit DMA controller
124  * @card: card structure
125  *
126  * gelic_card_disable_txdmac terminates processing on the DMA controller by
127  * turing off DMA and issuing a force end
128  */
129 static void gelic_card_disable_txdmac(struct gelic_card *card)
130 {
131 	int status;
132 
133 	/* this hvc blocks until the DMA in progress really stopped */
134 	status = lv1_net_stop_tx_dma(bus_id(card), dev_id(card));
135 	if (status)
136 		dev_err(ctodev(card),
137 			"lv1_net_stop_tx_dma failed, status=%d\n", status);
138 }
139 
140 /**
141  * gelic_card_enable_rxdmac - enables the receive DMA controller
142  * @card: card structure
143  *
144  * gelic_card_enable_rxdmac enables the DMA controller by setting RX_DMA_EN
145  * in the GDADMACCNTR register
146  */
147 static void gelic_card_enable_rxdmac(struct gelic_card *card)
148 {
149 	int status;
150 
151 #ifdef DEBUG
152 	if (gelic_descr_get_status(card->rx_chain.head) !=
153 	    GELIC_DESCR_DMA_CARDOWNED) {
154 		printk(KERN_ERR "%s: status=%x\n", __func__,
155 		       be32_to_cpu(card->rx_chain.head->dmac_cmd_status));
156 		printk(KERN_ERR "%s: nextphy=%x\n", __func__,
157 		       be32_to_cpu(card->rx_chain.head->next_descr_addr));
158 		printk(KERN_ERR "%s: head=%p\n", __func__,
159 		       card->rx_chain.head);
160 	}
161 #endif
162 	status = lv1_net_start_rx_dma(bus_id(card), dev_id(card),
163 				card->rx_chain.head->bus_addr, 0);
164 	if (status)
165 		dev_info(ctodev(card),
166 			 "lv1_net_start_rx_dma failed, status=%d\n", status);
167 }
168 
169 /**
170  * gelic_card_disable_rxdmac - disables the receive DMA controller
171  * @card: card structure
172  *
173  * gelic_card_disable_rxdmac terminates processing on the DMA controller by
174  * turing off DMA and issuing a force end
175  */
176 static void gelic_card_disable_rxdmac(struct gelic_card *card)
177 {
178 	int status;
179 
180 	/* this hvc blocks until the DMA in progress really stopped */
181 	status = lv1_net_stop_rx_dma(bus_id(card), dev_id(card));
182 	if (status)
183 		dev_err(ctodev(card),
184 			"lv1_net_stop_rx_dma failed, %d\n", status);
185 }
186 
187 /**
188  * gelic_descr_set_status -- sets the status of a descriptor
189  * @descr: descriptor to change
190  * @status: status to set in the descriptor
191  *
192  * changes the status to the specified value. Doesn't change other bits
193  * in the status
194  */
195 static void gelic_descr_set_status(struct gelic_descr *descr,
196 				   enum gelic_descr_dma_status status)
197 {
198 	descr->dmac_cmd_status = cpu_to_be32(status |
199 			(be32_to_cpu(descr->dmac_cmd_status) &
200 			 ~GELIC_DESCR_DMA_STAT_MASK));
201 	/*
202 	 * dma_cmd_status field is used to indicate whether the descriptor
203 	 * is valid or not.
204 	 * Usually caller of this function wants to inform that to the
205 	 * hardware, so we assure here the hardware sees the change.
206 	 */
207 	wmb();
208 }
209 
210 /**
211  * gelic_card_reset_chain - reset status of a descriptor chain
212  * @card: card structure
213  * @chain: address of chain
214  * @start_descr: address of descriptor array
215  *
216  * Reset the status of dma descriptors to ready state
217  * and re-initialize the hardware chain for later use
218  */
219 static void gelic_card_reset_chain(struct gelic_card *card,
220 				   struct gelic_descr_chain *chain,
221 				   struct gelic_descr *start_descr)
222 {
223 	struct gelic_descr *descr;
224 
225 	for (descr = start_descr; start_descr != descr->next; descr++) {
226 		gelic_descr_set_status(descr, GELIC_DESCR_DMA_CARDOWNED);
227 		descr->next_descr_addr = cpu_to_be32(descr->next->bus_addr);
228 	}
229 
230 	chain->head = start_descr;
231 	chain->tail = (descr - 1);
232 
233 	(descr - 1)->next_descr_addr = 0;
234 }
235 
236 void gelic_card_up(struct gelic_card *card)
237 {
238 	pr_debug("%s: called\n", __func__);
239 	mutex_lock(&card->updown_lock);
240 	if (atomic_inc_return(&card->users) == 1) {
241 		pr_debug("%s: real do\n", __func__);
242 		/* enable irq */
243 		gelic_card_set_irq_mask(card, card->irq_mask);
244 		/* start rx */
245 		gelic_card_enable_rxdmac(card);
246 
247 		napi_enable(&card->napi);
248 	}
249 	mutex_unlock(&card->updown_lock);
250 	pr_debug("%s: done\n", __func__);
251 }
252 
253 void gelic_card_down(struct gelic_card *card)
254 {
255 	u64 mask;
256 	pr_debug("%s: called\n", __func__);
257 	mutex_lock(&card->updown_lock);
258 	if (atomic_dec_if_positive(&card->users) == 0) {
259 		pr_debug("%s: real do\n", __func__);
260 		napi_disable(&card->napi);
261 		/*
262 		 * Disable irq. Wireless interrupts will
263 		 * be disabled later if any
264 		 */
265 		mask = card->irq_mask & (GELIC_CARD_WLAN_EVENT_RECEIVED |
266 					 GELIC_CARD_WLAN_COMMAND_COMPLETED);
267 		gelic_card_set_irq_mask(card, mask);
268 		/* stop rx */
269 		gelic_card_disable_rxdmac(card);
270 		gelic_card_reset_chain(card, &card->rx_chain,
271 				       card->descr + GELIC_NET_TX_DESCRIPTORS);
272 		/* stop tx */
273 		gelic_card_disable_txdmac(card);
274 	}
275 	mutex_unlock(&card->updown_lock);
276 	pr_debug("%s: done\n", __func__);
277 }
278 
279 /**
280  * gelic_card_free_chain - free descriptor chain
281  * @card: card structure
282  * @descr_in: address of desc
283  */
284 static void gelic_card_free_chain(struct gelic_card *card,
285 				  struct gelic_descr *descr_in)
286 {
287 	struct gelic_descr *descr;
288 
289 	for (descr = descr_in; descr && descr->bus_addr; descr = descr->next) {
290 		dma_unmap_single(ctodev(card), descr->bus_addr,
291 				 GELIC_DESCR_SIZE, DMA_BIDIRECTIONAL);
292 		descr->bus_addr = 0;
293 	}
294 }
295 
296 /**
297  * gelic_card_init_chain - links descriptor chain
298  * @card: card structure
299  * @chain: address of chain
300  * @start_descr: address of descriptor array
301  * @no: number of descriptors
302  *
303  * we manage a circular list that mirrors the hardware structure,
304  * except that the hardware uses bus addresses.
305  *
306  * returns 0 on success, <0 on failure
307  */
308 static int gelic_card_init_chain(struct gelic_card *card,
309 				 struct gelic_descr_chain *chain,
310 				 struct gelic_descr *start_descr, int no)
311 {
312 	int i;
313 	struct gelic_descr *descr;
314 
315 	descr = start_descr;
316 	memset(descr, 0, sizeof(*descr) * no);
317 
318 	/* set up the hardware pointers in each descriptor */
319 	for (i = 0; i < no; i++, descr++) {
320 		gelic_descr_set_status(descr, GELIC_DESCR_DMA_NOT_IN_USE);
321 		descr->bus_addr =
322 			dma_map_single(ctodev(card), descr,
323 				       GELIC_DESCR_SIZE,
324 				       DMA_BIDIRECTIONAL);
325 
326 		if (!descr->bus_addr)
327 			goto iommu_error;
328 
329 		descr->next = descr + 1;
330 		descr->prev = descr - 1;
331 	}
332 	/* make them as ring */
333 	(descr - 1)->next = start_descr;
334 	start_descr->prev = (descr - 1);
335 
336 	/* chain bus addr of hw descriptor */
337 	descr = start_descr;
338 	for (i = 0; i < no; i++, descr++) {
339 		descr->next_descr_addr = cpu_to_be32(descr->next->bus_addr);
340 	}
341 
342 	chain->head = start_descr;
343 	chain->tail = start_descr;
344 
345 	/* do not chain last hw descriptor */
346 	(descr - 1)->next_descr_addr = 0;
347 
348 	return 0;
349 
350 iommu_error:
351 	for (i--, descr--; 0 <= i; i--, descr--)
352 		if (descr->bus_addr)
353 			dma_unmap_single(ctodev(card), descr->bus_addr,
354 					 GELIC_DESCR_SIZE,
355 					 DMA_BIDIRECTIONAL);
356 	return -ENOMEM;
357 }
358 
359 /**
360  * gelic_descr_prepare_rx - reinitializes a rx descriptor
361  * @card: card structure
362  * @descr: descriptor to re-init
363  *
364  * return 0 on success, <0 on failure
365  *
366  * allocates a new rx skb, iommu-maps it and attaches it to the descriptor.
367  * Activate the descriptor state-wise
368  */
369 static int gelic_descr_prepare_rx(struct gelic_card *card,
370 				  struct gelic_descr *descr)
371 {
372 	int offset;
373 	unsigned int bufsize;
374 
375 	if (gelic_descr_get_status(descr) !=  GELIC_DESCR_DMA_NOT_IN_USE)
376 		dev_info(ctodev(card), "%s: ERROR status\n", __func__);
377 	/* we need to round up the buffer size to a multiple of 128 */
378 	bufsize = ALIGN(GELIC_NET_MAX_MTU, GELIC_NET_RXBUF_ALIGN);
379 
380 	/* and we need to have it 128 byte aligned, therefore we allocate a
381 	 * bit more */
382 	descr->skb = dev_alloc_skb(bufsize + GELIC_NET_RXBUF_ALIGN - 1);
383 	if (!descr->skb) {
384 		descr->buf_addr = 0; /* tell DMAC don't touch memory */
385 		return -ENOMEM;
386 	}
387 	descr->buf_size = cpu_to_be32(bufsize);
388 	descr->dmac_cmd_status = 0;
389 	descr->result_size = 0;
390 	descr->valid_size = 0;
391 	descr->data_error = 0;
392 
393 	offset = ((unsigned long)descr->skb->data) &
394 		(GELIC_NET_RXBUF_ALIGN - 1);
395 	if (offset)
396 		skb_reserve(descr->skb, GELIC_NET_RXBUF_ALIGN - offset);
397 	/* io-mmu-map the skb */
398 	descr->buf_addr = cpu_to_be32(dma_map_single(ctodev(card),
399 						     descr->skb->data,
400 						     GELIC_NET_MAX_MTU,
401 						     DMA_FROM_DEVICE));
402 	if (!descr->buf_addr) {
403 		dev_kfree_skb_any(descr->skb);
404 		descr->skb = NULL;
405 		dev_info(ctodev(card),
406 			 "%s:Could not iommu-map rx buffer\n", __func__);
407 		gelic_descr_set_status(descr, GELIC_DESCR_DMA_NOT_IN_USE);
408 		return -ENOMEM;
409 	} else {
410 		gelic_descr_set_status(descr, GELIC_DESCR_DMA_CARDOWNED);
411 		return 0;
412 	}
413 }
414 
415 /**
416  * gelic_card_release_rx_chain - free all skb of rx descr
417  * @card: card structure
418  *
419  */
420 static void gelic_card_release_rx_chain(struct gelic_card *card)
421 {
422 	struct gelic_descr *descr = card->rx_chain.head;
423 
424 	do {
425 		if (descr->skb) {
426 			dma_unmap_single(ctodev(card),
427 					 be32_to_cpu(descr->buf_addr),
428 					 descr->skb->len,
429 					 DMA_FROM_DEVICE);
430 			descr->buf_addr = 0;
431 			dev_kfree_skb_any(descr->skb);
432 			descr->skb = NULL;
433 			gelic_descr_set_status(descr,
434 					       GELIC_DESCR_DMA_NOT_IN_USE);
435 		}
436 		descr = descr->next;
437 	} while (descr != card->rx_chain.head);
438 }
439 
440 /**
441  * gelic_card_fill_rx_chain - fills descriptors/skbs in the rx chains
442  * @card: card structure
443  *
444  * fills all descriptors in the rx chain: allocates skbs
445  * and iommu-maps them.
446  * returns 0 on success, < 0 on failure
447  */
448 static int gelic_card_fill_rx_chain(struct gelic_card *card)
449 {
450 	struct gelic_descr *descr = card->rx_chain.head;
451 	int ret;
452 
453 	do {
454 		if (!descr->skb) {
455 			ret = gelic_descr_prepare_rx(card, descr);
456 			if (ret)
457 				goto rewind;
458 		}
459 		descr = descr->next;
460 	} while (descr != card->rx_chain.head);
461 
462 	return 0;
463 rewind:
464 	gelic_card_release_rx_chain(card);
465 	return ret;
466 }
467 
468 /**
469  * gelic_card_alloc_rx_skbs - allocates rx skbs in rx descriptor chains
470  * @card: card structure
471  *
472  * returns 0 on success, < 0 on failure
473  */
474 static int gelic_card_alloc_rx_skbs(struct gelic_card *card)
475 {
476 	struct gelic_descr_chain *chain;
477 	int ret;
478 	chain = &card->rx_chain;
479 	ret = gelic_card_fill_rx_chain(card);
480 	chain->tail = card->rx_top->prev; /* point to the last */
481 	return ret;
482 }
483 
484 /**
485  * gelic_descr_release_tx - processes a used tx descriptor
486  * @card: card structure
487  * @descr: descriptor to release
488  *
489  * releases a used tx descriptor (unmapping, freeing of skb)
490  */
491 static void gelic_descr_release_tx(struct gelic_card *card,
492 				       struct gelic_descr *descr)
493 {
494 	struct sk_buff *skb = descr->skb;
495 
496 	BUG_ON(!(be32_to_cpu(descr->data_status) & GELIC_DESCR_TX_TAIL));
497 
498 	dma_unmap_single(ctodev(card), be32_to_cpu(descr->buf_addr), skb->len,
499 			 DMA_TO_DEVICE);
500 	dev_kfree_skb_any(skb);
501 
502 	descr->buf_addr = 0;
503 	descr->buf_size = 0;
504 	descr->next_descr_addr = 0;
505 	descr->result_size = 0;
506 	descr->valid_size = 0;
507 	descr->data_status = 0;
508 	descr->data_error = 0;
509 	descr->skb = NULL;
510 
511 	/* set descr status */
512 	gelic_descr_set_status(descr, GELIC_DESCR_DMA_NOT_IN_USE);
513 }
514 
515 static void gelic_card_stop_queues(struct gelic_card *card)
516 {
517 	netif_stop_queue(card->netdev[GELIC_PORT_ETHERNET_0]);
518 
519 	if (card->netdev[GELIC_PORT_WIRELESS])
520 		netif_stop_queue(card->netdev[GELIC_PORT_WIRELESS]);
521 }
522 static void gelic_card_wake_queues(struct gelic_card *card)
523 {
524 	netif_wake_queue(card->netdev[GELIC_PORT_ETHERNET_0]);
525 
526 	if (card->netdev[GELIC_PORT_WIRELESS])
527 		netif_wake_queue(card->netdev[GELIC_PORT_WIRELESS]);
528 }
529 /**
530  * gelic_card_release_tx_chain - processes sent tx descriptors
531  * @card: adapter structure
532  * @stop: net_stop sequence
533  *
534  * releases the tx descriptors that gelic has finished with
535  */
536 static void gelic_card_release_tx_chain(struct gelic_card *card, int stop)
537 {
538 	struct gelic_descr_chain *tx_chain;
539 	enum gelic_descr_dma_status status;
540 	struct net_device *netdev;
541 	int release = 0;
542 
543 	for (tx_chain = &card->tx_chain;
544 	     tx_chain->head != tx_chain->tail && tx_chain->tail;
545 	     tx_chain->tail = tx_chain->tail->next) {
546 		status = gelic_descr_get_status(tx_chain->tail);
547 		netdev = tx_chain->tail->skb->dev;
548 		switch (status) {
549 		case GELIC_DESCR_DMA_RESPONSE_ERROR:
550 		case GELIC_DESCR_DMA_PROTECTION_ERROR:
551 		case GELIC_DESCR_DMA_FORCE_END:
552 			if (printk_ratelimit())
553 				dev_info(ctodev(card),
554 					 "%s: forcing end of tx descriptor " \
555 					 "with status %x\n",
556 					 __func__, status);
557 			netdev->stats.tx_dropped++;
558 			break;
559 
560 		case GELIC_DESCR_DMA_COMPLETE:
561 			if (tx_chain->tail->skb) {
562 				netdev->stats.tx_packets++;
563 				netdev->stats.tx_bytes +=
564 					tx_chain->tail->skb->len;
565 			}
566 			break;
567 
568 		case GELIC_DESCR_DMA_CARDOWNED:
569 			/* pending tx request */
570 		default:
571 			/* any other value (== GELIC_DESCR_DMA_NOT_IN_USE) */
572 			if (!stop)
573 				goto out;
574 		}
575 		gelic_descr_release_tx(card, tx_chain->tail);
576 		release ++;
577 	}
578 out:
579 	if (!stop && release)
580 		gelic_card_wake_queues(card);
581 }
582 
583 /**
584  * gelic_net_set_multi - sets multicast addresses and promisc flags
585  * @netdev: interface device structure
586  *
587  * gelic_net_set_multi configures multicast addresses as needed for the
588  * netdev interface. It also sets up multicast, allmulti and promisc
589  * flags appropriately
590  */
591 void gelic_net_set_multi(struct net_device *netdev)
592 {
593 	struct gelic_card *card = netdev_card(netdev);
594 	struct netdev_hw_addr *ha;
595 	unsigned int i;
596 	uint8_t *p;
597 	u64 addr;
598 	int status;
599 
600 	/* clear all multicast address */
601 	status = lv1_net_remove_multicast_address(bus_id(card), dev_id(card),
602 						  0, 1);
603 	if (status)
604 		dev_err(ctodev(card),
605 			"lv1_net_remove_multicast_address failed %d\n",
606 			status);
607 	/* set broadcast address */
608 	status = lv1_net_add_multicast_address(bus_id(card), dev_id(card),
609 					       GELIC_NET_BROADCAST_ADDR, 0);
610 	if (status)
611 		dev_err(ctodev(card),
612 			"lv1_net_add_multicast_address failed, %d\n",
613 			status);
614 
615 	if ((netdev->flags & IFF_ALLMULTI) ||
616 	    (netdev_mc_count(netdev) > GELIC_NET_MC_COUNT_MAX)) {
617 		status = lv1_net_add_multicast_address(bus_id(card),
618 						       dev_id(card),
619 						       0, 1);
620 		if (status)
621 			dev_err(ctodev(card),
622 				"lv1_net_add_multicast_address failed, %d\n",
623 				status);
624 		return;
625 	}
626 
627 	/* set multicast addresses */
628 	netdev_for_each_mc_addr(ha, netdev) {
629 		addr = 0;
630 		p = ha->addr;
631 		for (i = 0; i < ETH_ALEN; i++) {
632 			addr <<= 8;
633 			addr |= *p++;
634 		}
635 		status = lv1_net_add_multicast_address(bus_id(card),
636 						       dev_id(card),
637 						       addr, 0);
638 		if (status)
639 			dev_err(ctodev(card),
640 				"lv1_net_add_multicast_address failed, %d\n",
641 				status);
642 	}
643 }
644 
645 /**
646  * gelic_net_stop - called upon ifconfig down
647  * @netdev: interface device structure
648  *
649  * always returns 0
650  */
651 int gelic_net_stop(struct net_device *netdev)
652 {
653 	struct gelic_card *card;
654 
655 	pr_debug("%s: start\n", __func__);
656 
657 	netif_stop_queue(netdev);
658 	netif_carrier_off(netdev);
659 
660 	card = netdev_card(netdev);
661 	gelic_card_down(card);
662 
663 	pr_debug("%s: done\n", __func__);
664 	return 0;
665 }
666 
667 /**
668  * gelic_card_get_next_tx_descr - returns the next available tx descriptor
669  * @card: device structure to get descriptor from
670  *
671  * returns the address of the next descriptor, or NULL if not available.
672  */
673 static struct gelic_descr *
674 gelic_card_get_next_tx_descr(struct gelic_card *card)
675 {
676 	if (!card->tx_chain.head)
677 		return NULL;
678 	/*  see if the next descriptor is free */
679 	if (card->tx_chain.tail != card->tx_chain.head->next &&
680 	    gelic_descr_get_status(card->tx_chain.head) ==
681 	    GELIC_DESCR_DMA_NOT_IN_USE)
682 		return card->tx_chain.head;
683 	else
684 		return NULL;
685 
686 }
687 
688 /**
689  * gelic_net_set_txdescr_cmdstat - sets the tx descriptor command field
690  * @descr: descriptor structure to fill out
691  * @skb: packet to consider
692  *
693  * fills out the command and status field of the descriptor structure,
694  * depending on hardware checksum settings. This function assumes a wmb()
695  * has executed before.
696  */
697 static void gelic_descr_set_tx_cmdstat(struct gelic_descr *descr,
698 				       struct sk_buff *skb)
699 {
700 	if (skb->ip_summed != CHECKSUM_PARTIAL)
701 		descr->dmac_cmd_status =
702 			cpu_to_be32(GELIC_DESCR_DMA_CMD_NO_CHKSUM |
703 				    GELIC_DESCR_TX_DMA_FRAME_TAIL);
704 	else {
705 		/* is packet ip?
706 		 * if yes: tcp? udp? */
707 		if (skb->protocol == htons(ETH_P_IP)) {
708 			if (ip_hdr(skb)->protocol == IPPROTO_TCP)
709 				descr->dmac_cmd_status =
710 				cpu_to_be32(GELIC_DESCR_DMA_CMD_TCP_CHKSUM |
711 					    GELIC_DESCR_TX_DMA_FRAME_TAIL);
712 
713 			else if (ip_hdr(skb)->protocol == IPPROTO_UDP)
714 				descr->dmac_cmd_status =
715 				cpu_to_be32(GELIC_DESCR_DMA_CMD_UDP_CHKSUM |
716 					    GELIC_DESCR_TX_DMA_FRAME_TAIL);
717 			else	/*
718 				 * the stack should checksum non-tcp and non-udp
719 				 * packets on his own: NETIF_F_IP_CSUM
720 				 */
721 				descr->dmac_cmd_status =
722 				cpu_to_be32(GELIC_DESCR_DMA_CMD_NO_CHKSUM |
723 					    GELIC_DESCR_TX_DMA_FRAME_TAIL);
724 		}
725 	}
726 }
727 
728 static struct sk_buff *gelic_put_vlan_tag(struct sk_buff *skb,
729 						 unsigned short tag)
730 {
731 	struct vlan_ethhdr *veth;
732 	static unsigned int c;
733 
734 	if (skb_headroom(skb) < VLAN_HLEN) {
735 		struct sk_buff *sk_tmp = skb;
736 		pr_debug("%s: hd=%d c=%ud\n", __func__, skb_headroom(skb), c);
737 		skb = skb_realloc_headroom(sk_tmp, VLAN_HLEN);
738 		if (!skb)
739 			return NULL;
740 		dev_kfree_skb_any(sk_tmp);
741 	}
742 	veth = skb_push(skb, VLAN_HLEN);
743 
744 	/* Move the mac addresses to the top of buffer */
745 	memmove(skb->data, skb->data + VLAN_HLEN, 2 * ETH_ALEN);
746 
747 	veth->h_vlan_proto = cpu_to_be16(ETH_P_8021Q);
748 	veth->h_vlan_TCI = htons(tag);
749 
750 	return skb;
751 }
752 
753 /**
754  * gelic_descr_prepare_tx - setup a descriptor for sending packets
755  * @card: card structure
756  * @descr: descriptor structure
757  * @skb: packet to use
758  *
759  * returns 0 on success, <0 on failure.
760  *
761  */
762 static int gelic_descr_prepare_tx(struct gelic_card *card,
763 				  struct gelic_descr *descr,
764 				  struct sk_buff *skb)
765 {
766 	dma_addr_t buf;
767 
768 	if (card->vlan_required) {
769 		struct sk_buff *skb_tmp;
770 		enum gelic_port_type type;
771 
772 		type = netdev_port(skb->dev)->type;
773 		skb_tmp = gelic_put_vlan_tag(skb,
774 					     card->vlan[type].tx);
775 		if (!skb_tmp)
776 			return -ENOMEM;
777 		skb = skb_tmp;
778 	}
779 
780 	buf = dma_map_single(ctodev(card), skb->data, skb->len, DMA_TO_DEVICE);
781 
782 	if (!buf) {
783 		dev_err(ctodev(card),
784 			"dma map 2 failed (%p, %i). Dropping packet\n",
785 			skb->data, skb->len);
786 		return -ENOMEM;
787 	}
788 
789 	descr->buf_addr = cpu_to_be32(buf);
790 	descr->buf_size = cpu_to_be32(skb->len);
791 	descr->skb = skb;
792 	descr->data_status = 0;
793 	descr->next_descr_addr = 0; /* terminate hw descr */
794 	gelic_descr_set_tx_cmdstat(descr, skb);
795 
796 	/* bump free descriptor pointer */
797 	card->tx_chain.head = descr->next;
798 	return 0;
799 }
800 
801 /**
802  * gelic_card_kick_txdma - enables TX DMA processing
803  * @card: card structure
804  * @descr: descriptor address to enable TX processing at
805  *
806  */
807 static int gelic_card_kick_txdma(struct gelic_card *card,
808 				 struct gelic_descr *descr)
809 {
810 	int status = 0;
811 
812 	if (card->tx_dma_progress)
813 		return 0;
814 
815 	if (gelic_descr_get_status(descr) == GELIC_DESCR_DMA_CARDOWNED) {
816 		card->tx_dma_progress = 1;
817 		status = lv1_net_start_tx_dma(bus_id(card), dev_id(card),
818 					      descr->bus_addr, 0);
819 		if (status) {
820 			card->tx_dma_progress = 0;
821 			dev_info(ctodev(card), "lv1_net_start_txdma failed," \
822 				 "status=%d\n", status);
823 		}
824 	}
825 	return status;
826 }
827 
828 /**
829  * gelic_net_xmit - transmits a frame over the device
830  * @skb: packet to send out
831  * @netdev: interface device structure
832  *
833  * returns NETDEV_TX_OK on success, NETDEV_TX_BUSY on failure
834  */
835 netdev_tx_t gelic_net_xmit(struct sk_buff *skb, struct net_device *netdev)
836 {
837 	struct gelic_card *card = netdev_card(netdev);
838 	struct gelic_descr *descr;
839 	int result;
840 	unsigned long flags;
841 
842 	spin_lock_irqsave(&card->tx_lock, flags);
843 
844 	gelic_card_release_tx_chain(card, 0);
845 
846 	descr = gelic_card_get_next_tx_descr(card);
847 	if (!descr) {
848 		/*
849 		 * no more descriptors free
850 		 */
851 		gelic_card_stop_queues(card);
852 		spin_unlock_irqrestore(&card->tx_lock, flags);
853 		return NETDEV_TX_BUSY;
854 	}
855 
856 	result = gelic_descr_prepare_tx(card, descr, skb);
857 	if (result) {
858 		/*
859 		 * DMA map failed.  As chances are that failure
860 		 * would continue, just release skb and return
861 		 */
862 		netdev->stats.tx_dropped++;
863 		dev_kfree_skb_any(skb);
864 		spin_unlock_irqrestore(&card->tx_lock, flags);
865 		return NETDEV_TX_OK;
866 	}
867 	/*
868 	 * link this prepared descriptor to previous one
869 	 * to achieve high performance
870 	 */
871 	descr->prev->next_descr_addr = cpu_to_be32(descr->bus_addr);
872 	/*
873 	 * as hardware descriptor is modified in the above lines,
874 	 * ensure that the hardware sees it
875 	 */
876 	wmb();
877 	if (gelic_card_kick_txdma(card, descr)) {
878 		/*
879 		 * kick failed.
880 		 * release descriptor which was just prepared
881 		 */
882 		netdev->stats.tx_dropped++;
883 		/* don't trigger BUG_ON() in gelic_descr_release_tx */
884 		descr->data_status = cpu_to_be32(GELIC_DESCR_TX_TAIL);
885 		gelic_descr_release_tx(card, descr);
886 		/* reset head */
887 		card->tx_chain.head = descr;
888 		/* reset hw termination */
889 		descr->prev->next_descr_addr = 0;
890 		dev_info(ctodev(card), "%s: kick failure\n", __func__);
891 	}
892 
893 	spin_unlock_irqrestore(&card->tx_lock, flags);
894 	return NETDEV_TX_OK;
895 }
896 
897 /**
898  * gelic_net_pass_skb_up - takes an skb from a descriptor and passes it on
899  * @descr: descriptor to process
900  * @card: card structure
901  * @netdev: net_device structure to be passed packet
902  *
903  * iommu-unmaps the skb, fills out skb structure and passes the data to the
904  * stack. The descriptor state is not changed.
905  */
906 static void gelic_net_pass_skb_up(struct gelic_descr *descr,
907 				  struct gelic_card *card,
908 				  struct net_device *netdev)
909 
910 {
911 	struct sk_buff *skb = descr->skb;
912 	u32 data_status, data_error;
913 
914 	data_status = be32_to_cpu(descr->data_status);
915 	data_error = be32_to_cpu(descr->data_error);
916 	/* unmap skb buffer */
917 	dma_unmap_single(ctodev(card), be32_to_cpu(descr->buf_addr),
918 			 GELIC_NET_MAX_MTU,
919 			 DMA_FROM_DEVICE);
920 
921 	skb_put(skb, be32_to_cpu(descr->valid_size)?
922 		be32_to_cpu(descr->valid_size) :
923 		be32_to_cpu(descr->result_size));
924 	if (!descr->valid_size)
925 		dev_info(ctodev(card), "buffer full %x %x %x\n",
926 			 be32_to_cpu(descr->result_size),
927 			 be32_to_cpu(descr->buf_size),
928 			 be32_to_cpu(descr->dmac_cmd_status));
929 
930 	descr->skb = NULL;
931 	/*
932 	 * the card put 2 bytes vlan tag in front
933 	 * of the ethernet frame
934 	 */
935 	skb_pull(skb, 2);
936 	skb->protocol = eth_type_trans(skb, netdev);
937 
938 	/* checksum offload */
939 	if (netdev->features & NETIF_F_RXCSUM) {
940 		if ((data_status & GELIC_DESCR_DATA_STATUS_CHK_MASK) &&
941 		    (!(data_error & GELIC_DESCR_DATA_ERROR_CHK_MASK)))
942 			skb->ip_summed = CHECKSUM_UNNECESSARY;
943 		else
944 			skb_checksum_none_assert(skb);
945 	} else
946 		skb_checksum_none_assert(skb);
947 
948 	/* update netdevice statistics */
949 	netdev->stats.rx_packets++;
950 	netdev->stats.rx_bytes += skb->len;
951 
952 	/* pass skb up to stack */
953 	netif_receive_skb(skb);
954 }
955 
956 /**
957  * gelic_card_decode_one_descr - processes an rx descriptor
958  * @card: card structure
959  *
960  * returns 1 if a packet has been sent to the stack, otherwise 0
961  *
962  * processes an rx descriptor by iommu-unmapping the data buffer and passing
963  * the packet up to the stack
964  */
965 static int gelic_card_decode_one_descr(struct gelic_card *card)
966 {
967 	enum gelic_descr_dma_status status;
968 	struct gelic_descr_chain *chain = &card->rx_chain;
969 	struct gelic_descr *descr = chain->head;
970 	struct net_device *netdev = NULL;
971 	int dmac_chain_ended;
972 
973 	status = gelic_descr_get_status(descr);
974 
975 	if (status == GELIC_DESCR_DMA_CARDOWNED)
976 		return 0;
977 
978 	if (status == GELIC_DESCR_DMA_NOT_IN_USE) {
979 		dev_dbg(ctodev(card), "dormant descr? %p\n", descr);
980 		return 0;
981 	}
982 
983 	/* netdevice select */
984 	if (card->vlan_required) {
985 		unsigned int i;
986 		u16 vid;
987 		vid = *(u16 *)(descr->skb->data) & VLAN_VID_MASK;
988 		for (i = 0; i < GELIC_PORT_MAX; i++) {
989 			if (card->vlan[i].rx == vid) {
990 				netdev = card->netdev[i];
991 				break;
992 			}
993 		}
994 		if (GELIC_PORT_MAX <= i) {
995 			pr_info("%s: unknown packet vid=%x\n", __func__, vid);
996 			goto refill;
997 		}
998 	} else
999 		netdev = card->netdev[GELIC_PORT_ETHERNET_0];
1000 
1001 	if ((status == GELIC_DESCR_DMA_RESPONSE_ERROR) ||
1002 	    (status == GELIC_DESCR_DMA_PROTECTION_ERROR) ||
1003 	    (status == GELIC_DESCR_DMA_FORCE_END)) {
1004 		dev_info(ctodev(card), "dropping RX descriptor with state %x\n",
1005 			 status);
1006 		netdev->stats.rx_dropped++;
1007 		goto refill;
1008 	}
1009 
1010 	if (status == GELIC_DESCR_DMA_BUFFER_FULL) {
1011 		/*
1012 		 * Buffer full would occur if and only if
1013 		 * the frame length was longer than the size of this
1014 		 * descriptor's buffer.  If the frame length was equal
1015 		 * to or shorter than buffer'size, FRAME_END condition
1016 		 * would occur.
1017 		 * Anyway this frame was longer than the MTU,
1018 		 * just drop it.
1019 		 */
1020 		dev_info(ctodev(card), "overlength frame\n");
1021 		goto refill;
1022 	}
1023 	/*
1024 	 * descriptors any other than FRAME_END here should
1025 	 * be treated as error.
1026 	 */
1027 	if (status != GELIC_DESCR_DMA_FRAME_END) {
1028 		dev_dbg(ctodev(card), "RX descriptor with state %x\n",
1029 			status);
1030 		goto refill;
1031 	}
1032 
1033 	/* ok, we've got a packet in descr */
1034 	gelic_net_pass_skb_up(descr, card, netdev);
1035 refill:
1036 
1037 	/* is the current descriptor terminated with next_descr == NULL? */
1038 	dmac_chain_ended =
1039 		be32_to_cpu(descr->dmac_cmd_status) &
1040 		GELIC_DESCR_RX_DMA_CHAIN_END;
1041 	/*
1042 	 * So that always DMAC can see the end
1043 	 * of the descriptor chain to avoid
1044 	 * from unwanted DMAC overrun.
1045 	 */
1046 	descr->next_descr_addr = 0;
1047 
1048 	/* change the descriptor state: */
1049 	gelic_descr_set_status(descr, GELIC_DESCR_DMA_NOT_IN_USE);
1050 
1051 	/*
1052 	 * this call can fail, but for now, just leave this
1053 	 * descriptor without skb
1054 	 */
1055 	gelic_descr_prepare_rx(card, descr);
1056 
1057 	chain->tail = descr;
1058 	chain->head = descr->next;
1059 
1060 	/*
1061 	 * Set this descriptor the end of the chain.
1062 	 */
1063 	descr->prev->next_descr_addr = cpu_to_be32(descr->bus_addr);
1064 
1065 	/*
1066 	 * If dmac chain was met, DMAC stopped.
1067 	 * thus re-enable it
1068 	 */
1069 
1070 	if (dmac_chain_ended)
1071 		gelic_card_enable_rxdmac(card);
1072 
1073 	return 1;
1074 }
1075 
1076 /**
1077  * gelic_net_poll - NAPI poll function called by the stack to return packets
1078  * @napi: napi structure
1079  * @budget: number of packets we can pass to the stack at most
1080  *
1081  * returns the number of the processed packets
1082  *
1083  */
1084 static int gelic_net_poll(struct napi_struct *napi, int budget)
1085 {
1086 	struct gelic_card *card = container_of(napi, struct gelic_card, napi);
1087 	int packets_done = 0;
1088 
1089 	while (packets_done < budget) {
1090 		if (!gelic_card_decode_one_descr(card))
1091 			break;
1092 
1093 		packets_done++;
1094 	}
1095 
1096 	if (packets_done < budget) {
1097 		napi_complete_done(napi, packets_done);
1098 		gelic_card_rx_irq_on(card);
1099 	}
1100 	return packets_done;
1101 }
1102 
1103 /*
1104  * gelic_card_interrupt - event handler for gelic_net
1105  */
1106 static irqreturn_t gelic_card_interrupt(int irq, void *ptr)
1107 {
1108 	unsigned long flags;
1109 	struct gelic_card *card = ptr;
1110 	u64 status;
1111 
1112 	status = card->irq_status;
1113 
1114 	if (!status)
1115 		return IRQ_NONE;
1116 
1117 	status &= card->irq_mask;
1118 
1119 	if (status & GELIC_CARD_RXINT) {
1120 		gelic_card_rx_irq_off(card);
1121 		napi_schedule(&card->napi);
1122 	}
1123 
1124 	if (status & GELIC_CARD_TXINT) {
1125 		spin_lock_irqsave(&card->tx_lock, flags);
1126 		card->tx_dma_progress = 0;
1127 		gelic_card_release_tx_chain(card, 0);
1128 		/* kick outstanding tx descriptor if any */
1129 		gelic_card_kick_txdma(card, card->tx_chain.tail);
1130 		spin_unlock_irqrestore(&card->tx_lock, flags);
1131 	}
1132 
1133 	/* ether port status changed */
1134 	if (status & GELIC_CARD_PORT_STATUS_CHANGED)
1135 		gelic_card_get_ether_port_status(card, 1);
1136 
1137 #ifdef CONFIG_GELIC_WIRELESS
1138 	if (status & (GELIC_CARD_WLAN_EVENT_RECEIVED |
1139 		      GELIC_CARD_WLAN_COMMAND_COMPLETED))
1140 		gelic_wl_interrupt(card->netdev[GELIC_PORT_WIRELESS], status);
1141 #endif
1142 
1143 	return IRQ_HANDLED;
1144 }
1145 
1146 #ifdef CONFIG_NET_POLL_CONTROLLER
1147 /**
1148  * gelic_net_poll_controller - artificial interrupt for netconsole etc.
1149  * @netdev: interface device structure
1150  *
1151  * see Documentation/networking/netconsole.rst
1152  */
1153 void gelic_net_poll_controller(struct net_device *netdev)
1154 {
1155 	struct gelic_card *card = netdev_card(netdev);
1156 
1157 	gelic_card_set_irq_mask(card, 0);
1158 	gelic_card_interrupt(netdev->irq, netdev);
1159 	gelic_card_set_irq_mask(card, card->irq_mask);
1160 }
1161 #endif /* CONFIG_NET_POLL_CONTROLLER */
1162 
1163 /**
1164  * gelic_net_open - called upon ifconfig up
1165  * @netdev: interface device structure
1166  *
1167  * returns 0 on success, <0 on failure
1168  *
1169  * gelic_net_open allocates all the descriptors and memory needed for
1170  * operation, sets up multicast list and enables interrupts
1171  */
1172 int gelic_net_open(struct net_device *netdev)
1173 {
1174 	struct gelic_card *card = netdev_card(netdev);
1175 
1176 	dev_dbg(ctodev(card), " -> %s %p\n", __func__, netdev);
1177 
1178 	gelic_card_up(card);
1179 
1180 	netif_start_queue(netdev);
1181 	gelic_card_get_ether_port_status(card, 1);
1182 
1183 	dev_dbg(ctodev(card), " <- %s\n", __func__);
1184 	return 0;
1185 }
1186 
1187 void gelic_net_get_drvinfo(struct net_device *netdev,
1188 			   struct ethtool_drvinfo *info)
1189 {
1190 	strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
1191 	strlcpy(info->version, DRV_VERSION, sizeof(info->version));
1192 }
1193 
1194 static int gelic_ether_get_link_ksettings(struct net_device *netdev,
1195 					  struct ethtool_link_ksettings *cmd)
1196 {
1197 	struct gelic_card *card = netdev_card(netdev);
1198 	u32 supported, advertising;
1199 
1200 	gelic_card_get_ether_port_status(card, 0);
1201 
1202 	if (card->ether_port_status & GELIC_LV1_ETHER_FULL_DUPLEX)
1203 		cmd->base.duplex = DUPLEX_FULL;
1204 	else
1205 		cmd->base.duplex = DUPLEX_HALF;
1206 
1207 	switch (card->ether_port_status & GELIC_LV1_ETHER_SPEED_MASK) {
1208 	case GELIC_LV1_ETHER_SPEED_10:
1209 		cmd->base.speed = SPEED_10;
1210 		break;
1211 	case GELIC_LV1_ETHER_SPEED_100:
1212 		cmd->base.speed = SPEED_100;
1213 		break;
1214 	case GELIC_LV1_ETHER_SPEED_1000:
1215 		cmd->base.speed = SPEED_1000;
1216 		break;
1217 	default:
1218 		pr_info("%s: speed unknown\n", __func__);
1219 		cmd->base.speed = SPEED_10;
1220 		break;
1221 	}
1222 
1223 	supported = SUPPORTED_TP | SUPPORTED_Autoneg |
1224 			SUPPORTED_10baseT_Half | SUPPORTED_10baseT_Full |
1225 			SUPPORTED_100baseT_Half | SUPPORTED_100baseT_Full |
1226 			SUPPORTED_1000baseT_Full;
1227 	advertising = supported;
1228 	if (card->link_mode & GELIC_LV1_ETHER_AUTO_NEG) {
1229 		cmd->base.autoneg = AUTONEG_ENABLE;
1230 	} else {
1231 		cmd->base.autoneg = AUTONEG_DISABLE;
1232 		advertising &= ~ADVERTISED_Autoneg;
1233 	}
1234 	cmd->base.port = PORT_TP;
1235 
1236 	ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.supported,
1237 						supported);
1238 	ethtool_convert_legacy_u32_to_link_mode(cmd->link_modes.advertising,
1239 						advertising);
1240 
1241 	return 0;
1242 }
1243 
1244 static int
1245 gelic_ether_set_link_ksettings(struct net_device *netdev,
1246 			       const struct ethtool_link_ksettings *cmd)
1247 {
1248 	struct gelic_card *card = netdev_card(netdev);
1249 	u64 mode;
1250 	int ret;
1251 
1252 	if (cmd->base.autoneg == AUTONEG_ENABLE) {
1253 		mode = GELIC_LV1_ETHER_AUTO_NEG;
1254 	} else {
1255 		switch (cmd->base.speed) {
1256 		case SPEED_10:
1257 			mode = GELIC_LV1_ETHER_SPEED_10;
1258 			break;
1259 		case SPEED_100:
1260 			mode = GELIC_LV1_ETHER_SPEED_100;
1261 			break;
1262 		case SPEED_1000:
1263 			mode = GELIC_LV1_ETHER_SPEED_1000;
1264 			break;
1265 		default:
1266 			return -EINVAL;
1267 		}
1268 		if (cmd->base.duplex == DUPLEX_FULL) {
1269 			mode |= GELIC_LV1_ETHER_FULL_DUPLEX;
1270 		} else if (cmd->base.speed == SPEED_1000) {
1271 			pr_info("1000 half duplex is not supported.\n");
1272 			return -EINVAL;
1273 		}
1274 	}
1275 
1276 	ret = gelic_card_set_link_mode(card, mode);
1277 
1278 	if (ret)
1279 		return ret;
1280 
1281 	return 0;
1282 }
1283 
1284 static void gelic_net_get_wol(struct net_device *netdev,
1285 			      struct ethtool_wolinfo *wol)
1286 {
1287 	if (0 <= ps3_compare_firmware_version(2, 2, 0))
1288 		wol->supported = WAKE_MAGIC;
1289 	else
1290 		wol->supported = 0;
1291 
1292 	wol->wolopts = ps3_sys_manager_get_wol() ? wol->supported : 0;
1293 	memset(&wol->sopass, 0, sizeof(wol->sopass));
1294 }
1295 static int gelic_net_set_wol(struct net_device *netdev,
1296 			     struct ethtool_wolinfo *wol)
1297 {
1298 	int status;
1299 	struct gelic_card *card;
1300 	u64 v1, v2;
1301 
1302 	if (ps3_compare_firmware_version(2, 2, 0) < 0 ||
1303 	    !capable(CAP_NET_ADMIN))
1304 		return -EPERM;
1305 
1306 	if (wol->wolopts & ~WAKE_MAGIC)
1307 		return -EINVAL;
1308 
1309 	card = netdev_card(netdev);
1310 	if (wol->wolopts & WAKE_MAGIC) {
1311 		status = lv1_net_control(bus_id(card), dev_id(card),
1312 					 GELIC_LV1_SET_WOL,
1313 					 GELIC_LV1_WOL_MAGIC_PACKET,
1314 					 0, GELIC_LV1_WOL_MP_ENABLE,
1315 					 &v1, &v2);
1316 		if (status) {
1317 			pr_info("%s: enabling WOL failed %d\n", __func__,
1318 				status);
1319 			status = -EIO;
1320 			goto done;
1321 		}
1322 		status = lv1_net_control(bus_id(card), dev_id(card),
1323 					 GELIC_LV1_SET_WOL,
1324 					 GELIC_LV1_WOL_ADD_MATCH_ADDR,
1325 					 0, GELIC_LV1_WOL_MATCH_ALL,
1326 					 &v1, &v2);
1327 		if (!status)
1328 			ps3_sys_manager_set_wol(1);
1329 		else {
1330 			pr_info("%s: enabling WOL filter failed %d\n",
1331 				__func__, status);
1332 			status = -EIO;
1333 		}
1334 	} else {
1335 		status = lv1_net_control(bus_id(card), dev_id(card),
1336 					 GELIC_LV1_SET_WOL,
1337 					 GELIC_LV1_WOL_MAGIC_PACKET,
1338 					 0, GELIC_LV1_WOL_MP_DISABLE,
1339 					 &v1, &v2);
1340 		if (status) {
1341 			pr_info("%s: disabling WOL failed %d\n", __func__,
1342 				status);
1343 			status = -EIO;
1344 			goto done;
1345 		}
1346 		status = lv1_net_control(bus_id(card), dev_id(card),
1347 					 GELIC_LV1_SET_WOL,
1348 					 GELIC_LV1_WOL_DELETE_MATCH_ADDR,
1349 					 0, GELIC_LV1_WOL_MATCH_ALL,
1350 					 &v1, &v2);
1351 		if (!status)
1352 			ps3_sys_manager_set_wol(0);
1353 		else {
1354 			pr_info("%s: removing WOL filter failed %d\n",
1355 				__func__, status);
1356 			status = -EIO;
1357 		}
1358 	}
1359 done:
1360 	return status;
1361 }
1362 
1363 static const struct ethtool_ops gelic_ether_ethtool_ops = {
1364 	.get_drvinfo	= gelic_net_get_drvinfo,
1365 	.get_link	= ethtool_op_get_link,
1366 	.get_wol	= gelic_net_get_wol,
1367 	.set_wol	= gelic_net_set_wol,
1368 	.get_link_ksettings = gelic_ether_get_link_ksettings,
1369 	.set_link_ksettings = gelic_ether_set_link_ksettings,
1370 };
1371 
1372 /**
1373  * gelic_net_tx_timeout_task - task scheduled by the watchdog timeout
1374  * function (to be called not under interrupt status)
1375  * @work: work is context of tx timout task
1376  *
1377  * called as task when tx hangs, resets interface (if interface is up)
1378  */
1379 static void gelic_net_tx_timeout_task(struct work_struct *work)
1380 {
1381 	struct gelic_card *card =
1382 		container_of(work, struct gelic_card, tx_timeout_task);
1383 	struct net_device *netdev = card->netdev[GELIC_PORT_ETHERNET_0];
1384 
1385 	dev_info(ctodev(card), "%s:Timed out. Restarting...\n", __func__);
1386 
1387 	if (!(netdev->flags & IFF_UP))
1388 		goto out;
1389 
1390 	netif_device_detach(netdev);
1391 	gelic_net_stop(netdev);
1392 
1393 	gelic_net_open(netdev);
1394 	netif_device_attach(netdev);
1395 
1396 out:
1397 	atomic_dec(&card->tx_timeout_task_counter);
1398 }
1399 
1400 /**
1401  * gelic_net_tx_timeout - called when the tx timeout watchdog kicks in.
1402  * @netdev: interface device structure
1403  * @txqueue: unused
1404  *
1405  * called, if tx hangs. Schedules a task that resets the interface
1406  */
1407 void gelic_net_tx_timeout(struct net_device *netdev, unsigned int txqueue)
1408 {
1409 	struct gelic_card *card;
1410 
1411 	card = netdev_card(netdev);
1412 	atomic_inc(&card->tx_timeout_task_counter);
1413 	if (netdev->flags & IFF_UP)
1414 		schedule_work(&card->tx_timeout_task);
1415 	else
1416 		atomic_dec(&card->tx_timeout_task_counter);
1417 }
1418 
1419 static const struct net_device_ops gelic_netdevice_ops = {
1420 	.ndo_open = gelic_net_open,
1421 	.ndo_stop = gelic_net_stop,
1422 	.ndo_start_xmit = gelic_net_xmit,
1423 	.ndo_set_rx_mode = gelic_net_set_multi,
1424 	.ndo_tx_timeout = gelic_net_tx_timeout,
1425 	.ndo_set_mac_address = eth_mac_addr,
1426 	.ndo_validate_addr = eth_validate_addr,
1427 #ifdef CONFIG_NET_POLL_CONTROLLER
1428 	.ndo_poll_controller = gelic_net_poll_controller,
1429 #endif
1430 };
1431 
1432 /**
1433  * gelic_ether_setup_netdev_ops - initialization of net_device operations
1434  * @netdev: net_device structure
1435  * @napi: napi structure
1436  *
1437  * fills out function pointers in the net_device structure
1438  */
1439 static void gelic_ether_setup_netdev_ops(struct net_device *netdev,
1440 					 struct napi_struct *napi)
1441 {
1442 	netdev->watchdog_timeo = GELIC_NET_WATCHDOG_TIMEOUT;
1443 	/* NAPI */
1444 	netif_napi_add(netdev, napi, gelic_net_poll, NAPI_POLL_WEIGHT);
1445 	netdev->ethtool_ops = &gelic_ether_ethtool_ops;
1446 	netdev->netdev_ops = &gelic_netdevice_ops;
1447 }
1448 
1449 /**
1450  * gelic_ether_setup_netdev - initialization of net_device
1451  * @netdev: net_device structure
1452  * @card: card structure
1453  *
1454  * Returns 0 on success or <0 on failure
1455  *
1456  * gelic_ether_setup_netdev initializes the net_device structure
1457  * and register it.
1458  **/
1459 int gelic_net_setup_netdev(struct net_device *netdev, struct gelic_card *card)
1460 {
1461 	int status;
1462 	u64 v1, v2;
1463 
1464 	netdev->hw_features = NETIF_F_IP_CSUM | NETIF_F_RXCSUM;
1465 
1466 	netdev->features = NETIF_F_IP_CSUM;
1467 	if (GELIC_CARD_RX_CSUM_DEFAULT)
1468 		netdev->features |= NETIF_F_RXCSUM;
1469 
1470 	status = lv1_net_control(bus_id(card), dev_id(card),
1471 				 GELIC_LV1_GET_MAC_ADDRESS,
1472 				 0, 0, 0, &v1, &v2);
1473 	v1 <<= 16;
1474 	if (status || !is_valid_ether_addr((u8 *)&v1)) {
1475 		dev_info(ctodev(card),
1476 			 "%s:lv1_net_control GET_MAC_ADDR failed %d\n",
1477 			 __func__, status);
1478 		return -EINVAL;
1479 	}
1480 	eth_hw_addr_set(netdev, (u8 *)&v1);
1481 
1482 	if (card->vlan_required) {
1483 		netdev->hard_header_len += VLAN_HLEN;
1484 		/*
1485 		 * As vlan is internally used,
1486 		 * we can not receive vlan packets
1487 		 */
1488 		netdev->features |= NETIF_F_VLAN_CHALLENGED;
1489 	}
1490 
1491 	/* MTU range: 64 - 1518 */
1492 	netdev->min_mtu = GELIC_NET_MIN_MTU;
1493 	netdev->max_mtu = GELIC_NET_MAX_MTU;
1494 
1495 	status = register_netdev(netdev);
1496 	if (status) {
1497 		dev_err(ctodev(card), "%s:Couldn't register %s %d\n",
1498 			__func__, netdev->name, status);
1499 		return status;
1500 	}
1501 	dev_info(ctodev(card), "%s: MAC addr %pM\n",
1502 		 netdev->name, netdev->dev_addr);
1503 
1504 	return 0;
1505 }
1506 
1507 /**
1508  * gelic_alloc_card_net - allocates net_device and card structure
1509  *
1510  * returns the card structure or NULL in case of errors
1511  *
1512  * the card and net_device structures are linked to each other
1513  */
1514 #define GELIC_ALIGN (32)
1515 static struct gelic_card *gelic_alloc_card_net(struct net_device **netdev)
1516 {
1517 	struct gelic_card *card;
1518 	struct gelic_port *port;
1519 	void *p;
1520 	size_t alloc_size;
1521 	/*
1522 	 * gelic requires dma descriptor is 32 bytes aligned and
1523 	 * the hypervisor requires irq_status is 8 bytes aligned.
1524 	 */
1525 	BUILD_BUG_ON(offsetof(struct gelic_card, irq_status) % 8);
1526 	BUILD_BUG_ON(offsetof(struct gelic_card, descr) % 32);
1527 	alloc_size =
1528 		sizeof(struct gelic_card) +
1529 		sizeof(struct gelic_descr) * GELIC_NET_RX_DESCRIPTORS +
1530 		sizeof(struct gelic_descr) * GELIC_NET_TX_DESCRIPTORS +
1531 		GELIC_ALIGN - 1;
1532 
1533 	p  = kzalloc(alloc_size, GFP_KERNEL);
1534 	if (!p)
1535 		return NULL;
1536 	card = PTR_ALIGN(p, GELIC_ALIGN);
1537 	card->unalign = p;
1538 
1539 	/*
1540 	 * alloc netdev
1541 	 */
1542 	*netdev = alloc_etherdev(sizeof(struct gelic_port));
1543 	if (!*netdev) {
1544 		kfree(card->unalign);
1545 		return NULL;
1546 	}
1547 	port = netdev_priv(*netdev);
1548 
1549 	/* gelic_port */
1550 	port->netdev = *netdev;
1551 	port->card = card;
1552 	port->type = GELIC_PORT_ETHERNET_0;
1553 
1554 	/* gelic_card */
1555 	card->netdev[GELIC_PORT_ETHERNET_0] = *netdev;
1556 
1557 	INIT_WORK(&card->tx_timeout_task, gelic_net_tx_timeout_task);
1558 	init_waitqueue_head(&card->waitq);
1559 	atomic_set(&card->tx_timeout_task_counter, 0);
1560 	mutex_init(&card->updown_lock);
1561 	atomic_set(&card->users, 0);
1562 
1563 	return card;
1564 }
1565 
1566 static void gelic_card_get_vlan_info(struct gelic_card *card)
1567 {
1568 	u64 v1, v2;
1569 	int status;
1570 	unsigned int i;
1571 	struct {
1572 		int tx;
1573 		int rx;
1574 	} vlan_id_ix[2] = {
1575 		[GELIC_PORT_ETHERNET_0] = {
1576 			.tx = GELIC_LV1_VLAN_TX_ETHERNET_0,
1577 			.rx = GELIC_LV1_VLAN_RX_ETHERNET_0
1578 		},
1579 		[GELIC_PORT_WIRELESS] = {
1580 			.tx = GELIC_LV1_VLAN_TX_WIRELESS,
1581 			.rx = GELIC_LV1_VLAN_RX_WIRELESS
1582 		}
1583 	};
1584 
1585 	for (i = 0; i < ARRAY_SIZE(vlan_id_ix); i++) {
1586 		/* tx tag */
1587 		status = lv1_net_control(bus_id(card), dev_id(card),
1588 					 GELIC_LV1_GET_VLAN_ID,
1589 					 vlan_id_ix[i].tx,
1590 					 0, 0, &v1, &v2);
1591 		if (status || !v1) {
1592 			if (status != LV1_NO_ENTRY)
1593 				dev_dbg(ctodev(card),
1594 					"get vlan id for tx(%d) failed(%d)\n",
1595 					vlan_id_ix[i].tx, status);
1596 			card->vlan[i].tx = 0;
1597 			card->vlan[i].rx = 0;
1598 			continue;
1599 		}
1600 		card->vlan[i].tx = (u16)v1;
1601 
1602 		/* rx tag */
1603 		status = lv1_net_control(bus_id(card), dev_id(card),
1604 					 GELIC_LV1_GET_VLAN_ID,
1605 					 vlan_id_ix[i].rx,
1606 					 0, 0, &v1, &v2);
1607 		if (status || !v1) {
1608 			if (status != LV1_NO_ENTRY)
1609 				dev_info(ctodev(card),
1610 					 "get vlan id for rx(%d) failed(%d)\n",
1611 					 vlan_id_ix[i].rx, status);
1612 			card->vlan[i].tx = 0;
1613 			card->vlan[i].rx = 0;
1614 			continue;
1615 		}
1616 		card->vlan[i].rx = (u16)v1;
1617 
1618 		dev_dbg(ctodev(card), "vlan_id[%d] tx=%02x rx=%02x\n",
1619 			i, card->vlan[i].tx, card->vlan[i].rx);
1620 	}
1621 
1622 	if (card->vlan[GELIC_PORT_ETHERNET_0].tx) {
1623 		BUG_ON(!card->vlan[GELIC_PORT_WIRELESS].tx);
1624 		card->vlan_required = 1;
1625 	} else
1626 		card->vlan_required = 0;
1627 
1628 	/* check wirelss capable firmware */
1629 	if (ps3_compare_firmware_version(1, 6, 0) < 0) {
1630 		card->vlan[GELIC_PORT_WIRELESS].tx = 0;
1631 		card->vlan[GELIC_PORT_WIRELESS].rx = 0;
1632 	}
1633 
1634 	dev_info(ctodev(card), "internal vlan %s\n",
1635 		 card->vlan_required? "enabled" : "disabled");
1636 }
1637 /*
1638  * ps3_gelic_driver_probe - add a device to the control of this driver
1639  */
1640 static int ps3_gelic_driver_probe(struct ps3_system_bus_device *dev)
1641 {
1642 	struct gelic_card *card;
1643 	struct net_device *netdev;
1644 	int result;
1645 
1646 	pr_debug("%s: called\n", __func__);
1647 
1648 	udbg_shutdown_ps3gelic();
1649 
1650 	result = ps3_open_hv_device(dev);
1651 
1652 	if (result) {
1653 		dev_dbg(&dev->core, "%s:ps3_open_hv_device failed\n",
1654 			__func__);
1655 		goto fail_open;
1656 	}
1657 
1658 	result = ps3_dma_region_create(dev->d_region);
1659 
1660 	if (result) {
1661 		dev_dbg(&dev->core, "%s:ps3_dma_region_create failed(%d)\n",
1662 			__func__, result);
1663 		BUG_ON("check region type");
1664 		goto fail_dma_region;
1665 	}
1666 
1667 	/* alloc card/netdevice */
1668 	card = gelic_alloc_card_net(&netdev);
1669 	if (!card) {
1670 		dev_info(&dev->core, "%s:gelic_net_alloc_card failed\n",
1671 			 __func__);
1672 		result = -ENOMEM;
1673 		goto fail_alloc_card;
1674 	}
1675 	ps3_system_bus_set_drvdata(dev, card);
1676 	card->dev = dev;
1677 
1678 	/* get internal vlan info */
1679 	gelic_card_get_vlan_info(card);
1680 
1681 	card->link_mode = GELIC_LV1_ETHER_AUTO_NEG;
1682 
1683 	/* setup interrupt */
1684 	result = lv1_net_set_interrupt_status_indicator(bus_id(card),
1685 							dev_id(card),
1686 		ps3_mm_phys_to_lpar(__pa(&card->irq_status)),
1687 		0);
1688 
1689 	if (result) {
1690 		dev_dbg(&dev->core,
1691 			"%s:set_interrupt_status_indicator failed: %s\n",
1692 			__func__, ps3_result(result));
1693 		result = -EIO;
1694 		goto fail_status_indicator;
1695 	}
1696 
1697 	result = ps3_sb_event_receive_port_setup(dev, PS3_BINDING_CPU_ANY,
1698 		&card->irq);
1699 
1700 	if (result) {
1701 		dev_info(ctodev(card),
1702 			 "%s:gelic_net_open_device failed (%d)\n",
1703 			 __func__, result);
1704 		result = -EPERM;
1705 		goto fail_alloc_irq;
1706 	}
1707 	result = request_irq(card->irq, gelic_card_interrupt,
1708 			     0, netdev->name, card);
1709 
1710 	if (result) {
1711 		dev_info(ctodev(card), "%s:request_irq failed (%d)\n",
1712 			__func__, result);
1713 		goto fail_request_irq;
1714 	}
1715 
1716 	/* setup card structure */
1717 	card->irq_mask = GELIC_CARD_RXINT | GELIC_CARD_TXINT |
1718 		GELIC_CARD_PORT_STATUS_CHANGED;
1719 
1720 
1721 	result = gelic_card_init_chain(card, &card->tx_chain,
1722 				       card->descr, GELIC_NET_TX_DESCRIPTORS);
1723 	if (result)
1724 		goto fail_alloc_tx;
1725 	result = gelic_card_init_chain(card, &card->rx_chain,
1726 				       card->descr + GELIC_NET_TX_DESCRIPTORS,
1727 				       GELIC_NET_RX_DESCRIPTORS);
1728 	if (result)
1729 		goto fail_alloc_rx;
1730 
1731 	/* head of chain */
1732 	card->tx_top = card->tx_chain.head;
1733 	card->rx_top = card->rx_chain.head;
1734 	dev_dbg(ctodev(card), "descr rx %p, tx %p, size %#lx, num %#x\n",
1735 		card->rx_top, card->tx_top, sizeof(struct gelic_descr),
1736 		GELIC_NET_RX_DESCRIPTORS);
1737 	/* allocate rx skbs */
1738 	result = gelic_card_alloc_rx_skbs(card);
1739 	if (result)
1740 		goto fail_alloc_skbs;
1741 
1742 	spin_lock_init(&card->tx_lock);
1743 	card->tx_dma_progress = 0;
1744 
1745 	/* setup net_device structure */
1746 	netdev->irq = card->irq;
1747 	SET_NETDEV_DEV(netdev, &card->dev->core);
1748 	gelic_ether_setup_netdev_ops(netdev, &card->napi);
1749 	result = gelic_net_setup_netdev(netdev, card);
1750 	if (result) {
1751 		dev_dbg(&dev->core, "%s: setup_netdev failed %d\n",
1752 			__func__, result);
1753 		goto fail_setup_netdev;
1754 	}
1755 
1756 #ifdef CONFIG_GELIC_WIRELESS
1757 	result = gelic_wl_driver_probe(card);
1758 	if (result) {
1759 		dev_dbg(&dev->core, "%s: WL init failed\n", __func__);
1760 		goto fail_setup_netdev;
1761 	}
1762 #endif
1763 	pr_debug("%s: done\n", __func__);
1764 	return 0;
1765 
1766 fail_setup_netdev:
1767 fail_alloc_skbs:
1768 	gelic_card_free_chain(card, card->rx_chain.head);
1769 fail_alloc_rx:
1770 	gelic_card_free_chain(card, card->tx_chain.head);
1771 fail_alloc_tx:
1772 	free_irq(card->irq, card);
1773 	netdev->irq = 0;
1774 fail_request_irq:
1775 	ps3_sb_event_receive_port_destroy(dev, card->irq);
1776 fail_alloc_irq:
1777 	lv1_net_set_interrupt_status_indicator(bus_id(card),
1778 					       bus_id(card),
1779 					       0, 0);
1780 fail_status_indicator:
1781 	ps3_system_bus_set_drvdata(dev, NULL);
1782 	kfree(netdev_card(netdev)->unalign);
1783 	free_netdev(netdev);
1784 fail_alloc_card:
1785 	ps3_dma_region_free(dev->d_region);
1786 fail_dma_region:
1787 	ps3_close_hv_device(dev);
1788 fail_open:
1789 	return result;
1790 }
1791 
1792 /*
1793  * ps3_gelic_driver_remove - remove a device from the control of this driver
1794  */
1795 
1796 static void ps3_gelic_driver_remove(struct ps3_system_bus_device *dev)
1797 {
1798 	struct gelic_card *card = ps3_system_bus_get_drvdata(dev);
1799 	struct net_device *netdev0;
1800 	pr_debug("%s: called\n", __func__);
1801 
1802 	/* set auto-negotiation */
1803 	gelic_card_set_link_mode(card, GELIC_LV1_ETHER_AUTO_NEG);
1804 
1805 #ifdef CONFIG_GELIC_WIRELESS
1806 	gelic_wl_driver_remove(card);
1807 #endif
1808 	/* stop interrupt */
1809 	gelic_card_set_irq_mask(card, 0);
1810 
1811 	/* turn off DMA, force end */
1812 	gelic_card_disable_rxdmac(card);
1813 	gelic_card_disable_txdmac(card);
1814 
1815 	/* release chains */
1816 	gelic_card_release_tx_chain(card, 1);
1817 	gelic_card_release_rx_chain(card);
1818 
1819 	gelic_card_free_chain(card, card->tx_top);
1820 	gelic_card_free_chain(card, card->rx_top);
1821 
1822 	netdev0 = card->netdev[GELIC_PORT_ETHERNET_0];
1823 	/* disconnect event port */
1824 	free_irq(card->irq, card);
1825 	netdev0->irq = 0;
1826 	ps3_sb_event_receive_port_destroy(card->dev, card->irq);
1827 
1828 	wait_event(card->waitq,
1829 		   atomic_read(&card->tx_timeout_task_counter) == 0);
1830 
1831 	lv1_net_set_interrupt_status_indicator(bus_id(card), dev_id(card),
1832 					       0 , 0);
1833 
1834 	unregister_netdev(netdev0);
1835 	kfree(netdev_card(netdev0)->unalign);
1836 	free_netdev(netdev0);
1837 
1838 	ps3_system_bus_set_drvdata(dev, NULL);
1839 
1840 	ps3_dma_region_free(dev->d_region);
1841 
1842 	ps3_close_hv_device(dev);
1843 
1844 	pr_debug("%s: done\n", __func__);
1845 }
1846 
1847 static struct ps3_system_bus_driver ps3_gelic_driver = {
1848 	.match_id = PS3_MATCH_ID_GELIC,
1849 	.probe = ps3_gelic_driver_probe,
1850 	.remove = ps3_gelic_driver_remove,
1851 	.shutdown = ps3_gelic_driver_remove,
1852 	.core.name = "ps3_gelic_driver",
1853 	.core.owner = THIS_MODULE,
1854 };
1855 
1856 static int __init ps3_gelic_driver_init (void)
1857 {
1858 	return firmware_has_feature(FW_FEATURE_PS3_LV1)
1859 		? ps3_system_bus_driver_register(&ps3_gelic_driver)
1860 		: -ENODEV;
1861 }
1862 
1863 static void __exit ps3_gelic_driver_exit (void)
1864 {
1865 	ps3_system_bus_driver_unregister(&ps3_gelic_driver);
1866 }
1867 
1868 module_init(ps3_gelic_driver_init);
1869 module_exit(ps3_gelic_driver_exit);
1870 
1871 MODULE_ALIAS(PS3_MODULE_ALIAS_GELIC);
1872 
1873