Gitiles
Code Review Sign In
192.168.1.100 / T800_MD / 0b80c7188a6089ae59f523c5d460adad05960e1d / . / mcu / interface / driver / hif / hif_common_except.h
blob: 5386b617215648688438d8cc059231994c4c213b [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 * hif_common_except.h
40 *
41 * Project:
42 * --------
43 * TATAKA
44 *
45 * Description:
46 * ------------
47 * This is the HIF data path exception handler driver head file for both USB2.0/USB3.0.
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#ifndef __HIF_COMMON_EXCEPT_H__
70#define __HIF_COMMON_EXCEPT_H__
71
72#include "hif_common.h"
73
74/*!
75 * @brief initial the exception HIF driver, only support empty enqueue flow in exception
76*/
77kal_bool hif_except_initial(void);
78/*!
79 * @brief ask hif driver to flush all GPD buffer from QMU
80 * this API only used to stop exception mode to go back normal mode
81 * @param q_type the queue type
82 * @param queue_no QMU queue no
83 * @param flush type the flush type wished
84 * @param pp_head the head pointer of flush list
85 * @param pp_tail the tail pointer of flush list
86 * @return return total flushed gpd number
87 */
88kal_uint32 hif_except_flush_gpd(hif_queue_type_e q_type, kal_uint8 queue_no, hif_flush_type_e flush_type , void **pp_head, void **pp_tail);
89/*!
90 * @brief stop the queue and flush USB pipe fifo for following debug log
91 * HIF layer don't care remain GPD and upper layer could parsing their resource
92 * to handle remain data re-send flow (DHL would re-send remain data after using this API)
93 * @param q_type , define the queue tx/rx direction
94 * @param q_num , define the channel which using the queue number
95*/
96void hif_except_clear_q(hif_queue_type_e q_type, kal_uint8 q_num);
97/*!
98 * @brief ask hif driver to set GPD buffer into QMU
99 * don't handle critical section protection becuase in the single thread exception handler
100 * @param q_type the queue type
101 * @param queue_no QMU queue no
102 * @param first_gpd first GPD of a single GPD or GPD list
103 * @param last_gpd last GPD of a single GPD or GPD list
104 * @return KAL_TRUE : set gpd success,
105 KAL_FALSE : set gpd fail and upper module should re-submit or free the queue list
106 */
107kal_bool hif_except_set_gpd(hif_queue_type_e q_type, kal_uint8 queue_no, qbm_gpd* first_gpd, qbm_gpd* last_gpd);
108/*!
109 * @brief poll specified QMU queue to see if any GPD complete
110 * deq_type == HIFQ_FREEQ, (use qbmt_free_q_hwo())
111 * would free the used queue after this function and return the deq number
112 * deq_type == HIF_DEQ,
113 * would just deq and return the deq list and the deq number
114 * use use qbmt_de_q() if generic buffer type
115 * use deqmt_deq_hif_ul_type1() if QBM_TYPE_HIF_UL_TYPE1
116 * use deqmt_deq_hif_ul_type2() if QBM_TYPE_HIF_UL_TYPE2
117 * @param deq_info the que number , que type and deq type
118 * @param first_gpd first GPD of a single GPD or GPD list
119 * @param last_gpd last GPD of a single GPD or GPD list
120 * @return return the deq number
121 */
122kal_uint32 hif_except_poll_queue(hif_deq_info_t deq_info, void **pp_first_gpd, void **pp_last_gpd);
123
124/*!
125 * @brief hif driver would count the timeout for TX queue not progressing
126 * upper driver should check this the status when they found channel abnormal
127 * @param q_num, the tx queue number to check status
128 * @return Return the hif driver counter of txq stall time in millisecond (ms)
129*/
130kal_uint32 hif_except_get_txq_timeout(kal_uint8 q_num);
131
132#endif