arch/mips/include/asm/octeon/cvmx-bootmem.h

   1 /***********************license start***************
   2  * Author: Cavium Networks
   3  *
   4  * Contact: support@caviumnetworks.com
   5  * This file is part of the OCTEON SDK
   6  *
   7  * Copyright (c) 2003-2008 Cavium Networks
   8  *
   9  * This file is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License, Version 2, as
  11  * published by the Free Software Foundation.
  12  *
  13  * This file is distributed in the hope that it will be useful, but
  14  * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty
  15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
  16  * NONINFRINGEMENT.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this file; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  22  * or visit http://www.gnu.org/licenses/.
  23  *
  24  * This file may also be available under a different license from Cavium.
  25  * Contact Cavium Networks for more information
  26  ***********************license end**************************************/
  27
  28 /*
  29  * Simple allocate only memory allocator.  Used to allocate memory at
  30  * application start time.
  31  */
  32
  33 #ifndef __CVMX_BOOTMEM_H__
  34 #define __CVMX_BOOTMEM_H__
  35 /* Must be multiple of 8, changing breaks ABI */
  36 #define CVMX_BOOTMEM_NAME_LEN 128
  37
  38 /* Can change without breaking ABI */
  39 #define CVMX_BOOTMEM_NUM_NAMED_BLOCKS 64
  40
  41 /* minimum alignment of bootmem alloced blocks */
  42 #define CVMX_BOOTMEM_ALIGNMENT_SIZE     (16ull)
  43
  44 /* Flags for cvmx_bootmem_phy_mem* functions */
  45 /* Allocate from end of block instead of beginning */
  46 #define CVMX_BOOTMEM_FLAG_END_ALLOC    (1 << 0)
  47
  48 /* Don't do any locking. */
  49 #define CVMX_BOOTMEM_FLAG_NO_LOCKING   (1 << 1)
  50
  51 /* First bytes of each free physical block of memory contain this structure,
  52  * which is used to maintain the free memory list.  Since the bootloader is
  53  * only 32 bits, there is a union providing 64 and 32 bit versions.  The
  54  * application init code converts addresses to 64 bit addresses before the
  55  * application starts.
  56  */
  57 struct cvmx_bootmem_block_header {
  58         /*
  59          * Note: these are referenced from assembly routines in the
  60          * bootloader, so this structure should not be changed
  61          * without changing those routines as well.
  62          */
  63         uint64_t next_block_addr;
  64         uint64_t size;
  65
  66 };
  67
  68 /*
  69  * Structure for named memory blocks.  Number of descriptors available
  70  * can be changed without affecting compatiblity, but name length
  71  * changes require a bump in the bootmem descriptor version Note: This
  72  * structure must be naturally 64 bit aligned, as a single memory
  73  * image will be used by both 32 and 64 bit programs.
  74  */
  75 struct cvmx_bootmem_named_block_desc {
  76         /* Base address of named block */
  77         uint64_t base_addr;
  78         /*
  79          * Size actually allocated for named block (may differ from
  80          * requested).
  81          */
  82         uint64_t size;
  83         /* name of named block */
  84         char name[CVMX_BOOTMEM_NAME_LEN];
  85 };
  86
  87 /* Current descriptor versions */
  88 /* CVMX bootmem descriptor major version */
  89 #define CVMX_BOOTMEM_DESC_MAJ_VER   3
  90
  91 /* CVMX bootmem descriptor minor version */
  92 #define CVMX_BOOTMEM_DESC_MIN_VER   0
  93
  94 /* First three members of cvmx_bootmem_desc_t are left in original
  95  * positions for backwards compatibility.
  96  */
  97 struct cvmx_bootmem_desc {
  98         /* spinlock to control access to list */
  99         uint32_t lock;
 100         /* flags for indicating various conditions */
 101         uint32_t flags;
 102         uint64_t head_addr;
 103
 104         /* Incremented when incompatible changes made */
 105         uint32_t major_version;
 106
 107         /*
 108          * Incremented changed when compatible changes made, reset to
 109          * zero when major incremented.
 110          */
 111         uint32_t minor_version;
 112
 113         uint64_t app_data_addr;
 114         uint64_t app_data_size;
 115
 116         /* number of elements in named blocks array */
 117         uint32_t named_block_num_blocks;
 118
 119         /* length of name array in bootmem blocks */
 120         uint32_t named_block_name_len;
 121         /* address of named memory block descriptors */
 122         uint64_t named_block_array_addr;
 123
 124 };
 125
 126 /**
 127  * Initialize the boot alloc memory structures. This is
 128  * normally called inside of cvmx_user_app_init()
 129  *
 130  * @mem_desc_ptr:       Address of the free memory list
 131  */
 132 extern int cvmx_bootmem_init(void *mem_desc_ptr);
 133
 134 /**
 135  * Allocate a block of memory from the free list that was passed
 136  * to the application by the bootloader.
 137  * This is an allocate-only algorithm, so freeing memory is not possible.
 138  *
 139  * @size:      Size in bytes of block to allocate
 140  * @alignment: Alignment required - must be power of 2
 141  *
 142  * Returns pointer to block of memory, NULL on error
 143  */
 144 extern void *cvmx_bootmem_alloc(uint64_t size, uint64_t alignment);
 145
 146 /**
 147  * Allocate a block of memory from the free list that was
 148  * passed to the application by the bootloader at a specific
 149  * address. This is an allocate-only algorithm, so
 150  * freeing memory is not possible. Allocation will fail if
 151  * memory cannot be allocated at the specified address.
 152  *
 153  * @size:      Size in bytes of block to allocate
 154  * @address:   Physical address to allocate memory at.  If this memory is not
 155  *                  available, the allocation fails.
 156  * @alignment: Alignment required - must be power of 2
 157  * Returns pointer to block of memory, NULL on error
 158  */
 159 extern void *cvmx_bootmem_alloc_address(uint64_t size, uint64_t address,
 160                                         uint64_t alignment);
 161
 162 /**
 163  * Allocate a block of memory from the free list that was
 164  * passed to the application by the bootloader within a specified
 165  * address range. This is an allocate-only algorithm, so
 166  * freeing memory is not possible. Allocation will fail if
 167  * memory cannot be allocated in the requested range.
 168  *
 169  * @size:      Size in bytes of block to allocate
 170  * @min_addr:  defines the minimum address of the range
 171  * @max_addr:  defines the maximum address of the range
 172  * @alignment: Alignment required - must be power of 2
 173  * Returns pointer to block of memory, NULL on error
 174  */
 175 extern void *cvmx_bootmem_alloc_range(uint64_t size, uint64_t alignment,
 176                                       uint64_t min_addr, uint64_t max_addr);
 177
 178 /**
 179  * Frees a previously allocated named bootmem block.
 180  *
 181  * @name:   name of block to free
 182  *
 183  * Returns 0 on failure,
 184  *         !0 on success
 185  */
 186 extern int cvmx_bootmem_free_named(char *name);
 187
 188 /**
 189  * Finds a named bootmem block by name.
 190  *
 191  * @name:   name of block to free
 192  *
 193  * Returns pointer to named block descriptor on success
 194  *         0 on failure
 195  */
 196 struct cvmx_bootmem_named_block_desc *cvmx_bootmem_find_named_block(char *name);
 197
 198 /**
 199  * Allocates a block of physical memory from the free list, at
 200  * (optional) requested address and alignment.
 201  *
 202  * @req_size: size of region to allocate.  All requests are rounded up
 203  *            to be a multiple CVMX_BOOTMEM_ALIGNMENT_SIZE bytes size
 204  *
 205  * @address_min: Minimum address that block can occupy.
 206  *
 207  * @address_max: Specifies the maximum address_min (inclusive) that
 208  *               the allocation can use.
 209  *
 210  * @alignment: Requested alignment of the block.  If this alignment
 211  *             cannot be met, the allocation fails.  This must be a
 212  *             power of 2.  (Note: Alignment of
 213  *             CVMX_BOOTMEM_ALIGNMENT_SIZE bytes is required, and
 214  *             internally enforced.  Requested alignments of less than
 215  *             CVMX_BOOTMEM_ALIGNMENT_SIZE are set to
 216  *             CVMX_BOOTMEM_ALIGNMENT_SIZE.)
 217  *
 218  * @flags:     Flags to control options for the allocation.
 219  *
 220  * Returns physical address of block allocated, or -1 on failure
 221  */
 222 int64_t cvmx_bootmem_phy_alloc(uint64_t req_size, uint64_t address_min,
 223                                uint64_t address_max, uint64_t alignment,
 224                                uint32_t flags);
 225
 226 /**
 227  * Finds a named memory block by name.
 228  * Also used for finding an unused entry in the named block table.
 229  *
 230  * @name: Name of memory block to find.  If NULL pointer given, then
 231  *        finds unused descriptor, if available.
 232  *
 233  * @flags: Flags to control options for the allocation.
 234  *
 235  * Returns Pointer to memory block descriptor, NULL if not found.
 236  *         If NULL returned when name parameter is NULL, then no memory
 237  *         block descriptors are available.
 238  */
 239 struct cvmx_bootmem_named_block_desc *
 240 cvmx_bootmem_phy_named_block_find(char *name, uint32_t flags);
 241
 242 /**
 243  * Frees a named block.
 244  *
 245  * @name:   name of block to free
 246  * @flags:  flags for passing options
 247  *
 248  * Returns 0 on failure
 249  *         1 on success
 250  */
 251 int cvmx_bootmem_phy_named_block_free(char *name, uint32_t flags);
 252
 253 /**
 254  * Frees a block to the bootmem allocator list.  This must
 255  * be used with care, as the size provided must match the size
 256  * of the block that was allocated, or the list will become
 257  * corrupted.
 258  *
 259  * IMPORTANT:  This is only intended to be used as part of named block
 260  * frees and initial population of the free memory list.
 261  *                                                      *
 262  *
 263  * @phy_addr: physical address of block
 264  * @size:     size of block in bytes.
 265  * @flags:    flags for passing options
 266  *
 267  * Returns 1 on success,
 268  *         0 on failure
 269  */
 270 int __cvmx_bootmem_phy_free(uint64_t phy_addr, uint64_t size, uint32_t flags);
 271
 272 /**
 273  * Locks the bootmem allocator.  This is useful in certain situations
 274  * where multiple allocations must be made without being interrupted.
 275  * This should be used with the CVMX_BOOTMEM_FLAG_NO_LOCKING flag.
 276  *
 277  */
 278 void cvmx_bootmem_lock(void);
 279
 280 /**
 281  * Unlocks the bootmem allocator.  This is useful in certain situations
 282  * where multiple allocations must be made without being interrupted.
 283  * This should be used with the CVMX_BOOTMEM_FLAG_NO_LOCKING flag.
 284  *
 285  */
 286 void cvmx_bootmem_unlock(void);
 287
 288 #endif /*   __CVMX_BOOTMEM_H__ */