Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * linux/drivers/spi/spi-loopback-test.c
4 *
5 * (c) Martin Sperl <kernel@martin.sperl.org>
6 *
7 * Loopback test driver to test several typical spi_message conditions
8 * that a spi_master driver may encounter
9 * this can also get used for regression testing
10 */
11
12#include <linux/delay.h>
13#include <linux/kernel.h>
14#include <linux/ktime.h>
15#include <linux/list.h>
16#include <linux/list_sort.h>
17#include <linux/module.h>
18#include <linux/of_device.h>
19#include <linux/printk.h>
20#include <linux/vmalloc.h>
21#include <linux/spi/spi.h>
22
23#include "spi-test.h"
24
25/* flag to only simulate transfers */
26static int simulate_only;
27module_param(simulate_only, int, 0);
28MODULE_PARM_DESC(simulate_only, "if not 0 do not execute the spi message");
29
30/* dump spi messages */
31static int dump_messages;
32module_param(dump_messages, int, 0);
33MODULE_PARM_DESC(dump_messages,
34 "=1 dump the basic spi_message_structure, " \
35 "=2 dump the spi_message_structure including data, " \
36 "=3 dump the spi_message structure before and after execution");
37/* the device is jumpered for loopback - enabling some rx_buf tests */
38static int loopback;
39module_param(loopback, int, 0);
40MODULE_PARM_DESC(loopback,
41 "if set enable loopback mode, where the rx_buf " \
42 "is checked to match tx_buf after the spi_message " \
43 "is executed");
44
45static int loop_req;
46module_param(loop_req, int, 0);
47MODULE_PARM_DESC(loop_req,
48 "if set controller will be asked to enable test loop mode. " \
49 "If controller supported it, MISO and MOSI will be connected");
50
51static int no_cs;
52module_param(no_cs, int, 0);
53MODULE_PARM_DESC(no_cs,
54 "if set Chip Select (CS) will not be used");
55
56/* run only a specific test */
57static int run_only_test = -1;
58module_param(run_only_test, int, 0);
59MODULE_PARM_DESC(run_only_test,
60 "only run the test with this number (0-based !)");
61
62/* use vmalloc'ed buffers */
63static int use_vmalloc;
64module_param(use_vmalloc, int, 0644);
65MODULE_PARM_DESC(use_vmalloc,
66 "use vmalloc'ed buffers instead of kmalloc'ed");
67
68/* check rx ranges */
69static int check_ranges = 1;
70module_param(check_ranges, int, 0644);
71MODULE_PARM_DESC(check_ranges,
72 "checks rx_buffer pattern are valid");
73
74/* the actual tests to execute */
75static struct spi_test spi_tests[] = {
76 {
77 .description = "tx/rx-transfer - start of page",
78 .fill_option = FILL_COUNT_8,
79 .iterate_len = { ITERATE_MAX_LEN },
80 .iterate_tx_align = ITERATE_ALIGN,
81 .iterate_rx_align = ITERATE_ALIGN,
82 .transfer_count = 1,
83 .transfers = {
84 {
85 .tx_buf = TX(0),
86 .rx_buf = RX(0),
87 },
88 },
89 },
90 {
91 .description = "tx/rx-transfer - crossing PAGE_SIZE",
92 .fill_option = FILL_COUNT_8,
93 .iterate_len = { ITERATE_LEN },
94 .iterate_tx_align = ITERATE_ALIGN,
95 .iterate_rx_align = ITERATE_ALIGN,
96 .transfer_count = 1,
97 .transfers = {
98 {
99 .tx_buf = TX(PAGE_SIZE - 4),
100 .rx_buf = RX(PAGE_SIZE - 4),
101 },
102 },
103 },
104 {
105 .description = "tx-transfer - only",
106 .fill_option = FILL_COUNT_8,
107 .iterate_len = { ITERATE_MAX_LEN },
108 .iterate_tx_align = ITERATE_ALIGN,
109 .transfer_count = 1,
110 .transfers = {
111 {
112 .tx_buf = TX(0),
113 },
114 },
115 },
116 {
117 .description = "rx-transfer - only",
118 .fill_option = FILL_COUNT_8,
119 .iterate_len = { ITERATE_MAX_LEN },
120 .iterate_rx_align = ITERATE_ALIGN,
121 .transfer_count = 1,
122 .transfers = {
123 {
124 .rx_buf = RX(0),
125 },
126 },
127 },
128 {
129 .description = "two tx-transfers - alter both",
130 .fill_option = FILL_COUNT_8,
131 .iterate_len = { ITERATE_LEN },
132 .iterate_tx_align = ITERATE_ALIGN,
133 .iterate_transfer_mask = BIT(0) | BIT(1),
134 .transfer_count = 2,
135 .transfers = {
136 {
137 .tx_buf = TX(0),
138 },
139 {
140 /* this is why we cant use ITERATE_MAX_LEN */
141 .tx_buf = TX(SPI_TEST_MAX_SIZE_HALF),
142 },
143 },
144 },
145 {
146 .description = "two tx-transfers - alter first",
147 .fill_option = FILL_COUNT_8,
148 .iterate_len = { ITERATE_MAX_LEN },
149 .iterate_tx_align = ITERATE_ALIGN,
150 .iterate_transfer_mask = BIT(0),
151 .transfer_count = 2,
152 .transfers = {
153 {
154 .tx_buf = TX(64),
155 },
156 {
157 .len = 1,
158 .tx_buf = TX(0),
159 },
160 },
161 },
162 {
163 .description = "two tx-transfers - alter second",
164 .fill_option = FILL_COUNT_8,
165 .iterate_len = { ITERATE_MAX_LEN },
166 .iterate_tx_align = ITERATE_ALIGN,
167 .iterate_transfer_mask = BIT(1),
168 .transfer_count = 2,
169 .transfers = {
170 {
171 .len = 16,
172 .tx_buf = TX(0),
173 },
174 {
175 .tx_buf = TX(64),
176 },
177 },
178 },
179 {
180 .description = "two transfers tx then rx - alter both",
181 .fill_option = FILL_COUNT_8,
182 .iterate_len = { ITERATE_MAX_LEN },
183 .iterate_tx_align = ITERATE_ALIGN,
184 .iterate_transfer_mask = BIT(0) | BIT(1),
185 .transfer_count = 2,
186 .transfers = {
187 {
188 .tx_buf = TX(0),
189 },
190 {
191 .rx_buf = RX(0),
192 },
193 },
194 },
195 {
196 .description = "two transfers tx then rx - alter tx",
197 .fill_option = FILL_COUNT_8,
198 .iterate_len = { ITERATE_MAX_LEN },
199 .iterate_tx_align = ITERATE_ALIGN,
200 .iterate_transfer_mask = BIT(0),
201 .transfer_count = 2,
202 .transfers = {
203 {
204 .tx_buf = TX(0),
205 },
206 {
207 .len = 1,
208 .rx_buf = RX(0),
209 },
210 },
211 },
212 {
213 .description = "two transfers tx then rx - alter rx",
214 .fill_option = FILL_COUNT_8,
215 .iterate_len = { ITERATE_MAX_LEN },
216 .iterate_tx_align = ITERATE_ALIGN,
217 .iterate_transfer_mask = BIT(1),
218 .transfer_count = 2,
219 .transfers = {
220 {
221 .len = 1,
222 .tx_buf = TX(0),
223 },
224 {
225 .rx_buf = RX(0),
226 },
227 },
228 },
229 {
230 .description = "two tx+rx transfers - alter both",
231 .fill_option = FILL_COUNT_8,
232 .iterate_len = { ITERATE_LEN },
233 .iterate_tx_align = ITERATE_ALIGN,
234 .iterate_transfer_mask = BIT(0) | BIT(1),
235 .transfer_count = 2,
236 .transfers = {
237 {
238 .tx_buf = TX(0),
239 .rx_buf = RX(0),
240 },
241 {
242 /* making sure we align without overwrite
243 * the reason we can not use ITERATE_MAX_LEN
244 */
245 .tx_buf = TX(SPI_TEST_MAX_SIZE_HALF),
246 .rx_buf = RX(SPI_TEST_MAX_SIZE_HALF),
247 },
248 },
249 },
250 {
251 .description = "two tx+rx transfers - alter first",
252 .fill_option = FILL_COUNT_8,
253 .iterate_len = { ITERATE_MAX_LEN },
254 .iterate_tx_align = ITERATE_ALIGN,
255 .iterate_transfer_mask = BIT(0),
256 .transfer_count = 2,
257 .transfers = {
258 {
259 /* making sure we align without overwrite */
260 .tx_buf = TX(1024),
261 .rx_buf = RX(1024),
262 },
263 {
264 .len = 1,
265 /* making sure we align without overwrite */
266 .tx_buf = TX(0),
267 .rx_buf = RX(0),
268 },
269 },
270 },
271 {
272 .description = "two tx+rx transfers - alter second",
273 .fill_option = FILL_COUNT_8,
274 .iterate_len = { ITERATE_MAX_LEN },
275 .iterate_tx_align = ITERATE_ALIGN,
276 .iterate_transfer_mask = BIT(1),
277 .transfer_count = 2,
278 .transfers = {
279 {
280 .len = 1,
281 .tx_buf = TX(0),
282 .rx_buf = RX(0),
283 },
284 {
285 /* making sure we align without overwrite */
286 .tx_buf = TX(1024),
287 .rx_buf = RX(1024),
288 },
289 },
290 },
291 {
292 .description = "two tx+rx transfers - delay after transfer",
293 .fill_option = FILL_COUNT_8,
294 .iterate_len = { ITERATE_MAX_LEN },
295 .iterate_transfer_mask = BIT(0) | BIT(1),
296 .transfer_count = 2,
297 .transfers = {
298 {
299 .tx_buf = TX(0),
300 .rx_buf = RX(0),
301 .delay = {
302 .value = 1000,
303 .unit = SPI_DELAY_UNIT_USECS,
304 },
305 },
306 {
307 .tx_buf = TX(0),
308 .rx_buf = RX(0),
309 .delay = {
310 .value = 1000,
311 .unit = SPI_DELAY_UNIT_USECS,
312 },
313 },
314 },
315 },
316 {
317 .description = "three tx+rx transfers with overlapping cache lines",
318 .fill_option = FILL_COUNT_8,
319 /*
320 * This should be large enough for the controller driver to
321 * choose to transfer it with DMA.
322 */
323 .iterate_len = { 512, -1 },
324 .iterate_transfer_mask = BIT(1),
325 .transfer_count = 3,
326 .transfers = {
327 {
328 .len = 1,
329 .tx_buf = TX(0),
330 .rx_buf = RX(0),
331 },
332 {
333 .tx_buf = TX(1),
334 .rx_buf = RX(1),
335 },
336 {
337 .len = 1,
338 .tx_buf = TX(513),
339 .rx_buf = RX(513),
340 },
341 },
342 },
343
344 { /* end of tests sequence */ }
345};
346
347static int spi_loopback_test_probe(struct spi_device *spi)
348{
349 int ret;
350
351 if (loop_req || no_cs) {
352 spi->mode |= loop_req ? SPI_LOOP : 0;
353 spi->mode |= no_cs ? SPI_NO_CS : 0;
354 ret = spi_setup(spi);
355 if (ret) {
356 dev_err(&spi->dev, "SPI setup with SPI_LOOP or SPI_NO_CS failed (%d)\n",
357 ret);
358 return ret;
359 }
360 }
361
362 dev_info(&spi->dev, "Executing spi-loopback-tests\n");
363
364 ret = spi_test_run_tests(spi, spi_tests);
365
366 dev_info(&spi->dev, "Finished spi-loopback-tests with return: %i\n",
367 ret);
368
369 return ret;
370}
371
372/* non const match table to permit to change via a module parameter */
373static struct of_device_id spi_loopback_test_of_match[] = {
374 { .compatible = "linux,spi-loopback-test", },
375 { }
376};
377
378/* allow to override the compatible string via a module_parameter */
379module_param_string(compatible, spi_loopback_test_of_match[0].compatible,
380 sizeof(spi_loopback_test_of_match[0].compatible),
381 0000);
382
383MODULE_DEVICE_TABLE(of, spi_loopback_test_of_match);
384
385static struct spi_driver spi_loopback_test_driver = {
386 .driver = {
387 .name = "spi-loopback-test",
388 .owner = THIS_MODULE,
389 .of_match_table = spi_loopback_test_of_match,
390 },
391 .probe = spi_loopback_test_probe,
392};
393
394module_spi_driver(spi_loopback_test_driver);
395
396MODULE_AUTHOR("Martin Sperl <kernel@martin.sperl.org>");
397MODULE_DESCRIPTION("test spi_driver to check core functionality");
398MODULE_LICENSE("GPL");
399
400/*-------------------------------------------------------------------------*/
401
402/* spi_test implementation */
403
404#define RANGE_CHECK(ptr, plen, start, slen) \
405 ((ptr >= start) && (ptr + plen <= start + slen))
406
407/* we allocate one page more, to allow for offsets */
408#define SPI_TEST_MAX_SIZE_PLUS (SPI_TEST_MAX_SIZE + PAGE_SIZE)
409
410static void spi_test_print_hex_dump(char *pre, const void *ptr, size_t len)
411{
412 /* limit the hex_dump */
413 if (len < 1024) {
414 print_hex_dump(KERN_INFO, pre,
415 DUMP_PREFIX_OFFSET, 16, 1,
416 ptr, len, 0);
417 return;
418 }
419 /* print head */
420 print_hex_dump(KERN_INFO, pre,
421 DUMP_PREFIX_OFFSET, 16, 1,
422 ptr, 512, 0);
423 /* print tail */
424 pr_info("%s truncated - continuing at offset %04zx\n",
425 pre, len - 512);
426 print_hex_dump(KERN_INFO, pre,
427 DUMP_PREFIX_OFFSET, 16, 1,
428 ptr + (len - 512), 512, 0);
429}
430
431static void spi_test_dump_message(struct spi_device *spi,
432 struct spi_message *msg,
433 bool dump_data)
434{
435 struct spi_transfer *xfer;
436 int i;
437 u8 b;
438
439 dev_info(&spi->dev, " spi_msg@%pK\n", msg);
440 if (msg->status)
441 dev_info(&spi->dev, " status: %i\n",
442 msg->status);
443 dev_info(&spi->dev, " frame_length: %i\n",
444 msg->frame_length);
445 dev_info(&spi->dev, " actual_length: %i\n",
446 msg->actual_length);
447
448 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
449 dev_info(&spi->dev, " spi_transfer@%pK\n", xfer);
450 dev_info(&spi->dev, " len: %i\n", xfer->len);
451 dev_info(&spi->dev, " tx_buf: %pK\n", xfer->tx_buf);
452 if (dump_data && xfer->tx_buf)
453 spi_test_print_hex_dump(" TX: ",
454 xfer->tx_buf,
455 xfer->len);
456
457 dev_info(&spi->dev, " rx_buf: %pK\n", xfer->rx_buf);
458 if (dump_data && xfer->rx_buf)
459 spi_test_print_hex_dump(" RX: ",
460 xfer->rx_buf,
461 xfer->len);
462 /* check for unwritten test pattern on rx_buf */
463 if (xfer->rx_buf) {
464 for (i = 0 ; i < xfer->len ; i++) {
465 b = ((u8 *)xfer->rx_buf)[xfer->len - 1 - i];
466 if (b != SPI_TEST_PATTERN_UNWRITTEN)
467 break;
468 }
469 if (i)
470 dev_info(&spi->dev,
471 " rx_buf filled with %02x starts at offset: %i\n",
472 SPI_TEST_PATTERN_UNWRITTEN,
473 xfer->len - i);
474 }
475 }
476}
477
478struct rx_ranges {
479 struct list_head list;
480 u8 *start;
481 u8 *end;
482};
483
484static int rx_ranges_cmp(void *priv, const struct list_head *a,
485 const struct list_head *b)
486{
487 struct rx_ranges *rx_a = list_entry(a, struct rx_ranges, list);
488 struct rx_ranges *rx_b = list_entry(b, struct rx_ranges, list);
489
490 if (rx_a->start > rx_b->start)
491 return 1;
492 if (rx_a->start < rx_b->start)
493 return -1;
494 return 0;
495}
496
497static int spi_check_rx_ranges(struct spi_device *spi,
498 struct spi_message *msg,
499 void *rx)
500{
501 struct spi_transfer *xfer;
502 struct rx_ranges ranges[SPI_TEST_MAX_TRANSFERS], *r;
503 int i = 0;
504 LIST_HEAD(ranges_list);
505 u8 *addr;
506 int ret = 0;
507
508 /* loop over all transfers to fill in the rx_ranges */
509 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
510 /* if there is no rx, then no check is needed */
511 if (!xfer->rx_buf)
512 continue;
513 /* fill in the rx_range */
514 if (RANGE_CHECK(xfer->rx_buf, xfer->len,
515 rx, SPI_TEST_MAX_SIZE_PLUS)) {
516 ranges[i].start = xfer->rx_buf;
517 ranges[i].end = xfer->rx_buf + xfer->len;
518 list_add(&ranges[i].list, &ranges_list);
519 i++;
520 }
521 }
522
523 /* if no ranges, then we can return and avoid the checks...*/
524 if (!i)
525 return 0;
526
527 /* sort the list */
528 list_sort(NULL, &ranges_list, rx_ranges_cmp);
529
530 /* and iterate over all the rx addresses */
531 for (addr = rx; addr < (u8 *)rx + SPI_TEST_MAX_SIZE_PLUS; addr++) {
532 /* if we are the DO not write pattern,
533 * then continue with the loop...
534 */
535 if (*addr == SPI_TEST_PATTERN_DO_NOT_WRITE)
536 continue;
537
538 /* check if we are inside a range */
539 list_for_each_entry(r, &ranges_list, list) {
540 /* if so then set to end... */
541 if ((addr >= r->start) && (addr < r->end))
542 addr = r->end;
543 }
544 /* second test after a (hopefull) translation */
545 if (*addr == SPI_TEST_PATTERN_DO_NOT_WRITE)
546 continue;
547
548 /* if still not found then something has modified too much */
549 /* we could list the "closest" transfer here... */
550 dev_err(&spi->dev,
551 "loopback strangeness - rx changed outside of allowed range at: %pK\n",
552 addr);
553 /* do not return, only set ret,
554 * so that we list all addresses
555 */
556 ret = -ERANGE;
557 }
558
559 return ret;
560}
561
562static int spi_test_check_elapsed_time(struct spi_device *spi,
563 struct spi_test *test)
564{
565 int i;
566 unsigned long long estimated_time = 0;
567 unsigned long long delay_usecs = 0;
568
569 for (i = 0; i < test->transfer_count; i++) {
570 struct spi_transfer *xfer = test->transfers + i;
571 unsigned long long nbits = (unsigned long long)BITS_PER_BYTE *
572 xfer->len;
573
574 delay_usecs += xfer->delay.value;
575 if (!xfer->speed_hz)
576 continue;
577 estimated_time += div_u64(nbits * NSEC_PER_SEC, xfer->speed_hz);
578 }
579
580 estimated_time += delay_usecs * NSEC_PER_USEC;
581 if (test->elapsed_time < estimated_time) {
582 dev_err(&spi->dev,
583 "elapsed time %lld ns is shorter than minimum estimated time %lld ns\n",
584 test->elapsed_time, estimated_time);
585
586 return -EINVAL;
587 }
588
589 return 0;
590}
591
592static int spi_test_check_loopback_result(struct spi_device *spi,
593 struct spi_message *msg,
594 void *tx, void *rx)
595{
596 struct spi_transfer *xfer;
597 u8 rxb, txb;
598 size_t i;
599 int ret;
600
601 /* checks rx_buffer pattern are valid with loopback or without */
602 if (check_ranges) {
603 ret = spi_check_rx_ranges(spi, msg, rx);
604 if (ret)
605 return ret;
606 }
607
608 /* if we run without loopback, then return now */
609 if (!loopback)
610 return 0;
611
612 /* if applicable to transfer check that rx_buf is equal to tx_buf */
613 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
614 /* if there is no rx, then no check is needed */
615 if (!xfer->len || !xfer->rx_buf)
616 continue;
617 /* so depending on tx_buf we need to handle things */
618 if (xfer->tx_buf) {
619 for (i = 0; i < xfer->len; i++) {
620 txb = ((u8 *)xfer->tx_buf)[i];
621 rxb = ((u8 *)xfer->rx_buf)[i];
622 if (txb != rxb)
623 goto mismatch_error;
624 }
625 } else {
626 /* first byte received */
627 txb = ((u8 *)xfer->rx_buf)[0];
628 /* first byte may be 0 or xff */
629 if (!((txb == 0) || (txb == 0xff))) {
630 dev_err(&spi->dev,
631 "loopback strangeness - we expect 0x00 or 0xff, but not 0x%02x\n",
632 txb);
633 return -EINVAL;
634 }
635 /* check that all bytes are identical */
636 for (i = 1; i < xfer->len; i++) {
637 rxb = ((u8 *)xfer->rx_buf)[i];
638 if (rxb != txb)
639 goto mismatch_error;
640 }
641 }
642 }
643
644 return 0;
645
646mismatch_error:
647 dev_err(&spi->dev,
648 "loopback strangeness - transfer mismatch on byte %04zx - expected 0x%02x, but got 0x%02x\n",
649 i, txb, rxb);
650
651 return -EINVAL;
652}
653
654static int spi_test_translate(struct spi_device *spi,
655 void **ptr, size_t len,
656 void *tx, void *rx)
657{
658 size_t off;
659
660 /* return on null */
661 if (!*ptr)
662 return 0;
663
664 /* in the MAX_SIZE_HALF case modify the pointer */
665 if (((size_t)*ptr) & SPI_TEST_MAX_SIZE_HALF)
666 /* move the pointer to the correct range */
667 *ptr += (SPI_TEST_MAX_SIZE_PLUS / 2) -
668 SPI_TEST_MAX_SIZE_HALF;
669
670 /* RX range
671 * - we check against MAX_SIZE_PLUS to allow for automated alignment
672 */
673 if (RANGE_CHECK(*ptr, len, RX(0), SPI_TEST_MAX_SIZE_PLUS)) {
674 off = *ptr - RX(0);
675 *ptr = rx + off;
676
677 return 0;
678 }
679
680 /* TX range */
681 if (RANGE_CHECK(*ptr, len, TX(0), SPI_TEST_MAX_SIZE_PLUS)) {
682 off = *ptr - TX(0);
683 *ptr = tx + off;
684
685 return 0;
686 }
687
688 dev_err(&spi->dev,
689 "PointerRange [%pK:%pK[ not in range [%pK:%pK[ or [%pK:%pK[\n",
690 *ptr, *ptr + len,
691 RX(0), RX(SPI_TEST_MAX_SIZE),
692 TX(0), TX(SPI_TEST_MAX_SIZE));
693
694 return -EINVAL;
695}
696
697static int spi_test_fill_pattern(struct spi_device *spi,
698 struct spi_test *test)
699{
700 struct spi_transfer *xfers = test->transfers;
701 u8 *tx_buf;
702 size_t count = 0;
703 int i, j;
704
705#ifdef __BIG_ENDIAN
706#define GET_VALUE_BYTE(value, index, bytes) \
707 (value >> (8 * (bytes - 1 - count % bytes)))
708#else
709#define GET_VALUE_BYTE(value, index, bytes) \
710 (value >> (8 * (count % bytes)))
711#endif
712
713 /* fill all transfers with the pattern requested */
714 for (i = 0; i < test->transfer_count; i++) {
715 /* fill rx_buf with SPI_TEST_PATTERN_UNWRITTEN */
716 if (xfers[i].rx_buf)
717 memset(xfers[i].rx_buf, SPI_TEST_PATTERN_UNWRITTEN,
718 xfers[i].len);
719 /* if tx_buf is NULL then skip */
720 tx_buf = (u8 *)xfers[i].tx_buf;
721 if (!tx_buf)
722 continue;
723 /* modify all the transfers */
724 for (j = 0; j < xfers[i].len; j++, tx_buf++, count++) {
725 /* fill tx */
726 switch (test->fill_option) {
727 case FILL_MEMSET_8:
728 *tx_buf = test->fill_pattern;
729 break;
730 case FILL_MEMSET_16:
731 *tx_buf = GET_VALUE_BYTE(test->fill_pattern,
732 count, 2);
733 break;
734 case FILL_MEMSET_24:
735 *tx_buf = GET_VALUE_BYTE(test->fill_pattern,
736 count, 3);
737 break;
738 case FILL_MEMSET_32:
739 *tx_buf = GET_VALUE_BYTE(test->fill_pattern,
740 count, 4);
741 break;
742 case FILL_COUNT_8:
743 *tx_buf = count;
744 break;
745 case FILL_COUNT_16:
746 *tx_buf = GET_VALUE_BYTE(count, count, 2);
747 break;
748 case FILL_COUNT_24:
749 *tx_buf = GET_VALUE_BYTE(count, count, 3);
750 break;
751 case FILL_COUNT_32:
752 *tx_buf = GET_VALUE_BYTE(count, count, 4);
753 break;
754 case FILL_TRANSFER_BYTE_8:
755 *tx_buf = j;
756 break;
757 case FILL_TRANSFER_BYTE_16:
758 *tx_buf = GET_VALUE_BYTE(j, j, 2);
759 break;
760 case FILL_TRANSFER_BYTE_24:
761 *tx_buf = GET_VALUE_BYTE(j, j, 3);
762 break;
763 case FILL_TRANSFER_BYTE_32:
764 *tx_buf = GET_VALUE_BYTE(j, j, 4);
765 break;
766 case FILL_TRANSFER_NUM:
767 *tx_buf = i;
768 break;
769 default:
770 dev_err(&spi->dev,
771 "unsupported fill_option: %i\n",
772 test->fill_option);
773 return -EINVAL;
774 }
775 }
776 }
777
778 return 0;
779}
780
781static int _spi_test_run_iter(struct spi_device *spi,
782 struct spi_test *test,
783 void *tx, void *rx)
784{
785 struct spi_message *msg = &test->msg;
786 struct spi_transfer *x;
787 int i, ret;
788
789 /* initialize message - zero-filled via static initialization */
790 spi_message_init_no_memset(msg);
791
792 /* fill rx with the DO_NOT_WRITE pattern */
793 memset(rx, SPI_TEST_PATTERN_DO_NOT_WRITE, SPI_TEST_MAX_SIZE_PLUS);
794
795 /* add the individual transfers */
796 for (i = 0; i < test->transfer_count; i++) {
797 x = &test->transfers[i];
798
799 /* patch the values of tx_buf */
800 ret = spi_test_translate(spi, (void **)&x->tx_buf, x->len,
801 (void *)tx, rx);
802 if (ret)
803 return ret;
804
805 /* patch the values of rx_buf */
806 ret = spi_test_translate(spi, &x->rx_buf, x->len,
807 (void *)tx, rx);
808 if (ret)
809 return ret;
810
811 /* and add it to the list */
812 spi_message_add_tail(x, msg);
813 }
814
815 /* fill in the transfer buffers with pattern */
816 ret = spi_test_fill_pattern(spi, test);
817 if (ret)
818 return ret;
819
820 /* and execute */
821 if (test->execute_msg)
822 ret = test->execute_msg(spi, test, tx, rx);
823 else
824 ret = spi_test_execute_msg(spi, test, tx, rx);
825
826 /* handle result */
827 if (ret == test->expected_return)
828 return 0;
829
830 dev_err(&spi->dev,
831 "test failed - test returned %i, but we expect %i\n",
832 ret, test->expected_return);
833
834 if (ret)
835 return ret;
836
837 /* if it is 0, as we expected something else,
838 * then return something special
839 */
840 return -EFAULT;
841}
842
843static int spi_test_run_iter(struct spi_device *spi,
844 const struct spi_test *testtemplate,
845 void *tx, void *rx,
846 size_t len,
847 size_t tx_off,
848 size_t rx_off
849 )
850{
851 struct spi_test test;
852 int i, tx_count, rx_count;
853
854 /* copy the test template to test */
855 memcpy(&test, testtemplate, sizeof(test));
856
857 /* if iterate_transfer_mask is not set,
858 * then set it to first transfer only
859 */
860 if (!(test.iterate_transfer_mask & (BIT(test.transfer_count) - 1)))
861 test.iterate_transfer_mask = 1;
862
863 /* count number of transfers with tx/rx_buf != NULL */
864 rx_count = tx_count = 0;
865 for (i = 0; i < test.transfer_count; i++) {
866 if (test.transfers[i].tx_buf)
867 tx_count++;
868 if (test.transfers[i].rx_buf)
869 rx_count++;
870 }
871
872 /* in some iteration cases warn and exit early,
873 * as there is nothing to do, that has not been tested already...
874 */
875 if (tx_off && (!tx_count)) {
876 dev_warn_once(&spi->dev,
877 "%s: iterate_tx_off configured with tx_buf==NULL - ignoring\n",
878 test.description);
879 return 0;
880 }
881 if (rx_off && (!rx_count)) {
882 dev_warn_once(&spi->dev,
883 "%s: iterate_rx_off configured with rx_buf==NULL - ignoring\n",
884 test.description);
885 return 0;
886 }
887
888 /* write out info */
889 if (!(len || tx_off || rx_off)) {
890 dev_info(&spi->dev, "Running test %s\n", test.description);
891 } else {
892 dev_info(&spi->dev,
893 " with iteration values: len = %zu, tx_off = %zu, rx_off = %zu\n",
894 len, tx_off, rx_off);
895 }
896
897 /* update in the values from iteration values */
898 for (i = 0; i < test.transfer_count; i++) {
899 /* only when bit in transfer mask is set */
900 if (!(test.iterate_transfer_mask & BIT(i)))
901 continue;
902 test.transfers[i].len = len;
903 if (test.transfers[i].tx_buf)
904 test.transfers[i].tx_buf += tx_off;
905 if (test.transfers[i].rx_buf)
906 test.transfers[i].rx_buf += rx_off;
907 }
908
909 /* and execute */
910 return _spi_test_run_iter(spi, &test, tx, rx);
911}
912
913/**
914 * spi_test_execute_msg - default implementation to run a test
915 *
916 * @spi: @spi_device on which to run the @spi_message
917 * @test: the test to execute, which already contains @msg
918 * @tx: the tx buffer allocated for the test sequence
919 * @rx: the rx buffer allocated for the test sequence
920 *
921 * Returns: error code of spi_sync as well as basic error checking
922 */
923int spi_test_execute_msg(struct spi_device *spi, struct spi_test *test,
924 void *tx, void *rx)
925{
926 struct spi_message *msg = &test->msg;
927 int ret = 0;
928 int i;
929
930 /* only if we do not simulate */
931 if (!simulate_only) {
932 ktime_t start;
933
934 /* dump the complete message before and after the transfer */
935 if (dump_messages == 3)
936 spi_test_dump_message(spi, msg, true);
937
938 start = ktime_get();
939 /* run spi message */
940 ret = spi_sync(spi, msg);
941 test->elapsed_time = ktime_to_ns(ktime_sub(ktime_get(), start));
942 if (ret == -ETIMEDOUT) {
943 dev_info(&spi->dev,
944 "spi-message timed out - rerunning...\n");
945 /* rerun after a few explicit schedules */
946 for (i = 0; i < 16; i++)
947 schedule();
948 ret = spi_sync(spi, msg);
949 }
950 if (ret) {
951 dev_err(&spi->dev,
952 "Failed to execute spi_message: %i\n",
953 ret);
954 goto exit;
955 }
956
957 /* do some extra error checks */
958 if (msg->frame_length != msg->actual_length) {
959 dev_err(&spi->dev,
960 "actual length differs from expected\n");
961 ret = -EIO;
962 goto exit;
963 }
964
965 /* run rx-buffer tests */
966 ret = spi_test_check_loopback_result(spi, msg, tx, rx);
967 if (ret)
968 goto exit;
969
970 ret = spi_test_check_elapsed_time(spi, test);
971 }
972
973 /* if requested or on error dump message (including data) */
974exit:
975 if (dump_messages || ret)
976 spi_test_dump_message(spi, msg,
977 (dump_messages >= 2) || (ret));
978
979 return ret;
980}
981EXPORT_SYMBOL_GPL(spi_test_execute_msg);
982
983/**
984 * spi_test_run_test - run an individual spi_test
985 * including all the relevant iterations on:
986 * length and buffer alignment
987 *
988 * @spi: the spi_device to send the messages to
989 * @test: the test which we need to execute
990 * @tx: the tx buffer allocated for the test sequence
991 * @rx: the rx buffer allocated for the test sequence
992 *
993 * Returns: status code of spi_sync or other failures
994 */
995
996int spi_test_run_test(struct spi_device *spi, const struct spi_test *test,
997 void *tx, void *rx)
998{
999 int idx_len;
1000 size_t len;
1001 size_t tx_align, rx_align;
1002 int ret;
1003
1004 /* test for transfer limits */
1005 if (test->transfer_count >= SPI_TEST_MAX_TRANSFERS) {
1006 dev_err(&spi->dev,
1007 "%s: Exceeded max number of transfers with %i\n",
1008 test->description, test->transfer_count);
1009 return -E2BIG;
1010 }
1011
1012 /* setting up some values in spi_message
1013 * based on some settings in spi_master
1014 * some of this can also get done in the run() method
1015 */
1016
1017 /* iterate over all the iterable values using macros
1018 * (to make it a bit more readable...
1019 */
1020#define FOR_EACH_ALIGNMENT(var) \
1021 for (var = 0; \
1022 var < (test->iterate_##var ? \
1023 (spi->master->dma_alignment ? \
1024 spi->master->dma_alignment : \
1025 test->iterate_##var) : \
1026 1); \
1027 var++)
1028
1029 for (idx_len = 0; idx_len < SPI_TEST_MAX_ITERATE &&
1030 (len = test->iterate_len[idx_len]) != -1; idx_len++) {
1031 FOR_EACH_ALIGNMENT(tx_align) {
1032 FOR_EACH_ALIGNMENT(rx_align) {
1033 /* and run the iteration */
1034 ret = spi_test_run_iter(spi, test,
1035 tx, rx,
1036 len,
1037 tx_align,
1038 rx_align);
1039 if (ret)
1040 return ret;
1041 }
1042 }
1043 }
1044
1045 return 0;
1046}
1047EXPORT_SYMBOL_GPL(spi_test_run_test);
1048
1049/**
1050 * spi_test_run_tests - run an array of spi_messages tests
1051 * @spi: the spi device on which to run the tests
1052 * @tests: NULL-terminated array of @spi_test
1053 *
1054 * Returns: status errors as per @spi_test_run_test()
1055 */
1056
1057int spi_test_run_tests(struct spi_device *spi,
1058 struct spi_test *tests)
1059{
1060 char *rx = NULL, *tx = NULL;
1061 int ret = 0, count = 0;
1062 struct spi_test *test;
1063
1064 /* allocate rx/tx buffers of 128kB size without devm
1065 * in the hope that is on a page boundary
1066 */
1067 if (use_vmalloc)
1068 rx = vmalloc(SPI_TEST_MAX_SIZE_PLUS);
1069 else
1070 rx = kzalloc(SPI_TEST_MAX_SIZE_PLUS, GFP_KERNEL);
1071 if (!rx)
1072 return -ENOMEM;
1073
1074
1075 if (use_vmalloc)
1076 tx = vmalloc(SPI_TEST_MAX_SIZE_PLUS);
1077 else
1078 tx = kzalloc(SPI_TEST_MAX_SIZE_PLUS, GFP_KERNEL);
1079 if (!tx) {
1080 ret = -ENOMEM;
1081 goto err_tx;
1082 }
1083
1084 /* now run the individual tests in the table */
1085 for (test = tests, count = 0; test->description[0];
1086 test++, count++) {
1087 /* only run test if requested */
1088 if ((run_only_test > -1) && (count != run_only_test))
1089 continue;
1090 /* run custom implementation */
1091 if (test->run_test)
1092 ret = test->run_test(spi, test, tx, rx);
1093 else
1094 ret = spi_test_run_test(spi, test, tx, rx);
1095 if (ret)
1096 goto out;
1097 /* add some delays so that we can easily
1098 * detect the individual tests when using a logic analyzer
1099 * we also add scheduling to avoid potential spi_timeouts...
1100 */
1101 mdelay(100);
1102 schedule();
1103 }
1104
1105out:
1106 kvfree(tx);
1107err_tx:
1108 kvfree(rx);
1109 return ret;
1110}
1111EXPORT_SYMBOL_GPL(spi_test_run_tests);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * linux/drivers/spi/spi-loopback-test.c
4 *
5 * (c) Martin Sperl <kernel@martin.sperl.org>
6 *
7 * Loopback test driver to test several typical spi_message conditions
8 * that a spi_master driver may encounter
9 * this can also get used for regression testing
10 */
11
12#include <linux/delay.h>
13#include <linux/kernel.h>
14#include <linux/ktime.h>
15#include <linux/list.h>
16#include <linux/list_sort.h>
17#include <linux/mod_devicetable.h>
18#include <linux/module.h>
19#include <linux/printk.h>
20#include <linux/vmalloc.h>
21#include <linux/spi/spi.h>
22
23#include "spi-test.h"
24
25/* flag to only simulate transfers */
26static int simulate_only;
27module_param(simulate_only, int, 0);
28MODULE_PARM_DESC(simulate_only, "if not 0 do not execute the spi message");
29
30/* dump spi messages */
31static int dump_messages;
32module_param(dump_messages, int, 0);
33MODULE_PARM_DESC(dump_messages,
34 "=1 dump the basic spi_message_structure, " \
35 "=2 dump the spi_message_structure including data, " \
36 "=3 dump the spi_message structure before and after execution");
37/* the device is jumpered for loopback - enabling some rx_buf tests */
38static int loopback;
39module_param(loopback, int, 0);
40MODULE_PARM_DESC(loopback,
41 "if set enable loopback mode, where the rx_buf " \
42 "is checked to match tx_buf after the spi_message " \
43 "is executed");
44
45static int loop_req;
46module_param(loop_req, int, 0);
47MODULE_PARM_DESC(loop_req,
48 "if set controller will be asked to enable test loop mode. " \
49 "If controller supported it, MISO and MOSI will be connected");
50
51static int no_cs;
52module_param(no_cs, int, 0);
53MODULE_PARM_DESC(no_cs,
54 "if set Chip Select (CS) will not be used");
55
56/* run tests only for a specific length */
57static int run_only_iter_len = -1;
58module_param(run_only_iter_len, int, 0);
59MODULE_PARM_DESC(run_only_iter_len,
60 "only run tests for a length of this number in iterate_len list");
61
62/* run only a specific test */
63static int run_only_test = -1;
64module_param(run_only_test, int, 0);
65MODULE_PARM_DESC(run_only_test,
66 "only run the test with this number (0-based !)");
67
68/* use vmalloc'ed buffers */
69static int use_vmalloc;
70module_param(use_vmalloc, int, 0644);
71MODULE_PARM_DESC(use_vmalloc,
72 "use vmalloc'ed buffers instead of kmalloc'ed");
73
74/* check rx ranges */
75static int check_ranges = 1;
76module_param(check_ranges, int, 0644);
77MODULE_PARM_DESC(check_ranges,
78 "checks rx_buffer pattern are valid");
79
80static unsigned int delay_ms = 100;
81module_param(delay_ms, uint, 0644);
82MODULE_PARM_DESC(delay_ms,
83 "delay between tests, in milliseconds (default: 100)");
84
85/* the actual tests to execute */
86static struct spi_test spi_tests[] = {
87 {
88 .description = "tx/rx-transfer - start of page",
89 .fill_option = FILL_COUNT_8,
90 .iterate_len = { ITERATE_MAX_LEN },
91 .iterate_tx_align = ITERATE_ALIGN,
92 .iterate_rx_align = ITERATE_ALIGN,
93 .transfer_count = 1,
94 .transfers = {
95 {
96 .tx_buf = TX(0),
97 .rx_buf = RX(0),
98 },
99 },
100 },
101 {
102 .description = "tx/rx-transfer - crossing PAGE_SIZE",
103 .fill_option = FILL_COUNT_8,
104 .iterate_len = { ITERATE_LEN },
105 .iterate_tx_align = ITERATE_ALIGN,
106 .iterate_rx_align = ITERATE_ALIGN,
107 .transfer_count = 1,
108 .transfers = {
109 {
110 .tx_buf = TX(PAGE_SIZE - 4),
111 .rx_buf = RX(PAGE_SIZE - 4),
112 },
113 },
114 },
115 {
116 .description = "tx-transfer - only",
117 .fill_option = FILL_COUNT_8,
118 .iterate_len = { ITERATE_MAX_LEN },
119 .iterate_tx_align = ITERATE_ALIGN,
120 .transfer_count = 1,
121 .transfers = {
122 {
123 .tx_buf = TX(0),
124 },
125 },
126 },
127 {
128 .description = "rx-transfer - only",
129 .fill_option = FILL_COUNT_8,
130 .iterate_len = { ITERATE_MAX_LEN },
131 .iterate_rx_align = ITERATE_ALIGN,
132 .transfer_count = 1,
133 .transfers = {
134 {
135 .rx_buf = RX(0),
136 },
137 },
138 },
139 {
140 .description = "two tx-transfers - alter both",
141 .fill_option = FILL_COUNT_8,
142 .iterate_len = { ITERATE_LEN },
143 .iterate_tx_align = ITERATE_ALIGN,
144 .iterate_transfer_mask = BIT(0) | BIT(1),
145 .transfer_count = 2,
146 .transfers = {
147 {
148 .tx_buf = TX(0),
149 },
150 {
151 /* this is why we cant use ITERATE_MAX_LEN */
152 .tx_buf = TX(SPI_TEST_MAX_SIZE_HALF),
153 },
154 },
155 },
156 {
157 .description = "two tx-transfers - alter first",
158 .fill_option = FILL_COUNT_8,
159 .iterate_len = { ITERATE_MAX_LEN },
160 .iterate_tx_align = ITERATE_ALIGN,
161 .iterate_transfer_mask = BIT(0),
162 .transfer_count = 2,
163 .transfers = {
164 {
165 .tx_buf = TX(64),
166 },
167 {
168 .len = 1,
169 .tx_buf = TX(0),
170 },
171 },
172 },
173 {
174 .description = "two tx-transfers - alter second",
175 .fill_option = FILL_COUNT_8,
176 .iterate_len = { ITERATE_MAX_LEN },
177 .iterate_tx_align = ITERATE_ALIGN,
178 .iterate_transfer_mask = BIT(1),
179 .transfer_count = 2,
180 .transfers = {
181 {
182 .len = 16,
183 .tx_buf = TX(0),
184 },
185 {
186 .tx_buf = TX(64),
187 },
188 },
189 },
190 {
191 .description = "two transfers tx then rx - alter both",
192 .fill_option = FILL_COUNT_8,
193 .iterate_len = { ITERATE_MAX_LEN },
194 .iterate_tx_align = ITERATE_ALIGN,
195 .iterate_transfer_mask = BIT(0) | BIT(1),
196 .transfer_count = 2,
197 .transfers = {
198 {
199 .tx_buf = TX(0),
200 },
201 {
202 .rx_buf = RX(0),
203 },
204 },
205 },
206 {
207 .description = "two transfers tx then rx - alter tx",
208 .fill_option = FILL_COUNT_8,
209 .iterate_len = { ITERATE_MAX_LEN },
210 .iterate_tx_align = ITERATE_ALIGN,
211 .iterate_transfer_mask = BIT(0),
212 .transfer_count = 2,
213 .transfers = {
214 {
215 .tx_buf = TX(0),
216 },
217 {
218 .len = 1,
219 .rx_buf = RX(0),
220 },
221 },
222 },
223 {
224 .description = "two transfers tx then rx - alter rx",
225 .fill_option = FILL_COUNT_8,
226 .iterate_len = { ITERATE_MAX_LEN },
227 .iterate_tx_align = ITERATE_ALIGN,
228 .iterate_transfer_mask = BIT(1),
229 .transfer_count = 2,
230 .transfers = {
231 {
232 .len = 1,
233 .tx_buf = TX(0),
234 },
235 {
236 .rx_buf = RX(0),
237 },
238 },
239 },
240 {
241 .description = "two tx+rx transfers - alter both",
242 .fill_option = FILL_COUNT_8,
243 .iterate_len = { ITERATE_LEN },
244 .iterate_tx_align = ITERATE_ALIGN,
245 .iterate_transfer_mask = BIT(0) | BIT(1),
246 .transfer_count = 2,
247 .transfers = {
248 {
249 .tx_buf = TX(0),
250 .rx_buf = RX(0),
251 },
252 {
253 /* making sure we align without overwrite
254 * the reason we can not use ITERATE_MAX_LEN
255 */
256 .tx_buf = TX(SPI_TEST_MAX_SIZE_HALF),
257 .rx_buf = RX(SPI_TEST_MAX_SIZE_HALF),
258 },
259 },
260 },
261 {
262 .description = "two tx+rx transfers - alter first",
263 .fill_option = FILL_COUNT_8,
264 .iterate_len = { ITERATE_MAX_LEN },
265 .iterate_tx_align = ITERATE_ALIGN,
266 .iterate_transfer_mask = BIT(0),
267 .transfer_count = 2,
268 .transfers = {
269 {
270 /* making sure we align without overwrite */
271 .tx_buf = TX(1024),
272 .rx_buf = RX(1024),
273 },
274 {
275 .len = 1,
276 /* making sure we align without overwrite */
277 .tx_buf = TX(0),
278 .rx_buf = RX(0),
279 },
280 },
281 },
282 {
283 .description = "two tx+rx transfers - alter second",
284 .fill_option = FILL_COUNT_8,
285 .iterate_len = { ITERATE_MAX_LEN },
286 .iterate_tx_align = ITERATE_ALIGN,
287 .iterate_transfer_mask = BIT(1),
288 .transfer_count = 2,
289 .transfers = {
290 {
291 .len = 1,
292 .tx_buf = TX(0),
293 .rx_buf = RX(0),
294 },
295 {
296 /* making sure we align without overwrite */
297 .tx_buf = TX(1024),
298 .rx_buf = RX(1024),
299 },
300 },
301 },
302 {
303 .description = "two tx+rx transfers - delay after transfer",
304 .fill_option = FILL_COUNT_8,
305 .iterate_len = { ITERATE_MAX_LEN },
306 .iterate_transfer_mask = BIT(0) | BIT(1),
307 .transfer_count = 2,
308 .transfers = {
309 {
310 .tx_buf = TX(0),
311 .rx_buf = RX(0),
312 .delay = {
313 .value = 1000,
314 .unit = SPI_DELAY_UNIT_USECS,
315 },
316 },
317 {
318 .tx_buf = TX(0),
319 .rx_buf = RX(0),
320 .delay = {
321 .value = 1000,
322 .unit = SPI_DELAY_UNIT_USECS,
323 },
324 },
325 },
326 },
327 {
328 .description = "three tx+rx transfers with overlapping cache lines",
329 .fill_option = FILL_COUNT_8,
330 /*
331 * This should be large enough for the controller driver to
332 * choose to transfer it with DMA.
333 */
334 .iterate_len = { 512, -1 },
335 .iterate_transfer_mask = BIT(1),
336 .transfer_count = 3,
337 .transfers = {
338 {
339 .len = 1,
340 .tx_buf = TX(0),
341 .rx_buf = RX(0),
342 },
343 {
344 .tx_buf = TX(1),
345 .rx_buf = RX(1),
346 },
347 {
348 .len = 1,
349 .tx_buf = TX(513),
350 .rx_buf = RX(513),
351 },
352 },
353 },
354
355 { /* end of tests sequence */ }
356};
357
358static int spi_loopback_test_probe(struct spi_device *spi)
359{
360 int ret;
361
362 if (loop_req || no_cs) {
363 spi->mode |= loop_req ? SPI_LOOP : 0;
364 spi->mode |= no_cs ? SPI_NO_CS : 0;
365 ret = spi_setup(spi);
366 if (ret) {
367 dev_err(&spi->dev, "SPI setup with SPI_LOOP or SPI_NO_CS failed (%d)\n",
368 ret);
369 return ret;
370 }
371 }
372
373 dev_info(&spi->dev, "Executing spi-loopback-tests\n");
374
375 ret = spi_test_run_tests(spi, spi_tests);
376
377 dev_info(&spi->dev, "Finished spi-loopback-tests with return: %i\n",
378 ret);
379
380 return ret;
381}
382
383/* non const match table to permit to change via a module parameter */
384static struct of_device_id spi_loopback_test_of_match[] = {
385 { .compatible = "linux,spi-loopback-test", },
386 { }
387};
388
389/* allow to override the compatible string via a module_parameter */
390module_param_string(compatible, spi_loopback_test_of_match[0].compatible,
391 sizeof(spi_loopback_test_of_match[0].compatible),
392 0000);
393
394MODULE_DEVICE_TABLE(of, spi_loopback_test_of_match);
395
396static struct spi_driver spi_loopback_test_driver = {
397 .driver = {
398 .name = "spi-loopback-test",
399 .of_match_table = spi_loopback_test_of_match,
400 },
401 .probe = spi_loopback_test_probe,
402};
403
404module_spi_driver(spi_loopback_test_driver);
405
406MODULE_AUTHOR("Martin Sperl <kernel@martin.sperl.org>");
407MODULE_DESCRIPTION("test spi_driver to check core functionality");
408MODULE_LICENSE("GPL");
409
410/*-------------------------------------------------------------------------*/
411
412/* spi_test implementation */
413
414#define RANGE_CHECK(ptr, plen, start, slen) \
415 ((ptr >= start) && (ptr + plen <= start + slen))
416
417/* we allocate one page more, to allow for offsets */
418#define SPI_TEST_MAX_SIZE_PLUS (SPI_TEST_MAX_SIZE + PAGE_SIZE)
419
420static void spi_test_print_hex_dump(char *pre, const void *ptr, size_t len)
421{
422 /* limit the hex_dump */
423 if (len < 1024) {
424 print_hex_dump(KERN_INFO, pre,
425 DUMP_PREFIX_OFFSET, 16, 1,
426 ptr, len, 0);
427 return;
428 }
429 /* print head */
430 print_hex_dump(KERN_INFO, pre,
431 DUMP_PREFIX_OFFSET, 16, 1,
432 ptr, 512, 0);
433 /* print tail */
434 pr_info("%s truncated - continuing at offset %04zx\n",
435 pre, len - 512);
436 print_hex_dump(KERN_INFO, pre,
437 DUMP_PREFIX_OFFSET, 16, 1,
438 ptr + (len - 512), 512, 0);
439}
440
441static void spi_test_dump_message(struct spi_device *spi,
442 struct spi_message *msg,
443 bool dump_data)
444{
445 struct spi_transfer *xfer;
446 int i;
447 u8 b;
448
449 dev_info(&spi->dev, " spi_msg@%pK\n", msg);
450 if (msg->status)
451 dev_info(&spi->dev, " status: %i\n",
452 msg->status);
453 dev_info(&spi->dev, " frame_length: %i\n",
454 msg->frame_length);
455 dev_info(&spi->dev, " actual_length: %i\n",
456 msg->actual_length);
457
458 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
459 dev_info(&spi->dev, " spi_transfer@%pK\n", xfer);
460 dev_info(&spi->dev, " len: %i\n", xfer->len);
461 dev_info(&spi->dev, " tx_buf: %pK\n", xfer->tx_buf);
462 if (dump_data && xfer->tx_buf)
463 spi_test_print_hex_dump(" TX: ",
464 xfer->tx_buf,
465 xfer->len);
466
467 dev_info(&spi->dev, " rx_buf: %pK\n", xfer->rx_buf);
468 if (dump_data && xfer->rx_buf)
469 spi_test_print_hex_dump(" RX: ",
470 xfer->rx_buf,
471 xfer->len);
472 /* check for unwritten test pattern on rx_buf */
473 if (xfer->rx_buf) {
474 for (i = 0 ; i < xfer->len ; i++) {
475 b = ((u8 *)xfer->rx_buf)[xfer->len - 1 - i];
476 if (b != SPI_TEST_PATTERN_UNWRITTEN)
477 break;
478 }
479 if (i)
480 dev_info(&spi->dev,
481 " rx_buf filled with %02x starts at offset: %i\n",
482 SPI_TEST_PATTERN_UNWRITTEN,
483 xfer->len - i);
484 }
485 }
486}
487
488struct rx_ranges {
489 struct list_head list;
490 u8 *start;
491 u8 *end;
492};
493
494static int rx_ranges_cmp(void *priv, const struct list_head *a,
495 const struct list_head *b)
496{
497 struct rx_ranges *rx_a = list_entry(a, struct rx_ranges, list);
498 struct rx_ranges *rx_b = list_entry(b, struct rx_ranges, list);
499
500 if (rx_a->start > rx_b->start)
501 return 1;
502 if (rx_a->start < rx_b->start)
503 return -1;
504 return 0;
505}
506
507static int spi_check_rx_ranges(struct spi_device *spi,
508 struct spi_message *msg,
509 void *rx)
510{
511 struct spi_transfer *xfer;
512 struct rx_ranges ranges[SPI_TEST_MAX_TRANSFERS], *r;
513 int i = 0;
514 LIST_HEAD(ranges_list);
515 u8 *addr;
516 int ret = 0;
517
518 /* loop over all transfers to fill in the rx_ranges */
519 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
520 /* if there is no rx, then no check is needed */
521 if (!xfer->rx_buf)
522 continue;
523 /* fill in the rx_range */
524 if (RANGE_CHECK(xfer->rx_buf, xfer->len,
525 rx, SPI_TEST_MAX_SIZE_PLUS)) {
526 ranges[i].start = xfer->rx_buf;
527 ranges[i].end = xfer->rx_buf + xfer->len;
528 list_add(&ranges[i].list, &ranges_list);
529 i++;
530 }
531 }
532
533 /* if no ranges, then we can return and avoid the checks...*/
534 if (!i)
535 return 0;
536
537 /* sort the list */
538 list_sort(NULL, &ranges_list, rx_ranges_cmp);
539
540 /* and iterate over all the rx addresses */
541 for (addr = rx; addr < (u8 *)rx + SPI_TEST_MAX_SIZE_PLUS; addr++) {
542 /* if we are the DO not write pattern,
543 * then continue with the loop...
544 */
545 if (*addr == SPI_TEST_PATTERN_DO_NOT_WRITE)
546 continue;
547
548 /* check if we are inside a range */
549 list_for_each_entry(r, &ranges_list, list) {
550 /* if so then set to end... */
551 if ((addr >= r->start) && (addr < r->end))
552 addr = r->end;
553 }
554 /* second test after a (hopefull) translation */
555 if (*addr == SPI_TEST_PATTERN_DO_NOT_WRITE)
556 continue;
557
558 /* if still not found then something has modified too much */
559 /* we could list the "closest" transfer here... */
560 dev_err(&spi->dev,
561 "loopback strangeness - rx changed outside of allowed range at: %pK\n",
562 addr);
563 /* do not return, only set ret,
564 * so that we list all addresses
565 */
566 ret = -ERANGE;
567 }
568
569 return ret;
570}
571
572static int spi_test_check_elapsed_time(struct spi_device *spi,
573 struct spi_test *test)
574{
575 int i;
576 unsigned long long estimated_time = 0;
577 unsigned long long delay_usecs = 0;
578
579 for (i = 0; i < test->transfer_count; i++) {
580 struct spi_transfer *xfer = test->transfers + i;
581 unsigned long long nbits = (unsigned long long)BITS_PER_BYTE *
582 xfer->len;
583
584 delay_usecs += xfer->delay.value;
585 if (!xfer->speed_hz)
586 continue;
587 estimated_time += div_u64(nbits * NSEC_PER_SEC, xfer->speed_hz);
588 }
589
590 estimated_time += delay_usecs * NSEC_PER_USEC;
591 if (test->elapsed_time < estimated_time) {
592 dev_err(&spi->dev,
593 "elapsed time %lld ns is shorter than minimum estimated time %lld ns\n",
594 test->elapsed_time, estimated_time);
595
596 return -EINVAL;
597 }
598
599 return 0;
600}
601
602static int spi_test_check_loopback_result(struct spi_device *spi,
603 struct spi_message *msg,
604 void *tx, void *rx)
605{
606 struct spi_transfer *xfer;
607 u8 rxb, txb;
608 size_t i;
609 int ret;
610
611 /* checks rx_buffer pattern are valid with loopback or without */
612 if (check_ranges) {
613 ret = spi_check_rx_ranges(spi, msg, rx);
614 if (ret)
615 return ret;
616 }
617
618 /* if we run without loopback, then return now */
619 if (!loopback)
620 return 0;
621
622 /* if applicable to transfer check that rx_buf is equal to tx_buf */
623 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
624 /* if there is no rx, then no check is needed */
625 if (!xfer->len || !xfer->rx_buf)
626 continue;
627 /* so depending on tx_buf we need to handle things */
628 if (xfer->tx_buf) {
629 for (i = 0; i < xfer->len; i++) {
630 txb = ((u8 *)xfer->tx_buf)[i];
631 rxb = ((u8 *)xfer->rx_buf)[i];
632 if (txb != rxb)
633 goto mismatch_error;
634 }
635 } else {
636 /* first byte received */
637 txb = ((u8 *)xfer->rx_buf)[0];
638 /* first byte may be 0 or xff */
639 if (!((txb == 0) || (txb == 0xff))) {
640 dev_err(&spi->dev,
641 "loopback strangeness - we expect 0x00 or 0xff, but not 0x%02x\n",
642 txb);
643 return -EINVAL;
644 }
645 /* check that all bytes are identical */
646 for (i = 1; i < xfer->len; i++) {
647 rxb = ((u8 *)xfer->rx_buf)[i];
648 if (rxb != txb)
649 goto mismatch_error;
650 }
651 }
652 }
653
654 return 0;
655
656mismatch_error:
657 dev_err(&spi->dev,
658 "loopback strangeness - transfer mismatch on byte %04zx - expected 0x%02x, but got 0x%02x\n",
659 i, txb, rxb);
660
661 return -EINVAL;
662}
663
664static int spi_test_translate(struct spi_device *spi,
665 void **ptr, size_t len,
666 void *tx, void *rx)
667{
668 size_t off;
669
670 /* return on null */
671 if (!*ptr)
672 return 0;
673
674 /* in the MAX_SIZE_HALF case modify the pointer */
675 if (((size_t)*ptr) & SPI_TEST_MAX_SIZE_HALF)
676 /* move the pointer to the correct range */
677 *ptr += (SPI_TEST_MAX_SIZE_PLUS / 2) -
678 SPI_TEST_MAX_SIZE_HALF;
679
680 /* RX range
681 * - we check against MAX_SIZE_PLUS to allow for automated alignment
682 */
683 if (RANGE_CHECK(*ptr, len, RX(0), SPI_TEST_MAX_SIZE_PLUS)) {
684 off = *ptr - RX(0);
685 *ptr = rx + off;
686
687 return 0;
688 }
689
690 /* TX range */
691 if (RANGE_CHECK(*ptr, len, TX(0), SPI_TEST_MAX_SIZE_PLUS)) {
692 off = *ptr - TX(0);
693 *ptr = tx + off;
694
695 return 0;
696 }
697
698 dev_err(&spi->dev,
699 "PointerRange [%pK:%pK[ not in range [%pK:%pK[ or [%pK:%pK[\n",
700 *ptr, *ptr + len,
701 RX(0), RX(SPI_TEST_MAX_SIZE),
702 TX(0), TX(SPI_TEST_MAX_SIZE));
703
704 return -EINVAL;
705}
706
707static int spi_test_fill_pattern(struct spi_device *spi,
708 struct spi_test *test)
709{
710 struct spi_transfer *xfers = test->transfers;
711 u8 *tx_buf;
712 size_t count = 0;
713 int i, j;
714
715#ifdef __BIG_ENDIAN
716#define GET_VALUE_BYTE(value, index, bytes) \
717 (value >> (8 * (bytes - 1 - count % bytes)))
718#else
719#define GET_VALUE_BYTE(value, index, bytes) \
720 (value >> (8 * (count % bytes)))
721#endif
722
723 /* fill all transfers with the pattern requested */
724 for (i = 0; i < test->transfer_count; i++) {
725 /* fill rx_buf with SPI_TEST_PATTERN_UNWRITTEN */
726 if (xfers[i].rx_buf)
727 memset(xfers[i].rx_buf, SPI_TEST_PATTERN_UNWRITTEN,
728 xfers[i].len);
729 /* if tx_buf is NULL then skip */
730 tx_buf = (u8 *)xfers[i].tx_buf;
731 if (!tx_buf)
732 continue;
733 /* modify all the transfers */
734 for (j = 0; j < xfers[i].len; j++, tx_buf++, count++) {
735 /* fill tx */
736 switch (test->fill_option) {
737 case FILL_MEMSET_8:
738 *tx_buf = test->fill_pattern;
739 break;
740 case FILL_MEMSET_16:
741 *tx_buf = GET_VALUE_BYTE(test->fill_pattern,
742 count, 2);
743 break;
744 case FILL_MEMSET_24:
745 *tx_buf = GET_VALUE_BYTE(test->fill_pattern,
746 count, 3);
747 break;
748 case FILL_MEMSET_32:
749 *tx_buf = GET_VALUE_BYTE(test->fill_pattern,
750 count, 4);
751 break;
752 case FILL_COUNT_8:
753 *tx_buf = count;
754 break;
755 case FILL_COUNT_16:
756 *tx_buf = GET_VALUE_BYTE(count, count, 2);
757 break;
758 case FILL_COUNT_24:
759 *tx_buf = GET_VALUE_BYTE(count, count, 3);
760 break;
761 case FILL_COUNT_32:
762 *tx_buf = GET_VALUE_BYTE(count, count, 4);
763 break;
764 case FILL_TRANSFER_BYTE_8:
765 *tx_buf = j;
766 break;
767 case FILL_TRANSFER_BYTE_16:
768 *tx_buf = GET_VALUE_BYTE(j, j, 2);
769 break;
770 case FILL_TRANSFER_BYTE_24:
771 *tx_buf = GET_VALUE_BYTE(j, j, 3);
772 break;
773 case FILL_TRANSFER_BYTE_32:
774 *tx_buf = GET_VALUE_BYTE(j, j, 4);
775 break;
776 case FILL_TRANSFER_NUM:
777 *tx_buf = i;
778 break;
779 default:
780 dev_err(&spi->dev,
781 "unsupported fill_option: %i\n",
782 test->fill_option);
783 return -EINVAL;
784 }
785 }
786 }
787
788 return 0;
789}
790
791static int _spi_test_run_iter(struct spi_device *spi,
792 struct spi_test *test,
793 void *tx, void *rx)
794{
795 struct spi_message *msg = &test->msg;
796 struct spi_transfer *x;
797 int i, ret;
798
799 /* initialize message - zero-filled via static initialization */
800 spi_message_init_no_memset(msg);
801
802 /* fill rx with the DO_NOT_WRITE pattern */
803 memset(rx, SPI_TEST_PATTERN_DO_NOT_WRITE, SPI_TEST_MAX_SIZE_PLUS);
804
805 /* add the individual transfers */
806 for (i = 0; i < test->transfer_count; i++) {
807 x = &test->transfers[i];
808
809 /* patch the values of tx_buf */
810 ret = spi_test_translate(spi, (void **)&x->tx_buf, x->len,
811 (void *)tx, rx);
812 if (ret)
813 return ret;
814
815 /* patch the values of rx_buf */
816 ret = spi_test_translate(spi, &x->rx_buf, x->len,
817 (void *)tx, rx);
818 if (ret)
819 return ret;
820
821 /* and add it to the list */
822 spi_message_add_tail(x, msg);
823 }
824
825 /* fill in the transfer buffers with pattern */
826 ret = spi_test_fill_pattern(spi, test);
827 if (ret)
828 return ret;
829
830 /* and execute */
831 if (test->execute_msg)
832 ret = test->execute_msg(spi, test, tx, rx);
833 else
834 ret = spi_test_execute_msg(spi, test, tx, rx);
835
836 /* handle result */
837 if (ret == test->expected_return)
838 return 0;
839
840 dev_err(&spi->dev,
841 "test failed - test returned %i, but we expect %i\n",
842 ret, test->expected_return);
843
844 if (ret)
845 return ret;
846
847 /* if it is 0, as we expected something else,
848 * then return something special
849 */
850 return -EFAULT;
851}
852
853static int spi_test_run_iter(struct spi_device *spi,
854 const struct spi_test *testtemplate,
855 void *tx, void *rx,
856 size_t len,
857 size_t tx_off,
858 size_t rx_off
859 )
860{
861 struct spi_test test;
862 int i, tx_count, rx_count;
863
864 /* copy the test template to test */
865 memcpy(&test, testtemplate, sizeof(test));
866
867 /* if iterate_transfer_mask is not set,
868 * then set it to first transfer only
869 */
870 if (!(test.iterate_transfer_mask & (BIT(test.transfer_count) - 1)))
871 test.iterate_transfer_mask = 1;
872
873 /* count number of transfers with tx/rx_buf != NULL */
874 rx_count = tx_count = 0;
875 for (i = 0; i < test.transfer_count; i++) {
876 if (test.transfers[i].tx_buf)
877 tx_count++;
878 if (test.transfers[i].rx_buf)
879 rx_count++;
880 }
881
882 /* in some iteration cases warn and exit early,
883 * as there is nothing to do, that has not been tested already...
884 */
885 if (tx_off && (!tx_count)) {
886 dev_warn_once(&spi->dev,
887 "%s: iterate_tx_off configured with tx_buf==NULL - ignoring\n",
888 test.description);
889 return 0;
890 }
891 if (rx_off && (!rx_count)) {
892 dev_warn_once(&spi->dev,
893 "%s: iterate_rx_off configured with rx_buf==NULL - ignoring\n",
894 test.description);
895 return 0;
896 }
897
898 /* write out info */
899 if (!(len || tx_off || rx_off)) {
900 dev_info(&spi->dev, "Running test %s\n", test.description);
901 } else {
902 dev_info(&spi->dev,
903 " with iteration values: len = %zu, tx_off = %zu, rx_off = %zu\n",
904 len, tx_off, rx_off);
905 }
906
907 /* update in the values from iteration values */
908 for (i = 0; i < test.transfer_count; i++) {
909 /* only when bit in transfer mask is set */
910 if (!(test.iterate_transfer_mask & BIT(i)))
911 continue;
912 test.transfers[i].len = len;
913 if (test.transfers[i].tx_buf)
914 test.transfers[i].tx_buf += tx_off;
915 if (test.transfers[i].rx_buf)
916 test.transfers[i].rx_buf += rx_off;
917 }
918
919 /* and execute */
920 return _spi_test_run_iter(spi, &test, tx, rx);
921}
922
923/**
924 * spi_test_execute_msg - default implementation to run a test
925 *
926 * @spi: @spi_device on which to run the @spi_message
927 * @test: the test to execute, which already contains @msg
928 * @tx: the tx buffer allocated for the test sequence
929 * @rx: the rx buffer allocated for the test sequence
930 *
931 * Returns: error code of spi_sync as well as basic error checking
932 */
933int spi_test_execute_msg(struct spi_device *spi, struct spi_test *test,
934 void *tx, void *rx)
935{
936 struct spi_message *msg = &test->msg;
937 int ret = 0;
938 int i;
939
940 /* only if we do not simulate */
941 if (!simulate_only) {
942 ktime_t start;
943
944 /* dump the complete message before and after the transfer */
945 if (dump_messages == 3)
946 spi_test_dump_message(spi, msg, true);
947
948 start = ktime_get();
949 /* run spi message */
950 ret = spi_sync(spi, msg);
951 test->elapsed_time = ktime_to_ns(ktime_sub(ktime_get(), start));
952 if (ret == -ETIMEDOUT) {
953 dev_info(&spi->dev,
954 "spi-message timed out - rerunning...\n");
955 /* rerun after a few explicit schedules */
956 for (i = 0; i < 16; i++)
957 schedule();
958 ret = spi_sync(spi, msg);
959 }
960 if (ret) {
961 dev_err(&spi->dev,
962 "Failed to execute spi_message: %i\n",
963 ret);
964 goto exit;
965 }
966
967 /* do some extra error checks */
968 if (msg->frame_length != msg->actual_length) {
969 dev_err(&spi->dev,
970 "actual length differs from expected\n");
971 ret = -EIO;
972 goto exit;
973 }
974
975 /* run rx-buffer tests */
976 ret = spi_test_check_loopback_result(spi, msg, tx, rx);
977 if (ret)
978 goto exit;
979
980 ret = spi_test_check_elapsed_time(spi, test);
981 }
982
983 /* if requested or on error dump message (including data) */
984exit:
985 if (dump_messages || ret)
986 spi_test_dump_message(spi, msg,
987 (dump_messages >= 2) || (ret));
988
989 return ret;
990}
991EXPORT_SYMBOL_GPL(spi_test_execute_msg);
992
993/**
994 * spi_test_run_test - run an individual spi_test
995 * including all the relevant iterations on:
996 * length and buffer alignment
997 *
998 * @spi: the spi_device to send the messages to
999 * @test: the test which we need to execute
1000 * @tx: the tx buffer allocated for the test sequence
1001 * @rx: the rx buffer allocated for the test sequence
1002 *
1003 * Returns: status code of spi_sync or other failures
1004 */
1005
1006int spi_test_run_test(struct spi_device *spi, const struct spi_test *test,
1007 void *tx, void *rx)
1008{
1009 int idx_len;
1010 size_t len;
1011 size_t tx_align, rx_align;
1012 int ret;
1013
1014 /* test for transfer limits */
1015 if (test->transfer_count >= SPI_TEST_MAX_TRANSFERS) {
1016 dev_err(&spi->dev,
1017 "%s: Exceeded max number of transfers with %i\n",
1018 test->description, test->transfer_count);
1019 return -E2BIG;
1020 }
1021
1022 /* setting up some values in spi_message
1023 * based on some settings in spi_master
1024 * some of this can also get done in the run() method
1025 */
1026
1027 /* iterate over all the iterable values using macros
1028 * (to make it a bit more readable...
1029 */
1030#define FOR_EACH_ALIGNMENT(var) \
1031 for (var = 0; \
1032 var < (test->iterate_##var ? \
1033 (spi->controller->dma_alignment ? \
1034 spi->controller->dma_alignment : \
1035 test->iterate_##var) : \
1036 1); \
1037 var++)
1038
1039 for (idx_len = 0; idx_len < SPI_TEST_MAX_ITERATE &&
1040 (len = test->iterate_len[idx_len]) != -1; idx_len++) {
1041 if ((run_only_iter_len > -1) && len != run_only_iter_len)
1042 continue;
1043 FOR_EACH_ALIGNMENT(tx_align) {
1044 FOR_EACH_ALIGNMENT(rx_align) {
1045 /* and run the iteration */
1046 ret = spi_test_run_iter(spi, test,
1047 tx, rx,
1048 len,
1049 tx_align,
1050 rx_align);
1051 if (ret)
1052 return ret;
1053 }
1054 }
1055 }
1056
1057 return 0;
1058}
1059EXPORT_SYMBOL_GPL(spi_test_run_test);
1060
1061/**
1062 * spi_test_run_tests - run an array of spi_messages tests
1063 * @spi: the spi device on which to run the tests
1064 * @tests: NULL-terminated array of @spi_test
1065 *
1066 * Returns: status errors as per @spi_test_run_test()
1067 */
1068
1069int spi_test_run_tests(struct spi_device *spi,
1070 struct spi_test *tests)
1071{
1072 char *rx = NULL, *tx = NULL;
1073 int ret = 0, count = 0;
1074 struct spi_test *test;
1075
1076 /* allocate rx/tx buffers of 128kB size without devm
1077 * in the hope that is on a page boundary
1078 */
1079 if (use_vmalloc)
1080 rx = vmalloc(SPI_TEST_MAX_SIZE_PLUS);
1081 else
1082 rx = kzalloc(SPI_TEST_MAX_SIZE_PLUS, GFP_KERNEL);
1083 if (!rx)
1084 return -ENOMEM;
1085
1086
1087 if (use_vmalloc)
1088 tx = vmalloc(SPI_TEST_MAX_SIZE_PLUS);
1089 else
1090 tx = kzalloc(SPI_TEST_MAX_SIZE_PLUS, GFP_KERNEL);
1091 if (!tx) {
1092 ret = -ENOMEM;
1093 goto err_tx;
1094 }
1095
1096 /* now run the individual tests in the table */
1097 for (test = tests, count = 0; test->description[0];
1098 test++, count++) {
1099 /* only run test if requested */
1100 if ((run_only_test > -1) && (count != run_only_test))
1101 continue;
1102 /* run custom implementation */
1103 if (test->run_test)
1104 ret = test->run_test(spi, test, tx, rx);
1105 else
1106 ret = spi_test_run_test(spi, test, tx, rx);
1107 if (ret)
1108 goto out;
1109 /* add some delays so that we can easily
1110 * detect the individual tests when using a logic analyzer
1111 * we also add scheduling to avoid potential spi_timeouts...
1112 */
1113 if (delay_ms)
1114 mdelay(delay_ms);
1115 schedule();
1116 }
1117
1118out:
1119 kvfree(tx);
1120err_tx:
1121 kvfree(rx);
1122 return ret;
1123}
1124EXPORT_SYMBOL_GPL(spi_test_run_tests);