1 /****************************************************************************
2 * Driver for Solarflare Solarstorm network controllers and boards
3 * Copyright 2005-2006 Fen Systems Ltd.
4 * Copyright 2006-2009 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"
29 * Loopback test packet structure
31 * The self-test should stress every RSS vector, and unfortunately
32 * Falcon only performs RSS on TCP/UDP packets.
34 struct efx_loopback_payload {
40 } __attribute__ ((packed));
42 /* Loopback test source MAC address */
43 static const unsigned char payload_source[ETH_ALEN] = {
44 0x00, 0x0f, 0x53, 0x1b, 0x1b, 0x1b,
47 static const char payload_msg[] =
48 "Hello world! This is an Efx loopback test in progress!";
51 * efx_loopback_state - persistent state during a loopback selftest
52 * @flush: Drop all packets in efx_loopback_rx_packet
53 * @packet_count: Number of packets being used in this test
54 * @skbs: An array of skbs transmitted
55 * @offload_csum: Checksums are being offloaded
56 * @rx_good: RX good packet count
57 * @rx_bad: RX bad packet count
58 * @payload: Payload used in tests
60 struct efx_loopback_state {
63 struct sk_buff **skbs;
67 struct efx_loopback_payload payload;
70 /**************************************************************************
72 * MII, NVRAM and register tests
74 **************************************************************************/
76 static int efx_test_phy_alive(struct efx_nic *efx, struct efx_self_tests *tests)
80 if (efx->phy_op->test_alive) {
81 rc = efx->phy_op->test_alive(efx);
82 tests->phy_alive = rc ? -1 : 1;
88 static int efx_test_nvram(struct efx_nic *efx, struct efx_self_tests *tests)
92 if (efx->type->test_nvram) {
93 rc = efx->type->test_nvram(efx);
94 tests->nvram = rc ? -1 : 1;
100 static int efx_test_chip(struct efx_nic *efx, struct efx_self_tests *tests)
104 /* Test register access */
105 if (efx->type->test_registers) {
106 rc = efx->type->test_registers(efx);
107 tests->registers = rc ? -1 : 1;
113 /**************************************************************************
115 * Interrupt and event queue testing
117 **************************************************************************/
119 /* Test generation and receipt of interrupts */
120 static int efx_test_interrupts(struct efx_nic *efx,
121 struct efx_self_tests *tests)
123 struct efx_channel *channel;
125 EFX_LOG(efx, "testing interrupts\n");
126 tests->interrupt = -1;
128 /* Reset interrupt flag */
129 efx->last_irq_cpu = -1;
132 /* ACK each interrupting event queue. Receiving an interrupt due to
133 * traffic before a test event is raised is considered a pass */
134 efx_for_each_channel(channel, efx) {
135 if (channel->work_pending)
136 efx_process_channel_now(channel);
137 if (efx->last_irq_cpu >= 0)
141 efx_nic_generate_interrupt(efx);
143 /* Wait for arrival of test interrupt. */
144 EFX_LOG(efx, "waiting for test interrupt\n");
145 schedule_timeout_uninterruptible(HZ / 10);
146 if (efx->last_irq_cpu >= 0)
149 EFX_ERR(efx, "timed out waiting for interrupt\n");
153 EFX_LOG(efx, "%s test interrupt seen on CPU%d\n", INT_MODE(efx),
155 tests->interrupt = 1;
159 /* Test generation and receipt of interrupting events */
160 static int efx_test_eventq_irq(struct efx_channel *channel,
161 struct efx_self_tests *tests)
163 unsigned int magic, count;
165 /* Channel specific code, limited to 20 bits */
166 magic = (0x00010150 + channel->channel);
167 EFX_LOG(channel->efx, "channel %d testing event queue with code %x\n",
168 channel->channel, magic);
170 tests->eventq_dma[channel->channel] = -1;
171 tests->eventq_int[channel->channel] = -1;
172 tests->eventq_poll[channel->channel] = -1;
174 /* Reset flag and zero magic word */
175 channel->efx->last_irq_cpu = -1;
176 channel->eventq_magic = 0;
179 efx_nic_generate_test_event(channel, magic);
181 /* Wait for arrival of interrupt */
184 schedule_timeout_uninterruptible(HZ / 100);
186 if (channel->work_pending)
187 efx_process_channel_now(channel);
189 if (channel->eventq_magic == magic)
191 } while (++count < 2);
193 EFX_ERR(channel->efx, "channel %d timed out waiting for event queue\n",
196 /* See if interrupt arrived */
197 if (channel->efx->last_irq_cpu >= 0) {
198 EFX_ERR(channel->efx, "channel %d saw interrupt on CPU%d "
199 "during event queue test\n", channel->channel,
200 raw_smp_processor_id());
201 tests->eventq_int[channel->channel] = 1;
204 /* Check to see if event was received even if interrupt wasn't */
205 efx_process_channel_now(channel);
206 if (channel->eventq_magic == magic) {
207 EFX_ERR(channel->efx, "channel %d event was generated, but "
208 "failed to trigger an interrupt\n", channel->channel);
209 tests->eventq_dma[channel->channel] = 1;
214 EFX_LOG(channel->efx, "channel %d event queue passed\n",
216 tests->eventq_dma[channel->channel] = 1;
217 tests->eventq_int[channel->channel] = 1;
218 tests->eventq_poll[channel->channel] = 1;
222 static int efx_test_phy(struct efx_nic *efx, struct efx_self_tests *tests,
227 if (!efx->phy_op->run_tests)
230 mutex_lock(&efx->mac_lock);
231 rc = efx->phy_op->run_tests(efx, tests->phy_ext, flags);
232 mutex_unlock(&efx->mac_lock);
236 /**************************************************************************
239 * NB Only one loopback test can be executing concurrently.
241 **************************************************************************/
243 /* Loopback test RX callback
244 * This is called for each received packet during loopback testing.
246 void efx_loopback_rx_packet(struct efx_nic *efx,
247 const char *buf_ptr, int pkt_len)
249 struct efx_loopback_state *state = efx->loopback_selftest;
250 struct efx_loopback_payload *received;
251 struct efx_loopback_payload *payload;
255 /* If we are just flushing, then drop the packet */
256 if ((state == NULL) || state->flush)
259 payload = &state->payload;
261 received = (struct efx_loopback_payload *) buf_ptr;
262 received->ip.saddr = payload->ip.saddr;
263 if (state->offload_csum)
264 received->ip.check = payload->ip.check;
266 /* Check that header exists */
267 if (pkt_len < sizeof(received->header)) {
268 EFX_ERR(efx, "saw runt RX packet (length %d) in %s loopback "
269 "test\n", pkt_len, LOOPBACK_MODE(efx));
273 /* Check that the ethernet header exists */
274 if (memcmp(&received->header, &payload->header, ETH_HLEN) != 0) {
275 EFX_ERR(efx, "saw non-loopback RX packet in %s loopback test\n",
280 /* Check packet length */
281 if (pkt_len != sizeof(*payload)) {
282 EFX_ERR(efx, "saw incorrect RX packet length %d (wanted %d) in "
283 "%s loopback test\n", pkt_len, (int)sizeof(*payload),
288 /* Check that IP header matches */
289 if (memcmp(&received->ip, &payload->ip, sizeof(payload->ip)) != 0) {
290 EFX_ERR(efx, "saw corrupted IP header in %s loopback test\n",
295 /* Check that msg and padding matches */
296 if (memcmp(&received->msg, &payload->msg, sizeof(received->msg)) != 0) {
297 EFX_ERR(efx, "saw corrupted RX packet in %s loopback test\n",
302 /* Check that iteration matches */
303 if (received->iteration != payload->iteration) {
304 EFX_ERR(efx, "saw RX packet from iteration %d (wanted %d) in "
305 "%s loopback test\n", ntohs(received->iteration),
306 ntohs(payload->iteration), LOOPBACK_MODE(efx));
310 /* Increase correct RX count */
311 EFX_TRACE(efx, "got loopback RX in %s loopback test\n",
314 atomic_inc(&state->rx_good);
318 #ifdef EFX_ENABLE_DEBUG
319 if (atomic_read(&state->rx_bad) == 0) {
320 EFX_ERR(efx, "received packet:\n");
321 print_hex_dump(KERN_ERR, "", DUMP_PREFIX_OFFSET, 0x10, 1,
322 buf_ptr, pkt_len, 0);
323 EFX_ERR(efx, "expected packet:\n");
324 print_hex_dump(KERN_ERR, "", DUMP_PREFIX_OFFSET, 0x10, 1,
325 &state->payload, sizeof(state->payload), 0);
328 atomic_inc(&state->rx_bad);
331 /* Initialise an efx_selftest_state for a new iteration */
332 static void efx_iterate_state(struct efx_nic *efx)
334 struct efx_loopback_state *state = efx->loopback_selftest;
335 struct net_device *net_dev = efx->net_dev;
336 struct efx_loopback_payload *payload = &state->payload;
338 /* Initialise the layerII header */
339 memcpy(&payload->header.h_dest, net_dev->dev_addr, ETH_ALEN);
340 memcpy(&payload->header.h_source, &payload_source, ETH_ALEN);
341 payload->header.h_proto = htons(ETH_P_IP);
343 /* saddr set later and used as incrementing count */
344 payload->ip.daddr = htonl(INADDR_LOOPBACK);
346 payload->ip.check = htons(0xdead);
347 payload->ip.tot_len = htons(sizeof(*payload) - sizeof(struct ethhdr));
348 payload->ip.version = IPVERSION;
349 payload->ip.protocol = IPPROTO_UDP;
351 /* Initialise udp header */
352 payload->udp.source = 0;
353 payload->udp.len = htons(sizeof(*payload) - sizeof(struct ethhdr) -
354 sizeof(struct iphdr));
355 payload->udp.check = 0; /* checksum ignored */
357 /* Fill out payload */
358 payload->iteration = htons(ntohs(payload->iteration) + 1);
359 memcpy(&payload->msg, payload_msg, sizeof(payload_msg));
361 /* Fill out remaining state members */
362 atomic_set(&state->rx_good, 0);
363 atomic_set(&state->rx_bad, 0);
367 static int efx_begin_loopback(struct efx_tx_queue *tx_queue)
369 struct efx_nic *efx = tx_queue->efx;
370 struct efx_loopback_state *state = efx->loopback_selftest;
371 struct efx_loopback_payload *payload;
376 /* Transmit N copies of buffer */
377 for (i = 0; i < state->packet_count; i++) {
378 /* Allocate an skb, holding an extra reference for
379 * transmit completion counting */
380 skb = alloc_skb(sizeof(state->payload), GFP_KERNEL);
383 state->skbs[i] = skb;
386 /* Copy the payload in, incrementing the source address to
387 * exercise the rss vectors */
388 payload = ((struct efx_loopback_payload *)
389 skb_put(skb, sizeof(state->payload)));
390 memcpy(payload, &state->payload, sizeof(state->payload));
391 payload->ip.saddr = htonl(INADDR_LOOPBACK | (i << 2));
393 /* Ensure everything we've written is visible to the
394 * interrupt handler. */
397 if (efx_dev_registered(efx))
398 netif_tx_lock_bh(efx->net_dev);
399 rc = efx_enqueue_skb(tx_queue, skb);
400 if (efx_dev_registered(efx))
401 netif_tx_unlock_bh(efx->net_dev);
403 if (rc != NETDEV_TX_OK) {
404 EFX_ERR(efx, "TX queue %d could not transmit packet %d "
405 "of %d in %s loopback test\n", tx_queue->queue,
406 i + 1, state->packet_count, LOOPBACK_MODE(efx));
408 /* Defer cleaning up the other skbs for the caller */
417 static int efx_poll_loopback(struct efx_nic *efx)
419 struct efx_loopback_state *state = efx->loopback_selftest;
420 struct efx_channel *channel;
422 /* NAPI polling is not enabled, so process channels
424 efx_for_each_channel(channel, efx) {
425 if (channel->work_pending)
426 efx_process_channel_now(channel);
428 return atomic_read(&state->rx_good) == state->packet_count;
431 static int efx_end_loopback(struct efx_tx_queue *tx_queue,
432 struct efx_loopback_self_tests *lb_tests)
434 struct efx_nic *efx = tx_queue->efx;
435 struct efx_loopback_state *state = efx->loopback_selftest;
437 int tx_done = 0, rx_good, rx_bad;
440 if (efx_dev_registered(efx))
441 netif_tx_lock_bh(efx->net_dev);
443 /* Count the number of tx completions, and decrement the refcnt. Any
444 * skbs not already completed will be free'd when the queue is flushed */
445 for (i=0; i < state->packet_count; i++) {
446 skb = state->skbs[i];
447 if (skb && !skb_shared(skb))
449 dev_kfree_skb_any(skb);
452 if (efx_dev_registered(efx))
453 netif_tx_unlock_bh(efx->net_dev);
455 /* Check TX completion and received packet counts */
456 rx_good = atomic_read(&state->rx_good);
457 rx_bad = atomic_read(&state->rx_bad);
458 if (tx_done != state->packet_count) {
459 /* Don't free the skbs; they will be picked up on TX
460 * overflow or channel teardown.
462 EFX_ERR(efx, "TX queue %d saw only %d out of an expected %d "
463 "TX completion events in %s loopback test\n",
464 tx_queue->queue, tx_done, state->packet_count,
467 /* Allow to fall through so we see the RX errors as well */
470 /* We may always be up to a flush away from our desired packet total */
471 if (rx_good != state->packet_count) {
472 EFX_LOG(efx, "TX queue %d saw only %d out of an expected %d "
473 "received packets in %s loopback test\n",
474 tx_queue->queue, rx_good, state->packet_count,
480 /* Update loopback test structure */
481 lb_tests->tx_sent[tx_queue->queue] += state->packet_count;
482 lb_tests->tx_done[tx_queue->queue] += tx_done;
483 lb_tests->rx_good += rx_good;
484 lb_tests->rx_bad += rx_bad;
490 efx_test_loopback(struct efx_tx_queue *tx_queue,
491 struct efx_loopback_self_tests *lb_tests)
493 struct efx_nic *efx = tx_queue->efx;
494 struct efx_loopback_state *state = efx->loopback_selftest;
495 int i, begin_rc, end_rc;
497 for (i = 0; i < 3; i++) {
498 /* Determine how many packets to send */
499 state->packet_count = EFX_TXQ_SIZE / 3;
500 state->packet_count = min(1 << (i << 2), state->packet_count);
501 state->skbs = kzalloc(sizeof(state->skbs[0]) *
502 state->packet_count, GFP_KERNEL);
505 state->flush = false;
507 EFX_LOG(efx, "TX queue %d testing %s loopback with %d "
508 "packets\n", tx_queue->queue, LOOPBACK_MODE(efx),
509 state->packet_count);
511 efx_iterate_state(efx);
512 begin_rc = efx_begin_loopback(tx_queue);
514 /* This will normally complete very quickly, but be
515 * prepared to wait up to 100 ms. */
517 if (!efx_poll_loopback(efx)) {
519 efx_poll_loopback(efx);
522 end_rc = efx_end_loopback(tx_queue, lb_tests);
525 if (begin_rc || end_rc) {
526 /* Wait a while to ensure there are no packets
527 * floating around after a failure. */
528 schedule_timeout_uninterruptible(HZ / 10);
529 return begin_rc ? begin_rc : end_rc;
533 EFX_LOG(efx, "TX queue %d passed %s loopback test with a burst length "
534 "of %d packets\n", tx_queue->queue, LOOPBACK_MODE(efx),
535 state->packet_count);
540 /* Wait for link up. On Falcon, we would prefer to rely on efx_monitor, but
541 * any contention on the mac lock (via e.g. efx_mac_mcast_work) causes it
542 * to delay and retry. Therefore, it's safer to just poll directly. Wait
543 * for link up and any faults to dissipate. */
544 static int efx_wait_for_link(struct efx_nic *efx)
546 struct efx_link_state *link_state = &efx->link_state;
550 for (count = 0; count < 40; count++) {
551 schedule_timeout_uninterruptible(HZ / 10);
553 if (efx->type->monitor != NULL) {
554 mutex_lock(&efx->mac_lock);
555 efx->type->monitor(efx);
556 mutex_unlock(&efx->mac_lock);
558 struct efx_channel *channel = &efx->channel[0];
559 if (channel->work_pending)
560 efx_process_channel_now(channel);
563 mutex_lock(&efx->mac_lock);
564 link_up = link_state->up;
566 link_up = !efx->mac_op->check_fault(efx);
567 mutex_unlock(&efx->mac_lock);
576 static int efx_test_loopbacks(struct efx_nic *efx, struct efx_self_tests *tests,
577 unsigned int loopback_modes)
579 enum efx_loopback_mode mode;
580 struct efx_loopback_state *state;
581 struct efx_tx_queue *tx_queue;
584 /* Set the port loopback_selftest member. From this point on
585 * all received packets will be dropped. Mark the state as
586 * "flushing" so all inflight packets are dropped */
587 state = kzalloc(sizeof(*state), GFP_KERNEL);
590 BUG_ON(efx->loopback_selftest);
592 efx->loopback_selftest = state;
594 /* Test all supported loopback modes */
595 for (mode = LOOPBACK_NONE; mode <= LOOPBACK_TEST_MAX; mode++) {
596 if (!(loopback_modes & (1 << mode)))
599 /* Move the port into the specified loopback mode. */
601 mutex_lock(&efx->mac_lock);
602 efx->loopback_mode = mode;
603 rc = __efx_reconfigure_port(efx);
604 mutex_unlock(&efx->mac_lock);
606 EFX_ERR(efx, "unable to move into %s loopback\n",
611 rc = efx_wait_for_link(efx);
613 EFX_ERR(efx, "loopback %s never came up\n",
618 /* Test every TX queue */
619 efx_for_each_tx_queue(tx_queue, efx) {
620 state->offload_csum = (tx_queue->queue ==
621 EFX_TX_QUEUE_OFFLOAD_CSUM);
622 rc = efx_test_loopback(tx_queue,
623 &tests->loopback[mode]);
630 /* Remove the flush. The caller will remove the loopback setting */
632 efx->loopback_selftest = NULL;
639 /**************************************************************************
643 *************************************************************************/
645 int efx_selftest(struct efx_nic *efx, struct efx_self_tests *tests,
648 enum efx_loopback_mode loopback_mode = efx->loopback_mode;
649 int phy_mode = efx->phy_mode;
650 enum reset_type reset_method = RESET_TYPE_INVISIBLE;
651 struct efx_channel *channel;
652 int rc_test = 0, rc_reset = 0, rc;
654 /* Online (i.e. non-disruptive) testing
655 * This checks interrupt generation, event delivery and PHY presence. */
657 rc = efx_test_phy_alive(efx, tests);
661 rc = efx_test_nvram(efx, tests);
665 rc = efx_test_interrupts(efx, tests);
669 efx_for_each_channel(channel, efx) {
670 rc = efx_test_eventq_irq(channel, tests);
678 if (!(flags & ETH_TEST_FL_OFFLINE))
679 return efx_test_phy(efx, tests, flags);
681 /* Offline (i.e. disruptive) testing
682 * This checks MAC and PHY loopback on the specified port. */
684 /* force the carrier state off so the kernel doesn't transmit during
685 * the loopback test, and the watchdog timeout doesn't fire. Also put
686 * falcon into loopback for the register test.
688 mutex_lock(&efx->mac_lock);
689 efx->port_inhibited = true;
690 if (efx->loopback_modes) {
691 /* We need the 312 clock from the PHY to test the XMAC
692 * registers, so move into XGMII loopback if available */
693 if (efx->loopback_modes & (1 << LOOPBACK_XGMII))
694 efx->loopback_mode = LOOPBACK_XGMII;
696 efx->loopback_mode = __ffs(efx->loopback_modes);
699 __efx_reconfigure_port(efx);
700 mutex_unlock(&efx->mac_lock);
702 /* free up all consumers of SRAM (including all the queues) */
703 efx_reset_down(efx, reset_method);
705 rc = efx_test_chip(efx, tests);
709 /* reset the chip to recover from the register test */
710 rc_reset = efx->type->reset(efx, reset_method);
712 /* Ensure that the phy is powered and out of loopback
713 * for the bist and loopback tests */
714 efx->phy_mode &= ~PHY_MODE_LOW_POWER;
715 efx->loopback_mode = LOOPBACK_NONE;
717 rc = efx_reset_up(efx, reset_method, rc_reset == 0);
722 EFX_ERR(efx, "Unable to recover from chip test\n");
723 efx_schedule_reset(efx, RESET_TYPE_DISABLE);
727 rc = efx_test_phy(efx, tests, flags);
731 rc = efx_test_loopbacks(efx, tests, efx->loopback_modes);
735 /* restore the PHY to the previous state */
736 mutex_lock(&efx->mac_lock);
737 efx->phy_mode = phy_mode;
738 efx->port_inhibited = false;
739 efx->loopback_mode = loopback_mode;
740 __efx_reconfigure_port(efx);
741 mutex_unlock(&efx->mac_lock);