SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/dma/dmatest.c

   1 /*
   2  * DMA Engine test module
   3  *
   4  * Copyright (C) 2007 Atmel Corporation
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  */
  10 #include <linux/delay.h>
  11 #include <linux/dmaengine.h>
  12 #include <linux/init.h>
  13 #include <linux/kthread.h>
  14 #include <linux/module.h>
  15 #include <linux/moduleparam.h>
  16 #include <linux/random.h>
  17 #include <linux/wait.h>
  18
  19 static unsigned int test_buf_size = 16384;
  20 module_param(test_buf_size, uint, S_IRUGO);
  21 MODULE_PARM_DESC(test_buf_size, "Size of the memcpy test buffer");
  22
  23 static char test_channel[20];
  24 module_param_string(channel, test_channel, sizeof(test_channel), S_IRUGO);
  25 MODULE_PARM_DESC(channel, "Bus ID of the channel to test (default: any)");
  26
  27 static char test_device[20];
  28 module_param_string(device, test_device, sizeof(test_device), S_IRUGO);
  29 MODULE_PARM_DESC(device, "Bus ID of the DMA Engine to test (default: any)");
  30
  31 static unsigned int threads_per_chan = 1;
  32 module_param(threads_per_chan, uint, S_IRUGO);
  33 MODULE_PARM_DESC(threads_per_chan,
  34                 "Number of threads to start per channel (default: 1)");
  35
  36 static unsigned int max_channels;
  37 module_param(max_channels, uint, S_IRUGO);
  38 MODULE_PARM_DESC(max_channels,
  39                 "Maximum number of channels to use (default: all)");
  40
  41 static unsigned int xor_sources = 3;
  42 module_param(xor_sources, uint, S_IRUGO);
  43 MODULE_PARM_DESC(xor_sources,
  44                 "Number of xor source buffers (default: 3)");
  45
  46 static unsigned int pq_sources = 3;
  47 module_param(pq_sources, uint, S_IRUGO);
  48 MODULE_PARM_DESC(pq_sources,
  49                 "Number of p+q source buffers (default: 3)");
  50
  51 /*
  52  * Initialization patterns. All bytes in the source buffer has bit 7
  53  * set, all bytes in the destination buffer has bit 7 cleared.
  54  *
  55  * Bit 6 is set for all bytes which are to be copied by the DMA
  56  * engine. Bit 5 is set for all bytes which are to be overwritten by
  57  * the DMA engine.
  58  *
  59  * The remaining bits are the inverse of a counter which increments by
  60  * one for each byte address.
  61  */
  62 #define PATTERN_SRC             0x80
  63 #define PATTERN_DST             0x00
  64 #define PATTERN_COPY            0x40
  65 #define PATTERN_OVERWRITE       0x20
  66 #define PATTERN_COUNT_MASK      0x1f
  67
  68 struct dmatest_thread {
  69         struct list_head        node;
  70         struct task_struct      *task;
  71         struct dma_chan         *chan;
  72         u8                      **srcs;
  73         u8                      **dsts;
  74         enum dma_transaction_type type;
  75 };
  76
  77 struct dmatest_chan {
  78         struct list_head        node;
  79         struct dma_chan         *chan;
  80         struct list_head        threads;
  81 };
  82
  83 /*
  84  * These are protected by dma_list_mutex since they're only used by
  85  * the DMA filter function callback
  86  */
  87 static LIST_HEAD(dmatest_channels);
  88 static unsigned int nr_channels;
  89
  90 static bool dmatest_match_channel(struct dma_chan *chan)
  91 {
  92         if (test_channel[0] == '\0')
  93                 return true;
  94         return strcmp(dma_chan_name(chan), test_channel) == 0;
  95 }
  96
  97 static bool dmatest_match_device(struct dma_device *device)
  98 {
  99         if (test_device[0] == '\0')
 100                 return true;
 101         return strcmp(dev_name(device->dev), test_device) == 0;
 102 }
 103
 104 static unsigned long dmatest_random(void)
 105 {
 106         unsigned long buf;
 107
 108         get_random_bytes(&buf, sizeof(buf));
 109         return buf;
 110 }
 111
 112 static void dmatest_init_srcs(u8 **bufs, unsigned int start, unsigned int len)
 113 {
 114         unsigned int i;
 115         u8 *buf;
 116
 117         for (; (buf = *bufs); bufs++) {
 118                 for (i = 0; i < start; i++)
 119                         buf[i] = PATTERN_SRC | (~i & PATTERN_COUNT_MASK);
 120                 for ( ; i < start + len; i++)
 121                         buf[i] = PATTERN_SRC | PATTERN_COPY
 122                                 | (~i & PATTERN_COUNT_MASK);;
 123                 for ( ; i < test_buf_size; i++)
 124                         buf[i] = PATTERN_SRC | (~i & PATTERN_COUNT_MASK);
 125                 buf++;
 126         }
 127 }
 128
 129 static void dmatest_init_dsts(u8 **bufs, unsigned int start, unsigned int len)
 130 {
 131         unsigned int i;
 132         u8 *buf;
 133
 134         for (; (buf = *bufs); bufs++) {
 135                 for (i = 0; i < start; i++)
 136                         buf[i] = PATTERN_DST | (~i & PATTERN_COUNT_MASK);
 137                 for ( ; i < start + len; i++)
 138                         buf[i] = PATTERN_DST | PATTERN_OVERWRITE
 139                                 | (~i & PATTERN_COUNT_MASK);
 140                 for ( ; i < test_buf_size; i++)
 141                         buf[i] = PATTERN_DST | (~i & PATTERN_COUNT_MASK);
 142         }
 143 }
 144
 145 static void dmatest_mismatch(u8 actual, u8 pattern, unsigned int index,
 146                 unsigned int counter, bool is_srcbuf)
 147 {
 148         u8              diff = actual ^ pattern;
 149         u8              expected = pattern | (~counter & PATTERN_COUNT_MASK);
 150         const char      *thread_name = current->comm;
 151
 152         if (is_srcbuf)
 153                 pr_warning("%s: srcbuf[0x%x] overwritten!"
 154                                 " Expected %02x, got %02x\n",
 155                                 thread_name, index, expected, actual);
 156         else if ((pattern & PATTERN_COPY)
 157                         && (diff & (PATTERN_COPY | PATTERN_OVERWRITE)))
 158                 pr_warning("%s: dstbuf[0x%x] not copied!"
 159                                 " Expected %02x, got %02x\n",
 160                                 thread_name, index, expected, actual);
 161         else if (diff & PATTERN_SRC)
 162                 pr_warning("%s: dstbuf[0x%x] was copied!"
 163                                 " Expected %02x, got %02x\n",
 164                                 thread_name, index, expected, actual);
 165         else
 166                 pr_warning("%s: dstbuf[0x%x] mismatch!"
 167                                 " Expected %02x, got %02x\n",
 168                                 thread_name, index, expected, actual);
 169 }
 170
 171 static unsigned int dmatest_verify(u8 **bufs, unsigned int start,
 172                 unsigned int end, unsigned int counter, u8 pattern,
 173                 bool is_srcbuf)
 174 {
 175         unsigned int i;
 176         unsigned int error_count = 0;
 177         u8 actual;
 178         u8 expected;
 179         u8 *buf;
 180         unsigned int counter_orig = counter;
 181
 182         for (; (buf = *bufs); bufs++) {
 183                 counter = counter_orig;
 184                 for (i = start; i < end; i++) {
 185                         actual = buf[i];
 186                         expected = pattern | (~counter & PATTERN_COUNT_MASK);
 187                         if (actual != expected) {
 188                                 if (error_count < 32)
 189                                         dmatest_mismatch(actual, pattern, i,
 190                                                          counter, is_srcbuf);
 191                                 error_count++;
 192                         }
 193                         counter++;
 194                 }
 195         }
 196
 197         if (error_count > 32)
 198                 pr_warning("%s: %u errors suppressed\n",
 199                         current->comm, error_count - 32);
 200
 201         return error_count;
 202 }
 203
 204 static void dmatest_callback(void *completion)
 205 {
 206         complete(completion);
 207 }
 208
 209 /*
 210  * This function repeatedly tests DMA transfers of various lengths and
 211  * offsets for a given operation type until it is told to exit by
 212  * kthread_stop(). There may be multiple threads running this function
 213  * in parallel for a single channel, and there may be multiple channels
 214  * being tested in parallel.
 215  *
 216  * Before each test, the source and destination buffer is initialized
 217  * with a known pattern. This pattern is different depending on
 218  * whether it's in an area which is supposed to be copied or
 219  * overwritten, and different in the source and destination buffers.
 220  * So if the DMA engine doesn't copy exactly what we tell it to copy,
 221  * we'll notice.
 222  */
 223 static int dmatest_func(void *data)
 224 {
 225         struct dmatest_thread   *thread = data;
 226         struct dma_chan         *chan;
 227         const char              *thread_name;
 228         unsigned int            src_off, dst_off, len;
 229         unsigned int            error_count;
 230         unsigned int            failed_tests = 0;
 231         unsigned int            total_tests = 0;
 232         dma_cookie_t            cookie;
 233         enum dma_status         status;
 234         enum dma_ctrl_flags     flags;
 235         u8                      pq_coefs[pq_sources];
 236         int                     ret;
 237         int                     src_cnt;
 238         int                     dst_cnt;
 239         int                     i;
 240
 241         thread_name = current->comm;
 242
 243         ret = -ENOMEM;
 244
 245         smp_rmb();
 246         chan = thread->chan;
 247         if (thread->type == DMA_MEMCPY)
 248                 src_cnt = dst_cnt = 1;
 249         else if (thread->type == DMA_XOR) {
 250                 src_cnt = xor_sources | 1; /* force odd to ensure dst = src */
 251                 dst_cnt = 1;
 252         } else if (thread->type == DMA_PQ) {
 253                 src_cnt = pq_sources | 1; /* force odd to ensure dst = src */
 254                 dst_cnt = 2;
 255                 for (i = 0; i < pq_sources; i++)
 256                         pq_coefs[i] = 1;
 257         } else
 258                 goto err_srcs;
 259
 260         thread->srcs = kcalloc(src_cnt+1, sizeof(u8 *), GFP_KERNEL);
 261         if (!thread->srcs)
 262                 goto err_srcs;
 263         for (i = 0; i < src_cnt; i++) {
 264                 thread->srcs[i] = kmalloc(test_buf_size, GFP_KERNEL);
 265                 if (!thread->srcs[i])
 266                         goto err_srcbuf;
 267         }
 268         thread->srcs[i] = NULL;
 269
 270         thread->dsts = kcalloc(dst_cnt+1, sizeof(u8 *), GFP_KERNEL);
 271         if (!thread->dsts)
 272                 goto err_dsts;
 273         for (i = 0; i < dst_cnt; i++) {
 274                 thread->dsts[i] = kmalloc(test_buf_size, GFP_KERNEL);
 275                 if (!thread->dsts[i])
 276                         goto err_dstbuf;
 277         }
 278         thread->dsts[i] = NULL;
 279
 280         set_user_nice(current, 10);
 281
 282         flags = DMA_CTRL_ACK | DMA_COMPL_SKIP_DEST_UNMAP | DMA_PREP_INTERRUPT;
 283
 284         while (!kthread_should_stop()) {
 285                 struct dma_device *dev = chan->device;
 286                 struct dma_async_tx_descriptor *tx = NULL;
 287                 dma_addr_t dma_srcs[src_cnt];
 288                 dma_addr_t dma_dsts[dst_cnt];
 289                 struct completion cmp;
 290                 unsigned long tmo = msecs_to_jiffies(3000);
 291                 u8 align = 0;
 292
 293                 total_tests++;
 294
 295                 len = dmatest_random() % test_buf_size + 1;
 296                 src_off = dmatest_random() % (test_buf_size - len + 1);
 297                 dst_off = dmatest_random() % (test_buf_size - len + 1);
 298
 299                 /* honor alignment restrictions */
 300                 if (thread->type == DMA_MEMCPY)
 301                         align = dev->copy_align;
 302                 else if (thread->type == DMA_XOR)
 303                         align = dev->xor_align;
 304                 else if (thread->type == DMA_PQ)
 305                         align = dev->pq_align;
 306
 307                 len = (len >> align) << align;
 308                 src_off = (src_off >> align) << align;
 309                 dst_off = (dst_off >> align) << align;
 310
 311                 dmatest_init_srcs(thread->srcs, src_off, len);
 312                 dmatest_init_dsts(thread->dsts, dst_off, len);
 313
 314                 for (i = 0; i < src_cnt; i++) {
 315                         u8 *buf = thread->srcs[i] + src_off;
 316
 317                         dma_srcs[i] = dma_map_single(dev->dev, buf, len,
 318                                                      DMA_TO_DEVICE);
 319                 }
 320                 /* map with DMA_BIDIRECTIONAL to force writeback/invalidate */
 321                 for (i = 0; i < dst_cnt; i++) {
 322                         dma_dsts[i] = dma_map_single(dev->dev, thread->dsts[i],
 323                                                      test_buf_size,
 324                                                      DMA_BIDIRECTIONAL);
 325                 }
 326
 327
 328                 if (thread->type == DMA_MEMCPY)
 329                         tx = dev->device_prep_dma_memcpy(chan,
 330                                                          dma_dsts[0] + dst_off,
 331                                                          dma_srcs[0], len,
 332                                                          flags);
 333                 else if (thread->type == DMA_XOR)
 334                         tx = dev->device_prep_dma_xor(chan,
 335                                                       dma_dsts[0] + dst_off,
 336                                                       dma_srcs, xor_sources,
 337                                                       len, flags);
 338                 else if (thread->type == DMA_PQ) {
 339                         dma_addr_t dma_pq[dst_cnt];
 340
 341                         for (i = 0; i < dst_cnt; i++)
 342                                 dma_pq[i] = dma_dsts[i] + dst_off;
 343                         tx = dev->device_prep_dma_pq(chan, dma_pq, dma_srcs,
 344                                                      pq_sources, pq_coefs,
 345                                                      len, flags);
 346                 }
 347
 348                 if (!tx) {
 349                         for (i = 0; i < src_cnt; i++)
 350                                 dma_unmap_single(dev->dev, dma_srcs[i], len,
 351                                                  DMA_TO_DEVICE);
 352                         for (i = 0; i < dst_cnt; i++)
 353                                 dma_unmap_single(dev->dev, dma_dsts[i],
 354                                                  test_buf_size,
 355                                                  DMA_BIDIRECTIONAL);
 356                         pr_warning("%s: #%u: prep error with src_off=0x%x "
 357                                         "dst_off=0x%x len=0x%x\n",
 358                                         thread_name, total_tests - 1,
 359                                         src_off, dst_off, len);
 360                         msleep(100);
 361                         failed_tests++;
 362                         continue;
 363                 }
 364
 365                 init_completion(&cmp);
 366                 tx->callback = dmatest_callback;
 367                 tx->callback_param = &cmp;
 368                 cookie = tx->tx_submit(tx);
 369
 370                 if (dma_submit_error(cookie)) {
 371                         pr_warning("%s: #%u: submit error %d with src_off=0x%x "
 372                                         "dst_off=0x%x len=0x%x\n",
 373                                         thread_name, total_tests - 1, cookie,
 374                                         src_off, dst_off, len);
 375                         msleep(100);
 376                         failed_tests++;
 377                         continue;
 378                 }
 379                 dma_async_issue_pending(chan);
 380
 381                 tmo = wait_for_completion_timeout(&cmp, tmo);
 382                 status = dma_async_is_tx_complete(chan, cookie, NULL, NULL);
 383
 384                 if (tmo == 0) {
 385                         pr_warning("%s: #%u: test timed out\n",
 386                                    thread_name, total_tests - 1);
 387                         failed_tests++;
 388                         continue;
 389                 } else if (status != DMA_SUCCESS) {
 390                         pr_warning("%s: #%u: got completion callback,"
 391                                    " but status is \'%s\'\n",
 392                                    thread_name, total_tests - 1,
 393                                    status == DMA_ERROR ? "error" : "in progress");
 394                         failed_tests++;
 395                         continue;
 396                 }
 397
 398                 /* Unmap by myself (see DMA_COMPL_SKIP_DEST_UNMAP above) */
 399                 for (i = 0; i < dst_cnt; i++)
 400                         dma_unmap_single(dev->dev, dma_dsts[i], test_buf_size,
 401                                          DMA_BIDIRECTIONAL);
 402
 403                 error_count = 0;
 404
 405                 pr_debug("%s: verifying source buffer...\n", thread_name);
 406                 error_count += dmatest_verify(thread->srcs, 0, src_off,
 407                                 0, PATTERN_SRC, true);
 408                 error_count += dmatest_verify(thread->srcs, src_off,
 409                                 src_off + len, src_off,
 410                                 PATTERN_SRC | PATTERN_COPY, true);
 411                 error_count += dmatest_verify(thread->srcs, src_off + len,
 412                                 test_buf_size, src_off + len,
 413                                 PATTERN_SRC, true);
 414
 415                 pr_debug("%s: verifying dest buffer...\n",
 416                                 thread->task->comm);
 417                 error_count += dmatest_verify(thread->dsts, 0, dst_off,
 418                                 0, PATTERN_DST, false);
 419                 error_count += dmatest_verify(thread->dsts, dst_off,
 420                                 dst_off + len, src_off,
 421                                 PATTERN_SRC | PATTERN_COPY, false);
 422                 error_count += dmatest_verify(thread->dsts, dst_off + len,
 423                                 test_buf_size, dst_off + len,
 424                                 PATTERN_DST, false);
 425
 426                 if (error_count) {
 427                         pr_warning("%s: #%u: %u errors with "
 428                                 "src_off=0x%x dst_off=0x%x len=0x%x\n",
 429                                 thread_name, total_tests - 1, error_count,
 430                                 src_off, dst_off, len);
 431                         failed_tests++;
 432                 } else {
 433                         pr_debug("%s: #%u: No errors with "
 434                                 "src_off=0x%x dst_off=0x%x len=0x%x\n",
 435                                 thread_name, total_tests - 1,
 436                                 src_off, dst_off, len);
 437                 }
 438         }
 439
 440         ret = 0;
 441         for (i = 0; thread->dsts[i]; i++)
 442                 kfree(thread->dsts[i]);
 443 err_dstbuf:
 444         kfree(thread->dsts);
 445 err_dsts:
 446         for (i = 0; thread->srcs[i]; i++)
 447                 kfree(thread->srcs[i]);
 448 err_srcbuf:
 449         kfree(thread->srcs);
 450 err_srcs:
 451         pr_notice("%s: terminating after %u tests, %u failures (status %d)\n",
 452                         thread_name, total_tests, failed_tests, ret);
 453         return ret;
 454 }
 455
 456 static void dmatest_cleanup_channel(struct dmatest_chan *dtc)
 457 {
 458         struct dmatest_thread   *thread;
 459         struct dmatest_thread   *_thread;
 460         int                     ret;
 461
 462         list_for_each_entry_safe(thread, _thread, &dtc->threads, node) {
 463                 ret = kthread_stop(thread->task);
 464                 pr_debug("dmatest: thread %s exited with status %d\n",
 465                                 thread->task->comm, ret);
 466                 list_del(&thread->node);
 467                 kfree(thread);
 468         }
 469         kfree(dtc);
 470 }
 471
 472 static int dmatest_add_threads(struct dmatest_chan *dtc, enum dma_transaction_type type)
 473 {
 474         struct dmatest_thread *thread;
 475         struct dma_chan *chan = dtc->chan;
 476         char *op;
 477         unsigned int i;
 478
 479         if (type == DMA_MEMCPY)
 480                 op = "copy";
 481         else if (type == DMA_XOR)
 482                 op = "xor";
 483         else if (type == DMA_PQ)
 484                 op = "pq";
 485         else
 486                 return -EINVAL;
 487
 488         for (i = 0; i < threads_per_chan; i++) {
 489                 thread = kzalloc(sizeof(struct dmatest_thread), GFP_KERNEL);
 490                 if (!thread) {
 491                         pr_warning("dmatest: No memory for %s-%s%u\n",
 492                                    dma_chan_name(chan), op, i);
 493
 494                         break;
 495                 }
 496                 thread->chan = dtc->chan;
 497                 thread->type = type;
 498                 smp_wmb();
 499                 thread->task = kthread_run(dmatest_func, thread, "%s-%s%u",
 500                                 dma_chan_name(chan), op, i);
 501                 if (IS_ERR(thread->task)) {
 502                         pr_warning("dmatest: Failed to run thread %s-%s%u\n",
 503                                         dma_chan_name(chan), op, i);
 504                         kfree(thread);
 505                         break;
 506                 }
 507
 508                 /* srcbuf and dstbuf are allocated by the thread itself */
 509
 510                 list_add_tail(&thread->node, &dtc->threads);
 511         }
 512
 513         return i;
 514 }
 515
 516 static int dmatest_add_channel(struct dma_chan *chan)
 517 {
 518         struct dmatest_chan     *dtc;
 519         struct dma_device       *dma_dev = chan->device;
 520         unsigned int            thread_count = 0;
 521         unsigned int            cnt;
 522
 523         dtc = kmalloc(sizeof(struct dmatest_chan), GFP_KERNEL);
 524         if (!dtc) {
 525                 pr_warning("dmatest: No memory for %s\n", dma_chan_name(chan));
 526                 return -ENOMEM;
 527         }
 528
 529         dtc->chan = chan;
 530         INIT_LIST_HEAD(&dtc->threads);
 531
 532         if (dma_has_cap(DMA_MEMCPY, dma_dev->cap_mask)) {
 533                 cnt = dmatest_add_threads(dtc, DMA_MEMCPY);
 534                 thread_count += cnt > 0 ?: 0;
 535         }
 536         if (dma_has_cap(DMA_XOR, dma_dev->cap_mask)) {
 537                 cnt = dmatest_add_threads(dtc, DMA_XOR);
 538                 thread_count += cnt > 0 ?: 0;
 539         }
 540         if (dma_has_cap(DMA_PQ, dma_dev->cap_mask)) {
 541                 cnt = dmatest_add_threads(dtc, DMA_PQ);
 542                 thread_count += cnt > 0 ?: 0;
 543         }
 544
 545         pr_info("dmatest: Started %u threads using %s\n",
 546                 thread_count, dma_chan_name(chan));
 547
 548         list_add_tail(&dtc->node, &dmatest_channels);
 549         nr_channels++;
 550
 551         return 0;
 552 }
 553
 554 static bool filter(struct dma_chan *chan, void *param)
 555 {
 556         if (!dmatest_match_channel(chan) || !dmatest_match_device(chan->device))
 557                 return false;
 558         else
 559                 return true;
 560 }
 561
 562 static int __init dmatest_init(void)
 563 {
 564         dma_cap_mask_t mask;
 565         struct dma_chan *chan;
 566         int err = 0;
 567
 568         dma_cap_zero(mask);
 569         dma_cap_set(DMA_MEMCPY, mask);
 570         for (;;) {
 571                 chan = dma_request_channel(mask, filter, NULL);
 572                 if (chan) {
 573                         err = dmatest_add_channel(chan);
 574                         if (err) {
 575                                 dma_release_channel(chan);
 576                                 break; /* add_channel failed, punt */
 577                         }
 578                 } else
 579                         break; /* no more channels available */
 580                 if (max_channels && nr_channels >= max_channels)
 581                         break; /* we have all we need */
 582         }
 583
 584         return err;
 585 }
 586 /* when compiled-in wait for drivers to load first */
 587 late_initcall(dmatest_init);
 588
 589 static void __exit dmatest_exit(void)
 590 {
 591         struct dmatest_chan *dtc, *_dtc;
 592         struct dma_chan *chan;
 593
 594         list_for_each_entry_safe(dtc, _dtc, &dmatest_channels, node) {
 595                 list_del(&dtc->node);
 596                 chan = dtc->chan;
 597                 dmatest_cleanup_channel(dtc);
 598                 pr_debug("dmatest: dropped channel %s\n",
 599                          dma_chan_name(chan));
 600                 dma_release_channel(chan);
 601         }
 602 }
 603 module_exit(dmatest_exit);
 604
 605 MODULE_AUTHOR("Haavard Skinnemoen <hskinnemoen@atmel.com>");
 606 MODULE_LICENSE("GPL v2");