Gitiles
Code Review Sign In
192.168.1.100 / T800_MD / 0b80c7188a6089ae59f523c5d460adad05960e1d / . / mcu / interface / driver / hif / hifsdio_qmu.h
blob: a5d183035ea729de5d5dc855ccda22cb5746f3e7 [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +0800[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 * hifsdio_qmu.h
40 *
41 * Project:
42 * --------
43 * TATAKA
44 *
45 * Description:
46 * ------------
47 * This is the HIF data path driver API head file for SDIO.
48 *
49 * Author:
50 * -------
51 * -------
52 *
53 * ==========================================================================
54 * $Log$
55 *
56 * 02 04 2013 ming.hsieh
57 * [MOLY00006951] MT7208 U2/U3 driver and test driver maintain
58 * .modify project name as MT6290 and change all comment or log for new model name
59 *
60 * 01 15 2013 ming.hsieh
61 * [MOLY00006951] MT6290 U2/U3 driver and test driver maintain
62 * .separate USB/SDIO/CLDMA from hif_common.c for multi-hif request
63 * -- USB (ming.hsieh)
64 * -- SDIO (Wei-De/mick.lin)
65 * -- CLDMA (TH.Cheng)
66 * .resolve SDIO BPS TX/RX test case fail issue
67 ****************************************************************************/
68
69
70
71#ifndef __HIFSDIO_QMU_H__
72#define __HIFSDIO_QMU_H__
73
74#include "qmu_bm.h"
75//#include "kal_internal_api.h"
76#include "hif_common.h"
77
78
79/*!
80 * @brief ask hif driver to set GPD buffer into QMU
81 * @param q_type the queue type
82 * @param queue_no QMU queue no
83 * @param first_gpd first GPD of a single GPD or GPD list
84 * @param last_gpd last GPD of a single GPD or GPD list
85 * @return KAL_TRUE : set gpd success,
86 KAL_FALSE : set gpd fail and upper module should re-submit or free the queue list
87 */
88kal_bool hifsdioq_set_gpd(hif_queue_type_e q_type, kal_uint8 queue_no, qbm_gpd* first_gpd, qbm_gpd* last_gpd);
89
90
91/*!
92 * @brief ask hif driver to flush all GPD buffer from QMU
93 * @param q_type the queue type
94 * @param queue_no QMU queue no
95 * @param flush type the flush type wished
96 * @param pp_head the head pointer of flush list
97 * @param pp_tail the tail pointer of flush list
98 * @return return total flushed gpd number
99 */
100kal_uint32 hifsdioq_flush_gpd(hif_queue_type_e q_type, kal_uint8 queue_no, hif_flush_type_e flush_type , void **pp_head, void **pp_tail);
101
102
103/*!
104 * @brief poll specified QMU queue to see if any GPD complete
105 * deq_type == HIFQ_FREEQ, (use qbmt_free_q_hwo())
106 * would free the used queue after this function and return the deq number
107 * deq_type == HIF_DEQ,
108 * would just deq and return the deq list and the deq number
109 * use use qbmt_de_q() if generic buffer type
110 * use deqmt_deq_hif_ul_type1() if QBM_TYPE_HIF_UL_TYPE1
111 * use deqmt_deq_hif_ul_type2() if QBM_TYPE_HIF_UL_TYPE2
112 * @param deq_info the que number , que type and deq type
113 * @param first_gpd first GPD of a single GPD or GPD list
114 * @param last_gpd last GPD of a single GPD or GPD list
115 * @return return the deq number
116 */
117kal_uint32 hifsdioq_poll_queue(hif_deq_info_t deq_info, void **first_gpd, void **last_gpd);
118
119/*!
120 * @brief initial hif_common.c private structure and variable
121 * @return return KAL_TRUE if success , KAL_FALSE if failure
122 */
123kal_bool hifsdioq_common_qmu_init(void);
124
125/*!
126 * @brief get currently que list
127 * @param is_tx, KAL_TRUE for txq , KAL_FALSE for rxq
128 * @param q_no , the queue number form 0~n
129 * @param pp_head , return the currently queue head
130 * @param pp_tail , return the currently queue tail
131 */
132void hifsdioq_get_que_list(kal_bool is_tx , kal_uint8 q_no, void **pp_head, void **pp_tail);
133
134/*!
135 * @brief configure specific queue operation option with bit-map config
136 * @param is_tx, KAL_TRUE for txq , KAL_FALSE for rxq
137 * @param q_no , the queue number form 0~n
138 * @param que_cfg , the bit-map configuration , ex. HIF_QCFG_BM_TX_EMPTY_ENQ
139 * @return KAL_TRUE if success, KAL_FALSE if configure not valid
140 */
141kal_bool hifsdioq_set_que_cfg(kal_bool is_tx , kal_uint8 q_no, kal_uint16 que_cfg);
142
143#endif