ath9k_htc/target_firmware/magpie_fw_dev/target/inc/vbuf_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: VBUF_api.h
  37  *
  38  * @Abstract: Host Interface api
  39  *
  40  * @Notes:
  41  */
  42
  43 #ifndef _VBUF_API_H
  44 #define _VBUF_API_H
  45
  46 #include <vdesc_api.h>
  47
  48 #define MAX_BUF_CTX_LEN     20
  49
  50 typedef struct _VBUF
  51 {
  52         VDESC           *desc_list;
  53         struct _VBUF    *next_buf;
  54         A_UINT16        buf_length;
  55         A_UINT8         reserved[2];
  56         A_UINT8         ctx[MAX_BUF_CTX_LEN];
  57 } VBUF;
  58
  59 #define VBUF_GET_DATA_ADDR(vbuf)    (vbuf->desc_list->buf_addr + vbuf->desc_list->data_offset)
  60
  61 /* hardware API table structure (API descriptions below) */
  62 struct vbuf_api {
  63         void (*_init)(int nBuf);
  64         VBUF* (*_alloc_vbuf)(void);
  65         VBUF* (*_alloc_vbuf_with_size)(int size, int reserve);
  66         void (*_free_vbuf)(VBUF *buf);
  67
  68         /* room to expand this table by another table */
  69         void *pReserved;
  70 };
  71
  72 extern void vbuf_module_install(struct vbuf_api *apis);
  73
  74 #endif /* #ifndef _HIF_API_H */