1 /****************************************************************************
2 * Driver for Solarflare Solarstorm network controllers and boards
3 * Copyright 2005-2006 Fen Systems Ltd.
4 * Copyright 2006-2008 Solarflare Communications Inc.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published
8 * by the Free Software Foundation, incorporated herein by reference.
11 #include <linux/netdevice.h>
12 #include <linux/module.h>
13 #include <linux/delay.h>
14 #include <linux/kernel_stat.h>
15 #include <linux/pci.h>
16 #include <linux/ethtool.h>
19 #include <linux/udp.h>
20 #include <linux/rtnetlink.h>
22 #include "net_driver.h"
26 #include "workarounds.h"
32 * Loopback test packet structure
34 * The self-test should stress every RSS vector, and unfortunately
35 * Falcon only performs RSS on TCP/UDP packets.
37 struct efx_loopback_payload {
43 } __attribute__ ((packed));
45 /* Loopback test source MAC address */
46 static const unsigned char payload_source[ETH_ALEN] = {
47 0x00, 0x0f, 0x53, 0x1b, 0x1b, 0x1b,
50 static const char *payload_msg =
51 "Hello world! This is an Efx loopback test in progress!";
54 * efx_loopback_state - persistent state during a loopback selftest
55 * @flush: Drop all packets in efx_loopback_rx_packet
56 * @packet_count: Number of packets being used in this test
57 * @skbs: An array of skbs transmitted
58 * @offload_csum: Checksums are being offloaded
59 * @rx_good: RX good packet count
60 * @rx_bad: RX bad packet count
61 * @payload: Payload used in tests
63 struct efx_loopback_state {
66 struct sk_buff **skbs;
70 struct efx_loopback_payload payload;
73 /**************************************************************************
75 * MII, NVRAM and register tests
77 **************************************************************************/
79 static int efx_test_mdio(struct efx_nic *efx, struct efx_self_tests *tests)
82 int devad = __ffs(efx->mdio.mmds);
85 if (efx->phy_type == PHY_TYPE_NONE)
88 mutex_lock(&efx->mac_lock);
91 physid1 = efx_mdio_read(efx, devad, MDIO_DEVID1);
92 physid2 = efx_mdio_read(efx, devad, MDIO_DEVID2);
94 if ((physid1 == 0x0000) || (physid1 == 0xffff) ||
95 (physid2 == 0x0000) || (physid2 == 0xffff)) {
96 EFX_ERR(efx, "no MDIO PHY present with ID %d\n",
102 if (EFX_IS10G(efx)) {
103 rc = efx_mdio_check_mmds(efx, efx->phy_op->mmds, 0);
109 mutex_unlock(&efx->mac_lock);
110 tests->mdio = rc ? -1 : 1;
114 static int efx_test_nvram(struct efx_nic *efx, struct efx_self_tests *tests)
118 if (efx->type->test_nvram) {
119 rc = efx->type->test_nvram(efx);
120 tests->nvram = rc ? -1 : 1;
126 static int efx_test_chip(struct efx_nic *efx, struct efx_self_tests *tests)
130 /* Test register access */
131 if (efx->type->test_registers) {
132 rc = efx->type->test_registers(efx);
133 tests->registers = rc ? -1 : 1;
139 /**************************************************************************
141 * Interrupt and event queue testing
143 **************************************************************************/
145 /* Test generation and receipt of interrupts */
146 static int efx_test_interrupts(struct efx_nic *efx,
147 struct efx_self_tests *tests)
149 struct efx_channel *channel;
151 EFX_LOG(efx, "testing interrupts\n");
152 tests->interrupt = -1;
154 /* Reset interrupt flag */
155 efx->last_irq_cpu = -1;
158 /* ACK each interrupting event queue. Receiving an interrupt due to
159 * traffic before a test event is raised is considered a pass */
160 efx_for_each_channel(channel, efx) {
161 if (channel->work_pending)
162 efx_process_channel_now(channel);
163 if (efx->last_irq_cpu >= 0)
167 efx_nic_generate_interrupt(efx);
169 /* Wait for arrival of test interrupt. */
170 EFX_LOG(efx, "waiting for test interrupt\n");
171 schedule_timeout_uninterruptible(HZ / 10);
172 if (efx->last_irq_cpu >= 0)
175 EFX_ERR(efx, "timed out waiting for interrupt\n");
179 EFX_LOG(efx, "%s test interrupt seen on CPU%d\n", INT_MODE(efx),
181 tests->interrupt = 1;
185 /* Test generation and receipt of interrupting events */
186 static int efx_test_eventq_irq(struct efx_channel *channel,
187 struct efx_self_tests *tests)
189 unsigned int magic, count;
191 /* Channel specific code, limited to 20 bits */
192 magic = (0x00010150 + channel->channel);
193 EFX_LOG(channel->efx, "channel %d testing event queue with code %x\n",
194 channel->channel, magic);
196 tests->eventq_dma[channel->channel] = -1;
197 tests->eventq_int[channel->channel] = -1;
198 tests->eventq_poll[channel->channel] = -1;
200 /* Reset flag and zero magic word */
201 channel->efx->last_irq_cpu = -1;
202 channel->eventq_magic = 0;
205 efx_nic_generate_test_event(channel, magic);
207 /* Wait for arrival of interrupt */
210 schedule_timeout_uninterruptible(HZ / 100);
212 if (channel->work_pending)
213 efx_process_channel_now(channel);
215 if (channel->eventq_magic == magic)
217 } while (++count < 2);
219 EFX_ERR(channel->efx, "channel %d timed out waiting for event queue\n",
222 /* See if interrupt arrived */
223 if (channel->efx->last_irq_cpu >= 0) {
224 EFX_ERR(channel->efx, "channel %d saw interrupt on CPU%d "
225 "during event queue test\n", channel->channel,
226 raw_smp_processor_id());
227 tests->eventq_int[channel->channel] = 1;
230 /* Check to see if event was received even if interrupt wasn't */
231 efx_process_channel_now(channel);
232 if (channel->eventq_magic == magic) {
233 EFX_ERR(channel->efx, "channel %d event was generated, but "
234 "failed to trigger an interrupt\n", channel->channel);
235 tests->eventq_dma[channel->channel] = 1;
240 EFX_LOG(channel->efx, "channel %d event queue passed\n",
242 tests->eventq_dma[channel->channel] = 1;
243 tests->eventq_int[channel->channel] = 1;
244 tests->eventq_poll[channel->channel] = 1;
248 static int efx_test_phy(struct efx_nic *efx, struct efx_self_tests *tests,
253 if (!efx->phy_op->run_tests)
256 EFX_BUG_ON_PARANOID(efx->phy_op->num_tests == 0 ||
257 efx->phy_op->num_tests > EFX_MAX_PHY_TESTS);
259 mutex_lock(&efx->mac_lock);
260 rc = efx->phy_op->run_tests(efx, tests->phy, flags);
261 mutex_unlock(&efx->mac_lock);
265 /**************************************************************************
268 * NB Only one loopback test can be executing concurrently.
270 **************************************************************************/
272 /* Loopback test RX callback
273 * This is called for each received packet during loopback testing.
275 void efx_loopback_rx_packet(struct efx_nic *efx,
276 const char *buf_ptr, int pkt_len)
278 struct efx_loopback_state *state = efx->loopback_selftest;
279 struct efx_loopback_payload *received;
280 struct efx_loopback_payload *payload;
284 /* If we are just flushing, then drop the packet */
285 if ((state == NULL) || state->flush)
288 payload = &state->payload;
290 received = (struct efx_loopback_payload *) buf_ptr;
291 received->ip.saddr = payload->ip.saddr;
292 if (state->offload_csum)
293 received->ip.check = payload->ip.check;
295 /* Check that header exists */
296 if (pkt_len < sizeof(received->header)) {
297 EFX_ERR(efx, "saw runt RX packet (length %d) in %s loopback "
298 "test\n", pkt_len, LOOPBACK_MODE(efx));
302 /* Check that the ethernet header exists */
303 if (memcmp(&received->header, &payload->header, ETH_HLEN) != 0) {
304 EFX_ERR(efx, "saw non-loopback RX packet in %s loopback test\n",
309 /* Check packet length */
310 if (pkt_len != sizeof(*payload)) {
311 EFX_ERR(efx, "saw incorrect RX packet length %d (wanted %d) in "
312 "%s loopback test\n", pkt_len, (int)sizeof(*payload),
317 /* Check that IP header matches */
318 if (memcmp(&received->ip, &payload->ip, sizeof(payload->ip)) != 0) {
319 EFX_ERR(efx, "saw corrupted IP header in %s loopback test\n",
324 /* Check that msg and padding matches */
325 if (memcmp(&received->msg, &payload->msg, sizeof(received->msg)) != 0) {
326 EFX_ERR(efx, "saw corrupted RX packet in %s loopback test\n",
331 /* Check that iteration matches */
332 if (received->iteration != payload->iteration) {
333 EFX_ERR(efx, "saw RX packet from iteration %d (wanted %d) in "
334 "%s loopback test\n", ntohs(received->iteration),
335 ntohs(payload->iteration), LOOPBACK_MODE(efx));
339 /* Increase correct RX count */
340 EFX_TRACE(efx, "got loopback RX in %s loopback test\n",
343 atomic_inc(&state->rx_good);
347 #ifdef EFX_ENABLE_DEBUG
348 if (atomic_read(&state->rx_bad) == 0) {
349 EFX_ERR(efx, "received packet:\n");
350 print_hex_dump(KERN_ERR, "", DUMP_PREFIX_OFFSET, 0x10, 1,
351 buf_ptr, pkt_len, 0);
352 EFX_ERR(efx, "expected packet:\n");
353 print_hex_dump(KERN_ERR, "", DUMP_PREFIX_OFFSET, 0x10, 1,
354 &state->payload, sizeof(state->payload), 0);
357 atomic_inc(&state->rx_bad);
360 /* Initialise an efx_selftest_state for a new iteration */
361 static void efx_iterate_state(struct efx_nic *efx)
363 struct efx_loopback_state *state = efx->loopback_selftest;
364 struct net_device *net_dev = efx->net_dev;
365 struct efx_loopback_payload *payload = &state->payload;
367 /* Initialise the layerII header */
368 memcpy(&payload->header.h_dest, net_dev->dev_addr, ETH_ALEN);
369 memcpy(&payload->header.h_source, &payload_source, ETH_ALEN);
370 payload->header.h_proto = htons(ETH_P_IP);
372 /* saddr set later and used as incrementing count */
373 payload->ip.daddr = htonl(INADDR_LOOPBACK);
375 payload->ip.check = htons(0xdead);
376 payload->ip.tot_len = htons(sizeof(*payload) - sizeof(struct ethhdr));
377 payload->ip.version = IPVERSION;
378 payload->ip.protocol = IPPROTO_UDP;
380 /* Initialise udp header */
381 payload->udp.source = 0;
382 payload->udp.len = htons(sizeof(*payload) - sizeof(struct ethhdr) -
383 sizeof(struct iphdr));
384 payload->udp.check = 0; /* checksum ignored */
386 /* Fill out payload */
387 payload->iteration = htons(ntohs(payload->iteration) + 1);
388 memcpy(&payload->msg, payload_msg, sizeof(payload_msg));
390 /* Fill out remaining state members */
391 atomic_set(&state->rx_good, 0);
392 atomic_set(&state->rx_bad, 0);
396 static int efx_begin_loopback(struct efx_tx_queue *tx_queue)
398 struct efx_nic *efx = tx_queue->efx;
399 struct efx_loopback_state *state = efx->loopback_selftest;
400 struct efx_loopback_payload *payload;
405 /* Transmit N copies of buffer */
406 for (i = 0; i < state->packet_count; i++) {
407 /* Allocate an skb, holding an extra reference for
408 * transmit completion counting */
409 skb = alloc_skb(sizeof(state->payload), GFP_KERNEL);
412 state->skbs[i] = skb;
415 /* Copy the payload in, incrementing the source address to
416 * exercise the rss vectors */
417 payload = ((struct efx_loopback_payload *)
418 skb_put(skb, sizeof(state->payload)));
419 memcpy(payload, &state->payload, sizeof(state->payload));
420 payload->ip.saddr = htonl(INADDR_LOOPBACK | (i << 2));
422 /* Ensure everything we've written is visible to the
423 * interrupt handler. */
426 if (efx_dev_registered(efx))
427 netif_tx_lock_bh(efx->net_dev);
428 rc = efx_enqueue_skb(tx_queue, skb);
429 if (efx_dev_registered(efx))
430 netif_tx_unlock_bh(efx->net_dev);
432 if (rc != NETDEV_TX_OK) {
433 EFX_ERR(efx, "TX queue %d could not transmit packet %d "
434 "of %d in %s loopback test\n", tx_queue->queue,
435 i + 1, state->packet_count, LOOPBACK_MODE(efx));
437 /* Defer cleaning up the other skbs for the caller */
446 static int efx_poll_loopback(struct efx_nic *efx)
448 struct efx_loopback_state *state = efx->loopback_selftest;
449 struct efx_channel *channel;
451 /* NAPI polling is not enabled, so process channels
453 efx_for_each_channel(channel, efx) {
454 if (channel->work_pending)
455 efx_process_channel_now(channel);
457 return atomic_read(&state->rx_good) == state->packet_count;
460 static int efx_end_loopback(struct efx_tx_queue *tx_queue,
461 struct efx_loopback_self_tests *lb_tests)
463 struct efx_nic *efx = tx_queue->efx;
464 struct efx_loopback_state *state = efx->loopback_selftest;
466 int tx_done = 0, rx_good, rx_bad;
469 if (efx_dev_registered(efx))
470 netif_tx_lock_bh(efx->net_dev);
472 /* Count the number of tx completions, and decrement the refcnt. Any
473 * skbs not already completed will be free'd when the queue is flushed */
474 for (i=0; i < state->packet_count; i++) {
475 skb = state->skbs[i];
476 if (skb && !skb_shared(skb))
478 dev_kfree_skb_any(skb);
481 if (efx_dev_registered(efx))
482 netif_tx_unlock_bh(efx->net_dev);
484 /* Check TX completion and received packet counts */
485 rx_good = atomic_read(&state->rx_good);
486 rx_bad = atomic_read(&state->rx_bad);
487 if (tx_done != state->packet_count) {
488 /* Don't free the skbs; they will be picked up on TX
489 * overflow or channel teardown.
491 EFX_ERR(efx, "TX queue %d saw only %d out of an expected %d "
492 "TX completion events in %s loopback test\n",
493 tx_queue->queue, tx_done, state->packet_count,
496 /* Allow to fall through so we see the RX errors as well */
499 /* We may always be up to a flush away from our desired packet total */
500 if (rx_good != state->packet_count) {
501 EFX_LOG(efx, "TX queue %d saw only %d out of an expected %d "
502 "received packets in %s loopback test\n",
503 tx_queue->queue, rx_good, state->packet_count,
509 /* Update loopback test structure */
510 lb_tests->tx_sent[tx_queue->queue] += state->packet_count;
511 lb_tests->tx_done[tx_queue->queue] += tx_done;
512 lb_tests->rx_good += rx_good;
513 lb_tests->rx_bad += rx_bad;
519 efx_test_loopback(struct efx_tx_queue *tx_queue,
520 struct efx_loopback_self_tests *lb_tests)
522 struct efx_nic *efx = tx_queue->efx;
523 struct efx_loopback_state *state = efx->loopback_selftest;
524 int i, begin_rc, end_rc;
526 for (i = 0; i < 3; i++) {
527 /* Determine how many packets to send */
528 state->packet_count = EFX_TXQ_SIZE / 3;
529 state->packet_count = min(1 << (i << 2), state->packet_count);
530 state->skbs = kzalloc(sizeof(state->skbs[0]) *
531 state->packet_count, GFP_KERNEL);
534 state->flush = false;
536 EFX_LOG(efx, "TX queue %d testing %s loopback with %d "
537 "packets\n", tx_queue->queue, LOOPBACK_MODE(efx),
538 state->packet_count);
540 efx_iterate_state(efx);
541 begin_rc = efx_begin_loopback(tx_queue);
543 /* This will normally complete very quickly, but be
544 * prepared to wait up to 100 ms. */
546 if (!efx_poll_loopback(efx)) {
548 efx_poll_loopback(efx);
551 end_rc = efx_end_loopback(tx_queue, lb_tests);
554 if (begin_rc || end_rc) {
555 /* Wait a while to ensure there are no packets
556 * floating around after a failure. */
557 schedule_timeout_uninterruptible(HZ / 10);
558 return begin_rc ? begin_rc : end_rc;
562 EFX_LOG(efx, "TX queue %d passed %s loopback test with a burst length "
563 "of %d packets\n", tx_queue->queue, LOOPBACK_MODE(efx),
564 state->packet_count);
569 /* Wait for link up. On Falcon, we would prefer to rely on efx_monitor, but
570 * any contention on the mac lock (via e.g. efx_mac_mcast_work) causes it
571 * to delay and retry. Therefore, it's safer to just poll directly. Wait
572 * for link up and any faults to dissipate. */
573 static int efx_wait_for_link(struct efx_nic *efx)
575 struct efx_link_state *link_state = &efx->link_state;
579 for (count = 0; count < 40; count++) {
580 schedule_timeout_uninterruptible(HZ / 10);
582 if (efx->type->monitor != NULL) {
583 mutex_lock(&efx->mac_lock);
584 efx->type->monitor(efx);
585 mutex_unlock(&efx->mac_lock);
587 struct efx_channel *channel = &efx->channel[0];
588 if (channel->work_pending)
589 efx_process_channel_now(channel);
592 mutex_lock(&efx->mac_lock);
593 link_up = link_state->up;
595 link_up = !efx->mac_op->check_fault(efx);
596 mutex_unlock(&efx->mac_lock);
605 static int efx_test_loopbacks(struct efx_nic *efx, struct efx_self_tests *tests,
606 unsigned int loopback_modes)
608 enum efx_loopback_mode mode;
609 struct efx_loopback_state *state;
610 struct efx_tx_queue *tx_queue;
613 /* Set the port loopback_selftest member. From this point on
614 * all received packets will be dropped. Mark the state as
615 * "flushing" so all inflight packets are dropped */
616 state = kzalloc(sizeof(*state), GFP_KERNEL);
619 BUG_ON(efx->loopback_selftest);
621 efx->loopback_selftest = state;
623 /* Test all supported loopback modes */
624 for (mode = LOOPBACK_NONE; mode <= LOOPBACK_TEST_MAX; mode++) {
625 if (!(loopback_modes & (1 << mode)))
628 /* Move the port into the specified loopback mode. */
630 mutex_lock(&efx->mac_lock);
631 efx->loopback_mode = mode;
632 rc = __efx_reconfigure_port(efx);
633 mutex_unlock(&efx->mac_lock);
635 EFX_ERR(efx, "unable to move into %s loopback\n",
640 rc = efx_wait_for_link(efx);
642 EFX_ERR(efx, "loopback %s never came up\n",
647 /* Test every TX queue */
648 efx_for_each_tx_queue(tx_queue, efx) {
649 state->offload_csum = (tx_queue->queue ==
650 EFX_TX_QUEUE_OFFLOAD_CSUM);
651 rc = efx_test_loopback(tx_queue,
652 &tests->loopback[mode]);
659 /* Remove the flush. The caller will remove the loopback setting */
661 efx->loopback_selftest = NULL;
668 /**************************************************************************
672 *************************************************************************/
674 int efx_selftest(struct efx_nic *efx, struct efx_self_tests *tests,
677 enum efx_loopback_mode loopback_mode = efx->loopback_mode;
678 int phy_mode = efx->phy_mode;
679 enum reset_type reset_method = RESET_TYPE_INVISIBLE;
680 struct efx_channel *channel;
681 int rc_test = 0, rc_reset = 0, rc;
683 /* Online (i.e. non-disruptive) testing
684 * This checks interrupt generation, event delivery and PHY presence. */
686 rc = efx_test_mdio(efx, tests);
690 rc = efx_test_nvram(efx, tests);
694 rc = efx_test_interrupts(efx, tests);
698 efx_for_each_channel(channel, efx) {
699 rc = efx_test_eventq_irq(channel, tests);
707 if (!(flags & ETH_TEST_FL_OFFLINE))
708 return efx_test_phy(efx, tests, flags);
710 /* Offline (i.e. disruptive) testing
711 * This checks MAC and PHY loopback on the specified port. */
713 /* force the carrier state off so the kernel doesn't transmit during
714 * the loopback test, and the watchdog timeout doesn't fire. Also put
715 * falcon into loopback for the register test.
717 mutex_lock(&efx->mac_lock);
718 efx->port_inhibited = true;
719 if (efx->loopback_modes) {
720 /* We need the 312 clock from the PHY to test the XMAC
721 * registers, so move into XGMII loopback if available */
722 if (efx->loopback_modes & (1 << LOOPBACK_XGMII))
723 efx->loopback_mode = LOOPBACK_XGMII;
725 efx->loopback_mode = __ffs(efx->loopback_modes);
728 __efx_reconfigure_port(efx);
729 mutex_unlock(&efx->mac_lock);
731 /* free up all consumers of SRAM (including all the queues) */
732 efx_reset_down(efx, reset_method);
734 rc = efx_test_chip(efx, tests);
738 /* reset the chip to recover from the register test */
739 rc_reset = efx->type->reset(efx, reset_method);
741 /* Ensure that the phy is powered and out of loopback
742 * for the bist and loopback tests */
743 efx->phy_mode &= ~PHY_MODE_LOW_POWER;
744 efx->loopback_mode = LOOPBACK_NONE;
746 rc = efx_reset_up(efx, reset_method, rc_reset == 0);
751 EFX_ERR(efx, "Unable to recover from chip test\n");
752 efx_schedule_reset(efx, RESET_TYPE_DISABLE);
756 rc = efx_test_phy(efx, tests, flags);
760 rc = efx_test_loopbacks(efx, tests, efx->loopback_modes);
764 /* restore the PHY to the previous state */
765 mutex_lock(&efx->mac_lock);
766 efx->phy_mode = phy_mode;
767 efx->port_inhibited = false;
768 efx->loopback_mode = loopback_mode;
769 __efx_reconfigure_port(efx);
770 mutex_unlock(&efx->mac_lock);