target_firmware/magpie_fw_dev/target/inc/magpie/dma_lib.h

   1 /*
   2  * Copyright (c) 2013 Qualcomm Atheros, Inc.
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted (subject to the limitations in the
   8  * disclaimer below) provided that the following conditions are met:
   9  *
  10  *  * Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  *  * Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  *  * Neither the name of Qualcomm Atheros nor the names of its
  19  *    contributors may be used to endorse or promote products derived
  20  *    from this software without specific prior written permission.
  21  *
  22  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  23  * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
  24  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  25  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  26  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  31  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  32  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  33  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  34  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #ifndef __DMA_LIB_H
  38 #define __DMA_LIB_H
  39
  40
  41 /***********************External***************************/
  42
  43 /**
  44  * @brief DMA engine numbers, HIF need to map them to there
  45  *        respective order
  46  */
  47 typedef enum dma_engine{
  48     DMA_ENGINE_RX0,
  49     DMA_ENGINE_RX1,
  50     DMA_ENGINE_RX2,
  51     DMA_ENGINE_RX3,
  52     DMA_ENGINE_TX0,
  53     DMA_ENGINE_TX1,
  54     DMA_ENGINE_MAX
  55 }dma_engine_t;
  56
  57 /**
  58  * @brief Interface type, each HIF should call with its own interface type
  59  */
  60 typedef enum dma_iftype{
  61     DMA_IF_GMAC = 0x0,/* GMAC */
  62     DMA_IF_PCI  = 0x1,/*PCI */
  63     DMA_IF_PCIE = 0x2 /*PCI Express */
  64 }dma_iftype_t;
  65
  66
  67 struct dma_lib_api{
  68     A_UINT16  (*tx_init)(dma_engine_t eng_no, dma_iftype_t  if_type);
  69     void        (*tx_start)(dma_engine_t eng_no);
  70     A_UINT16  (*rx_init)(dma_engine_t eng_no, dma_iftype_t  if_type);
  71     void        (*rx_config)(dma_engine_t eng_no, a_uint16_t num_desc,
  72                                                  a_uint16_t   gran);
  73     void        (*rx_start)(dma_engine_t  eng_no);
  74     A_UINT32  (*intr_status)(dma_iftype_t  if_type);
  75     A_UINT16  (*hard_xmit)(dma_engine_t eng_no, VBUF *buf);
  76     void        (*flush_xmit)(dma_engine_t  eng_no);
  77     A_UINT16    (*xmit_done)(dma_engine_t   eng_no);
  78     VBUF *      (*reap_xmitted)(dma_engine_t  eng_no);
  79     VBUF *      (*reap_recv)(dma_engine_t  eng_no);
  80     void        (*return_recv)(dma_engine_t  eng_no, VBUF *buf);
  81     A_UINT16    (*recv_pkt)(dma_engine_t  eng_no);
  82 };
  83
  84
  85 /**
  86  * @brief Install the DMA lib api's this for ROM patching
  87  *        support
  88  *
  89  * @param apis
  90  */
  91 void        dma_lib_module_install(struct dma_lib_api  *apis);
  92
  93 #endif