2 * PS3 gelic network driver.
4 * Copyright (C) 2007 Sony Computer Entertainment Inc.
5 * Copyright 2006, 2007 Sony Corporation
7 * This file is based on: spider_net.c
9 * (C) Copyright IBM Corp. 2005
11 * Authors : Utz Bacher <utz.bacher@de.ibm.com>
12 * Jens Osterkamp <Jens.Osterkamp@de.ibm.com>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
31 #include <linux/kernel.h>
32 #include <linux/module.h>
34 #include <linux/etherdevice.h>
35 #include <linux/ethtool.h>
36 #include <linux/if_vlan.h>
40 #include <linux/tcp.h>
42 #include <linux/dma-mapping.h>
43 #include <net/checksum.h>
44 #include <asm/firmware.h>
46 #include <asm/lv1call.h>
48 #include "ps3_gelic_net.h"
50 #define DRV_NAME "Gelic Network Driver"
51 #define DRV_VERSION "1.0"
53 MODULE_AUTHOR("SCE Inc.");
54 MODULE_DESCRIPTION("Gelic Network driver");
55 MODULE_LICENSE("GPL");
57 static inline struct device *ctodev(struct gelic_net_card *card)
59 return &card->dev->core;
61 static inline unsigned int bus_id(struct gelic_net_card *card)
63 return card->dev->bus_id;
65 static inline unsigned int dev_id(struct gelic_net_card *card)
67 return card->dev->dev_id;
71 static int gelic_net_set_irq_mask(struct gelic_net_card *card, u64 mask)
75 status = lv1_net_set_interrupt_mask(bus_id(card), dev_id(card),
78 dev_info(ctodev(card),
79 "lv1_net_set_interrupt_mask failed %d\n", status);
82 static inline void gelic_net_rx_irq_on(struct gelic_net_card *card)
84 gelic_net_set_irq_mask(card, card->ghiintmask | GELIC_NET_RXINT);
86 static inline void gelic_net_rx_irq_off(struct gelic_net_card *card)
88 gelic_net_set_irq_mask(card, card->ghiintmask & ~GELIC_NET_RXINT);
91 * gelic_net_get_descr_status -- returns the status of a descriptor
92 * @descr: descriptor to look at
94 * returns the status as in the dmac_cmd_status field of the descriptor
96 static enum gelic_net_descr_status
97 gelic_net_get_descr_status(struct gelic_net_descr *descr)
101 cmd_status = descr->dmac_cmd_status;
102 cmd_status >>= GELIC_NET_DESCR_IND_PROC_SHIFT;
107 * gelic_net_set_descr_status -- sets the status of a descriptor
108 * @descr: descriptor to change
109 * @status: status to set in the descriptor
111 * changes the status to the specified value. Doesn't change other bits
114 static void gelic_net_set_descr_status(struct gelic_net_descr *descr,
115 enum gelic_net_descr_status status)
119 /* read the status */
120 cmd_status = descr->dmac_cmd_status;
121 /* clean the upper 4 bits */
122 cmd_status &= GELIC_NET_DESCR_IND_PROC_MASKO;
123 /* add the status to it */
124 cmd_status |= ((u32)status) << GELIC_NET_DESCR_IND_PROC_SHIFT;
125 /* and write it back */
126 descr->dmac_cmd_status = cmd_status;
128 * dma_cmd_status field is used to indicate whether the descriptor
130 * Usually caller of this function wants to inform that to the
131 * hardware, so we assure here the hardware sees the change.
137 * gelic_net_free_chain - free descriptor chain
138 * @card: card structure
139 * @descr_in: address of desc
141 static void gelic_net_free_chain(struct gelic_net_card *card,
142 struct gelic_net_descr *descr_in)
144 struct gelic_net_descr *descr;
146 for (descr = descr_in; descr && descr->bus_addr; descr = descr->next) {
147 dma_unmap_single(ctodev(card), descr->bus_addr,
148 GELIC_NET_DESCR_SIZE, DMA_BIDIRECTIONAL);
154 * gelic_net_init_chain - links descriptor chain
155 * @card: card structure
156 * @chain: address of chain
157 * @start_descr: address of descriptor array
158 * @no: number of descriptors
160 * we manage a circular list that mirrors the hardware structure,
161 * except that the hardware uses bus addresses.
163 * returns 0 on success, <0 on failure
165 static int gelic_net_init_chain(struct gelic_net_card *card,
166 struct gelic_net_descr_chain *chain,
167 struct gelic_net_descr *start_descr, int no)
170 struct gelic_net_descr *descr;
173 memset(descr, 0, sizeof(*descr) * no);
175 /* set up the hardware pointers in each descriptor */
176 for (i = 0; i < no; i++, descr++) {
177 gelic_net_set_descr_status(descr, GELIC_NET_DESCR_NOT_IN_USE);
179 dma_map_single(ctodev(card), descr,
180 GELIC_NET_DESCR_SIZE,
183 if (!descr->bus_addr)
186 descr->next = descr + 1;
187 descr->prev = descr - 1;
189 /* make them as ring */
190 (descr - 1)->next = start_descr;
191 start_descr->prev = (descr - 1);
193 /* chain bus addr of hw descriptor */
195 for (i = 0; i < no; i++, descr++) {
196 descr->next_descr_addr = descr->next->bus_addr;
199 chain->head = start_descr;
200 chain->tail = start_descr;
202 /* do not chain last hw descriptor */
203 (descr - 1)->next_descr_addr = 0;
208 for (i--, descr--; 0 <= i; i--, descr--)
210 dma_unmap_single(ctodev(card), descr->bus_addr,
211 GELIC_NET_DESCR_SIZE,
217 * gelic_net_prepare_rx_descr - reinitializes a rx descriptor
218 * @card: card structure
219 * @descr: descriptor to re-init
221 * return 0 on succes, <0 on failure
223 * allocates a new rx skb, iommu-maps it and attaches it to the descriptor.
224 * Activate the descriptor state-wise
226 static int gelic_net_prepare_rx_descr(struct gelic_net_card *card,
227 struct gelic_net_descr *descr)
230 unsigned int bufsize;
232 if (gelic_net_get_descr_status(descr) != GELIC_NET_DESCR_NOT_IN_USE) {
233 dev_info(ctodev(card), "%s: ERROR status \n", __func__);
235 /* we need to round up the buffer size to a multiple of 128 */
236 bufsize = ALIGN(GELIC_NET_MAX_MTU, GELIC_NET_RXBUF_ALIGN);
238 /* and we need to have it 128 byte aligned, therefore we allocate a
240 descr->skb = netdev_alloc_skb(card->netdev,
241 bufsize + GELIC_NET_RXBUF_ALIGN - 1);
243 descr->buf_addr = 0; /* tell DMAC don't touch memory */
244 dev_info(ctodev(card),
245 "%s:allocate skb failed !!\n", __func__);
248 descr->buf_size = bufsize;
249 descr->dmac_cmd_status = 0;
250 descr->result_size = 0;
251 descr->valid_size = 0;
252 descr->data_error = 0;
254 offset = ((unsigned long)descr->skb->data) &
255 (GELIC_NET_RXBUF_ALIGN - 1);
257 skb_reserve(descr->skb, GELIC_NET_RXBUF_ALIGN - offset);
258 /* io-mmu-map the skb */
259 descr->buf_addr = dma_map_single(ctodev(card), descr->skb->data,
262 if (!descr->buf_addr) {
263 dev_kfree_skb_any(descr->skb);
265 dev_info(ctodev(card),
266 "%s:Could not iommu-map rx buffer\n", __func__);
267 gelic_net_set_descr_status(descr, GELIC_NET_DESCR_NOT_IN_USE);
270 gelic_net_set_descr_status(descr, GELIC_NET_DESCR_CARDOWNED);
276 * gelic_net_release_rx_chain - free all skb of rx descr
277 * @card: card structure
280 static void gelic_net_release_rx_chain(struct gelic_net_card *card)
282 struct gelic_net_descr *descr = card->rx_chain.head;
286 dma_unmap_single(ctodev(card),
291 dev_kfree_skb_any(descr->skb);
293 gelic_net_set_descr_status(descr,
294 GELIC_NET_DESCR_NOT_IN_USE);
297 } while (descr != card->rx_chain.head);
301 * gelic_net_fill_rx_chain - fills descriptors/skbs in the rx chains
302 * @card: card structure
304 * fills all descriptors in the rx chain: allocates skbs
305 * and iommu-maps them.
306 * returns 0 on success, <0 on failure
308 static int gelic_net_fill_rx_chain(struct gelic_net_card *card)
310 struct gelic_net_descr *descr = card->rx_chain.head;
315 ret = gelic_net_prepare_rx_descr(card, descr);
320 } while (descr != card->rx_chain.head);
324 gelic_net_release_rx_chain(card);
329 * gelic_net_alloc_rx_skbs - allocates rx skbs in rx descriptor chains
330 * @card: card structure
332 * returns 0 on success, <0 on failure
334 static int gelic_net_alloc_rx_skbs(struct gelic_net_card *card)
336 struct gelic_net_descr_chain *chain;
338 chain = &card->rx_chain;
339 ret = gelic_net_fill_rx_chain(card);
340 chain->head = card->rx_top->prev; /* point to the last */
345 * gelic_net_release_tx_descr - processes a used tx descriptor
346 * @card: card structure
347 * @descr: descriptor to release
349 * releases a used tx descriptor (unmapping, freeing of skb)
351 static void gelic_net_release_tx_descr(struct gelic_net_card *card,
352 struct gelic_net_descr *descr)
357 if (descr->data_status & (1 << GELIC_NET_TXDESC_TAIL)) {
360 dma_unmap_single(ctodev(card), descr->buf_addr, skb->len,
362 dev_kfree_skb_any(skb);
364 dma_unmap_single(ctodev(card), descr->buf_addr,
365 descr->buf_size, DMA_TO_DEVICE);
370 descr->next_descr_addr = 0;
371 descr->result_size = 0;
372 descr->valid_size = 0;
373 descr->data_status = 0;
374 descr->data_error = 0;
377 /* set descr status */
378 gelic_net_set_descr_status(descr, GELIC_NET_DESCR_NOT_IN_USE);
382 * gelic_net_release_tx_chain - processes sent tx descriptors
383 * @card: adapter structure
384 * @stop: net_stop sequence
386 * releases the tx descriptors that gelic has finished with
388 static void gelic_net_release_tx_chain(struct gelic_net_card *card, int stop)
390 struct gelic_net_descr_chain *tx_chain;
391 enum gelic_net_descr_status status;
394 for (tx_chain = &card->tx_chain;
395 tx_chain->head != tx_chain->tail && tx_chain->tail;
396 tx_chain->tail = tx_chain->tail->next) {
397 status = gelic_net_get_descr_status(tx_chain->tail);
399 case GELIC_NET_DESCR_RESPONSE_ERROR:
400 case GELIC_NET_DESCR_PROTECTION_ERROR:
401 case GELIC_NET_DESCR_FORCE_END:
402 if (printk_ratelimit())
403 dev_info(ctodev(card),
404 "%s: forcing end of tx descriptor " \
407 card->netdev->stats.tx_dropped++;
410 case GELIC_NET_DESCR_COMPLETE:
411 if (tx_chain->tail->skb) {
412 card->netdev->stats.tx_packets++;
413 card->netdev->stats.tx_bytes +=
414 tx_chain->tail->skb->len;
418 case GELIC_NET_DESCR_CARDOWNED:
419 /* pending tx request */
421 /* any other value (== GELIC_NET_DESCR_NOT_IN_USE) */
425 gelic_net_release_tx_descr(card, tx_chain->tail);
429 if (!stop && (2 < release))
430 netif_wake_queue(card->netdev);
434 * gelic_net_set_multi - sets multicast addresses and promisc flags
435 * @netdev: interface device structure
437 * gelic_net_set_multi configures multicast addresses as needed for the
438 * netdev interface. It also sets up multicast, allmulti and promisc
439 * flags appropriately
441 static void gelic_net_set_multi(struct net_device *netdev)
443 struct gelic_net_card *card = netdev_priv(netdev);
444 struct dev_mc_list *mc;
450 /* clear all multicast address */
451 status = lv1_net_remove_multicast_address(bus_id(card), dev_id(card),
454 dev_err(ctodev(card),
455 "lv1_net_remove_multicast_address failed %d\n",
457 /* set broadcast address */
458 status = lv1_net_add_multicast_address(bus_id(card), dev_id(card),
459 GELIC_NET_BROADCAST_ADDR, 0);
461 dev_err(ctodev(card),
462 "lv1_net_add_multicast_address failed, %d\n",
465 if (netdev->flags & IFF_ALLMULTI
466 || netdev->mc_count > GELIC_NET_MC_COUNT_MAX) { /* list max */
467 status = lv1_net_add_multicast_address(bus_id(card),
471 dev_err(ctodev(card),
472 "lv1_net_add_multicast_address failed, %d\n",
477 /* set multicast address */
478 for (mc = netdev->mc_list; mc; mc = mc->next) {
481 for (i = 0; i < ETH_ALEN; i++) {
485 status = lv1_net_add_multicast_address(bus_id(card),
489 dev_err(ctodev(card),
490 "lv1_net_add_multicast_address failed, %d\n",
496 * gelic_net_enable_rxdmac - enables the receive DMA controller
497 * @card: card structure
499 * gelic_net_enable_rxdmac enables the DMA controller by setting RX_DMA_EN
500 * in the GDADMACCNTR register
502 static inline void gelic_net_enable_rxdmac(struct gelic_net_card *card)
506 status = lv1_net_start_rx_dma(bus_id(card), dev_id(card),
507 card->rx_chain.tail->bus_addr, 0);
509 dev_info(ctodev(card),
510 "lv1_net_start_rx_dma failed, status=%d\n", status);
514 * gelic_net_disable_rxdmac - disables the receive DMA controller
515 * @card: card structure
517 * gelic_net_disable_rxdmac terminates processing on the DMA controller by
518 * turing off DMA and issueing a force end
520 static inline void gelic_net_disable_rxdmac(struct gelic_net_card *card)
524 /* this hvc blocks until the DMA in progress really stopped */
525 status = lv1_net_stop_rx_dma(bus_id(card), dev_id(card), 0);
527 dev_err(ctodev(card),
528 "lv1_net_stop_rx_dma faild, %d\n", status);
532 * gelic_net_disable_txdmac - disables the transmit DMA controller
533 * @card: card structure
535 * gelic_net_disable_txdmac terminates processing on the DMA controller by
536 * turing off DMA and issueing a force end
538 static inline void gelic_net_disable_txdmac(struct gelic_net_card *card)
542 /* this hvc blocks until the DMA in progress really stopped */
543 status = lv1_net_stop_tx_dma(bus_id(card), dev_id(card), 0);
545 dev_err(ctodev(card),
546 "lv1_net_stop_tx_dma faild, status=%d\n", status);
550 * gelic_net_stop - called upon ifconfig down
551 * @netdev: interface device structure
555 static int gelic_net_stop(struct net_device *netdev)
557 struct gelic_net_card *card = netdev_priv(netdev);
559 netif_stop_queue(netdev);
561 /* turn off DMA, force end */
562 gelic_net_disable_rxdmac(card);
563 gelic_net_disable_txdmac(card);
565 gelic_net_set_irq_mask(card, 0);
567 /* disconnect event port */
568 free_irq(card->netdev->irq, card->netdev);
569 ps3_sb_event_receive_port_destroy(card->dev, card->netdev->irq);
570 card->netdev->irq = NO_IRQ;
572 netif_carrier_off(netdev);
575 gelic_net_release_tx_chain(card, 1);
576 gelic_net_release_rx_chain(card);
578 gelic_net_free_chain(card, card->tx_top);
579 gelic_net_free_chain(card, card->rx_top);
585 * gelic_net_get_next_tx_descr - returns the next available tx descriptor
586 * @card: device structure to get descriptor from
588 * returns the address of the next descriptor, or NULL if not available.
590 static struct gelic_net_descr *
591 gelic_net_get_next_tx_descr(struct gelic_net_card *card)
593 if (!card->tx_chain.head)
595 /* see if we can two consecutive free descrs */
596 if (card->tx_chain.tail != card->tx_chain.head->next &&
597 gelic_net_get_descr_status(card->tx_chain.head) ==
598 GELIC_NET_DESCR_NOT_IN_USE &&
599 card->tx_chain.tail != card->tx_chain.head->next->next &&
600 gelic_net_get_descr_status(card->tx_chain.head->next) ==
601 GELIC_NET_DESCR_NOT_IN_USE )
602 return card->tx_chain.head;
609 * gelic_net_set_txdescr_cmdstat - sets the tx descriptor command field
610 * @descr: descriptor structure to fill out
611 * @skb: packet to consider
612 * @middle: middle of frame
614 * fills out the command and status field of the descriptor structure,
615 * depending on hardware checksum settings. This function assumes a wmb()
616 * has executed before.
618 static void gelic_net_set_txdescr_cmdstat(struct gelic_net_descr *descr,
619 struct sk_buff *skb, int middle)
626 eofr = GELIC_NET_DMAC_CMDSTAT_END_FRAME;
628 if (skb->ip_summed != CHECKSUM_PARTIAL)
629 descr->dmac_cmd_status = GELIC_NET_DMAC_CMDSTAT_NOCS | eofr;
632 * if yes: tcp? udp? */
633 if (skb->protocol == htons(ETH_P_IP)) {
634 if (ip_hdr(skb)->protocol == IPPROTO_TCP)
635 descr->dmac_cmd_status =
636 GELIC_NET_DMAC_CMDSTAT_TCPCS | eofr;
637 else if (ip_hdr(skb)->protocol == IPPROTO_UDP)
638 descr->dmac_cmd_status =
639 GELIC_NET_DMAC_CMDSTAT_UDPCS | eofr;
641 * the stack should checksum non-tcp and non-udp
642 * packets on his own: NETIF_F_IP_CSUM
644 descr->dmac_cmd_status =
645 GELIC_NET_DMAC_CMDSTAT_NOCS | eofr;
651 * gelic_net_prepare_tx_descr_v - get dma address of skb_data
652 * @card: card structure
653 * @descr: descriptor structure
654 * @skb: packet to use
656 * returns 0 on success, <0 on failure.
659 static int gelic_net_prepare_tx_descr_v(struct gelic_net_card *card,
660 struct gelic_net_descr *descr,
664 unsigned int vlan_len;
665 struct gelic_net_descr *sec_descr = descr->next;
667 if (skb->len < GELIC_NET_VLAN_POS)
670 vlan_len = GELIC_NET_VLAN_POS;
671 memcpy(&descr->vlan, skb->data, vlan_len);
672 if (card->vlan_index != -1) {
673 /* internal vlan tag used */
674 descr->vlan.h_vlan_proto = htons(ETH_P_8021Q); /* vlan 0x8100*/
675 descr->vlan.h_vlan_TCI = htons(card->vlan_id[card->vlan_index]);
676 vlan_len += VLAN_HLEN; /* added for above two lines */
680 buf[0] = dma_map_single(ctodev(card), &descr->vlan,
681 vlan_len, DMA_TO_DEVICE);
684 dev_err(ctodev(card),
685 "dma map 1 failed (%p, %i). Dropping packet\n",
686 skb->data, vlan_len);
690 buf[1] = dma_map_single(ctodev(card), skb->data + GELIC_NET_VLAN_POS,
691 skb->len - GELIC_NET_VLAN_POS,
695 dev_err(ctodev(card),
696 "dma map 2 failed (%p, %i). Dropping packet\n",
697 skb->data + GELIC_NET_VLAN_POS,
698 skb->len - GELIC_NET_VLAN_POS);
699 dma_unmap_single(ctodev(card), buf[0], vlan_len,
705 descr->buf_addr = buf[0];
706 descr->buf_size = vlan_len;
707 descr->skb = NULL; /* not used */
708 descr->data_status = 0;
709 descr->next_descr_addr = descr->next->bus_addr;
710 gelic_net_set_txdescr_cmdstat(descr, skb, 1); /* not the frame end */
713 sec_descr->buf_addr = buf[1];
714 sec_descr->buf_size = skb->len - GELIC_NET_VLAN_POS;
715 sec_descr->skb = skb;
716 sec_descr->data_status = 0;
717 sec_descr->next_descr_addr = 0; /* terminate hw descr */
718 gelic_net_set_txdescr_cmdstat(sec_descr, skb, 0);
720 /* bump free descriptor pointer */
721 card->tx_chain.head = sec_descr->next;
726 * gelic_net_kick_txdma - enables TX DMA processing
727 * @card: card structure
728 * @descr: descriptor address to enable TX processing at
731 static int gelic_net_kick_txdma(struct gelic_net_card *card,
732 struct gelic_net_descr *descr)
737 if (card->tx_dma_progress)
740 if (gelic_net_get_descr_status(descr) == GELIC_NET_DESCR_CARDOWNED) {
741 card->tx_dma_progress = 1;
742 /* sometimes we need retry here */
744 status = lv1_net_start_tx_dma(bus_id(card),
751 dev_info(ctodev(card), "lv1_net_start_txdma failed," \
753 status, card->irq_status);
759 * gelic_net_xmit - transmits a frame over the device
760 * @skb: packet to send out
761 * @netdev: interface device structure
763 * returns 0 on success, <0 on failure
765 static int gelic_net_xmit(struct sk_buff *skb, struct net_device *netdev)
767 struct gelic_net_card *card = netdev_priv(netdev);
768 struct gelic_net_descr *descr;
772 spin_lock_irqsave(&card->tx_dma_lock, flags);
774 gelic_net_release_tx_chain(card, 0);
776 descr = gelic_net_get_next_tx_descr(card);
779 * no more descriptors free
781 netif_stop_queue(netdev);
782 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
783 return NETDEV_TX_BUSY;
786 result = gelic_net_prepare_tx_descr_v(card, descr, skb);
789 * DMA map failed. As chanses are that failure
790 * would continue, just release skb and return
792 card->netdev->stats.tx_dropped++;
793 dev_kfree_skb_any(skb);
794 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
798 * link this prepared descriptor to previous one
799 * to achieve high performance
801 descr->prev->next_descr_addr = descr->bus_addr;
803 * as hardware descriptor is modified in the above lines,
804 * ensure that the hardware sees it
807 if (gelic_net_kick_txdma(card, descr)) {
810 * release descriptors which were just prepared
812 card->netdev->stats.tx_dropped++;
813 gelic_net_release_tx_descr(card, descr);
814 gelic_net_release_tx_descr(card, descr->next);
815 card->tx_chain.tail = descr->next->next;
816 dev_info(ctodev(card), "%s: kick failure\n", __func__);
818 /* OK, DMA started/reserved */
819 netdev->trans_start = jiffies;
822 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
827 * gelic_net_pass_skb_up - takes an skb from a descriptor and passes it on
828 * @descr: descriptor to process
829 * @card: card structure
831 * iommu-unmaps the skb, fills out skb structure and passes the data to the
832 * stack. The descriptor state is not changed.
834 static void gelic_net_pass_skb_up(struct gelic_net_descr *descr,
835 struct gelic_net_card *card)
838 struct net_device *netdev;
839 u32 data_status, data_error;
841 data_status = descr->data_status;
842 data_error = descr->data_error;
843 netdev = card->netdev;
844 /* unmap skb buffer */
846 dma_unmap_single(ctodev(card), descr->buf_addr, GELIC_NET_MAX_MTU,
849 skb_put(skb, descr->valid_size? descr->valid_size : descr->result_size);
850 if (!descr->valid_size)
851 dev_info(ctodev(card), "buffer full %x %x %x\n",
852 descr->result_size, descr->buf_size,
853 descr->dmac_cmd_status);
857 * the card put 2 bytes vlan tag in front
858 * of the ethernet frame
861 skb->protocol = eth_type_trans(skb, netdev);
863 /* checksum offload */
865 if ((data_status & GELIC_NET_DATA_STATUS_CHK_MASK) &&
866 (!(data_error & GELIC_NET_DATA_ERROR_CHK_MASK)))
867 skb->ip_summed = CHECKSUM_UNNECESSARY;
869 skb->ip_summed = CHECKSUM_NONE;
871 skb->ip_summed = CHECKSUM_NONE;
873 /* update netdevice statistics */
874 card->netdev->stats.rx_packets++;
875 card->netdev->stats.rx_bytes += skb->len;
877 /* pass skb up to stack */
878 netif_receive_skb(skb);
882 * gelic_net_decode_one_descr - processes an rx descriptor
883 * @card: card structure
885 * returns 1 if a packet has been sent to the stack, otherwise 0
887 * processes an rx descriptor by iommu-unmapping the data buffer and passing
888 * the packet up to the stack
890 static int gelic_net_decode_one_descr(struct gelic_net_card *card)
892 enum gelic_net_descr_status status;
893 struct gelic_net_descr_chain *chain = &card->rx_chain;
894 struct gelic_net_descr *descr = chain->tail;
895 int dmac_chain_ended;
897 status = gelic_net_get_descr_status(descr);
898 /* is this descriptor terminated with next_descr == NULL? */
900 descr->dmac_cmd_status & GELIC_NET_DMAC_CMDSTAT_RXDCEIS;
902 if (status == GELIC_NET_DESCR_CARDOWNED)
905 if (status == GELIC_NET_DESCR_NOT_IN_USE) {
906 dev_dbg(ctodev(card), "dormant descr? %p\n", descr);
910 if ((status == GELIC_NET_DESCR_RESPONSE_ERROR) ||
911 (status == GELIC_NET_DESCR_PROTECTION_ERROR) ||
912 (status == GELIC_NET_DESCR_FORCE_END)) {
913 dev_info(ctodev(card), "dropping RX descriptor with state %x\n",
915 card->netdev->stats.rx_dropped++;
919 if (status == GELIC_NET_DESCR_BUFFER_FULL) {
921 * Buffer full would occur if and only if
922 * the frame length was longer than the size of this
923 * descriptor's buffer. If the frame length was equal
924 * to or shorter than buffer'size, FRAME_END condition
926 * Anyway this frame was longer than the MTU,
929 dev_info(ctodev(card), "overlength frame\n");
933 * descriptoers any other than FRAME_END here should
934 * be treated as error.
936 if (status != GELIC_NET_DESCR_FRAME_END) {
937 dev_dbg(ctodev(card), "RX descriptor with state %x\n",
942 /* ok, we've got a packet in descr */
943 gelic_net_pass_skb_up(descr, card);
946 * So that always DMAC can see the end
947 * of the descriptor chain to avoid
948 * from unwanted DMAC overrun.
950 descr->next_descr_addr = 0;
952 /* change the descriptor state: */
953 gelic_net_set_descr_status(descr, GELIC_NET_DESCR_NOT_IN_USE);
956 * this call can fail, but for now, just leave this
957 * decriptor without skb
959 gelic_net_prepare_rx_descr(card, descr);
962 chain->tail = descr->next;
965 * Set this descriptor the end of the chain.
967 descr->prev->next_descr_addr = descr->bus_addr;
970 * If dmac chain was met, DMAC stopped.
973 if (dmac_chain_ended) {
974 card->rx_dma_restart_required = 1;
975 dev_dbg(ctodev(card), "reenable rx dma scheduled\n");
982 * gelic_net_poll - NAPI poll function called by the stack to return packets
983 * @netdev: interface device structure
984 * @budget: number of packets we can pass to the stack at most
986 * returns 0 if no more packets available to the driver/stack. Returns 1,
987 * if the quota is exceeded, but the driver has still packets.
990 static int gelic_net_poll(struct net_device *netdev, int *budget)
992 struct gelic_net_card *card = netdev_priv(netdev);
993 int packets_to_do, packets_done = 0;
994 int no_more_packets = 0;
996 packets_to_do = min(*budget, netdev->quota);
998 while (packets_to_do) {
999 if (gelic_net_decode_one_descr(card)) {
1003 /* no more packets for the stack */
1004 no_more_packets = 1;
1008 netdev->quota -= packets_done;
1009 *budget -= packets_done;
1010 if (no_more_packets) {
1011 netif_rx_complete(netdev);
1012 gelic_net_rx_irq_on(card);
1018 * gelic_net_change_mtu - changes the MTU of an interface
1019 * @netdev: interface device structure
1020 * @new_mtu: new MTU value
1022 * returns 0 on success, <0 on failure
1024 static int gelic_net_change_mtu(struct net_device *netdev, int new_mtu)
1026 /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
1027 * and mtu is outbound only anyway */
1028 if ((new_mtu < GELIC_NET_MIN_MTU) ||
1029 (new_mtu > GELIC_NET_MAX_MTU)) {
1032 netdev->mtu = new_mtu;
1037 * gelic_net_interrupt - event handler for gelic_net
1039 static irqreturn_t gelic_net_interrupt(int irq, void *ptr)
1041 unsigned long flags;
1042 struct net_device *netdev = ptr;
1043 struct gelic_net_card *card = netdev_priv(netdev);
1046 status = card->irq_status;
1051 if (card->rx_dma_restart_required) {
1052 card->rx_dma_restart_required = 0;
1053 gelic_net_enable_rxdmac(card);
1056 if (status & GELIC_NET_RXINT) {
1057 gelic_net_rx_irq_off(card);
1058 netif_rx_schedule(netdev);
1061 if (status & GELIC_NET_TXINT) {
1062 spin_lock_irqsave(&card->tx_dma_lock, flags);
1063 card->tx_dma_progress = 0;
1064 gelic_net_release_tx_chain(card, 0);
1065 /* kick outstanding tx descriptor if any */
1066 gelic_net_kick_txdma(card, card->tx_chain.tail);
1067 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
1072 #ifdef CONFIG_NET_POLL_CONTROLLER
1074 * gelic_net_poll_controller - artificial interrupt for netconsole etc.
1075 * @netdev: interface device structure
1077 * see Documentation/networking/netconsole.txt
1079 static void gelic_net_poll_controller(struct net_device *netdev)
1081 struct gelic_net_card *card = netdev_priv(netdev);
1083 gelic_net_set_irq_mask(card, 0);
1084 gelic_net_interrupt(netdev->irq, netdev);
1085 gelic_net_set_irq_mask(card, card->ghiintmask);
1087 #endif /* CONFIG_NET_POLL_CONTROLLER */
1090 * gelic_net_open_device - open device and map dma region
1091 * @card: card structure
1093 static int gelic_net_open_device(struct gelic_net_card *card)
1097 result = ps3_sb_event_receive_port_setup(card->dev, PS3_BINDING_CPU_ANY,
1098 &card->netdev->irq);
1101 dev_info(ctodev(card),
1102 "%s:%d: gelic_net_open_device failed (%d)\n",
1103 __func__, __LINE__, result);
1105 goto fail_alloc_irq;
1108 result = request_irq(card->netdev->irq, gelic_net_interrupt,
1109 IRQF_DISABLED, card->netdev->name, card->netdev);
1112 dev_info(ctodev(card), "%s:%d: request_irq failed (%d)\n",
1113 __func__, __LINE__, result);
1114 goto fail_request_irq;
1120 ps3_sb_event_receive_port_destroy(card->dev, card->netdev->irq);
1121 card->netdev->irq = NO_IRQ;
1128 * gelic_net_open - called upon ifonfig up
1129 * @netdev: interface device structure
1131 * returns 0 on success, <0 on failure
1133 * gelic_net_open allocates all the descriptors and memory needed for
1134 * operation, sets up multicast list and enables interrupts
1136 static int gelic_net_open(struct net_device *netdev)
1138 struct gelic_net_card *card = netdev_priv(netdev);
1140 dev_dbg(ctodev(card), " -> %s:%d\n", __func__, __LINE__);
1142 gelic_net_open_device(card);
1144 if (gelic_net_init_chain(card, &card->tx_chain,
1145 card->descr, GELIC_NET_TX_DESCRIPTORS))
1146 goto alloc_tx_failed;
1147 if (gelic_net_init_chain(card, &card->rx_chain,
1148 card->descr + GELIC_NET_TX_DESCRIPTORS,
1149 GELIC_NET_RX_DESCRIPTORS))
1150 goto alloc_rx_failed;
1153 card->tx_top = card->tx_chain.head;
1154 card->rx_top = card->rx_chain.head;
1155 dev_dbg(ctodev(card), "descr rx %p, tx %p, size %#lx, num %#x\n",
1156 card->rx_top, card->tx_top, sizeof(struct gelic_net_descr),
1157 GELIC_NET_RX_DESCRIPTORS);
1158 /* allocate rx skbs */
1159 if (gelic_net_alloc_rx_skbs(card))
1160 goto alloc_skbs_failed;
1162 card->tx_dma_progress = 0;
1163 card->ghiintmask = GELIC_NET_RXINT | GELIC_NET_TXINT;
1165 gelic_net_set_irq_mask(card, card->ghiintmask);
1166 gelic_net_enable_rxdmac(card);
1168 netif_start_queue(netdev);
1169 netif_carrier_on(netdev);
1174 gelic_net_free_chain(card, card->rx_top);
1176 gelic_net_free_chain(card, card->tx_top);
1181 static void gelic_net_get_drvinfo (struct net_device *netdev,
1182 struct ethtool_drvinfo *info)
1184 strncpy(info->driver, DRV_NAME, sizeof(info->driver) - 1);
1185 strncpy(info->version, DRV_VERSION, sizeof(info->version) - 1);
1188 static int gelic_net_get_settings(struct net_device *netdev,
1189 struct ethtool_cmd *cmd)
1191 struct gelic_net_card *card = netdev_priv(netdev);
1196 speed = duplex = -1;
1197 status = lv1_net_control(bus_id(card), dev_id(card),
1198 GELIC_NET_GET_ETH_PORT_STATUS, GELIC_NET_PORT, 0, 0,
1203 if (v1 & GELIC_NET_FULL_DUPLEX) {
1204 duplex = DUPLEX_FULL;
1206 duplex = DUPLEX_HALF;
1209 if (v1 & GELIC_NET_SPEED_10 ) {
1211 } else if (v1 & GELIC_NET_SPEED_100) {
1213 } else if (v1 & GELIC_NET_SPEED_1000) {
1217 cmd->supported = SUPPORTED_TP | SUPPORTED_Autoneg |
1218 SUPPORTED_10baseT_Half | SUPPORTED_10baseT_Full |
1219 SUPPORTED_100baseT_Half | SUPPORTED_100baseT_Full |
1220 SUPPORTED_1000baseT_Half | SUPPORTED_1000baseT_Full;
1221 cmd->advertising = cmd->supported;
1223 cmd->duplex = duplex;
1224 cmd->autoneg = AUTONEG_ENABLE; /* always enabled */
1225 cmd->port = PORT_TP;
1230 static u32 gelic_net_get_link(struct net_device *netdev)
1232 struct gelic_net_card *card = netdev_priv(netdev);
1237 status = lv1_net_control(bus_id(card), dev_id(card),
1238 GELIC_NET_GET_ETH_PORT_STATUS, GELIC_NET_PORT, 0, 0,
1241 return 0; /* link down */
1243 if (v1 & GELIC_NET_LINK_UP)
1251 static int gelic_net_nway_reset(struct net_device *netdev)
1253 if (netif_running(netdev)) {
1254 gelic_net_stop(netdev);
1255 gelic_net_open(netdev);
1260 static u32 gelic_net_get_tx_csum(struct net_device *netdev)
1262 return (netdev->features & NETIF_F_IP_CSUM) != 0;
1265 static int gelic_net_set_tx_csum(struct net_device *netdev, u32 data)
1268 netdev->features |= NETIF_F_IP_CSUM;
1270 netdev->features &= ~NETIF_F_IP_CSUM;
1275 static u32 gelic_net_get_rx_csum(struct net_device *netdev)
1277 struct gelic_net_card *card = netdev_priv(netdev);
1279 return card->rx_csum;
1282 static int gelic_net_set_rx_csum(struct net_device *netdev, u32 data)
1284 struct gelic_net_card *card = netdev_priv(netdev);
1286 card->rx_csum = data;
1290 static struct ethtool_ops gelic_net_ethtool_ops = {
1291 .get_drvinfo = gelic_net_get_drvinfo,
1292 .get_settings = gelic_net_get_settings,
1293 .get_link = gelic_net_get_link,
1294 .nway_reset = gelic_net_nway_reset,
1295 .get_tx_csum = gelic_net_get_tx_csum,
1296 .set_tx_csum = gelic_net_set_tx_csum,
1297 .get_rx_csum = gelic_net_get_rx_csum,
1298 .set_rx_csum = gelic_net_set_rx_csum,
1302 * gelic_net_tx_timeout_task - task scheduled by the watchdog timeout
1303 * function (to be called not under interrupt status)
1304 * @work: work is context of tx timout task
1306 * called as task when tx hangs, resets interface (if interface is up)
1308 static void gelic_net_tx_timeout_task(struct work_struct *work)
1310 struct gelic_net_card *card =
1311 container_of(work, struct gelic_net_card, tx_timeout_task);
1312 struct net_device *netdev = card->netdev;
1314 dev_info(ctodev(card), "%s:Timed out. Restarting... \n", __func__);
1316 if (!(netdev->flags & IFF_UP))
1319 netif_device_detach(netdev);
1320 gelic_net_stop(netdev);
1322 gelic_net_open(netdev);
1323 netif_device_attach(netdev);
1326 atomic_dec(&card->tx_timeout_task_counter);
1330 * gelic_net_tx_timeout - called when the tx timeout watchdog kicks in.
1331 * @netdev: interface device structure
1333 * called, if tx hangs. Schedules a task that resets the interface
1335 static void gelic_net_tx_timeout(struct net_device *netdev)
1337 struct gelic_net_card *card;
1339 card = netdev_priv(netdev);
1340 atomic_inc(&card->tx_timeout_task_counter);
1341 if (netdev->flags & IFF_UP)
1342 schedule_work(&card->tx_timeout_task);
1344 atomic_dec(&card->tx_timeout_task_counter);
1348 * gelic_net_setup_netdev_ops - initialization of net_device operations
1349 * @netdev: net_device structure
1351 * fills out function pointers in the net_device structure
1353 static void gelic_net_setup_netdev_ops(struct net_device *netdev)
1355 netdev->open = &gelic_net_open;
1356 netdev->stop = &gelic_net_stop;
1357 netdev->hard_start_xmit = &gelic_net_xmit;
1358 netdev->set_multicast_list = &gelic_net_set_multi;
1359 netdev->change_mtu = &gelic_net_change_mtu;
1361 netdev->tx_timeout = &gelic_net_tx_timeout;
1362 netdev->watchdog_timeo = GELIC_NET_WATCHDOG_TIMEOUT;
1364 netdev->poll = &gelic_net_poll;
1365 netdev->weight = GELIC_NET_NAPI_WEIGHT;
1366 netdev->ethtool_ops = &gelic_net_ethtool_ops;
1370 * gelic_net_setup_netdev - initialization of net_device
1371 * @card: card structure
1373 * Returns 0 on success or <0 on failure
1375 * gelic_net_setup_netdev initializes the net_device structure
1377 static int gelic_net_setup_netdev(struct gelic_net_card *card)
1379 struct net_device *netdev = card->netdev;
1380 struct sockaddr addr;
1385 SET_MODULE_OWNER(netdev);
1386 SET_NETDEV_DEV(netdev, &card->dev->core);
1387 spin_lock_init(&card->tx_dma_lock);
1389 card->rx_csum = GELIC_NET_RX_CSUM_DEFAULT;
1391 gelic_net_setup_netdev_ops(netdev);
1393 netdev->features = NETIF_F_IP_CSUM;
1395 status = lv1_net_control(bus_id(card), dev_id(card),
1396 GELIC_NET_GET_MAC_ADDRESS,
1398 if (status || !is_valid_ether_addr((u8 *)&v1)) {
1399 dev_info(ctodev(card),
1400 "%s:lv1_net_control GET_MAC_ADDR failed %d\n",
1405 memcpy(addr.sa_data, &v1, ETH_ALEN);
1406 memcpy(netdev->dev_addr, addr.sa_data, ETH_ALEN);
1407 dev_info(ctodev(card), "MAC addr %02x:%02x:%02x:%02x:%02x:%02x\n",
1408 netdev->dev_addr[0], netdev->dev_addr[1],
1409 netdev->dev_addr[2], netdev->dev_addr[3],
1410 netdev->dev_addr[4], netdev->dev_addr[5]);
1412 card->vlan_index = -1; /* no vlan */
1413 for (i = 0; i < GELIC_NET_VLAN_MAX; i++) {
1414 status = lv1_net_control(bus_id(card), dev_id(card),
1415 GELIC_NET_GET_VLAN_ID,
1416 i + 1, /* index; one based */
1418 if (status == GELIC_NET_VLAN_NO_ENTRY) {
1419 dev_dbg(ctodev(card),
1420 "GELIC_VLAN_ID no entry:%d, VLAN disabled\n",
1422 card->vlan_id[i] = 0;
1423 } else if (status) {
1424 dev_dbg(ctodev(card),
1425 "%s:GELIC_NET_VLAN_ID faild, status=%d\n",
1427 card->vlan_id[i] = 0;
1429 card->vlan_id[i] = (u32)v1;
1430 dev_dbg(ctodev(card), "vlan_id:%d, %lx\n", i, v1);
1433 if (card->vlan_id[GELIC_NET_VLAN_WIRED - 1])
1434 card->vlan_index = GELIC_NET_VLAN_WIRED - 1;
1436 status = register_netdev(netdev);
1438 dev_err(ctodev(card), "%s:Couldn't register net_device: %d\n",
1447 * gelic_net_alloc_card - allocates net_device and card structure
1449 * returns the card structure or NULL in case of errors
1451 * the card and net_device structures are linked to each other
1453 static struct gelic_net_card *gelic_net_alloc_card(void)
1455 struct net_device *netdev;
1456 struct gelic_net_card *card;
1459 alloc_size = sizeof (*card) +
1460 sizeof (struct gelic_net_descr) * GELIC_NET_RX_DESCRIPTORS +
1461 sizeof (struct gelic_net_descr) * GELIC_NET_TX_DESCRIPTORS;
1463 * we assume private data is allocated 32 bytes (or more) aligned
1464 * so that gelic_net_descr should be 32 bytes aligned.
1465 * Current alloc_etherdev() does do it because NETDEV_ALIGN
1467 * check this assumption here.
1469 BUILD_BUG_ON(NETDEV_ALIGN < 32);
1470 BUILD_BUG_ON(offsetof(struct gelic_net_card, irq_status) % 8);
1471 BUILD_BUG_ON(offsetof(struct gelic_net_card, descr) % 32);
1473 netdev = alloc_etherdev(alloc_size);
1477 card = netdev_priv(netdev);
1478 card->netdev = netdev;
1479 INIT_WORK(&card->tx_timeout_task, gelic_net_tx_timeout_task);
1480 init_waitqueue_head(&card->waitq);
1481 atomic_set(&card->tx_timeout_task_counter, 0);
1487 * ps3_gelic_driver_probe - add a device to the control of this driver
1489 static int ps3_gelic_driver_probe (struct ps3_system_bus_device *dev)
1491 struct gelic_net_card *card = gelic_net_alloc_card();
1495 dev_info(&dev->core, "gelic_net_alloc_card failed\n");
1497 goto fail_alloc_card;
1500 ps3_system_bus_set_driver_data(dev, card);
1503 result = ps3_open_hv_device(dev);
1506 dev_dbg(&dev->core, "ps3_open_hv_device failed\n");
1510 result = ps3_dma_region_create(dev->d_region);
1513 dev_dbg(&dev->core, "ps3_dma_region_create failed(%d)\n",
1515 BUG_ON("check region type");
1516 goto fail_dma_region;
1519 result = lv1_net_set_interrupt_status_indicator(bus_id(card),
1521 ps3_mm_phys_to_lpar(__pa(&card->irq_status)),
1526 "lv1_net_set_interrupt_status_indicator failed: %s\n",
1527 ps3_result(result));
1529 goto fail_status_indicator;
1532 result = gelic_net_setup_netdev(card);
1535 dev_dbg(&dev->core, "%s:%d: ps3_dma_region_create failed: "
1536 "(%d)\n", __func__, __LINE__, result);
1537 goto fail_setup_netdev;
1543 lv1_net_set_interrupt_status_indicator(bus_id(card),
1546 fail_status_indicator:
1547 ps3_dma_region_free(dev->d_region);
1549 ps3_close_hv_device(dev);
1551 ps3_system_bus_set_driver_data(dev, NULL);
1552 free_netdev(card->netdev);
1558 * ps3_gelic_driver_remove - remove a device from the control of this driver
1561 static int ps3_gelic_driver_remove (struct ps3_system_bus_device *dev)
1563 struct gelic_net_card *card = ps3_system_bus_get_driver_data(dev);
1565 wait_event(card->waitq,
1566 atomic_read(&card->tx_timeout_task_counter) == 0);
1568 lv1_net_set_interrupt_status_indicator(bus_id(card), dev_id(card),
1571 unregister_netdev(card->netdev);
1572 free_netdev(card->netdev);
1574 ps3_system_bus_set_driver_data(dev, NULL);
1576 ps3_dma_region_free(dev->d_region);
1578 ps3_close_hv_device(dev);
1583 static struct ps3_system_bus_driver ps3_gelic_driver = {
1584 .match_id = PS3_MATCH_ID_GELIC,
1585 .probe = ps3_gelic_driver_probe,
1586 .remove = ps3_gelic_driver_remove,
1587 .shutdown = ps3_gelic_driver_remove,
1588 .core.name = "ps3_gelic_driver",
1589 .core.owner = THIS_MODULE,
1592 static int __init ps3_gelic_driver_init (void)
1594 return firmware_has_feature(FW_FEATURE_PS3_LV1)
1595 ? ps3_system_bus_driver_register(&ps3_gelic_driver)
1599 static void __exit ps3_gelic_driver_exit (void)
1601 ps3_system_bus_driver_unregister(&ps3_gelic_driver);
1604 module_init (ps3_gelic_driver_init);
1605 module_exit (ps3_gelic_driver_exit);
1607 MODULE_ALIAS(PS3_MODULE_ALIAS_GELIC);