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 descr->dmac_cmd_status = GELIC_NET_DESCR_NOT_IN_USE;
296 } while (descr != card->rx_chain.head);
300 * gelic_net_fill_rx_chain - fills descriptors/skbs in the rx chains
301 * @card: card structure
303 * fills all descriptors in the rx chain: allocates skbs
304 * and iommu-maps them.
305 * returns 0 on success, <0 on failure
307 static int gelic_net_fill_rx_chain(struct gelic_net_card *card)
309 struct gelic_net_descr *descr = card->rx_chain.head;
314 ret = gelic_net_prepare_rx_descr(card, descr);
319 } while (descr != card->rx_chain.head);
323 gelic_net_release_rx_chain(card);
328 * gelic_net_alloc_rx_skbs - allocates rx skbs in rx descriptor chains
329 * @card: card structure
331 * returns 0 on success, <0 on failure
333 static int gelic_net_alloc_rx_skbs(struct gelic_net_card *card)
335 struct gelic_net_descr_chain *chain;
337 chain = &card->rx_chain;
338 ret = gelic_net_fill_rx_chain(card);
339 chain->head = card->rx_top->prev; /* point to the last */
344 * gelic_net_release_tx_descr - processes a used tx descriptor
345 * @card: card structure
346 * @descr: descriptor to release
348 * releases a used tx descriptor (unmapping, freeing of skb)
350 static void gelic_net_release_tx_descr(struct gelic_net_card *card,
351 struct gelic_net_descr *descr)
356 if (descr->data_status & (1 << GELIC_NET_TXDESC_TAIL)) {
359 dma_unmap_single(ctodev(card), descr->buf_addr, skb->len,
361 dev_kfree_skb_any(skb);
363 dma_unmap_single(ctodev(card), descr->buf_addr,
364 descr->buf_size, DMA_TO_DEVICE);
369 descr->next_descr_addr = 0;
370 descr->result_size = 0;
371 descr->valid_size = 0;
372 descr->data_status = 0;
373 descr->data_error = 0;
376 /* set descr status */
377 descr->dmac_cmd_status = GELIC_NET_DMAC_CMDSTAT_NOT_IN_USE;
381 * gelic_net_release_tx_chain - processes sent tx descriptors
382 * @card: adapter structure
383 * @stop: net_stop sequence
385 * releases the tx descriptors that gelic has finished with
387 static void gelic_net_release_tx_chain(struct gelic_net_card *card, int stop)
389 struct gelic_net_descr_chain *tx_chain;
390 enum gelic_net_descr_status status;
393 for (tx_chain = &card->tx_chain;
394 tx_chain->head != tx_chain->tail && tx_chain->tail;
395 tx_chain->tail = tx_chain->tail->next) {
396 status = gelic_net_get_descr_status(tx_chain->tail);
398 case GELIC_NET_DESCR_RESPONSE_ERROR:
399 case GELIC_NET_DESCR_PROTECTION_ERROR:
400 case GELIC_NET_DESCR_FORCE_END:
401 if (printk_ratelimit())
402 dev_info(ctodev(card),
403 "%s: forcing end of tx descriptor " \
406 card->netdev_stats.tx_dropped++;
409 case GELIC_NET_DESCR_COMPLETE:
410 card->netdev_stats.tx_packets++;
411 card->netdev_stats.tx_bytes +=
412 tx_chain->tail->skb->len;
415 case GELIC_NET_DESCR_CARDOWNED:
416 /* pending tx request */
418 /* any other value (== GELIC_NET_DESCR_NOT_IN_USE) */
421 gelic_net_release_tx_descr(card, tx_chain->tail);
425 if (!stop && release)
426 netif_wake_queue(card->netdev);
430 * gelic_net_set_multi - sets multicast addresses and promisc flags
431 * @netdev: interface device structure
433 * gelic_net_set_multi configures multicast addresses as needed for the
434 * netdev interface. It also sets up multicast, allmulti and promisc
435 * flags appropriately
437 static void gelic_net_set_multi(struct net_device *netdev)
439 struct gelic_net_card *card = netdev_priv(netdev);
440 struct dev_mc_list *mc;
446 /* clear all multicast address */
447 status = lv1_net_remove_multicast_address(bus_id(card), dev_id(card),
450 dev_err(ctodev(card),
451 "lv1_net_remove_multicast_address failed %d\n",
453 /* set broadcast address */
454 status = lv1_net_add_multicast_address(bus_id(card), dev_id(card),
455 GELIC_NET_BROADCAST_ADDR, 0);
457 dev_err(ctodev(card),
458 "lv1_net_add_multicast_address failed, %d\n",
461 if (netdev->flags & IFF_ALLMULTI
462 || netdev->mc_count > GELIC_NET_MC_COUNT_MAX) { /* list max */
463 status = lv1_net_add_multicast_address(bus_id(card),
467 dev_err(ctodev(card),
468 "lv1_net_add_multicast_address failed, %d\n",
473 /* set multicast address */
474 for (mc = netdev->mc_list; mc; mc = mc->next) {
477 for (i = 0; i < ETH_ALEN; i++) {
481 status = lv1_net_add_multicast_address(bus_id(card),
485 dev_err(ctodev(card),
486 "lv1_net_add_multicast_address failed, %d\n",
492 * gelic_net_enable_rxdmac - enables the receive DMA controller
493 * @card: card structure
495 * gelic_net_enable_rxdmac enables the DMA controller by setting RX_DMA_EN
496 * in the GDADMACCNTR register
498 static inline void gelic_net_enable_rxdmac(struct gelic_net_card *card)
502 status = lv1_net_start_rx_dma(bus_id(card), dev_id(card),
503 card->rx_chain.tail->bus_addr, 0);
505 dev_info(ctodev(card),
506 "lv1_net_start_rx_dma failed, status=%d\n", status);
510 * gelic_net_disable_rxdmac - disables the receive DMA controller
511 * @card: card structure
513 * gelic_net_disable_rxdmac terminates processing on the DMA controller by
514 * turing off DMA and issueing a force end
516 static inline void gelic_net_disable_rxdmac(struct gelic_net_card *card)
520 /* this hvc blocks until the DMA in progress really stopped */
521 status = lv1_net_stop_rx_dma(bus_id(card), dev_id(card), 0);
523 dev_err(ctodev(card),
524 "lv1_net_stop_rx_dma faild, %d\n", status);
528 * gelic_net_disable_txdmac - disables the transmit DMA controller
529 * @card: card structure
531 * gelic_net_disable_txdmac terminates processing on the DMA controller by
532 * turing off DMA and issueing a force end
534 static inline void gelic_net_disable_txdmac(struct gelic_net_card *card)
538 /* this hvc blocks until the DMA in progress really stopped */
539 status = lv1_net_stop_tx_dma(bus_id(card), dev_id(card), 0);
541 dev_err(ctodev(card),
542 "lv1_net_stop_tx_dma faild, status=%d\n", status);
546 * gelic_net_stop - called upon ifconfig down
547 * @netdev: interface device structure
551 static int gelic_net_stop(struct net_device *netdev)
553 struct gelic_net_card *card = netdev_priv(netdev);
555 netif_poll_disable(netdev);
556 netif_stop_queue(netdev);
558 /* turn off DMA, force end */
559 gelic_net_disable_rxdmac(card);
560 gelic_net_disable_txdmac(card);
562 gelic_net_set_irq_mask(card, 0);
564 /* disconnect event port */
565 free_irq(card->netdev->irq, card->netdev);
566 ps3_sb_event_receive_port_destroy(card->dev, card->netdev->irq);
567 card->netdev->irq = NO_IRQ;
569 netif_carrier_off(netdev);
572 gelic_net_release_tx_chain(card, 1);
573 gelic_net_release_rx_chain(card);
575 gelic_net_free_chain(card, card->tx_top);
576 gelic_net_free_chain(card, card->rx_top);
582 * gelic_net_get_next_tx_descr - returns the next available tx descriptor
583 * @card: device structure to get descriptor from
585 * returns the address of the next descriptor, or NULL if not available.
587 static struct gelic_net_descr *
588 gelic_net_get_next_tx_descr(struct gelic_net_card *card)
590 if (!card->tx_chain.head)
592 /* see if we can two consecutive free descrs */
593 if (card->tx_chain.tail != card->tx_chain.head->next &&
594 gelic_net_get_descr_status(card->tx_chain.head) ==
595 GELIC_NET_DESCR_NOT_IN_USE &&
596 card->tx_chain.tail != card->tx_chain.head->next->next &&
597 gelic_net_get_descr_status(card->tx_chain.head->next) ==
598 GELIC_NET_DESCR_NOT_IN_USE )
599 return card->tx_chain.head;
606 * gelic_net_set_txdescr_cmdstat - sets the tx descriptor command field
607 * @descr: descriptor structure to fill out
608 * @skb: packet to consider
609 * @middle: middle of frame
611 * fills out the command and status field of the descriptor structure,
612 * depending on hardware checksum settings. This function assumes a wmb()
613 * has executed before.
615 static void gelic_net_set_txdescr_cmdstat(struct gelic_net_descr *descr,
616 struct sk_buff *skb, int middle)
623 eofr = GELIC_NET_DMAC_CMDSTAT_END_FRAME;
625 if (skb->ip_summed != CHECKSUM_PARTIAL)
626 descr->dmac_cmd_status = GELIC_NET_DMAC_CMDSTAT_NOCS | eofr;
629 * if yes: tcp? udp? */
630 if (skb->protocol == htons(ETH_P_IP)) {
631 if (ip_hdr(skb)->protocol == IPPROTO_TCP)
632 descr->dmac_cmd_status =
633 GELIC_NET_DMAC_CMDSTAT_TCPCS | eofr;
634 else if (ip_hdr(skb)->protocol == IPPROTO_UDP)
635 descr->dmac_cmd_status =
636 GELIC_NET_DMAC_CMDSTAT_UDPCS | eofr;
638 * the stack should checksum non-tcp and non-udp
639 * packets on his own: NETIF_F_IP_CSUM
641 descr->dmac_cmd_status =
642 GELIC_NET_DMAC_CMDSTAT_NOCS | eofr;
648 * gelic_net_prepare_tx_descr_v - get dma address of skb_data
649 * @card: card structure
650 * @descr: descriptor structure
651 * @skb: packet to use
653 * returns 0 on success, <0 on failure.
656 static int gelic_net_prepare_tx_descr_v(struct gelic_net_card *card,
657 struct gelic_net_descr *descr,
661 unsigned int vlan_len;
663 if (skb->len < GELIC_NET_VLAN_POS)
666 memcpy(&descr->vlan, skb->data, GELIC_NET_VLAN_POS);
667 if (card->vlan_index != -1) {
668 descr->vlan.h_vlan_proto = htons(ETH_P_8021Q); /* vlan 0x8100*/
669 descr->vlan.h_vlan_TCI = htons(card->vlan_id[card->vlan_index]);
670 vlan_len = GELIC_NET_VLAN_POS + VLAN_HLEN; /* VLAN_HLEN=4 */
672 vlan_len = GELIC_NET_VLAN_POS; /* no vlan tag */
675 buf[0] = dma_map_single(ctodev(card), &descr->vlan,
676 vlan_len, DMA_TO_DEVICE);
679 dev_err(ctodev(card),
680 "dma map 1 failed (%p, %i). Dropping packet\n",
681 skb->data, vlan_len);
685 descr->buf_addr = buf[0];
686 descr->buf_size = vlan_len;
687 descr->skb = skb; /* not used */
688 descr->data_status = 0;
689 gelic_net_set_txdescr_cmdstat(descr, skb, 1); /* not the frame end */
692 card->tx_chain.head = card->tx_chain.head->next;
693 descr->next_descr_addr = descr->next->bus_addr;
695 if (gelic_net_get_descr_status(descr) != GELIC_NET_DESCR_NOT_IN_USE)
696 /* XXX will be removed */
697 dev_err(ctodev(card), "descr is not free!\n");
699 buf[1] = dma_map_single(ctodev(card), skb->data + GELIC_NET_VLAN_POS,
700 skb->len - GELIC_NET_VLAN_POS,
704 dev_err(ctodev(card),
705 "dma map 2 failed (%p, %i). Dropping packet\n",
706 skb->data + GELIC_NET_VLAN_POS,
707 skb->len - GELIC_NET_VLAN_POS);
708 dma_unmap_single(ctodev(card), buf[0], vlan_len,
713 descr->buf_addr = buf[1];
714 descr->buf_size = skb->len - GELIC_NET_VLAN_POS;
716 descr->data_status = 0;
717 descr->next_descr_addr = 0; /* terminate hw descr */
718 gelic_net_set_txdescr_cmdstat(descr, skb, 0);
724 * gelic_net_kick_txdma - enables TX DMA processing
725 * @card: card structure
726 * @descr: descriptor address to enable TX processing at
729 static int gelic_net_kick_txdma(struct gelic_net_card *card,
730 struct gelic_net_descr *descr)
735 if (card->tx_dma_progress)
738 if (gelic_net_get_descr_status(descr) == GELIC_NET_DESCR_CARDOWNED) {
739 card->tx_dma_progress = 1;
740 /* sometimes we need retry here */
742 status = lv1_net_start_tx_dma(bus_id(card),
749 dev_info(ctodev(card), "lv1_net_start_txdma failed," \
751 status, card->irq_status);
757 * gelic_net_xmit - transmits a frame over the device
758 * @skb: packet to send out
759 * @netdev: interface device structure
761 * returns 0 on success, <0 on failure
763 static int gelic_net_xmit(struct sk_buff *skb, struct net_device *netdev)
765 struct gelic_net_card *card = netdev_priv(netdev);
766 struct gelic_net_descr *descr = NULL;
770 spin_lock_irqsave(&card->tx_dma_lock, flags);
772 gelic_net_release_tx_chain(card, 0);
775 descr = gelic_net_get_next_tx_descr(card);
777 netif_stop_queue(netdev);
778 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
779 return NETDEV_TX_BUSY;
781 result = gelic_net_prepare_tx_descr_v(card, descr, skb);
786 card->tx_chain.head = card->tx_chain.head->next;
789 descr->prev->next_descr_addr = descr->bus_addr;
792 * as hardware descriptor is modified in the above lines,
793 * ensure that the hardware sees it
796 if (gelic_net_kick_txdma(card, card->tx_chain.tail))
799 netdev->trans_start = jiffies;
800 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
804 card->netdev_stats.tx_dropped++;
805 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
806 return NETDEV_TX_LOCKED;
810 * gelic_net_pass_skb_up - takes an skb from a descriptor and passes it on
811 * @descr: descriptor to process
812 * @card: card structure
814 * iommu-unmaps the skb, fills out skb structure and passes the data to the
815 * stack. The descriptor state is not changed.
817 static void gelic_net_pass_skb_up(struct gelic_net_descr *descr,
818 struct gelic_net_card *card)
821 struct net_device *netdev;
822 u32 data_status, data_error;
824 data_status = descr->data_status;
825 data_error = descr->data_error;
826 netdev = card->netdev;
827 /* unmap skb buffer */
829 dma_unmap_single(ctodev(card), descr->buf_addr, GELIC_NET_MAX_MTU,
832 skb_put(skb, descr->valid_size? descr->valid_size : descr->result_size);
833 if (!descr->valid_size)
834 dev_info(ctodev(card), "buffer full %x %x %x\n",
835 descr->result_size, descr->buf_size,
836 descr->dmac_cmd_status);
840 * the card put 2 bytes vlan tag in front
841 * of the ethernet frame
844 skb->protocol = eth_type_trans(skb, netdev);
846 /* checksum offload */
848 if ((data_status & GELIC_NET_DATA_STATUS_CHK_MASK) &&
849 (!(data_error & GELIC_NET_DATA_ERROR_CHK_MASK)))
850 skb->ip_summed = CHECKSUM_UNNECESSARY;
852 skb->ip_summed = CHECKSUM_NONE;
854 skb->ip_summed = CHECKSUM_NONE;
856 /* update netdevice statistics */
857 card->netdev_stats.rx_packets++;
858 card->netdev_stats.rx_bytes += skb->len;
860 /* pass skb up to stack */
861 netif_receive_skb(skb);
865 * gelic_net_decode_one_descr - processes an rx descriptor
866 * @card: card structure
868 * returns 1 if a packet has been sent to the stack, otherwise 0
870 * processes an rx descriptor by iommu-unmapping the data buffer and passing
871 * the packet up to the stack
873 static int gelic_net_decode_one_descr(struct gelic_net_card *card)
875 enum gelic_net_descr_status status;
876 struct gelic_net_descr_chain *chain = &card->rx_chain;
877 struct gelic_net_descr *descr = chain->tail;
878 int dmac_chain_ended;
880 status = gelic_net_get_descr_status(descr);
881 /* is this descriptor terminated with next_descr == NULL? */
883 descr->dmac_cmd_status & GELIC_NET_DMAC_CMDSTAT_RXDCEIS;
885 if (status == GELIC_NET_DESCR_CARDOWNED)
888 if (status == GELIC_NET_DESCR_NOT_IN_USE) {
889 dev_dbg(ctodev(card), "dormant descr? %p\n", descr);
893 if ((status == GELIC_NET_DESCR_RESPONSE_ERROR) ||
894 (status == GELIC_NET_DESCR_PROTECTION_ERROR) ||
895 (status == GELIC_NET_DESCR_FORCE_END)) {
896 dev_info(ctodev(card), "dropping RX descriptor with state %x\n",
898 card->netdev_stats.rx_dropped++;
902 if ((status != GELIC_NET_DESCR_COMPLETE) &&
903 (status != GELIC_NET_DESCR_FRAME_END)) {
904 dev_dbg(ctodev(card), "RX descriptor with state %x\n",
909 /* ok, we've got a packet in descr */
910 gelic_net_pass_skb_up(descr, card); /* 1: skb_up sccess */
913 descr->next_descr_addr = 0; /* unlink the descr */
915 /* change the descriptor state: */
916 gelic_net_set_descr_status(descr, GELIC_NET_DESCR_NOT_IN_USE);
919 * FIXME: this can fail, but for now, just leave this
920 * descriptor without skb
922 gelic_net_prepare_rx_descr(card, descr);
924 chain->tail = descr->next;
925 descr->prev->next_descr_addr = descr->bus_addr;
927 if (dmac_chain_ended) {
928 gelic_net_enable_rxdmac(card);
929 dev_dbg(ctodev(card), "reenable rx dma\n");
936 * gelic_net_poll - NAPI poll function called by the stack to return packets
937 * @netdev: interface device structure
938 * @budget: number of packets we can pass to the stack at most
940 * returns 0 if no more packets available to the driver/stack. Returns 1,
941 * if the quota is exceeded, but the driver has still packets.
944 static int gelic_net_poll(struct net_device *netdev, int *budget)
946 struct gelic_net_card *card = netdev_priv(netdev);
947 int packets_to_do, packets_done = 0;
948 int no_more_packets = 0;
950 packets_to_do = min(*budget, netdev->quota);
952 while (packets_to_do) {
953 if (gelic_net_decode_one_descr(card)) {
957 /* no more packets for the stack */
962 netdev->quota -= packets_done;
963 *budget -= packets_done;
964 if (no_more_packets) {
965 netif_rx_complete(netdev);
966 gelic_net_rx_irq_on(card);
973 * gelic_net_get_stats - get interface statistics
974 * @netdev: interface device structure
976 * returns the interface statistics residing in the gelic_net_card struct
978 static struct net_device_stats *gelic_net_get_stats(struct net_device *netdev)
980 struct gelic_net_card *card = netdev_priv(netdev);
982 return &card->netdev_stats;
986 * gelic_net_change_mtu - changes the MTU of an interface
987 * @netdev: interface device structure
988 * @new_mtu: new MTU value
990 * returns 0 on success, <0 on failure
992 static int gelic_net_change_mtu(struct net_device *netdev, int new_mtu)
994 /* no need to re-alloc skbs or so -- the max mtu is about 2.3k
995 * and mtu is outbound only anyway */
996 if ((new_mtu < GELIC_NET_MIN_MTU) ||
997 (new_mtu > GELIC_NET_MAX_MTU)) {
1000 netdev->mtu = new_mtu;
1005 * gelic_net_interrupt - event handler for gelic_net
1007 static irqreturn_t gelic_net_interrupt(int irq, void *ptr)
1009 unsigned long flags;
1010 struct net_device *netdev = ptr;
1011 struct gelic_net_card *card = netdev_priv(netdev);
1014 status = card->irq_status;
1019 if (status & GELIC_NET_RXINT) {
1020 gelic_net_rx_irq_off(card);
1021 netif_rx_schedule(netdev);
1024 if (status & GELIC_NET_TXINT) {
1025 spin_lock_irqsave(&card->tx_dma_lock, flags);
1026 card->tx_dma_progress = 0;
1027 spin_unlock_irqrestore(&card->tx_dma_lock, flags);
1028 /* start pending DMA */
1029 gelic_net_xmit(NULL, netdev);
1034 #ifdef CONFIG_NET_POLL_CONTROLLER
1036 * gelic_net_poll_controller - artificial interrupt for netconsole etc.
1037 * @netdev: interface device structure
1039 * see Documentation/networking/netconsole.txt
1041 static void gelic_net_poll_controller(struct net_device *netdev)
1043 struct gelic_net_card *card = netdev_priv(netdev);
1045 gelic_net_set_irq_mask(card, 0);
1046 gelic_net_interrupt(netdev->irq, netdev);
1047 gelic_net_set_irq_mask(card, card->ghiintmask);
1049 #endif /* CONFIG_NET_POLL_CONTROLLER */
1052 * gelic_net_open_device - open device and map dma region
1053 * @card: card structure
1055 static int gelic_net_open_device(struct gelic_net_card *card)
1059 result = ps3_sb_event_receive_port_setup(card->dev, PS3_BINDING_CPU_ANY,
1060 &card->netdev->irq);
1063 dev_info(ctodev(card),
1064 "%s:%d: gelic_net_open_device failed (%d)\n",
1065 __func__, __LINE__, result);
1067 goto fail_alloc_irq;
1070 result = request_irq(card->netdev->irq, gelic_net_interrupt,
1071 IRQF_DISABLED, "gelic network", card->netdev);
1074 dev_info(ctodev(card), "%s:%d: request_irq failed (%d)\n",
1075 __func__, __LINE__, result);
1076 goto fail_request_irq;
1082 ps3_sb_event_receive_port_destroy(card->dev, card->netdev->irq);
1083 card->netdev->irq = NO_IRQ;
1090 * gelic_net_open - called upon ifonfig up
1091 * @netdev: interface device structure
1093 * returns 0 on success, <0 on failure
1095 * gelic_net_open allocates all the descriptors and memory needed for
1096 * operation, sets up multicast list and enables interrupts
1098 static int gelic_net_open(struct net_device *netdev)
1100 struct gelic_net_card *card = netdev_priv(netdev);
1102 dev_dbg(ctodev(card), " -> %s:%d\n", __func__, __LINE__);
1104 gelic_net_open_device(card);
1106 if (gelic_net_init_chain(card, &card->tx_chain,
1107 card->descr, GELIC_NET_TX_DESCRIPTORS))
1108 goto alloc_tx_failed;
1109 if (gelic_net_init_chain(card, &card->rx_chain,
1110 card->descr + GELIC_NET_RX_DESCRIPTORS,
1111 GELIC_NET_RX_DESCRIPTORS))
1112 goto alloc_rx_failed;
1115 card->tx_top = card->tx_chain.head;
1116 card->rx_top = card->rx_chain.head;
1117 dev_dbg(ctodev(card), "descr rx %p, tx %p, size %#lx, num %#x\n",
1118 card->rx_top, card->tx_top, sizeof(struct gelic_net_descr),
1119 GELIC_NET_RX_DESCRIPTORS);
1120 /* allocate rx skbs */
1121 if (gelic_net_alloc_rx_skbs(card))
1122 goto alloc_skbs_failed;
1124 card->tx_dma_progress = 0;
1125 card->ghiintmask = GELIC_NET_RXINT | GELIC_NET_TXINT;
1127 gelic_net_set_irq_mask(card, card->ghiintmask);
1128 gelic_net_enable_rxdmac(card);
1130 netif_start_queue(netdev);
1131 netif_carrier_on(netdev);
1132 netif_poll_enable(netdev);
1137 gelic_net_free_chain(card, card->rx_top);
1139 gelic_net_free_chain(card, card->tx_top);
1144 #ifdef GELIC_NET_ETHTOOL
1145 static void gelic_net_get_drvinfo (struct net_device *netdev,
1146 struct ethtool_drvinfo *info)
1148 strncpy(info->driver, DRV_NAME, sizeof(info->driver) - 1);
1149 strncpy(info->version, DRV_VERSION, sizeof(info->version) - 1);
1152 static int gelic_net_get_settings(struct net_device *netdev,
1153 struct ethtool_cmd *cmd)
1155 struct gelic_net_card *card = netdev_priv(netdev);
1160 speed = duplex = -1;
1161 status = lv1_net_control(bus_id(card), dev_id(card),
1162 GELIC_NET_GET_ETH_PORT_STATUS, GELIC_NET_PORT, 0, 0,
1167 if (v1 & GELIC_NET_FULL_DUPLEX) {
1168 duplex = DUPLEX_FULL;
1170 duplex = DUPLEX_HALF;
1173 if (v1 & GELIC_NET_SPEED_10 ) {
1175 } else if (v1 & GELIC_NET_SPEED_100) {
1177 } else if (v1 & GELIC_NET_SPEED_1000) {
1181 cmd->supported = SUPPORTED_TP | SUPPORTED_Autoneg |
1182 SUPPORTED_10baseT_Half | SUPPORTED_10baseT_Full |
1183 SUPPORTED_100baseT_Half | SUPPORTED_100baseT_Full |
1184 SUPPORTED_1000baseT_Half | SUPPORTED_1000baseT_Full;
1185 cmd->advertising = cmd->supported;
1187 cmd->duplex = duplex;
1188 cmd->autoneg = AUTONEG_ENABLE; /* always enabled */
1189 cmd->port = PORT_TP;
1194 static u32 gelic_net_get_link(struct net_device *netdev)
1196 struct gelic_net_card *card = netdev_priv(netdev);
1201 status = lv1_net_control(bus_id(card), dev_id(card),
1202 GELIC_NET_GET_ETH_PORT_STATUS, GELIC_NET_PORT, 0, 0,
1205 return 0; /* link down */
1207 if (v1 & GELIC_NET_LINK_UP)
1215 static int gelic_net_nway_reset(struct net_device *netdev)
1217 if (netif_running(netdev)) {
1218 gelic_net_stop(netdev);
1219 gelic_net_open(netdev);
1224 static u32 gelic_net_get_tx_csum(struct net_device *netdev)
1226 return (netdev->features & NETIF_F_IP_CSUM) != 0;
1229 static int gelic_net_set_tx_csum(struct net_device *netdev, u32 data)
1232 netdev->features |= NETIF_F_IP_CSUM;
1234 netdev->features &= ~NETIF_F_IP_CSUM;
1239 static u32 gelic_net_get_rx_csum(struct net_device *netdev)
1241 struct gelic_net_card *card = netdev_priv(netdev);
1243 return card->rx_csum;
1246 static int gelic_net_set_rx_csum(struct net_device *netdev, u32 data)
1248 struct gelic_net_card *card = netdev_priv(netdev);
1250 card->rx_csum = data;
1254 static struct ethtool_ops gelic_net_ethtool_ops = {
1255 .get_drvinfo = gelic_net_get_drvinfo,
1256 .get_settings = gelic_net_get_settings,
1257 .get_link = gelic_net_get_link,
1258 .nway_reset = gelic_net_nway_reset,
1259 .get_tx_csum = gelic_net_get_tx_csum,
1260 .set_tx_csum = gelic_net_set_tx_csum,
1261 .get_rx_csum = gelic_net_get_rx_csum,
1262 .set_rx_csum = gelic_net_set_rx_csum,
1267 * gelic_net_tx_timeout_task - task scheduled by the watchdog timeout
1268 * function (to be called not under interrupt status)
1269 * @work: work is context of tx timout task
1271 * called as task when tx hangs, resets interface (if interface is up)
1273 static void gelic_net_tx_timeout_task(struct work_struct *work)
1275 struct gelic_net_card *card =
1276 container_of(work, struct gelic_net_card, tx_timeout_task);
1277 struct net_device *netdev = card->netdev;
1279 dev_info(ctodev(card), "%s:Timed out. Restarting... \n", __func__);
1281 if (!(netdev->flags & IFF_UP))
1284 netif_device_detach(netdev);
1285 gelic_net_stop(netdev);
1287 gelic_net_open(netdev);
1288 netif_device_attach(netdev);
1291 atomic_dec(&card->tx_timeout_task_counter);
1295 * gelic_net_tx_timeout - called when the tx timeout watchdog kicks in.
1296 * @netdev: interface device structure
1298 * called, if tx hangs. Schedules a task that resets the interface
1300 static void gelic_net_tx_timeout(struct net_device *netdev)
1302 struct gelic_net_card *card;
1304 card = netdev_priv(netdev);
1305 atomic_inc(&card->tx_timeout_task_counter);
1306 if (netdev->flags & IFF_UP)
1307 schedule_work(&card->tx_timeout_task);
1309 atomic_dec(&card->tx_timeout_task_counter);
1313 * gelic_net_setup_netdev_ops - initialization of net_device operations
1314 * @netdev: net_device structure
1316 * fills out function pointers in the net_device structure
1318 static void gelic_net_setup_netdev_ops(struct net_device *netdev)
1320 netdev->open = &gelic_net_open;
1321 netdev->stop = &gelic_net_stop;
1322 netdev->hard_start_xmit = &gelic_net_xmit;
1323 netdev->get_stats = &gelic_net_get_stats;
1324 netdev->set_multicast_list = &gelic_net_set_multi;
1325 netdev->change_mtu = &gelic_net_change_mtu;
1327 netdev->tx_timeout = &gelic_net_tx_timeout;
1328 netdev->watchdog_timeo = GELIC_NET_WATCHDOG_TIMEOUT;
1330 netdev->poll = &gelic_net_poll;
1331 netdev->weight = GELIC_NET_NAPI_WEIGHT;
1332 #ifdef GELIC_NET_ETHTOOL
1333 netdev->ethtool_ops = &gelic_net_ethtool_ops;
1338 * gelic_net_setup_netdev - initialization of net_device
1339 * @card: card structure
1341 * Returns 0 on success or <0 on failure
1343 * gelic_net_setup_netdev initializes the net_device structure
1345 static int gelic_net_setup_netdev(struct gelic_net_card *card)
1347 struct net_device *netdev = card->netdev;
1348 struct sockaddr addr;
1353 SET_MODULE_OWNER(netdev);
1354 SET_NETDEV_DEV(netdev, &card->dev->core);
1355 spin_lock_init(&card->tx_dma_lock);
1357 card->rx_csum = GELIC_NET_RX_CSUM_DEFAULT;
1359 gelic_net_setup_netdev_ops(netdev);
1361 netdev->features = NETIF_F_IP_CSUM;
1363 status = lv1_net_control(bus_id(card), dev_id(card),
1364 GELIC_NET_GET_MAC_ADDRESS,
1366 if (status || !is_valid_ether_addr((u8 *)&v1)) {
1367 dev_info(ctodev(card),
1368 "%s:lv1_net_control GET_MAC_ADDR failed %d\n",
1373 memcpy(addr.sa_data, &v1, ETH_ALEN);
1374 memcpy(netdev->dev_addr, addr.sa_data, ETH_ALEN);
1375 dev_info(ctodev(card), "MAC addr %02x:%02x:%02x:%02x:%02x:%02x\n",
1376 netdev->dev_addr[0], netdev->dev_addr[1],
1377 netdev->dev_addr[2], netdev->dev_addr[3],
1378 netdev->dev_addr[4], netdev->dev_addr[5]);
1380 card->vlan_index = -1; /* no vlan */
1381 for (i = 0; i < GELIC_NET_VLAN_MAX; i++) {
1382 status = lv1_net_control(bus_id(card), dev_id(card),
1383 GELIC_NET_GET_VLAN_ID,
1384 i + 1, /* index; one based */
1386 if (status == GELIC_NET_VLAN_NO_ENTRY) {
1387 dev_dbg(ctodev(card),
1388 "GELIC_VLAN_ID no entry:%d, VLAN disabled\n",
1390 card->vlan_id[i] = 0;
1391 } else if (status) {
1392 dev_dbg(ctodev(card),
1393 "%s:GELIC_NET_VLAN_ID faild, status=%d\n",
1395 card->vlan_id[i] = 0;
1397 card->vlan_id[i] = (u32)v1;
1398 dev_dbg(ctodev(card), "vlan_id:%d, %lx\n", i, v1);
1401 if (card->vlan_id[GELIC_NET_VLAN_WIRED - 1])
1402 card->vlan_index = GELIC_NET_VLAN_WIRED - 1;
1404 status = register_netdev(netdev);
1406 dev_err(ctodev(card), "%s:Couldn't register net_device: %d\n",
1415 * gelic_net_alloc_card - allocates net_device and card structure
1417 * returns the card structure or NULL in case of errors
1419 * the card and net_device structures are linked to each other
1421 static struct gelic_net_card *gelic_net_alloc_card(void)
1423 struct net_device *netdev;
1424 struct gelic_net_card *card;
1427 alloc_size = sizeof (*card) +
1428 sizeof (struct gelic_net_descr) * GELIC_NET_RX_DESCRIPTORS +
1429 sizeof (struct gelic_net_descr) * GELIC_NET_TX_DESCRIPTORS;
1431 * we assume private data is allocated 32 bytes (or more) aligned
1432 * so that gelic_net_descr should be 32 bytes aligned.
1433 * Current alloc_etherdev() does do it because NETDEV_ALIGN
1435 * check this assumption here.
1437 BUILD_BUG_ON(NETDEV_ALIGN < 32);
1438 BUILD_BUG_ON(offsetof(struct gelic_net_card, irq_status) % 8);
1439 BUILD_BUG_ON(offsetof(struct gelic_net_card, descr) % 32);
1441 netdev = alloc_etherdev(alloc_size);
1445 card = netdev_priv(netdev);
1446 card->netdev = netdev;
1447 INIT_WORK(&card->tx_timeout_task, gelic_net_tx_timeout_task);
1448 init_waitqueue_head(&card->waitq);
1449 atomic_set(&card->tx_timeout_task_counter, 0);
1455 * ps3_gelic_driver_probe - add a device to the control of this driver
1457 static int ps3_gelic_driver_probe (struct ps3_system_bus_device *dev)
1459 struct gelic_net_card *card = gelic_net_alloc_card();
1463 dev_info(&dev->core, "gelic_net_alloc_card failed\n");
1465 goto fail_alloc_card;
1468 ps3_system_bus_set_driver_data(dev, card);
1471 result = ps3_open_hv_device(dev);
1474 dev_dbg(&dev->core, "ps3_open_hv_device failed\n");
1478 result = ps3_dma_region_create(dev->d_region);
1481 dev_dbg(&dev->core, "ps3_dma_region_create failed(%d)\n",
1483 BUG_ON("check region type");
1484 goto fail_dma_region;
1487 result = lv1_net_set_interrupt_status_indicator(bus_id(card),
1489 ps3_mm_phys_to_lpar(__pa(&card->irq_status)),
1494 "lv1_net_set_interrupt_status_indicator failed: %s\n",
1495 ps3_result(result));
1497 goto fail_status_indicator;
1500 result = gelic_net_setup_netdev(card);
1503 dev_dbg(&dev->core, "%s:%d: ps3_dma_region_create failed: "
1504 "(%d)\n", __func__, __LINE__, result);
1505 goto fail_setup_netdev;
1511 lv1_net_set_interrupt_status_indicator(bus_id(card),
1514 fail_status_indicator:
1515 ps3_dma_region_free(dev->d_region);
1517 ps3_close_hv_device(dev);
1519 ps3_system_bus_set_driver_data(dev, NULL);
1520 free_netdev(card->netdev);
1526 * ps3_gelic_driver_remove - remove a device from the control of this driver
1529 static int ps3_gelic_driver_remove (struct ps3_system_bus_device *dev)
1531 struct gelic_net_card *card = ps3_system_bus_get_driver_data(dev);
1533 wait_event(card->waitq,
1534 atomic_read(&card->tx_timeout_task_counter) == 0);
1536 lv1_net_set_interrupt_status_indicator(bus_id(card), dev_id(card),
1539 unregister_netdev(card->netdev);
1540 free_netdev(card->netdev);
1542 ps3_system_bus_set_driver_data(dev, NULL);
1544 ps3_dma_region_free(dev->d_region);
1546 ps3_close_hv_device(dev);
1551 static struct ps3_system_bus_driver ps3_gelic_driver = {
1552 .match_id = PS3_MATCH_ID_GELIC,
1553 .probe = ps3_gelic_driver_probe,
1554 .remove = ps3_gelic_driver_remove,
1555 .shutdown = ps3_gelic_driver_remove,
1556 .core.name = "ps3_gelic_driver",
1557 .core.owner = THIS_MODULE,
1560 static int __init ps3_gelic_driver_init (void)
1562 return firmware_has_feature(FW_FEATURE_PS3_LV1)
1563 ? ps3_system_bus_driver_register(&ps3_gelic_driver)
1567 static void __exit ps3_gelic_driver_exit (void)
1569 ps3_system_bus_driver_unregister(&ps3_gelic_driver);
1572 module_init (ps3_gelic_driver_init);
1573 module_exit (ps3_gelic_driver_exit);
1575 MODULE_ALIAS(PS3_MODULE_ALIAS_GELIC);