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