1 /*
2 * Header file describing the internal (inter-module) DHD interfaces.
3 *
4 * Provides type definitions and function prototypes used to link the
5 * DHD OS, bus, and protocol modules.
6 *
7 * Portions of this code are copyright (c) 2022 Cypress Semiconductor Corporation
8 *
9 * Copyright (C) 1999-2017, Broadcom Corporation
10 *
11 * Unless you and Broadcom execute a separate written software license
12 * agreement governing use of this software, this software is licensed to you
13 * under the terms of the GNU General Public License version 2 (the "GPL"),
14 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
15 * following added to such license:
16 *
17 * As a special exception, the copyright holders of this software give you
18 * permission to link this software with independent modules, and to copy and
19 * distribute the resulting executable under terms of your choice, provided that
20 * you also meet, for each linked independent module, the terms and conditions of
21 * the license of that module. An independent module is a module which is not
22 * derived from this software. The special exception does not apply to any
23 * modifications of the software.
24 *
25 * Notwithstanding the above, under no circumstances may you combine this
26 * software in any way with any other Broadcom software provided under a license
27 * other than the GPL, without Broadcom's express prior written consent.
28 *
29 *
30 * <<Broadcom-WL-IPTag/Open:>>
31 *
32 * $Id: dhd_proto.h 694343 2017-04-11 19:05:58Z $
33 */
34
35 #ifndef _dhd_proto_h_
36 #define _dhd_proto_h_
37
38 #include <dhdioctl.h>
39 #include <wlioctl.h>
40 #ifdef BCMPCIE
41 #include <dhd_flowring.h>
42 #endif // endif
43
44 #define DEFAULT_IOCTL_RESP_TIMEOUT 5000
45 #ifndef IOCTL_RESP_TIMEOUT
46 #ifdef BCMQT
47 #define IOCTL_RESP_TIMEOUT 130000 /* In milli second */
48 #else
49 /* In milli second default value for Production FW */
50 #define IOCTL_RESP_TIMEOUT DEFAULT_IOCTL_RESP_TIMEOUT
51 #endif /* BCMQT */
52 #endif /* IOCTL_RESP_TIMEOUT */
53
54 #ifdef BCMQT
55 #define IOCTL_DMAXFER_TIMEOUT 260000 /* In milli second */
56 #else
57 /* In milli second default value for Production FW */
58 #define IOCTL_DMAXFER_TIMEOUT 10000
59 #endif /* BCMQT */
60
61 #ifndef MFG_IOCTL_RESP_TIMEOUT
62 #define MFG_IOCTL_RESP_TIMEOUT 20000 /* In milli second default value for MFG FW */
63 #endif /* MFG_IOCTL_RESP_TIMEOUT */
64
65 #define DEFAULT_D3_ACK_RESP_TIMEOUT 2000
66 #ifndef D3_ACK_RESP_TIMEOUT
67 #define D3_ACK_RESP_TIMEOUT DEFAULT_D3_ACK_RESP_TIMEOUT
68 #endif /* D3_ACK_RESP_TIMEOUT */
69
70 #define DEFAULT_DHD_BUS_BUSY_TIMEOUT (IOCTL_RESP_TIMEOUT + 1000)
71 #ifndef DHD_BUS_BUSY_TIMEOUT
72 #define DHD_BUS_BUSY_TIMEOUT DEFAULT_DHD_BUS_BUSY_TIMEOUT
73 #endif /* DEFAULT_DHD_BUS_BUSY_TIMEOUT */
74
75 #define DS_EXIT_TIMEOUT 1000 /* In ms */
76 #define DS_ENTER_TIMEOUT 1000 /* In ms */
77
78 #define IOCTL_DISABLE_TIMEOUT 0
79
80 /*
81 * Exported from the dhd protocol module (dhd_cdc, dhd_rndis)
82 */
83
84 /* Linkage, sets prot link and updates hdrlen in pub */
85 extern int dhd_prot_attach(dhd_pub_t *dhdp);
86
87 /* Initilizes the index block for dma'ing indices */
88 extern int dhd_prot_dma_indx_init(dhd_pub_t *dhdp, uint32 rw_index_sz,
89 uint8 type, uint32 length);
90
91 /* Unlink, frees allocated protocol memory (including dhd_prot) */
92 extern void dhd_prot_detach(dhd_pub_t *dhdp);
93
94 /* Initialize protocol: sync w/dongle state.
95 * Sets dongle media info (iswl, drv_version, mac address).
96 */
97 extern int dhd_sync_with_dongle(dhd_pub_t *dhdp);
98
99 /* Protocol initialization needed for IOCTL/IOVAR path */
100 extern int dhd_prot_init(dhd_pub_t *dhd);
101
102 /* Stop protocol: sync w/dongle state. */
103 extern void dhd_prot_stop(dhd_pub_t *dhdp);
104
105 /* Add any protocol-specific data header.
106 * Caller must reserve prot_hdrlen prepend space.
107 */
108 extern void dhd_prot_hdrpush(dhd_pub_t *, int ifidx, void *txp);
109 extern uint dhd_prot_hdrlen(dhd_pub_t *, void *txp);
110
111 /* Remove any protocol-specific data header. */
112 extern int dhd_prot_hdrpull(dhd_pub_t *, int *ifidx, void *rxp, uchar *buf, uint *len);
113
114 /* Use protocol to issue ioctl to dongle */
115 extern int dhd_prot_ioctl(dhd_pub_t *dhd, int ifidx, wl_ioctl_t * ioc, void * buf, int len);
116
117 /* Handles a protocol control response asynchronously */
118 extern int dhd_prot_ctl_complete(dhd_pub_t *dhd);
119
120 /* Check for and handle local prot-specific iovar commands */
121 extern int dhd_prot_iovar_op(dhd_pub_t *dhdp, const char *name,
122 void *params, int plen, void *arg, int len, bool set);
123
124 /* Add prot dump output to a buffer */
125 extern void dhd_prot_dump(dhd_pub_t *dhdp, struct bcmstrbuf *strbuf);
126
127 /* Dump extended trap data */
128 extern int dhd_prot_dump_extended_trap(dhd_pub_t *dhdp, struct bcmstrbuf *b, bool raw);
129
130 /* Update local copy of dongle statistics */
131 extern void dhd_prot_dstats(dhd_pub_t *dhdp);
132
133 extern int dhd_ioctl(dhd_pub_t * dhd_pub, dhd_ioctl_t *ioc, void * buf, uint buflen);
134
135 extern int dhd_preinit_ioctls(dhd_pub_t *dhd);
136
137 extern int dhd_process_pkt_reorder_info(dhd_pub_t *dhd, uchar *reorder_info_buf,
138 uint reorder_info_len, void **pkt, uint32 *free_buf_count);
139
140 #ifdef BCMPCIE
141 extern bool dhd_prot_process_msgbuf_txcpl(dhd_pub_t *dhd, uint bound, int ringtype);
142 extern bool dhd_prot_process_msgbuf_rxcpl(dhd_pub_t *dhd, uint bound, int ringtype);
143 extern bool dhd_prot_process_msgbuf_infocpl(dhd_pub_t *dhd, uint bound);
144 extern int dhd_prot_process_ctrlbuf(dhd_pub_t * dhd);
145 extern int dhd_prot_process_trapbuf(dhd_pub_t * dhd);
146 extern bool dhd_prot_dtohsplit(dhd_pub_t * dhd);
147 extern int dhd_post_dummy_msg(dhd_pub_t *dhd);
148 extern int dhdmsgbuf_lpbk_req(dhd_pub_t *dhd, uint len);
149 extern void dhd_prot_rx_dataoffset(dhd_pub_t *dhd, uint32 offset);
150 extern int dhd_prot_txdata(dhd_pub_t *dhd, void *p, uint8 ifidx);
151 extern int dhdmsgbuf_dmaxfer_req(dhd_pub_t *dhd,
152 uint len, uint srcdelay, uint destdelay, uint d11_lpbk, uint core_num);
153 extern int dhdmsgbuf_dmaxfer_status(dhd_pub_t *dhd, dma_xfer_info_t *result);
154
155 extern void dhd_dma_buf_init(dhd_pub_t *dhd, void *dma_buf,
156 void *va, uint32 len, dmaaddr_t pa, void *dmah, void *secdma);
157 extern void dhd_prot_flowrings_pool_release(dhd_pub_t *dhd,
158 uint16 flowid, void *msgbuf_ring);
159 extern int dhd_prot_flow_ring_create(dhd_pub_t *dhd, flow_ring_node_t *flow_ring_node);
160 extern int dhd_post_tx_ring_item(dhd_pub_t *dhd, void *PKTBUF, uint8 ifindex);
161 extern int dhd_prot_flow_ring_delete(dhd_pub_t *dhd, flow_ring_node_t *flow_ring_node);
162 extern int dhd_prot_flow_ring_flush(dhd_pub_t *dhd, flow_ring_node_t *flow_ring_node);
163 extern int dhd_prot_ringupd_dump(dhd_pub_t *dhd, struct bcmstrbuf *b);
164 extern uint32 dhd_prot_metadata_dbg_set(dhd_pub_t *dhd, bool val);
165 extern uint32 dhd_prot_metadata_dbg_get(dhd_pub_t *dhd);
166 extern uint32 dhd_prot_metadatalen_set(dhd_pub_t *dhd, uint32 val, bool rx);
167 extern uint32 dhd_prot_metadatalen_get(dhd_pub_t *dhd, bool rx);
168 extern void dhd_prot_print_flow_ring(dhd_pub_t *dhd, void *msgbuf_flow_info,
169 struct bcmstrbuf *strbuf, const char * fmt);
170 extern void dhd_prot_print_info(dhd_pub_t *dhd, struct bcmstrbuf *strbuf);
171 extern void dhd_prot_update_txflowring(dhd_pub_t *dhdp, uint16 flow_id, void *msgring_info);
172 extern void dhd_prot_txdata_write_flush(dhd_pub_t *dhd, uint16 flow_id);
173 extern uint32 dhd_prot_txp_threshold(dhd_pub_t *dhd, bool set, uint32 val);
174 extern void dhd_prot_reset(dhd_pub_t *dhd);
175 extern uint16 dhd_get_max_flow_rings(dhd_pub_t *dhd);
176
177 #ifdef IDLE_TX_FLOW_MGMT
178 extern int dhd_prot_flow_ring_batch_suspend_request(dhd_pub_t *dhd, uint16 *ringid, uint16 count);
179 extern int dhd_prot_flow_ring_resume(dhd_pub_t *dhd, flow_ring_node_t *flow_ring_node);
180 #endif /* IDLE_TX_FLOW_MGMT */
181 extern int dhd_prot_init_info_rings(dhd_pub_t *dhd);
182 #ifdef DHD_HP2P
183 extern int dhd_prot_init_hp2p_rings(dhd_pub_t *dhd);
184 #endif /* DHD_HP2P */
185
186 extern int dhd_prot_check_tx_resource(dhd_pub_t *dhd);
187
188 extern void dhd_prot_update_pktid_txq_stop_cnt(dhd_pub_t *dhd);
189 extern void dhd_prot_update_pktid_txq_start_cnt(dhd_pub_t *dhd);
190 #else
dhd_prot_update_pktid_txq_stop_cnt(dhd_pub_t * dhd)191 static INLINE void dhd_prot_update_pktid_txq_stop_cnt(dhd_pub_t *dhd) { return; }
dhd_prot_update_pktid_txq_start_cnt(dhd_pub_t * dhd)192 static INLINE void dhd_prot_update_pktid_txq_start_cnt(dhd_pub_t *dhd) { return; }
193 #endif /* BCMPCIE */
194
195 #ifdef DHD_LB
196 extern void dhd_lb_tx_compl_handler(unsigned long data);
197 extern void dhd_lb_rx_compl_handler(unsigned long data);
198 extern void dhd_lb_rx_process_handler(unsigned long data);
199 #endif /* DHD_LB */
200 extern int dhd_prot_h2d_mbdata_send_ctrlmsg(dhd_pub_t *dhd, uint32 mb_data);
201
202 #ifdef BCMPCIE
203 extern int dhd_prot_send_host_timestamp(dhd_pub_t *dhdp, uchar *tlv, uint16 tlv_len,
204 uint16 seq, uint16 xt_id);
205 extern bool dhd_prot_data_path_tx_timestamp_logging(dhd_pub_t *dhd, bool enable, bool set);
206 extern bool dhd_prot_data_path_rx_timestamp_logging(dhd_pub_t *dhd, bool enable, bool set);
207 extern bool dhd_prot_pkt_noretry(dhd_pub_t *dhd, bool enable, bool set);
208 extern bool dhd_prot_pkt_noaggr(dhd_pub_t *dhd, bool enable, bool set);
209 extern bool dhd_prot_pkt_fixed_rate(dhd_pub_t *dhd, bool enable, bool set);
210 #else /* BCMPCIE */
211 #define dhd_prot_send_host_timestamp(a, b, c, d, e) 0
212 #define dhd_prot_data_path_tx_timestamp_logging(a, b, c) 0
213 #define dhd_prot_data_path_rx_timestamp_logging(a, b, c) 0
214 #endif /* BCMPCIE */
215
216 extern void dhd_prot_dma_indx_free(dhd_pub_t *dhd);
217
218 #ifdef EWP_EDL
219 int dhd_prot_init_edl_rings(dhd_pub_t *dhd);
220 bool dhd_prot_process_msgbuf_edl(dhd_pub_t *dhd);
221 int dhd_prot_process_edl_complete(dhd_pub_t *dhd, void *evt_decode_data);
222 #endif /* EWP_EDL */
223
224 /* APIs for managing a DMA-able buffer */
225 int dhd_dma_buf_alloc(dhd_pub_t *dhd, dhd_dma_buf_t *dma_buf, uint32 buf_len);
226 void dhd_dma_buf_free(dhd_pub_t *dhd, dhd_dma_buf_t *dma_buf);
227
228 /********************************
229 * For version-string expansion *
230 */
231 #if defined(BDC)
232 #define DHD_PROTOCOL "bdc"
233 #elif defined(CDC)
234 #define DHD_PROTOCOL "cdc"
235 #else
236 #define DHD_PROTOCOL "unknown"
237 #endif /* proto */
238
239 int dhd_get_hscb_info(dhd_pub_t *dhd, void ** va, uint32 *len);
240 int dhd_get_hscb_buff(dhd_pub_t *dhd, uint32 offset, uint32 length, void * buff);
241
242 #ifdef DHD_HP2P
243 extern uint8 dhd_prot_hp2p_enable(dhd_pub_t *dhd, bool set, int enable);
244 extern uint32 dhd_prot_pkt_threshold(dhd_pub_t *dhd, bool set, uint32 val);
245 extern uint32 dhd_prot_time_threshold(dhd_pub_t *dhd, bool set, uint32 val);
246 extern uint32 dhd_prot_pkt_expiry(dhd_pub_t *dhd, bool set, uint32 val);
247 #endif // endif
248
249 #ifdef DHD_MAP_LOGGING
250 extern void dhd_prot_smmu_fault_dump(dhd_pub_t *dhdp);
251 #endif /* DHD_MAP_LOGGING */
252 #endif /* _dhd_proto_h_ */
253