ath9k_htc/target_firmware/magpie_fw_dev/target/inc/magpie/dma_engine_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: dma_engine_api.h
  37  *
  38  * @Abstract: DMA Engine api
  39  *
  40  * @Notes:
  41  */
  42
  43 #ifndef _DMA_ENGINE_API_H
  44 #define _DMA_ENGINE_API_H
  45
  46 #include <vbuf_api.h>
  47 #include <vdesc_api.h>
  48
  49 struct zsDmaDesc
  50 {
  51 #if 1   // BIG_ENDIAN
  52     volatile u16_t      ctrl;       // Descriptor control
  53     volatile u16_t      status;     // Descriptor status
  54     volatile u16_t      totalLen;   // Total length
  55     volatile u16_t      dataSize;   // Data size
  56 #else
  57     volatile u16_t      status;     // Descriptor status
  58     volatile u16_t      ctrl;       // Descriptor control
  59     volatile u16_t      dataSize;   // Data size
  60     volatile u16_t      totalLen;   // Total length
  61 #endif
  62     struct zsDmaDesc*   lastAddr;   // Last address of this chain
  63     volatile u32_t      dataAddr;   // Data buffer address
  64     struct zsDmaDesc*   nextAddr;   // Next TD address
  65 };
  66
  67 struct zsDmaQueue
  68 {
  69     struct zsDmaDesc* head;
  70     struct zsDmaDesc* terminator;
  71 };
  72
  73 // Subclass of zsDmaQueue for TX
  74 struct zsTxDmaQueue
  75 {
  76     struct zsDmaDesc* head;
  77     struct zsDmaDesc* terminator;
  78
  79     /* Below are fields specific to TX */
  80     VBUF *xmited_buf_head;
  81     VBUF *xmited_buf_tail;
  82 };
  83
  84 /* hardware API table structure (API descriptions below) */
  85 struct dma_engine_api
  86 {
  87     void  (*_init)();
  88
  89     void  (*_init_rx_queue)(struct zsDmaQueue *q);
  90
  91     void  (*_init_tx_queue)(struct zsTxDmaQueue *q);
  92
  93     void  (*_config_rx_queue)(struct zsDmaQueue *q, int num_desc, int buf_size);
  94
  95     void  (*_xmit_buf)(struct zsTxDmaQueue *q, VBUF *buf);
  96
  97     void  (*_flush_xmit)(struct zsDmaQueue *q);
  98
  99     VBUF* (*_reap_recv_buf)(struct zsDmaQueue *q);
 100
 101     void  (*_return_recv_buf)(struct zsDmaQueue *q, VBUF *buf);
 102
 103     VBUF* (*_reap_xmited_buf)(struct zsTxDmaQueue *q);
 104
 105     void  (*_swap_data)(struct zsDmaDesc* desc);
 106
 107     int   (*_has_compl_packets)(struct zsDmaQueue *q);
 108
 109     void  (*_desc_dump)(struct zsDmaQueue *q);
 110
 111     /* The functions below are for patchable */
 112     struct zsDmaDesc* (*_get_packet)(struct zsDmaQueue* q);
 113     void  (*_reclaim_packet)(struct zsDmaQueue* q, struct zsDmaDesc* desc);
 114     void (*_put_packet)(struct zsDmaQueue* q, struct zsDmaDesc* desc);
 115
 116     /* room to expand this table by another table */
 117     void *pReserved;
 118 };
 119
 120 extern void dma_engine_module_install(struct dma_engine_api *apis);
 121
 122 #endif /* #ifndef _DMA_ENGINE_API_H */