drivers/staging/wilc1000/wilc_memory.h

   1 #ifndef __WILC_MEMORY_H__
   2 #define __WILC_MEMORY_H__
   3
   4 /*!
   5  *  @file       wilc_memory.h
   6  *  @brief      Memory OS wrapper functionality
   7  *  @author     syounan
   8  *  @sa         wilc_oswrapper.h top level OS wrapper file
   9  *  @date       16 Aug 2010
  10  *  @version    1.0
  11  */
  12
  13 #include <linux/types.h>
  14 #include <linux/slab.h>
  15
  16 /*!
  17  *  @struct             tstrWILC_MemoryAttrs
  18  *  @brief              Memory API options
  19  *  @author             syounan
  20  *  @date               16 Aug 2010
  21  *  @version            1.0
  22  */
  23 typedef struct {
  24 } tstrWILC_MemoryAttrs;
  25
  26 /*!
  27  *  @brief      Allocates a given size of bytes
  28  *  @param[in]  u32Size size of memory in bytes to be allocated
  29  *  @param[in]  strAttrs Optional attributes, NULL for default
  30  *              if not NULL, pAllocationPool should point to the pool to use for
  31  *              this allocation. if NULL memory will be allocated directly from
  32  *              the system
  33  *  @param[in]  pcFileName file name of the calling code for debugging
  34  *  @param[in]  u32LineNo line number of the calling code for debugging
  35  *  @return     The new allocated block, NULL if allocation fails
  36  *  @note       It is recommended to use of of the wrapper macros instead of
  37  *              calling this function directly
  38  *  @sa         sttrWILC_MemoryAttrs
  39  *  @sa         WILC_MALLOC
  40  *  @sa         WILC_MALLOC_EX
  41  *  @author     syounan
  42  *  @date       16 Aug 2010
  43  *  @version    1.0
  44  */
  45 void *WILC_MemoryAlloc(u32 u32Size, tstrWILC_MemoryAttrs *strAttrs,
  46                        char *pcFileName, u32 u32LineNo);
  47
  48 /*!
  49  * @brief       standrad malloc wrapper with custom attributes
  50  */
  51         #define WILC_MALLOC_EX(__size__, __attrs__) \
  52         (WILC_MemoryAlloc( \
  53                  (__size__), __attrs__, NULL, 0))
  54
  55
  56 /*!
  57  * @brief       standrad malloc wrapper with default attributes
  58  */
  59 #define WILC_MALLOC(__size__) \
  60         WILC_MALLOC_EX(__size__, NULL)
  61
  62
  63
  64
  65
  66 #endif