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"
31 * Loopback test packet structure
33 * The self-test should stress every RSS vector, and unfortunately
34 * Falcon only performs RSS on TCP/UDP packets.
36 struct efx_loopback_payload {
42 } __attribute__ ((packed));
44 /* Loopback test source MAC address */
45 static const unsigned char payload_source[ETH_ALEN] = {
46 0x00, 0x0f, 0x53, 0x1b, 0x1b, 0x1b,
49 static const char payload_msg[] =
50 "Hello world! This is an Efx loopback test in progress!";
53 * efx_loopback_state - persistent state during a loopback selftest
54 * @flush: Drop all packets in efx_loopback_rx_packet
55 * @packet_count: Number of packets being used in this test
56 * @skbs: An array of skbs transmitted
57 * @offload_csum: Checksums are being offloaded
58 * @rx_good: RX good packet count
59 * @rx_bad: RX bad packet count
60 * @payload: Payload used in tests
62 struct efx_loopback_state {
65 struct sk_buff **skbs;
69 struct efx_loopback_payload payload;
72 /**************************************************************************
74 * MII, NVRAM and register tests
76 **************************************************************************/
78 static int efx_test_phy_alive(struct efx_nic *efx, struct efx_self_tests *tests)
82 if (efx->phy_op->test_alive) {
83 rc = efx->phy_op->test_alive(efx);
84 tests->phy_alive = rc ? -1 : 1;
90 static int efx_test_nvram(struct efx_nic *efx, struct efx_self_tests *tests)
94 if (efx->type->test_nvram) {
95 rc = efx->type->test_nvram(efx);
96 tests->nvram = rc ? -1 : 1;
102 static int efx_test_chip(struct efx_nic *efx, struct efx_self_tests *tests)
106 /* Test register access */
107 if (efx->type->test_registers) {
108 rc = efx->type->test_registers(efx);
109 tests->registers = rc ? -1 : 1;
115 /**************************************************************************
117 * Interrupt and event queue testing
119 **************************************************************************/
121 /* Test generation and receipt of interrupts */
122 static int efx_test_interrupts(struct efx_nic *efx,
123 struct efx_self_tests *tests)
125 struct efx_channel *channel;
127 EFX_LOG(efx, "testing interrupts\n");
128 tests->interrupt = -1;
130 /* Reset interrupt flag */
131 efx->last_irq_cpu = -1;
134 /* ACK each interrupting event queue. Receiving an interrupt due to
135 * traffic before a test event is raised is considered a pass */
136 efx_for_each_channel(channel, efx) {
137 if (channel->work_pending)
138 efx_process_channel_now(channel);
139 if (efx->last_irq_cpu >= 0)
143 efx_nic_generate_interrupt(efx);
145 /* Wait for arrival of test interrupt. */
146 EFX_LOG(efx, "waiting for test interrupt\n");
147 schedule_timeout_uninterruptible(HZ / 10);
148 if (efx->last_irq_cpu >= 0)
151 EFX_ERR(efx, "timed out waiting for interrupt\n");
155 EFX_LOG(efx, "%s test interrupt seen on CPU%d\n", INT_MODE(efx),
157 tests->interrupt = 1;
161 /* Test generation and receipt of interrupting events */
162 static int efx_test_eventq_irq(struct efx_channel *channel,
163 struct efx_self_tests *tests)
165 unsigned int magic, count;
167 /* Channel specific code, limited to 20 bits */
168 magic = (0x00010150 + channel->channel);
169 EFX_LOG(channel->efx, "channel %d testing event queue with code %x\n",
170 channel->channel, magic);
172 tests->eventq_dma[channel->channel] = -1;
173 tests->eventq_int[channel->channel] = -1;
174 tests->eventq_poll[channel->channel] = -1;
176 /* Reset flag and zero magic word */
177 channel->efx->last_irq_cpu = -1;
178 channel->eventq_magic = 0;
181 efx_nic_generate_test_event(channel, magic);
183 /* Wait for arrival of interrupt */
186 schedule_timeout_uninterruptible(HZ / 100);
188 if (channel->work_pending)
189 efx_process_channel_now(channel);
191 if (channel->eventq_magic == magic)
193 } while (++count < 2);
195 EFX_ERR(channel->efx, "channel %d timed out waiting for event queue\n",
198 /* See if interrupt arrived */
199 if (channel->efx->last_irq_cpu >= 0) {
200 EFX_ERR(channel->efx, "channel %d saw interrupt on CPU%d "
201 "during event queue test\n", channel->channel,
202 raw_smp_processor_id());
203 tests->eventq_int[channel->channel] = 1;
206 /* Check to see if event was received even if interrupt wasn't */
207 efx_process_channel_now(channel);
208 if (channel->eventq_magic == magic) {
209 EFX_ERR(channel->efx, "channel %d event was generated, but "
210 "failed to trigger an interrupt\n", channel->channel);
211 tests->eventq_dma[channel->channel] = 1;
216 EFX_LOG(channel->efx, "channel %d event queue passed\n",
218 tests->eventq_dma[channel->channel] = 1;
219 tests->eventq_int[channel->channel] = 1;
220 tests->eventq_poll[channel->channel] = 1;
224 static int efx_test_phy(struct efx_nic *efx, struct efx_self_tests *tests,
229 if (!efx->phy_op->run_tests)
232 mutex_lock(&efx->mac_lock);
233 rc = efx->phy_op->run_tests(efx, tests->phy_ext, flags);
234 mutex_unlock(&efx->mac_lock);
238 /**************************************************************************
241 * NB Only one loopback test can be executing concurrently.
243 **************************************************************************/
245 /* Loopback test RX callback
246 * This is called for each received packet during loopback testing.
248 void efx_loopback_rx_packet(struct efx_nic *efx,
249 const char *buf_ptr, int pkt_len)
251 struct efx_loopback_state *state = efx->loopback_selftest;
252 struct efx_loopback_payload *received;
253 struct efx_loopback_payload *payload;
257 /* If we are just flushing, then drop the packet */
258 if ((state == NULL) || state->flush)
261 payload = &state->payload;
263 received = (struct efx_loopback_payload *) buf_ptr;
264 received->ip.saddr = payload->ip.saddr;
265 if (state->offload_csum)
266 received->ip.check = payload->ip.check;
268 /* Check that header exists */
269 if (pkt_len < sizeof(received->header)) {
270 EFX_ERR(efx, "saw runt RX packet (length %d) in %s loopback "
271 "test\n", pkt_len, LOOPBACK_MODE(efx));
275 /* Check that the ethernet header exists */
276 if (memcmp(&received->header, &payload->header, ETH_HLEN) != 0) {
277 EFX_ERR(efx, "saw non-loopback RX packet in %s loopback test\n",
282 /* Check packet length */
283 if (pkt_len != sizeof(*payload)) {
284 EFX_ERR(efx, "saw incorrect RX packet length %d (wanted %d) in "
285 "%s loopback test\n", pkt_len, (int)sizeof(*payload),
290 /* Check that IP header matches */
291 if (memcmp(&received->ip, &payload->ip, sizeof(payload->ip)) != 0) {
292 EFX_ERR(efx, "saw corrupted IP header in %s loopback test\n",
297 /* Check that msg and padding matches */
298 if (memcmp(&received->msg, &payload->msg, sizeof(received->msg)) != 0) {
299 EFX_ERR(efx, "saw corrupted RX packet in %s loopback test\n",
304 /* Check that iteration matches */
305 if (received->iteration != payload->iteration) {
306 EFX_ERR(efx, "saw RX packet from iteration %d (wanted %d) in "
307 "%s loopback test\n", ntohs(received->iteration),
308 ntohs(payload->iteration), LOOPBACK_MODE(efx));
312 /* Increase correct RX count */
313 EFX_TRACE(efx, "got loopback RX in %s loopback test\n",
316 atomic_inc(&state->rx_good);
320 #ifdef EFX_ENABLE_DEBUG
321 if (atomic_read(&state->rx_bad) == 0) {
322 EFX_ERR(efx, "received packet:\n");
323 print_hex_dump(KERN_ERR, "", DUMP_PREFIX_OFFSET, 0x10, 1,
324 buf_ptr, pkt_len, 0);
325 EFX_ERR(efx, "expected packet:\n");
326 print_hex_dump(KERN_ERR, "", DUMP_PREFIX_OFFSET, 0x10, 1,
327 &state->payload, sizeof(state->payload), 0);
330 atomic_inc(&state->rx_bad);
333 /* Initialise an efx_selftest_state for a new iteration */
334 static void efx_iterate_state(struct efx_nic *efx)
336 struct efx_loopback_state *state = efx->loopback_selftest;
337 struct net_device *net_dev = efx->net_dev;
338 struct efx_loopback_payload *payload = &state->payload;
340 /* Initialise the layerII header */
341 memcpy(&payload->header.h_dest, net_dev->dev_addr, ETH_ALEN);
342 memcpy(&payload->header.h_source, &payload_source, ETH_ALEN);
343 payload->header.h_proto = htons(ETH_P_IP);
345 /* saddr set later and used as incrementing count */
346 payload->ip.daddr = htonl(INADDR_LOOPBACK);
348 payload->ip.check = htons(0xdead);
349 payload->ip.tot_len = htons(sizeof(*payload) - sizeof(struct ethhdr));
350 payload->ip.version = IPVERSION;
351 payload->ip.protocol = IPPROTO_UDP;
353 /* Initialise udp header */
354 payload->udp.source = 0;
355 payload->udp.len = htons(sizeof(*payload) - sizeof(struct ethhdr) -
356 sizeof(struct iphdr));
357 payload->udp.check = 0; /* checksum ignored */
359 /* Fill out payload */
360 payload->iteration = htons(ntohs(payload->iteration) + 1);
361 memcpy(&payload->msg, payload_msg, sizeof(payload_msg));
363 /* Fill out remaining state members */
364 atomic_set(&state->rx_good, 0);
365 atomic_set(&state->rx_bad, 0);
369 static int efx_begin_loopback(struct efx_tx_queue *tx_queue)
371 struct efx_nic *efx = tx_queue->efx;
372 struct efx_loopback_state *state = efx->loopback_selftest;
373 struct efx_loopback_payload *payload;
378 /* Transmit N copies of buffer */
379 for (i = 0; i < state->packet_count; i++) {
380 /* Allocate an skb, holding an extra reference for
381 * transmit completion counting */
382 skb = alloc_skb(sizeof(state->payload), GFP_KERNEL);
385 state->skbs[i] = skb;
388 /* Copy the payload in, incrementing the source address to
389 * exercise the rss vectors */
390 payload = ((struct efx_loopback_payload *)
391 skb_put(skb, sizeof(state->payload)));
392 memcpy(payload, &state->payload, sizeof(state->payload));
393 payload->ip.saddr = htonl(INADDR_LOOPBACK | (i << 2));
395 /* Ensure everything we've written is visible to the
396 * interrupt handler. */
399 if (efx_dev_registered(efx))
400 netif_tx_lock_bh(efx->net_dev);
401 rc = efx_enqueue_skb(tx_queue, skb);
402 if (efx_dev_registered(efx))
403 netif_tx_unlock_bh(efx->net_dev);
405 if (rc != NETDEV_TX_OK) {
406 EFX_ERR(efx, "TX queue %d could not transmit packet %d "
407 "of %d in %s loopback test\n", tx_queue->queue,
408 i + 1, state->packet_count, LOOPBACK_MODE(efx));
410 /* Defer cleaning up the other skbs for the caller */
419 static int efx_poll_loopback(struct efx_nic *efx)
421 struct efx_loopback_state *state = efx->loopback_selftest;
422 struct efx_channel *channel;
424 /* NAPI polling is not enabled, so process channels
426 efx_for_each_channel(channel, efx) {
427 if (channel->work_pending)
428 efx_process_channel_now(channel);
430 return atomic_read(&state->rx_good) == state->packet_count;
433 static int efx_end_loopback(struct efx_tx_queue *tx_queue,
434 struct efx_loopback_self_tests *lb_tests)
436 struct efx_nic *efx = tx_queue->efx;
437 struct efx_loopback_state *state = efx->loopback_selftest;
439 int tx_done = 0, rx_good, rx_bad;
442 if (efx_dev_registered(efx))
443 netif_tx_lock_bh(efx->net_dev);
445 /* Count the number of tx completions, and decrement the refcnt. Any
446 * skbs not already completed will be free'd when the queue is flushed */
447 for (i=0; i < state->packet_count; i++) {
448 skb = state->skbs[i];
449 if (skb && !skb_shared(skb))
451 dev_kfree_skb_any(skb);
454 if (efx_dev_registered(efx))
455 netif_tx_unlock_bh(efx->net_dev);
457 /* Check TX completion and received packet counts */
458 rx_good = atomic_read(&state->rx_good);
459 rx_bad = atomic_read(&state->rx_bad);
460 if (tx_done != state->packet_count) {
461 /* Don't free the skbs; they will be picked up on TX
462 * overflow or channel teardown.
464 EFX_ERR(efx, "TX queue %d saw only %d out of an expected %d "
465 "TX completion events in %s loopback test\n",
466 tx_queue->queue, tx_done, state->packet_count,
469 /* Allow to fall through so we see the RX errors as well */
472 /* We may always be up to a flush away from our desired packet total */
473 if (rx_good != state->packet_count) {
474 EFX_LOG(efx, "TX queue %d saw only %d out of an expected %d "
475 "received packets in %s loopback test\n",
476 tx_queue->queue, rx_good, state->packet_count,
482 /* Update loopback test structure */
483 lb_tests->tx_sent[tx_queue->queue] += state->packet_count;
484 lb_tests->tx_done[tx_queue->queue] += tx_done;
485 lb_tests->rx_good += rx_good;
486 lb_tests->rx_bad += rx_bad;
492 efx_test_loopback(struct efx_tx_queue *tx_queue,
493 struct efx_loopback_self_tests *lb_tests)
495 struct efx_nic *efx = tx_queue->efx;
496 struct efx_loopback_state *state = efx->loopback_selftest;
497 int i, begin_rc, end_rc;
499 for (i = 0; i < 3; i++) {
500 /* Determine how many packets to send */
501 state->packet_count = EFX_TXQ_SIZE / 3;
502 state->packet_count = min(1 << (i << 2), state->packet_count);
503 state->skbs = kzalloc(sizeof(state->skbs[0]) *
504 state->packet_count, GFP_KERNEL);
507 state->flush = false;
509 EFX_LOG(efx, "TX queue %d testing %s loopback with %d "
510 "packets\n", tx_queue->queue, LOOPBACK_MODE(efx),
511 state->packet_count);
513 efx_iterate_state(efx);
514 begin_rc = efx_begin_loopback(tx_queue);
516 /* This will normally complete very quickly, but be
517 * prepared to wait up to 100 ms. */
519 if (!efx_poll_loopback(efx)) {
521 efx_poll_loopback(efx);
524 end_rc = efx_end_loopback(tx_queue, lb_tests);
527 if (begin_rc || end_rc) {
528 /* Wait a while to ensure there are no packets
529 * floating around after a failure. */
530 schedule_timeout_uninterruptible(HZ / 10);
531 return begin_rc ? begin_rc : end_rc;
535 EFX_LOG(efx, "TX queue %d passed %s loopback test with a burst length "
536 "of %d packets\n", tx_queue->queue, LOOPBACK_MODE(efx),
537 state->packet_count);
542 /* Wait for link up. On Falcon, we would prefer to rely on efx_monitor, but
543 * any contention on the mac lock (via e.g. efx_mac_mcast_work) causes it
544 * to delay and retry. Therefore, it's safer to just poll directly. Wait
545 * for link up and any faults to dissipate. */
546 static int efx_wait_for_link(struct efx_nic *efx)
548 struct efx_link_state *link_state = &efx->link_state;
552 for (count = 0; count < 40; count++) {
553 schedule_timeout_uninterruptible(HZ / 10);
555 if (efx->type->monitor != NULL) {
556 mutex_lock(&efx->mac_lock);
557 efx->type->monitor(efx);
558 mutex_unlock(&efx->mac_lock);
560 struct efx_channel *channel = &efx->channel[0];
561 if (channel->work_pending)
562 efx_process_channel_now(channel);
565 mutex_lock(&efx->mac_lock);
566 link_up = link_state->up;
568 link_up = !efx->mac_op->check_fault(efx);
569 mutex_unlock(&efx->mac_lock);
578 static int efx_test_loopbacks(struct efx_nic *efx, struct efx_self_tests *tests,
579 unsigned int loopback_modes)
581 enum efx_loopback_mode mode;
582 struct efx_loopback_state *state;
583 struct efx_tx_queue *tx_queue;
586 /* Set the port loopback_selftest member. From this point on
587 * all received packets will be dropped. Mark the state as
588 * "flushing" so all inflight packets are dropped */
589 state = kzalloc(sizeof(*state), GFP_KERNEL);
592 BUG_ON(efx->loopback_selftest);
594 efx->loopback_selftest = state;
596 /* Test all supported loopback modes */
597 for (mode = LOOPBACK_NONE; mode <= LOOPBACK_TEST_MAX; mode++) {
598 if (!(loopback_modes & (1 << mode)))
601 /* Move the port into the specified loopback mode. */
603 mutex_lock(&efx->mac_lock);
604 efx->loopback_mode = mode;
605 rc = __efx_reconfigure_port(efx);
606 mutex_unlock(&efx->mac_lock);
608 EFX_ERR(efx, "unable to move into %s loopback\n",
613 rc = efx_wait_for_link(efx);
615 EFX_ERR(efx, "loopback %s never came up\n",
620 /* Test every TX queue */
621 efx_for_each_tx_queue(tx_queue, efx) {
622 state->offload_csum = (tx_queue->queue ==
623 EFX_TX_QUEUE_OFFLOAD_CSUM);
624 rc = efx_test_loopback(tx_queue,
625 &tests->loopback[mode]);
632 /* Remove the flush. The caller will remove the loopback setting */
634 efx->loopback_selftest = NULL;
641 /**************************************************************************
645 *************************************************************************/
647 int efx_selftest(struct efx_nic *efx, struct efx_self_tests *tests,
650 enum efx_loopback_mode loopback_mode = efx->loopback_mode;
651 int phy_mode = efx->phy_mode;
652 enum reset_type reset_method = RESET_TYPE_INVISIBLE;
653 struct efx_channel *channel;
654 int rc_test = 0, rc_reset = 0, rc;
656 /* Online (i.e. non-disruptive) testing
657 * This checks interrupt generation, event delivery and PHY presence. */
659 rc = efx_test_phy_alive(efx, tests);
663 rc = efx_test_nvram(efx, tests);
667 rc = efx_test_interrupts(efx, tests);
671 efx_for_each_channel(channel, efx) {
672 rc = efx_test_eventq_irq(channel, tests);
680 if (!(flags & ETH_TEST_FL_OFFLINE))
681 return efx_test_phy(efx, tests, flags);
683 /* Offline (i.e. disruptive) testing
684 * This checks MAC and PHY loopback on the specified port. */
686 /* force the carrier state off so the kernel doesn't transmit during
687 * the loopback test, and the watchdog timeout doesn't fire. Also put
688 * falcon into loopback for the register test.
690 mutex_lock(&efx->mac_lock);
691 efx->port_inhibited = true;
692 if (efx->loopback_modes) {
693 /* We need the 312 clock from the PHY to test the XMAC
694 * registers, so move into XGMII loopback if available */
695 if (efx->loopback_modes & (1 << LOOPBACK_XGMII))
696 efx->loopback_mode = LOOPBACK_XGMII;
698 efx->loopback_mode = __ffs(efx->loopback_modes);
701 __efx_reconfigure_port(efx);
702 mutex_unlock(&efx->mac_lock);
704 /* free up all consumers of SRAM (including all the queues) */
705 efx_reset_down(efx, reset_method);
707 rc = efx_test_chip(efx, tests);
711 /* reset the chip to recover from the register test */
712 rc_reset = efx->type->reset(efx, reset_method);
714 /* Ensure that the phy is powered and out of loopback
715 * for the bist and loopback tests */
716 efx->phy_mode &= ~PHY_MODE_LOW_POWER;
717 efx->loopback_mode = LOOPBACK_NONE;
719 rc = efx_reset_up(efx, reset_method, rc_reset == 0);
724 EFX_ERR(efx, "Unable to recover from chip test\n");
725 efx_schedule_reset(efx, RESET_TYPE_DISABLE);
729 rc = efx_test_phy(efx, tests, flags);
733 rc = efx_test_loopbacks(efx, tests, efx->loopback_modes);
737 /* restore the PHY to the previous state */
738 mutex_lock(&efx->mac_lock);
739 efx->phy_mode = phy_mode;
740 efx->port_inhibited = false;
741 efx->loopback_mode = loopback_mode;
742 __efx_reconfigure_port(efx);
743 mutex_unlock(&efx->mac_lock);