ath9k_htc/target_firmware/magpie_fw_dev/target/inc/k2/allocram_api.h

   1 /*
   2  * Copyright (c) 2013 Qualcomm Atheros, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted (subject to the limitations in the
   7  * disclaimer below) provided that the following conditions are met:
   8  *
   9  *  * Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  *  * Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the
  15  *    distribution.
  16  *
  17  *  * Neither the name of Qualcomm Atheros nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  22  * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
  23  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  33  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 #ifndef __ALLOCRAM_API_H__
  36 #define __ALLOCRAM_API_H__
  37
  38 /* API for Target-side startup-time RAM allocations */
  39
  40 struct allocram_api {
  41         /*
  42          * Initialize allocram, providing it with a block of RAM
  43          * (an "arena") from which to allocate.
  44          *
  45          * If arena_start is 0, a default start -- the end of
  46          * the application's text & data -- is used.
  47          *
  48          * If arena_sz is 0, a default size -- which uses most
  49          * of physical RAM beyond arena_start -- is used.
  50          *
  51          * Return value is reserved for future use -- it's an arena handle.
  52          */
  53         void *(* cmnos_allocram_init)(void *arena_start, A_UINT32 arena_sz);
  54
  55         /*
  56          * Allocate nbytes of memory, returning a pointer to the start
  57          * of the allocated block.  Allocation size is rounded up to the
  58          * nearest A_CACHE_LINE_SIZE and the returned address similarly
  59          * aligned.
  60          *
  61          * There is no need to check the return value from this function.
  62          * A failure to satisfy a RAM allocation request is treated as a
  63          * fatal error.
  64          *
  65          * Allocations are expected to occur only during startup; this
  66          * API does not, for instance, guarantee atomicity with respect
  67          * to allocations that might (foolishly) be attempted from
  68          * interrupt handlers.
  69          *
  70          * The "which_arena" parameter is currently unused, and should
  71          * be set to 0 -- only a single arena is currently supported.
  72          */
  73         void *(* cmnos_allocram)(void *which_arena, A_UINT32 nbytes);
  74
  75         void (* cmnos_allocram_debug)(void);
  76 };
  77
  78 extern void allocram_module_install(struct allocram_api *api);
  79
  80
  81 #endif /* __ALLOCRAM_API_H__ */