| yu.dong | c33b307 | 2024-08-21 23:14:49 -0700 | [diff] [blame^] | 1 | /***************************************************************************** |
| 2 | * Copyright Statement: |
| 3 | * -------------------- |
| 4 | * This software is protected by Copyright and the information contained |
| 5 | * herein is confidential. The software may not be copied and the information |
| 6 | * contained herein may not be used or disclosed except with the written |
| 7 | * permission of MediaTek Inc. (C) 2012 |
| 8 | * |
| 9 | * BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES |
| 10 | * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE") |
| 11 | * RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON |
| 12 | * AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES, |
| 13 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF |
| 14 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. |
| 15 | * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE |
| 16 | * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR |
| 17 | * SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH |
| 18 | * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO |
| 19 | * NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S |
| 20 | * SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM. |
| 21 | * |
| 22 | * BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE |
| 23 | * LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE, |
| 24 | * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE, |
| 25 | * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO |
| 26 | * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. |
| 27 | * |
| 28 | * THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE |
| 29 | * WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF |
| 30 | * LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND |
| 31 | * RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER |
| 32 | * THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC). |
| 33 | * |
| 34 | *****************************************************************************/ |
| 35 | |
| 36 | /******************************************************************************* |
| 37 | * Filename: |
| 38 | * --------- |
| 39 | * hifcldma_qmu.h |
| 40 | * |
| 41 | * Project: |
| 42 | * -------- |
| 43 | * TATAKA |
| 44 | * |
| 45 | * Description: |
| 46 | * ------------ |
| 47 | * This is the HIF data path driver API head file for CLDMA |
| 48 | * |
| 49 | * Author: |
| 50 | * ------- |
| 51 | * ------- |
| 52 | * |
| 53 | * ========================================================================== |
| 54 | * $Log$ |
| 55 | * |
| 56 | * 11 11 2020 flamingo.wang |
| 57 | * [MOLY00526005] [Colgin] CLDMA driver code porting |
| 58 | * CLDMA driver porting to MD700.MP |
| 59 | * |
| 60 | * 06 02 2017 da.li |
| 61 | * [MOLY00254661] [MT6758][VINSON][N1][Cat7][PHONE][Overnight][HQ][MTBF][Lab][Ericsson][Gemini][ASSERT] file:mcu/common/driver/sleep_drv/internal/src/ostd.c line:3058 |
| 62 | * Bypass TXQ2 check, always enable sleep after poll queue done |
| 63 | * |
| 64 | * 05 11 2017 da.li |
| 65 | * [MOLY00245917] [MT6799][WHITNEY][MP2][PHONE][Overnight][HQ][MTBF][Lab][Ericsson][Gemini]Externel (EE),0,0,99,/data/core/,1,modem,md3: [Others] MD long time no response |
| 66 | * Check TX backup list before enable sleep and unmask CLDMA interrupt. |
| 67 | * |
| 68 | * 02 04 2013 ming.hsieh |
| 69 | * [MOLY00006951] MT7208 U2/U3 driver and test driver maintain |
| 70 | * .modify project name as MT6290 and change all comment or log for new model name |
| 71 | * |
| 72 | * 01 15 2013 ming.hsieh |
| 73 | * [MOLY00006951] MT6290 U2/U3 driver and test driver maintain |
| 74 | * .separate USB/SDIO/CLDMA from hif_common.c for multi-hif request |
| 75 | * -- USB (ming.hsieh) |
| 76 | * -- SDIO (Wei-De/mick.lin) |
| 77 | * -- CLDMA (TH.Cheng) |
| 78 | * .resolve SDIO BPS TX/RX test case fail issue |
| 79 | ****************************************************************************/ |
| 80 | |
| 81 | |
| 82 | |
| 83 | #ifndef __HIFCLDMA_QMU_H__ |
| 84 | #define __HIFCLDMA_QMU_H__ |
| 85 | |
| 86 | #if defined(__MD97__) |
| 87 | #if defined(MT6297)||(CHIP10992) |
| 88 | |
| 89 | #include "qmu_bm.h" |
| 90 | //#include "kal_internal_api.h" |
| 91 | #include "hif_common.h" |
| 92 | |
| 93 | |
| 94 | /*! |
| 95 | * @brief ask hif driver to set GPD buffer into QMU |
| 96 | * @param q_type the queue type |
| 97 | * @param queue_no QMU queue no |
| 98 | * @param first_gpd first GPD of a single GPD or GPD list |
| 99 | * @param last_gpd last GPD of a single GPD or GPD list |
| 100 | * @return KAL_TRUE : set gpd success, |
| 101 | KAL_FALSE : set gpd fail and upper module should re-submit or free the queue list |
| 102 | */ |
| 103 | kal_bool hifcldmaq_set_gpd(hif_queue_type_e q_type, kal_uint8 queue_no, qbm_gpd* first_gpd, qbm_gpd* last_gpd); |
| 104 | |
| 105 | |
| 106 | /*! |
| 107 | * @brief ask hif driver to flush all GPD buffer from QMU |
| 108 | * @param q_type the queue type |
| 109 | * @param queue_no QMU queue no |
| 110 | * @param flush type the flush type wished |
| 111 | * @param pp_head the head pointer of flush list |
| 112 | * @param pp_tail the tail pointer of flush list |
| 113 | * @return return total flushed gpd number |
| 114 | */ |
| 115 | kal_uint32 hifcldmaq_flush_gpd(hif_queue_type_e q_type, kal_uint8 queue_no, hif_flush_type_e flush_type , void **pp_head, void **pp_tail); |
| 116 | |
| 117 | |
| 118 | /*! |
| 119 | * @brief poll specified QMU queue to see if any GPD complete |
| 120 | * deq_type == HIFQ_FREEQ, (use qbmt_free_q_hwo()) |
| 121 | * would free the used queue after this function and return the deq number |
| 122 | * deq_type == HIF_DEQ, |
| 123 | * would just deq and return the deq list and the deq number |
| 124 | * use use qbmt_de_q() if generic buffer type |
| 125 | * use deqmt_deq_hif_ul_type1() if QBM_TYPE_HIF_UL_TYPE1 |
| 126 | * use deqmt_deq_hif_ul_type2() if QBM_TYPE_HIF_UL_TYPE2 |
| 127 | * @param deq_info the que number , que type and deq type |
| 128 | * @param first_gpd first GPD of a single GPD or GPD list |
| 129 | * @param last_gpd last GPD of a single GPD or GPD list |
| 130 | * @return return the deq number |
| 131 | */ |
| 132 | kal_uint32 hifcldmaq_poll_queue(hif_deq_info_t deq_info, void **first_gpd, void **last_gpd); |
| 133 | |
| 134 | /*! |
| 135 | * @brief initial hif_common.c private structure and variable |
| 136 | * @return return KAL_TRUE if success , KAL_FALSE if failure |
| 137 | */ |
| 138 | kal_bool hifcldmaq_common_qmu_init(void); |
| 139 | |
| 140 | /*! |
| 141 | * @brief get currently que list |
| 142 | * @param is_tx, KAL_TRUE for txq , KAL_FALSE for rxq |
| 143 | * @param q_no , the queue number form 0~n |
| 144 | * @param pp_head , return the currently queue head |
| 145 | * @param pp_tail , return the currently queue tail |
| 146 | */ |
| 147 | void hifcldmaq_get_que_list(kal_bool is_tx , kal_uint8 q_no, void **pp_head, void **pp_tail); |
| 148 | |
| 149 | /*! |
| 150 | * @brief configure specific queue operation option with bit-map config |
| 151 | * @param is_tx, KAL_TRUE for txq , KAL_FALSE for rxq |
| 152 | * @param q_no , the queue number form 0~n |
| 153 | * @param que_cfg , the bit-map configuration , ex. HIF_QCFG_BM_TX_EMPTY_ENQ |
| 154 | * @return KAL_TRUE if success, KAL_FALSE if configure not valid |
| 155 | */ |
| 156 | kal_bool hifcldmaq_set_que_cfg(kal_bool is_tx , kal_uint8 q_no, kal_uint16 que_cfg); |
| 157 | |
| 158 | kal_bool hifcldma_is_tx_bkp_list_empty(kal_uint8 q_no); |
| 159 | kal_bool hifcldma_is_tx_slp_en(kal_uint8 q_no); |
| 160 | |
| 161 | #endif |
| 162 | #endif |
| 163 | |
| 164 | #endif |