drivers/base/dma-contiguous.c

   1 /*
   2  * Contiguous Memory Allocator for DMA mapping framework
   3  * Copyright (c) 2010-2011 by Samsung Electronics.
   4  * Written by:
   5  *      Marek Szyprowski <m.szyprowski@samsung.com>
   6  *      Michal Nazarewicz <mina86@mina86.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License or (at your optional) any later version of the license.
  12  */
  13
  14 #define pr_fmt(fmt) "cma: " fmt
  15
  16 #ifdef CONFIG_CMA_DEBUG
  17 #ifndef DEBUG
  18 #  define DEBUG
  19 #endif
  20 #endif
  21
  22 #include <asm/page.h>
  23 #include <asm/dma-contiguous.h>
  24
  25 #include <linux/memblock.h>
  26 #include <linux/err.h>
  27 #include <linux/mm.h>
  28 #include <linux/mutex.h>
  29 #include <linux/page-isolation.h>
  30 #include <linux/sizes.h>
  31 #include <linux/slab.h>
  32 #include <linux/swap.h>
  33 #include <linux/mm_types.h>
  34 #include <linux/dma-contiguous.h>
  35
  36 struct cma {
  37         unsigned long   base_pfn;
  38         unsigned long   count;
  39         unsigned long   *bitmap;
  40         struct mutex    lock;
  41 };
  42
  43 struct cma *dma_contiguous_default_area;
  44
  45 #ifdef CONFIG_CMA_SIZE_MBYTES
  46 #define CMA_SIZE_MBYTES CONFIG_CMA_SIZE_MBYTES
  47 #else
  48 #define CMA_SIZE_MBYTES 0
  49 #endif
  50
  51 /*
  52  * Default global CMA area size can be defined in kernel's .config.
  53  * This is useful mainly for distro maintainers to create a kernel
  54  * that works correctly for most supported systems.
  55  * The size can be set in bytes or as a percentage of the total memory
  56  * in the system.
  57  *
  58  * Users, who want to set the size of global CMA area for their system
  59  * should use cma= kernel parameter.
  60  */
  61 static const phys_addr_t size_bytes = CMA_SIZE_MBYTES * SZ_1M;
  62 static phys_addr_t size_cmdline = -1;
  63
  64 static int __init early_cma(char *p)
  65 {
  66         pr_debug("%s(%s)\n", __func__, p);
  67         size_cmdline = memparse(p, &p);
  68         return 0;
  69 }
  70 early_param("cma", early_cma);
  71
  72 #ifdef CONFIG_CMA_SIZE_PERCENTAGE
  73
  74 static phys_addr_t __init __maybe_unused cma_early_percent_memory(void)
  75 {
  76         struct memblock_region *reg;
  77         unsigned long total_pages = 0;
  78
  79         /*
  80          * We cannot use memblock_phys_mem_size() here, because
  81          * memblock_analyze() has not been called yet.
  82          */
  83         for_each_memblock(memory, reg)
  84                 total_pages += memblock_region_memory_end_pfn(reg) -
  85                                memblock_region_memory_base_pfn(reg);
  86
  87         return (total_pages * CONFIG_CMA_SIZE_PERCENTAGE / 100) << PAGE_SHIFT;
  88 }
  89
  90 #else
  91
  92 static inline __maybe_unused phys_addr_t cma_early_percent_memory(void)
  93 {
  94         return 0;
  95 }
  96
  97 #endif
  98
  99 /**
 100  * dma_contiguous_reserve() - reserve area(s) for contiguous memory handling
 101  * @limit: End address of the reserved memory (optional, 0 for any).
 102  *
 103  * This function reserves memory from early allocator. It should be
 104  * called by arch specific code once the early allocator (memblock or bootmem)
 105  * has been activated and all other subsystems have already allocated/reserved
 106  * memory.
 107  */
 108 void __init dma_contiguous_reserve(phys_addr_t limit)
 109 {
 110         phys_addr_t selected_size = 0;
 111
 112         pr_debug("%s(limit %08lx)\n", __func__, (unsigned long)limit);
 113
 114         if (size_cmdline != -1) {
 115                 selected_size = size_cmdline;
 116         } else {
 117 #ifdef CONFIG_CMA_SIZE_SEL_MBYTES
 118                 selected_size = size_bytes;
 119 #elif defined(CONFIG_CMA_SIZE_SEL_PERCENTAGE)
 120                 selected_size = cma_early_percent_memory();
 121 #elif defined(CONFIG_CMA_SIZE_SEL_MIN)
 122                 selected_size = min(size_bytes, cma_early_percent_memory());
 123 #elif defined(CONFIG_CMA_SIZE_SEL_MAX)
 124                 selected_size = max(size_bytes, cma_early_percent_memory());
 125 #endif
 126         }
 127
 128         if (selected_size && !dma_contiguous_default_area) {
 129                 pr_debug("%s: reserving %ld MiB for global area\n", __func__,
 130                          (unsigned long)selected_size / SZ_1M);
 131
 132                 dma_contiguous_reserve_area(selected_size, 0, limit,
 133                                             &dma_contiguous_default_area);
 134         }
 135 };
 136
 137 static DEFINE_MUTEX(cma_mutex);
 138
 139 static int __init cma_activate_area(struct cma *cma)
 140 {
 141         int bitmap_size = BITS_TO_LONGS(cma->count) * sizeof(long);
 142         unsigned long base_pfn = cma->base_pfn, pfn = base_pfn;
 143         unsigned i = cma->count >> pageblock_order;
 144         struct zone *zone;
 145
 146         cma->bitmap = kzalloc(bitmap_size, GFP_KERNEL);
 147
 148         if (!cma->bitmap)
 149                 return -ENOMEM;
 150
 151         WARN_ON_ONCE(!pfn_valid(pfn));
 152         zone = page_zone(pfn_to_page(pfn));
 153
 154         do {
 155                 unsigned j;
 156                 base_pfn = pfn;
 157                 for (j = pageblock_nr_pages; j; --j, pfn++) {
 158                         WARN_ON_ONCE(!pfn_valid(pfn));
 159                         if (page_zone(pfn_to_page(pfn)) != zone)
 160                                 return -EINVAL;
 161                 }
 162                 init_cma_reserved_pageblock(pfn_to_page(base_pfn));
 163         } while (--i);
 164
 165         mutex_init(&cma->lock);
 166         return 0;
 167 }
 168
 169 static struct cma cma_areas[MAX_CMA_AREAS];
 170 static unsigned cma_area_count;
 171
 172 static int __init cma_init_reserved_areas(void)
 173 {
 174         int i;
 175
 176         for (i = 0; i < cma_area_count; i++) {
 177                 int ret = cma_activate_area(&cma_areas[i]);
 178                 if (ret)
 179                         return ret;
 180         }
 181
 182         return 0;
 183 }
 184 core_initcall(cma_init_reserved_areas);
 185
 186 /**
 187  * dma_contiguous_reserve_area() - reserve custom contiguous area
 188  * @size: Size of the reserved area (in bytes),
 189  * @base: Base address of the reserved area optional, use 0 for any
 190  * @limit: End address of the reserved memory (optional, 0 for any).
 191  * @res_cma: Pointer to store the created cma region.
 192  *
 193  * This function reserves memory from early allocator. It should be
 194  * called by arch specific code once the early allocator (memblock or bootmem)
 195  * has been activated and all other subsystems have already allocated/reserved
 196  * memory. This function allows to create custom reserved areas for specific
 197  * devices.
 198  */
 199 int __init dma_contiguous_reserve_area(phys_addr_t size, phys_addr_t base,
 200                                        phys_addr_t limit, struct cma **res_cma)
 201 {
 202         struct cma *cma = &cma_areas[cma_area_count];
 203         phys_addr_t alignment;
 204         int ret = 0;
 205
 206         pr_debug("%s(size %lx, base %08lx, limit %08lx)\n", __func__,
 207                  (unsigned long)size, (unsigned long)base,
 208                  (unsigned long)limit);
 209
 210         /* Sanity checks */
 211         if (cma_area_count == ARRAY_SIZE(cma_areas)) {
 212                 pr_err("Not enough slots for CMA reserved regions!\n");
 213                 return -ENOSPC;
 214         }
 215
 216         if (!size)
 217                 return -EINVAL;
 218
 219         /* Sanitise input arguments */
 220         alignment = PAGE_SIZE << max(MAX_ORDER - 1, pageblock_order);
 221         base = ALIGN(base, alignment);
 222         size = ALIGN(size, alignment);
 223         limit &= ~(alignment - 1);
 224
 225         /* Reserve memory */
 226         if (base) {
 227                 if (memblock_is_region_reserved(base, size) ||
 228                     memblock_reserve(base, size) < 0) {
 229                         ret = -EBUSY;
 230                         goto err;
 231                 }
 232         } else {
 233                 /*
 234                  * Use __memblock_alloc_base() since
 235                  * memblock_alloc_base() panic()s.
 236                  */
 237                 phys_addr_t addr = __memblock_alloc_base(size, alignment, limit);
 238                 if (!addr) {
 239                         ret = -ENOMEM;
 240                         goto err;
 241                 } else {
 242                         base = addr;
 243                 }
 244         }
 245
 246         /*
 247          * Each reserved area must be initialised later, when more kernel
 248          * subsystems (like slab allocator) are available.
 249          */
 250         cma->base_pfn = PFN_DOWN(base);
 251         cma->count = size >> PAGE_SHIFT;
 252         *res_cma = cma;
 253         cma_area_count++;
 254
 255         pr_info("CMA: reserved %ld MiB at %08lx\n", (unsigned long)size / SZ_1M,
 256                 (unsigned long)base);
 257
 258         /* Architecture specific contiguous memory fixup. */
 259         dma_contiguous_early_fixup(base, size);
 260         return 0;
 261 err:
 262         pr_err("CMA: failed to reserve %ld MiB\n", (unsigned long)size / SZ_1M);
 263         return ret;
 264 }
 265
 266 static void clear_cma_bitmap(struct cma *cma, unsigned long pfn, int count)
 267 {
 268         mutex_lock(&cma->lock);
 269         bitmap_clear(cma->bitmap, pfn - cma->base_pfn, count);
 270         mutex_unlock(&cma->lock);
 271 }
 272
 273 /**
 274  * dma_alloc_from_contiguous() - allocate pages from contiguous area
 275  * @dev:   Pointer to device for which the allocation is performed.
 276  * @count: Requested number of pages.
 277  * @align: Requested alignment of pages (in PAGE_SIZE order).
 278  *
 279  * This function allocates memory buffer for specified device. It uses
 280  * device specific contiguous memory area if available or the default
 281  * global one. Requires architecture specific dev_get_cma_area() helper
 282  * function.
 283  */
 284 struct page *dma_alloc_from_contiguous(struct device *dev, int count,
 285                                        unsigned int align)
 286 {
 287         unsigned long mask, pfn, pageno, start = 0;
 288         struct cma *cma = dev_get_cma_area(dev);
 289         struct page *page = NULL;
 290         int ret;
 291
 292         if (!cma || !cma->count)
 293                 return NULL;
 294
 295         if (align > CONFIG_CMA_ALIGNMENT)
 296                 align = CONFIG_CMA_ALIGNMENT;
 297
 298         pr_debug("%s(cma %p, count %d, align %d)\n", __func__, (void *)cma,
 299                  count, align);
 300
 301         if (!count)
 302                 return NULL;
 303
 304         mask = (1 << align) - 1;
 305
 306
 307         for (;;) {
 308                 mutex_lock(&cma->lock);
 309                 pageno = bitmap_find_next_zero_area(cma->bitmap, cma->count,
 310                                                     start, count, mask);
 311                 if (pageno >= cma->count) {
 312                         mutex_unlock(&cma->lock);
 313                         break;
 314                 }
 315                 bitmap_set(cma->bitmap, pageno, count);
 316                 /*
 317                  * It's safe to drop the lock here. We've marked this region for
 318                  * our exclusive use. If the migration fails we will take the
 319                  * lock again and unmark it.
 320                  */
 321                 mutex_unlock(&cma->lock);
 322
 323                 pfn = cma->base_pfn + pageno;
 324                 mutex_lock(&cma_mutex);
 325                 ret = alloc_contig_range(pfn, pfn + count, MIGRATE_CMA);
 326                 mutex_unlock(&cma_mutex);
 327                 if (ret == 0) {
 328                         page = pfn_to_page(pfn);
 329                         break;
 330                 } else if (ret != -EBUSY) {
 331                         clear_cma_bitmap(cma, pfn, count);
 332                         break;
 333                 }
 334                 clear_cma_bitmap(cma, pfn, count);
 335                 pr_debug("%s(): memory range at %p is busy, retrying\n",
 336                          __func__, pfn_to_page(pfn));
 337                 /* try again with a bit different memory target */
 338                 start = pageno + mask + 1;
 339         }
 340
 341         pr_debug("%s(): returned %p\n", __func__, page);
 342         return page;
 343 }
 344
 345 /**
 346  * dma_release_from_contiguous() - release allocated pages
 347  * @dev:   Pointer to device for which the pages were allocated.
 348  * @pages: Allocated pages.
 349  * @count: Number of allocated pages.
 350  *
 351  * This function releases memory allocated by dma_alloc_from_contiguous().
 352  * It returns false when provided pages do not belong to contiguous area and
 353  * true otherwise.
 354  */
 355 bool dma_release_from_contiguous(struct device *dev, struct page *pages,
 356                                  int count)
 357 {
 358         struct cma *cma = dev_get_cma_area(dev);
 359         unsigned long pfn;
 360
 361         if (!cma || !pages)
 362                 return false;
 363
 364         pr_debug("%s(page %p)\n", __func__, (void *)pages);
 365
 366         pfn = page_to_pfn(pages);
 367
 368         if (pfn < cma->base_pfn || pfn >= cma->base_pfn + cma->count)
 369                 return false;
 370
 371         VM_BUG_ON(pfn + count > cma->base_pfn + cma->count);
 372
 373         free_contig_range(pfn, count);
 374         clear_cma_bitmap(cma, pfn, count);
 375
 376         return true;
 377 }