ath9k_htc/target_firmware/magpie_fw_dev/target/inc/k2/dma_lib.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 __DMA_LIB_H
  36 #define __DMA_LIB_H
  37
  38
  39 /***********************External***************************/
  40
  41 /**
  42  * @brief DMA engine numbers, HIF need to map them to there
  43  *        respective order
  44  */
  45 typedef enum dma_engine{
  46     DMA_ENGINE_RX0,
  47     DMA_ENGINE_RX1,
  48     DMA_ENGINE_RX2,
  49     DMA_ENGINE_RX3,
  50     DMA_ENGINE_TX0,
  51     DMA_ENGINE_TX1,
  52     DMA_ENGINE_MAX
  53 }dma_engine_t;
  54
  55 /**
  56  * @brief Interface type, each HIF should call with its own interface type
  57  */
  58 typedef enum dma_iftype{
  59     DMA_IF_GMAC = 0x0,/* GMAC */
  60     DMA_IF_PCI  = 0x1,/*PCI */
  61     DMA_IF_PCIE = 0x2 /*PCI Express */
  62 }dma_iftype_t;
  63
  64
  65 struct dma_lib_api{
  66     A_UINT16  (*tx_init)(dma_engine_t eng_no, dma_iftype_t  if_type);
  67     void        (*tx_start)(dma_engine_t eng_no);
  68     A_UINT16  (*rx_init)(dma_engine_t eng_no, dma_iftype_t  if_type);
  69     void        (*rx_config)(dma_engine_t eng_no, a_uint16_t num_desc,
  70                                                  a_uint16_t   gran);
  71     void        (*rx_start)(dma_engine_t  eng_no);
  72     A_UINT32  (*intr_status)(dma_iftype_t  if_type);
  73     A_UINT16  (*hard_xmit)(dma_engine_t eng_no, VBUF *buf);
  74     void        (*flush_xmit)(dma_engine_t  eng_no);
  75     A_UINT16    (*xmit_done)(dma_engine_t   eng_no);
  76     VBUF *      (*reap_xmitted)(dma_engine_t  eng_no);
  77     VBUF *      (*reap_recv)(dma_engine_t  eng_no);
  78     void        (*return_recv)(dma_engine_t  eng_no, VBUF *buf);
  79     A_UINT16    (*recv_pkt)(dma_engine_t  eng_no);
  80 };
  81
  82
  83 /**
  84  * @brief Install the DMA lib api's this for ROM patching
  85  *        support
  86  *
  87  * @param apis
  88  */
  89 void        dma_lib_module_install(struct dma_lib_api  *apis);
  90
  91 #endif