include/linux/cma.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __CMA_H__
   3 #define __CMA_H__
   4
   5 #include <linux/init.h>
   6 #include <linux/types.h>
   7 #include <linux/numa.h>
   8
   9 /*
  10  * There is always at least global CMA area and a few optional
  11  * areas configured in kernel .config.
  12  */
  13 #ifdef CONFIG_CMA_AREAS
  14 #define MAX_CMA_AREAS   (1 + CONFIG_CMA_AREAS)
  15
  16 #else
  17 #define MAX_CMA_AREAS   (0)
  18
  19 #endif
  20
  21 #define CMA_MAX_NAME 64
  22
  23 /*
  24  * TODO: once the buddy -- especially pageblock merging and alloc_contig_range()
  25  * -- can deal with only some pageblocks of a higher-order page being
  26  *  MIGRATE_CMA, we can use pageblock_nr_pages.
  27  */
  28 #define CMA_MIN_ALIGNMENT_PAGES MAX_ORDER_NR_PAGES
  29 #define CMA_MIN_ALIGNMENT_BYTES (PAGE_SIZE * CMA_MIN_ALIGNMENT_PAGES)
  30
  31 struct cma;
  32
  33 extern unsigned long totalcma_pages;
  34 extern phys_addr_t cma_get_base(const struct cma *cma);
  35 extern unsigned long cma_get_size(const struct cma *cma);
  36 extern const char *cma_get_name(const struct cma *cma);
  37
  38 extern int __init cma_declare_contiguous_nid(phys_addr_t base,
  39                         phys_addr_t size, phys_addr_t limit,
  40                         phys_addr_t alignment, unsigned int order_per_bit,
  41                         bool fixed, const char *name, struct cma **res_cma,
  42                         int nid);
  43 static inline int __init cma_declare_contiguous(phys_addr_t base,
  44                         phys_addr_t size, phys_addr_t limit,
  45                         phys_addr_t alignment, unsigned int order_per_bit,
  46                         bool fixed, const char *name, struct cma **res_cma)
  47 {
  48         return cma_declare_contiguous_nid(base, size, limit, alignment,
  49                         order_per_bit, fixed, name, res_cma, NUMA_NO_NODE);
  50 }
  51 extern int cma_init_reserved_mem(phys_addr_t base, phys_addr_t size,
  52                                         unsigned int order_per_bit,
  53                                         const char *name,
  54                                         struct cma **res_cma);
  55 extern struct page *cma_alloc(struct cma *cma, unsigned long count, unsigned int align,
  56                               bool no_warn);
  57 extern bool cma_pages_valid(struct cma *cma, const struct page *pages, unsigned long count);
  58 extern bool cma_release(struct cma *cma, const struct page *pages, unsigned long count);
  59
  60 extern int cma_for_each_area(int (*it)(struct cma *cma, void *data), void *data);
  61
  62 extern void cma_reserve_pages_on_error(struct cma *cma);
  63 #endif