ath9k_htc/sboot/magpie_1_1/sboot/buf_pool/inc/buf_pool_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 /*
  36  * @File: buf_pool_api.h
  37  *
  38  * @Abstract: BUF Pool api
  39  *
  40  * @Notes:
  41  */
  42
  43 #ifndef _BUF_POOL_API_H
  44 #define _BUF_POOL_API_H
  45
  46 #include <adf_nbuf.h>
  47
  48 /* endpoint defines */
  49 typedef enum
  50 {
  51     POOL_ID_HTC_CONTROL         = 0,
  52     POOL_ID_WMI_SVC_CMD_REPLY   = 1,
  53     POOL_ID_WMI_SVC_EVENT       = 2,
  54     POOL_ID_WLAN_RX_BUF         = 3,
  55     POOL_ID_MAX                 = 10
  56 } BUF_POOL_ID;
  57
  58 typedef void* pool_handle_t;
  59
  60 /* hardware API table structure (API descriptions below) */
  61 struct buf_pool_api {
  62     pool_handle_t (*_init)(adf_os_handle_t handle);
  63
  64     void (*_shutdown)(pool_handle_t handle);
  65
  66     void (*_create_pool)(pool_handle_t handle, BUF_POOL_ID poolId, int nItems, int nSize);
  67
  68     adf_nbuf_t  (*_alloc_buf)(pool_handle_t handle, BUF_POOL_ID poolId, int reserve);
  69
  70     adf_nbuf_t  (*_alloc_buf_align)(pool_handle_t handle, BUF_POOL_ID poolId, int reserve, int align);
  71
  72     void (*_free_buf)(pool_handle_t handle, BUF_POOL_ID poolId, adf_nbuf_t buf);
  73
  74         /* room to expand this table by another table */
  75     void *pReserved;
  76 };
  77
  78 extern void buf_pool_module_install(struct buf_pool_api *apis);
  79
  80 #endif /* #ifndef _BUF_POOL_API_H */