Merge tag 'for-linus-20190706' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / drivers / net / ethernet / qualcomm / qca_spi.c
blobb28360bc2255e85bc5bdfb45b1313268f1f5e833
1 /*
2 * Copyright (c) 2011, 2012, Qualcomm Atheros Communications Inc.
3 * Copyright (c) 2014, I2SE GmbH
5 * Permission to use, copy, modify, and/or distribute this software
6 * for any purpose with or without fee is hereby granted, provided
7 * that the above copyright notice and this permission notice appear
8 * in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
13 * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
14 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
16 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
17 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 /* This module implements the Qualcomm Atheros SPI protocol for
21 * kernel-based SPI device; it is essentially an Ethernet-to-SPI
22 * serial converter;
25 #include <linux/errno.h>
26 #include <linux/etherdevice.h>
27 #include <linux/if_arp.h>
28 #include <linux/if_ether.h>
29 #include <linux/init.h>
30 #include <linux/interrupt.h>
31 #include <linux/jiffies.h>
32 #include <linux/kernel.h>
33 #include <linux/kthread.h>
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/netdevice.h>
37 #include <linux/of.h>
38 #include <linux/of_device.h>
39 #include <linux/of_net.h>
40 #include <linux/sched.h>
41 #include <linux/skbuff.h>
42 #include <linux/spi/spi.h>
43 #include <linux/types.h>
45 #include "qca_7k.h"
46 #include "qca_7k_common.h"
47 #include "qca_debug.h"
48 #include "qca_spi.h"
50 #define MAX_DMA_BURST_LEN 5000
52 /* Modules parameters */
53 #define QCASPI_CLK_SPEED_MIN 1000000
54 #define QCASPI_CLK_SPEED_MAX 16000000
55 #define QCASPI_CLK_SPEED 8000000
56 static int qcaspi_clkspeed;
57 module_param(qcaspi_clkspeed, int, 0);
58 MODULE_PARM_DESC(qcaspi_clkspeed, "SPI bus clock speed (Hz). Use 1000000-16000000.");
60 #define QCASPI_BURST_LEN_MIN 1
61 #define QCASPI_BURST_LEN_MAX MAX_DMA_BURST_LEN
62 static int qcaspi_burst_len = MAX_DMA_BURST_LEN;
63 module_param(qcaspi_burst_len, int, 0);
64 MODULE_PARM_DESC(qcaspi_burst_len, "Number of data bytes per burst. Use 1-5000.");
66 #define QCASPI_PLUGGABLE_MIN 0
67 #define QCASPI_PLUGGABLE_MAX 1
68 static int qcaspi_pluggable = QCASPI_PLUGGABLE_MIN;
69 module_param(qcaspi_pluggable, int, 0);
70 MODULE_PARM_DESC(qcaspi_pluggable, "Pluggable SPI connection (yes/no).");
72 #define QCASPI_WRITE_VERIFY_MIN 0
73 #define QCASPI_WRITE_VERIFY_MAX 3
74 static int wr_verify = QCASPI_WRITE_VERIFY_MIN;
75 module_param(wr_verify, int, 0);
76 MODULE_PARM_DESC(wr_verify, "SPI register write verify trails. Use 0-3.");
78 #define QCASPI_TX_TIMEOUT (1 * HZ)
79 #define QCASPI_QCA7K_REBOOT_TIME_MS 1000
81 static void
82 start_spi_intr_handling(struct qcaspi *qca, u16 *intr_cause)
84 *intr_cause = 0;
86 qcaspi_write_register(qca, SPI_REG_INTR_ENABLE, 0, wr_verify);
87 qcaspi_read_register(qca, SPI_REG_INTR_CAUSE, intr_cause);
88 netdev_dbg(qca->net_dev, "interrupts: 0x%04x\n", *intr_cause);
91 static void
92 end_spi_intr_handling(struct qcaspi *qca, u16 intr_cause)
94 u16 intr_enable = (SPI_INT_CPU_ON |
95 SPI_INT_PKT_AVLBL |
96 SPI_INT_RDBUF_ERR |
97 SPI_INT_WRBUF_ERR);
99 qcaspi_write_register(qca, SPI_REG_INTR_CAUSE, intr_cause, 0);
100 qcaspi_write_register(qca, SPI_REG_INTR_ENABLE, intr_enable, wr_verify);
101 netdev_dbg(qca->net_dev, "acking int: 0x%04x\n", intr_cause);
104 static u32
105 qcaspi_write_burst(struct qcaspi *qca, u8 *src, u32 len)
107 __be16 cmd;
108 struct spi_message msg;
109 struct spi_transfer transfer[2];
110 int ret;
112 memset(&transfer, 0, sizeof(transfer));
113 spi_message_init(&msg);
115 cmd = cpu_to_be16(QCA7K_SPI_WRITE | QCA7K_SPI_EXTERNAL);
116 transfer[0].tx_buf = &cmd;
117 transfer[0].len = QCASPI_CMD_LEN;
118 transfer[1].tx_buf = src;
119 transfer[1].len = len;
121 spi_message_add_tail(&transfer[0], &msg);
122 spi_message_add_tail(&transfer[1], &msg);
123 ret = spi_sync(qca->spi_dev, &msg);
125 if (ret || (msg.actual_length != QCASPI_CMD_LEN + len)) {
126 qcaspi_spi_error(qca);
127 return 0;
130 return len;
133 static u32
134 qcaspi_write_legacy(struct qcaspi *qca, u8 *src, u32 len)
136 struct spi_message msg;
137 struct spi_transfer transfer;
138 int ret;
140 memset(&transfer, 0, sizeof(transfer));
141 spi_message_init(&msg);
143 transfer.tx_buf = src;
144 transfer.len = len;
146 spi_message_add_tail(&transfer, &msg);
147 ret = spi_sync(qca->spi_dev, &msg);
149 if (ret || (msg.actual_length != len)) {
150 qcaspi_spi_error(qca);
151 return 0;
154 return len;
157 static u32
158 qcaspi_read_burst(struct qcaspi *qca, u8 *dst, u32 len)
160 struct spi_message msg;
161 __be16 cmd;
162 struct spi_transfer transfer[2];
163 int ret;
165 memset(&transfer, 0, sizeof(transfer));
166 spi_message_init(&msg);
168 cmd = cpu_to_be16(QCA7K_SPI_READ | QCA7K_SPI_EXTERNAL);
169 transfer[0].tx_buf = &cmd;
170 transfer[0].len = QCASPI_CMD_LEN;
171 transfer[1].rx_buf = dst;
172 transfer[1].len = len;
174 spi_message_add_tail(&transfer[0], &msg);
175 spi_message_add_tail(&transfer[1], &msg);
176 ret = spi_sync(qca->spi_dev, &msg);
178 if (ret || (msg.actual_length != QCASPI_CMD_LEN + len)) {
179 qcaspi_spi_error(qca);
180 return 0;
183 return len;
186 static u32
187 qcaspi_read_legacy(struct qcaspi *qca, u8 *dst, u32 len)
189 struct spi_message msg;
190 struct spi_transfer transfer;
191 int ret;
193 memset(&transfer, 0, sizeof(transfer));
194 spi_message_init(&msg);
196 transfer.rx_buf = dst;
197 transfer.len = len;
199 spi_message_add_tail(&transfer, &msg);
200 ret = spi_sync(qca->spi_dev, &msg);
202 if (ret || (msg.actual_length != len)) {
203 qcaspi_spi_error(qca);
204 return 0;
207 return len;
210 static int
211 qcaspi_tx_cmd(struct qcaspi *qca, u16 cmd)
213 __be16 tx_data;
214 struct spi_message msg;
215 struct spi_transfer transfer;
216 int ret;
218 memset(&transfer, 0, sizeof(transfer));
220 spi_message_init(&msg);
222 tx_data = cpu_to_be16(cmd);
223 transfer.len = sizeof(cmd);
224 transfer.tx_buf = &tx_data;
225 spi_message_add_tail(&transfer, &msg);
227 ret = spi_sync(qca->spi_dev, &msg);
229 if (!ret)
230 ret = msg.status;
232 if (ret)
233 qcaspi_spi_error(qca);
235 return ret;
238 static int
239 qcaspi_tx_frame(struct qcaspi *qca, struct sk_buff *skb)
241 u32 count;
242 u32 written;
243 u32 offset;
244 u32 len;
246 len = skb->len;
248 qcaspi_write_register(qca, SPI_REG_BFR_SIZE, len, wr_verify);
249 if (qca->legacy_mode)
250 qcaspi_tx_cmd(qca, QCA7K_SPI_WRITE | QCA7K_SPI_EXTERNAL);
252 offset = 0;
253 while (len) {
254 count = len;
255 if (count > qca->burst_len)
256 count = qca->burst_len;
258 if (qca->legacy_mode) {
259 written = qcaspi_write_legacy(qca,
260 skb->data + offset,
261 count);
262 } else {
263 written = qcaspi_write_burst(qca,
264 skb->data + offset,
265 count);
268 if (written != count)
269 return -1;
271 offset += count;
272 len -= count;
275 return 0;
278 static int
279 qcaspi_transmit(struct qcaspi *qca)
281 struct net_device_stats *n_stats = &qca->net_dev->stats;
282 u16 available = 0;
283 u32 pkt_len;
284 u16 new_head;
285 u16 packets = 0;
287 if (qca->txr.skb[qca->txr.head] == NULL)
288 return 0;
290 qcaspi_read_register(qca, SPI_REG_WRBUF_SPC_AVA, &available);
292 if (available > QCASPI_HW_BUF_LEN) {
293 /* This could only happen by interferences on the SPI line.
294 * So retry later ...
296 qca->stats.buf_avail_err++;
297 return -1;
300 while (qca->txr.skb[qca->txr.head]) {
301 pkt_len = qca->txr.skb[qca->txr.head]->len + QCASPI_HW_PKT_LEN;
303 if (available < pkt_len) {
304 if (packets == 0)
305 qca->stats.write_buf_miss++;
306 break;
309 if (qcaspi_tx_frame(qca, qca->txr.skb[qca->txr.head]) == -1) {
310 qca->stats.write_err++;
311 return -1;
314 packets++;
315 n_stats->tx_packets++;
316 n_stats->tx_bytes += qca->txr.skb[qca->txr.head]->len;
317 available -= pkt_len;
319 /* remove the skb from the queue */
320 /* XXX After inconsistent lock states netif_tx_lock()
321 * has been replaced by netif_tx_lock_bh() and so on.
323 netif_tx_lock_bh(qca->net_dev);
324 dev_kfree_skb(qca->txr.skb[qca->txr.head]);
325 qca->txr.skb[qca->txr.head] = NULL;
326 qca->txr.size -= pkt_len;
327 new_head = qca->txr.head + 1;
328 if (new_head >= qca->txr.count)
329 new_head = 0;
330 qca->txr.head = new_head;
331 if (netif_queue_stopped(qca->net_dev))
332 netif_wake_queue(qca->net_dev);
333 netif_tx_unlock_bh(qca->net_dev);
336 return 0;
339 static int
340 qcaspi_receive(struct qcaspi *qca)
342 struct net_device *net_dev = qca->net_dev;
343 struct net_device_stats *n_stats = &net_dev->stats;
344 u16 available = 0;
345 u32 bytes_read;
346 u8 *cp;
348 /* Allocate rx SKB if we don't have one available. */
349 if (!qca->rx_skb) {
350 qca->rx_skb = netdev_alloc_skb_ip_align(net_dev,
351 net_dev->mtu +
352 VLAN_ETH_HLEN);
353 if (!qca->rx_skb) {
354 netdev_dbg(net_dev, "out of RX resources\n");
355 qca->stats.out_of_mem++;
356 return -1;
360 /* Read the packet size. */
361 qcaspi_read_register(qca, SPI_REG_RDBUF_BYTE_AVA, &available);
363 netdev_dbg(net_dev, "qcaspi_receive: SPI_REG_RDBUF_BYTE_AVA: Value: %08x\n",
364 available);
366 if (available > QCASPI_HW_BUF_LEN) {
367 /* This could only happen by interferences on the SPI line.
368 * So retry later ...
370 qca->stats.buf_avail_err++;
371 return -1;
372 } else if (available == 0) {
373 netdev_dbg(net_dev, "qcaspi_receive called without any data being available!\n");
374 return -1;
377 qcaspi_write_register(qca, SPI_REG_BFR_SIZE, available, wr_verify);
379 if (qca->legacy_mode)
380 qcaspi_tx_cmd(qca, QCA7K_SPI_READ | QCA7K_SPI_EXTERNAL);
382 while (available) {
383 u32 count = available;
385 if (count > qca->burst_len)
386 count = qca->burst_len;
388 if (qca->legacy_mode) {
389 bytes_read = qcaspi_read_legacy(qca, qca->rx_buffer,
390 count);
391 } else {
392 bytes_read = qcaspi_read_burst(qca, qca->rx_buffer,
393 count);
396 netdev_dbg(net_dev, "available: %d, byte read: %d\n",
397 available, bytes_read);
399 if (bytes_read) {
400 available -= bytes_read;
401 } else {
402 qca->stats.read_err++;
403 return -1;
406 cp = qca->rx_buffer;
408 while ((bytes_read--) && (qca->rx_skb)) {
409 s32 retcode;
411 retcode = qcafrm_fsm_decode(&qca->frm_handle,
412 qca->rx_skb->data,
413 skb_tailroom(qca->rx_skb),
414 *cp);
415 cp++;
416 switch (retcode) {
417 case QCAFRM_GATHER:
418 case QCAFRM_NOHEAD:
419 break;
420 case QCAFRM_NOTAIL:
421 netdev_dbg(net_dev, "no RX tail\n");
422 n_stats->rx_errors++;
423 n_stats->rx_dropped++;
424 break;
425 case QCAFRM_INVLEN:
426 netdev_dbg(net_dev, "invalid RX length\n");
427 n_stats->rx_errors++;
428 n_stats->rx_dropped++;
429 break;
430 default:
431 qca->rx_skb->dev = qca->net_dev;
432 n_stats->rx_packets++;
433 n_stats->rx_bytes += retcode;
434 skb_put(qca->rx_skb, retcode);
435 qca->rx_skb->protocol = eth_type_trans(
436 qca->rx_skb, qca->rx_skb->dev);
437 qca->rx_skb->ip_summed = CHECKSUM_UNNECESSARY;
438 netif_rx_ni(qca->rx_skb);
439 qca->rx_skb = netdev_alloc_skb_ip_align(net_dev,
440 net_dev->mtu + VLAN_ETH_HLEN);
441 if (!qca->rx_skb) {
442 netdev_dbg(net_dev, "out of RX resources\n");
443 n_stats->rx_errors++;
444 qca->stats.out_of_mem++;
445 break;
451 return 0;
454 /* Check that tx ring stores only so much bytes
455 * that fit into the internal QCA buffer.
458 static int
459 qcaspi_tx_ring_has_space(struct tx_ring *txr)
461 if (txr->skb[txr->tail])
462 return 0;
464 return (txr->size + QCAFRM_MAX_LEN < QCASPI_HW_BUF_LEN) ? 1 : 0;
467 /* Flush the tx ring. This function is only safe to
468 * call from the qcaspi_spi_thread.
471 static void
472 qcaspi_flush_tx_ring(struct qcaspi *qca)
474 int i;
476 /* XXX After inconsistent lock states netif_tx_lock()
477 * has been replaced by netif_tx_lock_bh() and so on.
479 netif_tx_lock_bh(qca->net_dev);
480 for (i = 0; i < TX_RING_MAX_LEN; i++) {
481 if (qca->txr.skb[i]) {
482 dev_kfree_skb(qca->txr.skb[i]);
483 qca->txr.skb[i] = NULL;
484 qca->net_dev->stats.tx_dropped++;
487 qca->txr.tail = 0;
488 qca->txr.head = 0;
489 qca->txr.size = 0;
490 netif_tx_unlock_bh(qca->net_dev);
493 static void
494 qcaspi_qca7k_sync(struct qcaspi *qca, int event)
496 u16 signature = 0;
497 u16 spi_config;
498 u16 wrbuf_space = 0;
499 static u16 reset_count;
501 if (event == QCASPI_EVENT_CPUON) {
502 /* Read signature twice, if not valid
503 * go back to unknown state.
505 qcaspi_read_register(qca, SPI_REG_SIGNATURE, &signature);
506 qcaspi_read_register(qca, SPI_REG_SIGNATURE, &signature);
507 if (signature != QCASPI_GOOD_SIGNATURE) {
508 qca->sync = QCASPI_SYNC_UNKNOWN;
509 netdev_dbg(qca->net_dev, "sync: got CPU on, but signature was invalid, restart\n");
510 } else {
511 /* ensure that the WRBUF is empty */
512 qcaspi_read_register(qca, SPI_REG_WRBUF_SPC_AVA,
513 &wrbuf_space);
514 if (wrbuf_space != QCASPI_HW_BUF_LEN) {
515 netdev_dbg(qca->net_dev, "sync: got CPU on, but wrbuf not empty. reset!\n");
516 qca->sync = QCASPI_SYNC_UNKNOWN;
517 } else {
518 netdev_dbg(qca->net_dev, "sync: got CPU on, now in sync\n");
519 qca->sync = QCASPI_SYNC_READY;
520 return;
525 switch (qca->sync) {
526 case QCASPI_SYNC_READY:
527 /* Read signature, if not valid go to unknown state. */
528 qcaspi_read_register(qca, SPI_REG_SIGNATURE, &signature);
529 if (signature != QCASPI_GOOD_SIGNATURE) {
530 qca->sync = QCASPI_SYNC_UNKNOWN;
531 netdev_dbg(qca->net_dev, "sync: bad signature, restart\n");
532 /* don't reset right away */
533 return;
535 break;
536 case QCASPI_SYNC_UNKNOWN:
537 /* Read signature, if not valid stay in unknown state */
538 qcaspi_read_register(qca, SPI_REG_SIGNATURE, &signature);
539 if (signature != QCASPI_GOOD_SIGNATURE) {
540 netdev_dbg(qca->net_dev, "sync: could not read signature to reset device, retry.\n");
541 return;
544 /* TODO: use GPIO to reset QCA7000 in legacy mode*/
545 netdev_dbg(qca->net_dev, "sync: resetting device.\n");
546 qcaspi_read_register(qca, SPI_REG_SPI_CONFIG, &spi_config);
547 spi_config |= QCASPI_SLAVE_RESET_BIT;
548 qcaspi_write_register(qca, SPI_REG_SPI_CONFIG, spi_config, 0);
550 qca->sync = QCASPI_SYNC_RESET;
551 qca->stats.trig_reset++;
552 reset_count = 0;
553 break;
554 case QCASPI_SYNC_RESET:
555 reset_count++;
556 netdev_dbg(qca->net_dev, "sync: waiting for CPU on, count %u.\n",
557 reset_count);
558 if (reset_count >= QCASPI_RESET_TIMEOUT) {
559 /* reset did not seem to take place, try again */
560 qca->sync = QCASPI_SYNC_UNKNOWN;
561 qca->stats.reset_timeout++;
562 netdev_dbg(qca->net_dev, "sync: reset timeout, restarting process.\n");
564 break;
568 static int
569 qcaspi_spi_thread(void *data)
571 struct qcaspi *qca = data;
572 u16 intr_cause = 0;
574 netdev_info(qca->net_dev, "SPI thread created\n");
575 while (!kthread_should_stop()) {
576 set_current_state(TASK_INTERRUPTIBLE);
577 if ((qca->intr_req == qca->intr_svc) &&
578 (qca->txr.skb[qca->txr.head] == NULL) &&
579 (qca->sync == QCASPI_SYNC_READY))
580 schedule();
582 set_current_state(TASK_RUNNING);
584 netdev_dbg(qca->net_dev, "have work to do. int: %d, tx_skb: %p\n",
585 qca->intr_req - qca->intr_svc,
586 qca->txr.skb[qca->txr.head]);
588 qcaspi_qca7k_sync(qca, QCASPI_EVENT_UPDATE);
590 if (qca->sync != QCASPI_SYNC_READY) {
591 netdev_dbg(qca->net_dev, "sync: not ready %u, turn off carrier and flush\n",
592 (unsigned int)qca->sync);
593 netif_stop_queue(qca->net_dev);
594 netif_carrier_off(qca->net_dev);
595 qcaspi_flush_tx_ring(qca);
596 msleep(QCASPI_QCA7K_REBOOT_TIME_MS);
599 if (qca->intr_svc != qca->intr_req) {
600 qca->intr_svc = qca->intr_req;
601 start_spi_intr_handling(qca, &intr_cause);
603 if (intr_cause & SPI_INT_CPU_ON) {
604 qcaspi_qca7k_sync(qca, QCASPI_EVENT_CPUON);
606 /* not synced. */
607 if (qca->sync != QCASPI_SYNC_READY)
608 continue;
610 qca->stats.device_reset++;
611 netif_wake_queue(qca->net_dev);
612 netif_carrier_on(qca->net_dev);
615 if (intr_cause & SPI_INT_RDBUF_ERR) {
616 /* restart sync */
617 netdev_dbg(qca->net_dev, "===> rdbuf error!\n");
618 qca->stats.read_buf_err++;
619 qca->sync = QCASPI_SYNC_UNKNOWN;
620 continue;
623 if (intr_cause & SPI_INT_WRBUF_ERR) {
624 /* restart sync */
625 netdev_dbg(qca->net_dev, "===> wrbuf error!\n");
626 qca->stats.write_buf_err++;
627 qca->sync = QCASPI_SYNC_UNKNOWN;
628 continue;
631 /* can only handle other interrupts
632 * if sync has occurred
634 if (qca->sync == QCASPI_SYNC_READY) {
635 if (intr_cause & SPI_INT_PKT_AVLBL)
636 qcaspi_receive(qca);
639 end_spi_intr_handling(qca, intr_cause);
642 if (qca->sync == QCASPI_SYNC_READY)
643 qcaspi_transmit(qca);
645 set_current_state(TASK_RUNNING);
646 netdev_info(qca->net_dev, "SPI thread exit\n");
648 return 0;
651 static irqreturn_t
652 qcaspi_intr_handler(int irq, void *data)
654 struct qcaspi *qca = data;
656 qca->intr_req++;
657 if (qca->spi_thread &&
658 qca->spi_thread->state != TASK_RUNNING)
659 wake_up_process(qca->spi_thread);
661 return IRQ_HANDLED;
664 static int
665 qcaspi_netdev_open(struct net_device *dev)
667 struct qcaspi *qca = netdev_priv(dev);
668 int ret = 0;
670 if (!qca)
671 return -EINVAL;
673 qca->intr_req = 1;
674 qca->intr_svc = 0;
675 qca->sync = QCASPI_SYNC_UNKNOWN;
676 qcafrm_fsm_init_spi(&qca->frm_handle);
678 qca->spi_thread = kthread_run((void *)qcaspi_spi_thread,
679 qca, "%s", dev->name);
681 if (IS_ERR(qca->spi_thread)) {
682 netdev_err(dev, "%s: unable to start kernel thread.\n",
683 QCASPI_DRV_NAME);
684 return PTR_ERR(qca->spi_thread);
687 ret = request_irq(qca->spi_dev->irq, qcaspi_intr_handler, 0,
688 dev->name, qca);
689 if (ret) {
690 netdev_err(dev, "%s: unable to get IRQ %d (irqval=%d).\n",
691 QCASPI_DRV_NAME, qca->spi_dev->irq, ret);
692 kthread_stop(qca->spi_thread);
693 return ret;
696 /* SPI thread takes care of TX queue */
698 return 0;
701 static int
702 qcaspi_netdev_close(struct net_device *dev)
704 struct qcaspi *qca = netdev_priv(dev);
706 netif_stop_queue(dev);
708 qcaspi_write_register(qca, SPI_REG_INTR_ENABLE, 0, wr_verify);
709 free_irq(qca->spi_dev->irq, qca);
711 kthread_stop(qca->spi_thread);
712 qca->spi_thread = NULL;
713 qcaspi_flush_tx_ring(qca);
715 return 0;
718 static netdev_tx_t
719 qcaspi_netdev_xmit(struct sk_buff *skb, struct net_device *dev)
721 u32 frame_len;
722 u8 *ptmp;
723 struct qcaspi *qca = netdev_priv(dev);
724 u16 new_tail;
725 struct sk_buff *tskb;
726 u8 pad_len = 0;
728 if (skb->len < QCAFRM_MIN_LEN)
729 pad_len = QCAFRM_MIN_LEN - skb->len;
731 if (qca->txr.skb[qca->txr.tail]) {
732 netdev_warn(qca->net_dev, "queue was unexpectedly full!\n");
733 netif_stop_queue(qca->net_dev);
734 qca->stats.ring_full++;
735 return NETDEV_TX_BUSY;
738 if ((skb_headroom(skb) < QCAFRM_HEADER_LEN) ||
739 (skb_tailroom(skb) < QCAFRM_FOOTER_LEN + pad_len)) {
740 tskb = skb_copy_expand(skb, QCAFRM_HEADER_LEN,
741 QCAFRM_FOOTER_LEN + pad_len, GFP_ATOMIC);
742 if (!tskb) {
743 qca->stats.out_of_mem++;
744 return NETDEV_TX_BUSY;
746 dev_kfree_skb(skb);
747 skb = tskb;
750 frame_len = skb->len + pad_len;
752 ptmp = skb_push(skb, QCAFRM_HEADER_LEN);
753 qcafrm_create_header(ptmp, frame_len);
755 if (pad_len) {
756 ptmp = skb_put_zero(skb, pad_len);
759 ptmp = skb_put(skb, QCAFRM_FOOTER_LEN);
760 qcafrm_create_footer(ptmp);
762 netdev_dbg(qca->net_dev, "Tx-ing packet: Size: 0x%08x\n",
763 skb->len);
765 qca->txr.size += skb->len + QCASPI_HW_PKT_LEN;
767 new_tail = qca->txr.tail + 1;
768 if (new_tail >= qca->txr.count)
769 new_tail = 0;
771 qca->txr.skb[qca->txr.tail] = skb;
772 qca->txr.tail = new_tail;
774 if (!qcaspi_tx_ring_has_space(&qca->txr)) {
775 netif_stop_queue(qca->net_dev);
776 qca->stats.ring_full++;
779 netif_trans_update(dev);
781 if (qca->spi_thread &&
782 qca->spi_thread->state != TASK_RUNNING)
783 wake_up_process(qca->spi_thread);
785 return NETDEV_TX_OK;
788 static void
789 qcaspi_netdev_tx_timeout(struct net_device *dev)
791 struct qcaspi *qca = netdev_priv(dev);
793 netdev_info(qca->net_dev, "Transmit timeout at %ld, latency %ld\n",
794 jiffies, jiffies - dev_trans_start(dev));
795 qca->net_dev->stats.tx_errors++;
796 /* Trigger tx queue flush and QCA7000 reset */
797 qca->sync = QCASPI_SYNC_UNKNOWN;
799 if (qca->spi_thread)
800 wake_up_process(qca->spi_thread);
803 static int
804 qcaspi_netdev_init(struct net_device *dev)
806 struct qcaspi *qca = netdev_priv(dev);
808 dev->mtu = QCAFRM_MAX_MTU;
809 dev->type = ARPHRD_ETHER;
810 qca->clkspeed = qcaspi_clkspeed;
811 qca->burst_len = qcaspi_burst_len;
812 qca->spi_thread = NULL;
813 qca->buffer_size = (dev->mtu + VLAN_ETH_HLEN + QCAFRM_HEADER_LEN +
814 QCAFRM_FOOTER_LEN + 4) * 4;
816 memset(&qca->stats, 0, sizeof(struct qcaspi_stats));
818 qca->rx_buffer = kmalloc(qca->buffer_size, GFP_KERNEL);
819 if (!qca->rx_buffer)
820 return -ENOBUFS;
822 qca->rx_skb = netdev_alloc_skb_ip_align(dev, qca->net_dev->mtu +
823 VLAN_ETH_HLEN);
824 if (!qca->rx_skb) {
825 kfree(qca->rx_buffer);
826 netdev_info(qca->net_dev, "Failed to allocate RX sk_buff.\n");
827 return -ENOBUFS;
830 return 0;
833 static void
834 qcaspi_netdev_uninit(struct net_device *dev)
836 struct qcaspi *qca = netdev_priv(dev);
838 kfree(qca->rx_buffer);
839 qca->buffer_size = 0;
840 if (qca->rx_skb)
841 dev_kfree_skb(qca->rx_skb);
844 static const struct net_device_ops qcaspi_netdev_ops = {
845 .ndo_init = qcaspi_netdev_init,
846 .ndo_uninit = qcaspi_netdev_uninit,
847 .ndo_open = qcaspi_netdev_open,
848 .ndo_stop = qcaspi_netdev_close,
849 .ndo_start_xmit = qcaspi_netdev_xmit,
850 .ndo_set_mac_address = eth_mac_addr,
851 .ndo_tx_timeout = qcaspi_netdev_tx_timeout,
852 .ndo_validate_addr = eth_validate_addr,
855 static void
856 qcaspi_netdev_setup(struct net_device *dev)
858 struct qcaspi *qca = NULL;
860 dev->netdev_ops = &qcaspi_netdev_ops;
861 qcaspi_set_ethtool_ops(dev);
862 dev->watchdog_timeo = QCASPI_TX_TIMEOUT;
863 dev->priv_flags &= ~IFF_TX_SKB_SHARING;
864 dev->tx_queue_len = 100;
866 /* MTU range: 46 - 1500 */
867 dev->min_mtu = QCAFRM_MIN_MTU;
868 dev->max_mtu = QCAFRM_MAX_MTU;
870 qca = netdev_priv(dev);
871 memset(qca, 0, sizeof(struct qcaspi));
873 memset(&qca->txr, 0, sizeof(qca->txr));
874 qca->txr.count = TX_RING_MAX_LEN;
877 static const struct of_device_id qca_spi_of_match[] = {
878 { .compatible = "qca,qca7000" },
879 { /* sentinel */ }
881 MODULE_DEVICE_TABLE(of, qca_spi_of_match);
883 static int
884 qca_spi_probe(struct spi_device *spi)
886 struct qcaspi *qca = NULL;
887 struct net_device *qcaspi_devs = NULL;
888 u8 legacy_mode = 0;
889 u16 signature;
890 const char *mac;
892 if (!spi->dev.of_node) {
893 dev_err(&spi->dev, "Missing device tree\n");
894 return -EINVAL;
897 legacy_mode = of_property_read_bool(spi->dev.of_node,
898 "qca,legacy-mode");
900 if (qcaspi_clkspeed == 0) {
901 if (spi->max_speed_hz)
902 qcaspi_clkspeed = spi->max_speed_hz;
903 else
904 qcaspi_clkspeed = QCASPI_CLK_SPEED;
907 if ((qcaspi_clkspeed < QCASPI_CLK_SPEED_MIN) ||
908 (qcaspi_clkspeed > QCASPI_CLK_SPEED_MAX)) {
909 dev_err(&spi->dev, "Invalid clkspeed: %d\n",
910 qcaspi_clkspeed);
911 return -EINVAL;
914 if ((qcaspi_burst_len < QCASPI_BURST_LEN_MIN) ||
915 (qcaspi_burst_len > QCASPI_BURST_LEN_MAX)) {
916 dev_err(&spi->dev, "Invalid burst len: %d\n",
917 qcaspi_burst_len);
918 return -EINVAL;
921 if ((qcaspi_pluggable < QCASPI_PLUGGABLE_MIN) ||
922 (qcaspi_pluggable > QCASPI_PLUGGABLE_MAX)) {
923 dev_err(&spi->dev, "Invalid pluggable: %d\n",
924 qcaspi_pluggable);
925 return -EINVAL;
928 if (wr_verify < QCASPI_WRITE_VERIFY_MIN ||
929 wr_verify > QCASPI_WRITE_VERIFY_MAX) {
930 dev_err(&spi->dev, "Invalid write verify: %d\n",
931 wr_verify);
932 return -EINVAL;
935 dev_info(&spi->dev, "ver=%s, clkspeed=%d, burst_len=%d, pluggable=%d\n",
936 QCASPI_DRV_VERSION,
937 qcaspi_clkspeed,
938 qcaspi_burst_len,
939 qcaspi_pluggable);
941 spi->mode = SPI_MODE_3;
942 spi->max_speed_hz = qcaspi_clkspeed;
943 if (spi_setup(spi) < 0) {
944 dev_err(&spi->dev, "Unable to setup SPI device\n");
945 return -EFAULT;
948 qcaspi_devs = alloc_etherdev(sizeof(struct qcaspi));
949 if (!qcaspi_devs)
950 return -ENOMEM;
952 qcaspi_netdev_setup(qcaspi_devs);
953 SET_NETDEV_DEV(qcaspi_devs, &spi->dev);
955 qca = netdev_priv(qcaspi_devs);
956 if (!qca) {
957 free_netdev(qcaspi_devs);
958 dev_err(&spi->dev, "Fail to retrieve private structure\n");
959 return -ENOMEM;
961 qca->net_dev = qcaspi_devs;
962 qca->spi_dev = spi;
963 qca->legacy_mode = legacy_mode;
965 spi_set_drvdata(spi, qcaspi_devs);
967 mac = of_get_mac_address(spi->dev.of_node);
969 if (!IS_ERR(mac))
970 ether_addr_copy(qca->net_dev->dev_addr, mac);
972 if (!is_valid_ether_addr(qca->net_dev->dev_addr)) {
973 eth_hw_addr_random(qca->net_dev);
974 dev_info(&spi->dev, "Using random MAC address: %pM\n",
975 qca->net_dev->dev_addr);
978 netif_carrier_off(qca->net_dev);
980 if (!qcaspi_pluggable) {
981 qcaspi_read_register(qca, SPI_REG_SIGNATURE, &signature);
982 qcaspi_read_register(qca, SPI_REG_SIGNATURE, &signature);
984 if (signature != QCASPI_GOOD_SIGNATURE) {
985 dev_err(&spi->dev, "Invalid signature (0x%04X)\n",
986 signature);
987 free_netdev(qcaspi_devs);
988 return -EFAULT;
992 if (register_netdev(qcaspi_devs)) {
993 dev_err(&spi->dev, "Unable to register net device %s\n",
994 qcaspi_devs->name);
995 free_netdev(qcaspi_devs);
996 return -EFAULT;
999 qcaspi_init_device_debugfs(qca);
1001 return 0;
1004 static int
1005 qca_spi_remove(struct spi_device *spi)
1007 struct net_device *qcaspi_devs = spi_get_drvdata(spi);
1008 struct qcaspi *qca = netdev_priv(qcaspi_devs);
1010 qcaspi_remove_device_debugfs(qca);
1012 unregister_netdev(qcaspi_devs);
1013 free_netdev(qcaspi_devs);
1015 return 0;
1018 static const struct spi_device_id qca_spi_id[] = {
1019 { "qca7000", 0 },
1020 { /* sentinel */ }
1022 MODULE_DEVICE_TABLE(spi, qca_spi_id);
1024 static struct spi_driver qca_spi_driver = {
1025 .driver = {
1026 .name = QCASPI_DRV_NAME,
1027 .of_match_table = qca_spi_of_match,
1029 .id_table = qca_spi_id,
1030 .probe = qca_spi_probe,
1031 .remove = qca_spi_remove,
1033 module_spi_driver(qca_spi_driver);
1035 MODULE_DESCRIPTION("Qualcomm Atheros QCA7000 SPI Driver");
1036 MODULE_AUTHOR("Qualcomm Atheros Communications");
1037 MODULE_AUTHOR("Stefan Wahren <stefan.wahren@i2se.com>");
1038 MODULE_LICENSE("Dual BSD/GPL");
1039 MODULE_VERSION(QCASPI_DRV_VERSION);