1bdcd8170SKalle Valo /*
2bdcd8170SKalle Valo * Copyright (c) 2004-2011 Atheros Communications Inc.
31b2df407SVasanthakumar Thiagarajan * Copyright (c) 2011 Qualcomm Atheros, Inc.
4bdcd8170SKalle Valo *
5bdcd8170SKalle Valo * Permission to use, copy, modify, and/or distribute this software for any
6bdcd8170SKalle Valo * purpose with or without fee is hereby granted, provided that the above
7bdcd8170SKalle Valo * copyright notice and this permission notice appear in all copies.
8bdcd8170SKalle Valo *
9bdcd8170SKalle Valo * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10bdcd8170SKalle Valo * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11bdcd8170SKalle Valo * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12bdcd8170SKalle Valo * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13bdcd8170SKalle Valo * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14bdcd8170SKalle Valo * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15bdcd8170SKalle Valo * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16bdcd8170SKalle Valo */
17bdcd8170SKalle Valo
18bdcd8170SKalle Valo #ifndef HTC_H
19bdcd8170SKalle Valo #define HTC_H
20bdcd8170SKalle Valo
21bdcd8170SKalle Valo #include "common.h"
22bdcd8170SKalle Valo
23bdcd8170SKalle Valo /* frame header flags */
24bdcd8170SKalle Valo
25bdcd8170SKalle Valo /* send direction */
26bdcd8170SKalle Valo #define HTC_FLAGS_NEED_CREDIT_UPDATE (1 << 0)
27bdcd8170SKalle Valo #define HTC_FLAGS_SEND_BUNDLE (1 << 1)
28636f8288SKalle Valo #define HTC_FLAGS_TX_FIXUP_NETBUF (1 << 2)
29bdcd8170SKalle Valo
30bdcd8170SKalle Valo /* receive direction */
31bdcd8170SKalle Valo #define HTC_FLG_RX_UNUSED (1 << 0)
32bdcd8170SKalle Valo #define HTC_FLG_RX_TRAILER (1 << 1)
33bdcd8170SKalle Valo /* Bundle count maske and shift */
34bdcd8170SKalle Valo #define HTC_FLG_RX_BNDL_CNT (0xF0)
35bdcd8170SKalle Valo #define HTC_FLG_RX_BNDL_CNT_S 4
36bdcd8170SKalle Valo
37bdcd8170SKalle Valo #define HTC_HDR_LENGTH (sizeof(struct htc_frame_hdr))
38bdcd8170SKalle Valo #define HTC_MAX_PAYLOAD_LENGTH (4096 - sizeof(struct htc_frame_hdr))
39bdcd8170SKalle Valo
40bdcd8170SKalle Valo /* HTC control message IDs */
41bdcd8170SKalle Valo
42bdcd8170SKalle Valo #define HTC_MSG_READY_ID 1
43bdcd8170SKalle Valo #define HTC_MSG_CONN_SVC_ID 2
44bdcd8170SKalle Valo #define HTC_MSG_CONN_SVC_RESP_ID 3
45bdcd8170SKalle Valo #define HTC_MSG_SETUP_COMPLETE_ID 4
46bdcd8170SKalle Valo #define HTC_MSG_SETUP_COMPLETE_EX_ID 5
47bdcd8170SKalle Valo
48bdcd8170SKalle Valo #define HTC_MAX_CTRL_MSG_LEN 256
49bdcd8170SKalle Valo
50bdcd8170SKalle Valo #define HTC_VERSION_2P0 0x00
51bdcd8170SKalle Valo #define HTC_VERSION_2P1 0x01
52bdcd8170SKalle Valo
53bdcd8170SKalle Valo #define HTC_SERVICE_META_DATA_MAX_LENGTH 128
54bdcd8170SKalle Valo
55bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_LVL_QUAT 0x0
56bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_LVL_HALF 0x1
57bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_LVL_THREE_QUAT 0x2
58bdcd8170SKalle Valo #define HTC_CONN_FLGS_REDUCE_CRED_DRIB 0x4
59bdcd8170SKalle Valo #define HTC_CONN_FLGS_THRESH_MASK 0x3
60636f8288SKalle Valo /* disable credit flow control on a specific service */
61636f8288SKalle Valo #define HTC_CONN_FLGS_DISABLE_CRED_FLOW_CTRL (1 << 3)
62636f8288SKalle Valo #define HTC_CONN_FLGS_SET_RECV_ALLOC_SHIFT 8
63a07b5b84SVladimir Murzin #define HTC_CONN_FLGS_SET_RECV_ALLOC_MASK 0xFF00U
64bdcd8170SKalle Valo
65bdcd8170SKalle Valo /* connect response status codes */
66bdcd8170SKalle Valo #define HTC_SERVICE_SUCCESS 0
67bdcd8170SKalle Valo #define HTC_SERVICE_NOT_FOUND 1
68bdcd8170SKalle Valo #define HTC_SERVICE_FAILED 2
69bdcd8170SKalle Valo
70bdcd8170SKalle Valo /* no resources (i.e. no more endpoints) */
71bdcd8170SKalle Valo #define HTC_SERVICE_NO_RESOURCES 3
72bdcd8170SKalle Valo
73bdcd8170SKalle Valo /* specific service is not allowing any more endpoints */
74bdcd8170SKalle Valo #define HTC_SERVICE_NO_MORE_EP 4
75bdcd8170SKalle Valo
76bdcd8170SKalle Valo /* report record IDs */
77bdcd8170SKalle Valo #define HTC_RECORD_NULL 0
78bdcd8170SKalle Valo #define HTC_RECORD_CREDITS 1
79bdcd8170SKalle Valo #define HTC_RECORD_LOOKAHEAD 2
80bdcd8170SKalle Valo #define HTC_RECORD_LOOKAHEAD_BUNDLE 3
81bdcd8170SKalle Valo
82bdcd8170SKalle Valo #define HTC_SETUP_COMP_FLG_RX_BNDL_EN (1 << 0)
83636f8288SKalle Valo #define HTC_SETUP_COMP_FLG_DISABLE_TX_CREDIT_FLOW (1 << 1)
84bdcd8170SKalle Valo
85bdcd8170SKalle Valo #define MAKE_SERVICE_ID(group, index) \
86bdcd8170SKalle Valo (int)(((int)group << 8) | (int)(index))
87bdcd8170SKalle Valo
88bdcd8170SKalle Valo /* NOTE: service ID of 0x0000 is reserved and should never be used */
89bdcd8170SKalle Valo #define HTC_CTRL_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 1)
90bdcd8170SKalle Valo #define WMI_CONTROL_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 0)
91bdcd8170SKalle Valo #define WMI_DATA_BE_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 1)
92bdcd8170SKalle Valo #define WMI_DATA_BK_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 2)
93bdcd8170SKalle Valo #define WMI_DATA_VI_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 3)
94bdcd8170SKalle Valo #define WMI_DATA_VO_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 4)
95bdcd8170SKalle Valo #define WMI_MAX_SERVICES 5
96bdcd8170SKalle Valo
97b29072ccSChilam Ng #define WMM_NUM_AC 4
98b29072ccSChilam Ng
99bdcd8170SKalle Valo /* reserved and used to flush ALL packets */
100bdcd8170SKalle Valo #define HTC_TX_PACKET_TAG_ALL 0
101bdcd8170SKalle Valo #define HTC_SERVICE_TX_PACKET_TAG 1
102bdcd8170SKalle Valo #define HTC_TX_PACKET_TAG_USER_DEFINED (HTC_SERVICE_TX_PACKET_TAG + 9)
103bdcd8170SKalle Valo
104bdcd8170SKalle Valo /* more packets on this endpoint are being fetched */
105bdcd8170SKalle Valo #define HTC_RX_FLAGS_INDICATE_MORE_PKTS (1 << 0)
106bdcd8170SKalle Valo
107bdcd8170SKalle Valo /* TODO.. for BMI */
108bdcd8170SKalle Valo #define ENDPOINT1 0
109bdcd8170SKalle Valo /* TODO -remove me, but we have to fix BMI first */
110bdcd8170SKalle Valo #define HTC_MAILBOX_NUM_MAX 4
111bdcd8170SKalle Valo
112bdcd8170SKalle Valo /* enable send bundle padding for this endpoint */
113bdcd8170SKalle Valo #define HTC_FLGS_TX_BNDL_PAD_EN (1 << 0)
114bdcd8170SKalle Valo #define HTC_EP_ACTIVE ((u32) (1u << 31))
115bdcd8170SKalle Valo
116bdcd8170SKalle Valo /* HTC operational parameters */
117bdcd8170SKalle Valo #define HTC_TARGET_RESPONSE_TIMEOUT 2000 /* in ms */
118636f8288SKalle Valo #define HTC_TARGET_RESPONSE_POLL_WAIT 10
119636f8288SKalle Valo #define HTC_TARGET_RESPONSE_POLL_COUNT 200
120bdcd8170SKalle Valo #define HTC_TARGET_DEBUG_INTR_MASK 0x01
121bdcd8170SKalle Valo #define HTC_TARGET_CREDIT_INTR_MASK 0xF0
122bdcd8170SKalle Valo
123bdcd8170SKalle Valo #define HTC_HOST_MAX_MSG_PER_BUNDLE 8
124bdcd8170SKalle Valo #define HTC_MIN_HTC_MSGS_TO_BUNDLE 2
125bdcd8170SKalle Valo
126bdcd8170SKalle Valo /* packet flags */
127bdcd8170SKalle Valo
128bdcd8170SKalle Valo #define HTC_RX_PKT_IGNORE_LOOKAHEAD (1 << 0)
129bdcd8170SKalle Valo #define HTC_RX_PKT_REFRESH_HDR (1 << 1)
130bdcd8170SKalle Valo #define HTC_RX_PKT_PART_OF_BUNDLE (1 << 2)
131bdcd8170SKalle Valo #define HTC_RX_PKT_NO_RECYCLE (1 << 3)
132bdcd8170SKalle Valo
133bdcd8170SKalle Valo #define NUM_CONTROL_BUFFERS 8
134bdcd8170SKalle Valo #define NUM_CONTROL_TX_BUFFERS 2
135bdcd8170SKalle Valo #define NUM_CONTROL_RX_BUFFERS (NUM_CONTROL_BUFFERS - NUM_CONTROL_TX_BUFFERS)
136bdcd8170SKalle Valo
137bdcd8170SKalle Valo #define HTC_RECV_WAIT_BUFFERS (1 << 0)
138bdcd8170SKalle Valo #define HTC_OP_STATE_STOPPING (1 << 0)
139636f8288SKalle Valo #define HTC_OP_STATE_SETUP_COMPLETE (1 << 1)
140bdcd8170SKalle Valo
141bdcd8170SKalle Valo /*
142bdcd8170SKalle Valo * The frame header length and message formats defined herein were selected
143bdcd8170SKalle Valo * to accommodate optimal alignment for target processing. This reduces
144bdcd8170SKalle Valo * code size and improves performance. Any changes to the header length may
145bdcd8170SKalle Valo * alter the alignment and cause exceptions on the target. When adding to
146bdcd8170SKalle Valo * the messagestructures insure that fields are properly aligned.
147bdcd8170SKalle Valo */
148bdcd8170SKalle Valo
149bdcd8170SKalle Valo /* HTC frame header
150bdcd8170SKalle Valo *
151bdcd8170SKalle Valo * NOTE: do not remove or re-arrange the fields, these are minimally
152bdcd8170SKalle Valo * required to take advantage of 4-byte lookaheads in some hardware
153bdcd8170SKalle Valo * implementations.
154bdcd8170SKalle Valo */
155bdcd8170SKalle Valo struct htc_frame_hdr {
156*e3128a9dSKees Cook struct_group_tagged(htc_frame_look_ahead, header,
157*e3128a9dSKees Cook union {
158*e3128a9dSKees Cook struct {
159bdcd8170SKalle Valo u8 eid;
160bdcd8170SKalle Valo u8 flags;
161bdcd8170SKalle Valo
162bdcd8170SKalle Valo /* length of data (including trailer) that follows the header */
163bdcd8170SKalle Valo __le16 payld_len;
164bdcd8170SKalle Valo
165*e3128a9dSKees Cook };
166*e3128a9dSKees Cook u32 word;
167*e3128a9dSKees Cook };
168*e3128a9dSKees Cook );
169bdcd8170SKalle Valo /* end of 4-byte lookahead */
170bdcd8170SKalle Valo
171bdcd8170SKalle Valo u8 ctrl[2];
172bdcd8170SKalle Valo } __packed;
173bdcd8170SKalle Valo
174bdcd8170SKalle Valo /* HTC ready message */
175bdcd8170SKalle Valo struct htc_ready_msg {
176bdcd8170SKalle Valo __le16 msg_id;
177bdcd8170SKalle Valo __le16 cred_cnt;
178bdcd8170SKalle Valo __le16 cred_sz;
179bdcd8170SKalle Valo u8 max_ep;
180bdcd8170SKalle Valo u8 pad;
181bdcd8170SKalle Valo } __packed;
182bdcd8170SKalle Valo
183bdcd8170SKalle Valo /* extended HTC ready message */
184bdcd8170SKalle Valo struct htc_ready_ext_msg {
185bdcd8170SKalle Valo struct htc_ready_msg ver2_0_info;
186bdcd8170SKalle Valo u8 htc_ver;
187bdcd8170SKalle Valo u8 msg_per_htc_bndl;
188bdcd8170SKalle Valo } __packed;
189bdcd8170SKalle Valo
190bdcd8170SKalle Valo /* connect service */
191bdcd8170SKalle Valo struct htc_conn_service_msg {
192bdcd8170SKalle Valo __le16 msg_id;
193bdcd8170SKalle Valo __le16 svc_id;
194bdcd8170SKalle Valo __le16 conn_flags;
195bdcd8170SKalle Valo u8 svc_meta_len;
196bdcd8170SKalle Valo u8 pad;
197bdcd8170SKalle Valo } __packed;
198bdcd8170SKalle Valo
199bdcd8170SKalle Valo /* connect response */
200bdcd8170SKalle Valo struct htc_conn_service_resp {
201bdcd8170SKalle Valo __le16 msg_id;
202bdcd8170SKalle Valo __le16 svc_id;
203bdcd8170SKalle Valo u8 status;
204bdcd8170SKalle Valo u8 eid;
205bdcd8170SKalle Valo __le16 max_msg_sz;
206bdcd8170SKalle Valo u8 svc_meta_len;
207bdcd8170SKalle Valo u8 pad;
208bdcd8170SKalle Valo } __packed;
209bdcd8170SKalle Valo
210bdcd8170SKalle Valo struct htc_setup_comp_msg {
211bdcd8170SKalle Valo __le16 msg_id;
212bdcd8170SKalle Valo } __packed;
213bdcd8170SKalle Valo
214bdcd8170SKalle Valo /* extended setup completion message */
215bdcd8170SKalle Valo struct htc_setup_comp_ext_msg {
216bdcd8170SKalle Valo __le16 msg_id;
217bdcd8170SKalle Valo __le32 flags;
218bdcd8170SKalle Valo u8 msg_per_rxbndl;
219bdcd8170SKalle Valo u8 Rsvd[3];
220bdcd8170SKalle Valo } __packed;
221bdcd8170SKalle Valo
222bdcd8170SKalle Valo struct htc_record_hdr {
223bdcd8170SKalle Valo u8 rec_id;
224bdcd8170SKalle Valo u8 len;
225bdcd8170SKalle Valo } __packed;
226bdcd8170SKalle Valo
227bdcd8170SKalle Valo struct htc_credit_report {
228bdcd8170SKalle Valo u8 eid;
229bdcd8170SKalle Valo u8 credits;
230bdcd8170SKalle Valo } __packed;
231bdcd8170SKalle Valo
232bdcd8170SKalle Valo /*
233bdcd8170SKalle Valo * NOTE: The lk_ahd array is guarded by a pre_valid
234bdcd8170SKalle Valo * and Post Valid guard bytes. The pre_valid bytes must
235bdcd8170SKalle Valo * equal the inverse of the post_valid byte.
236bdcd8170SKalle Valo */
237bdcd8170SKalle Valo struct htc_lookahead_report {
238bdcd8170SKalle Valo u8 pre_valid;
239bdcd8170SKalle Valo u8 lk_ahd[4];
240bdcd8170SKalle Valo u8 post_valid;
241bdcd8170SKalle Valo } __packed;
242bdcd8170SKalle Valo
243bdcd8170SKalle Valo struct htc_bundle_lkahd_rpt {
244bdcd8170SKalle Valo u8 lk_ahd[4];
245bdcd8170SKalle Valo } __packed;
246bdcd8170SKalle Valo
247bdcd8170SKalle Valo /* Current service IDs */
248bdcd8170SKalle Valo
249bdcd8170SKalle Valo enum htc_service_grp_ids {
250bdcd8170SKalle Valo RSVD_SERVICE_GROUP = 0,
251bdcd8170SKalle Valo WMI_SERVICE_GROUP = 1,
252bdcd8170SKalle Valo
253bdcd8170SKalle Valo HTC_TEST_GROUP = 254,
254bdcd8170SKalle Valo HTC_SERVICE_GROUP_LAST = 255
255bdcd8170SKalle Valo };
256bdcd8170SKalle Valo
257bdcd8170SKalle Valo /* ------ endpoint IDS ------ */
258bdcd8170SKalle Valo
259bdcd8170SKalle Valo enum htc_endpoint_id {
260bdcd8170SKalle Valo ENDPOINT_UNUSED = -1,
261bdcd8170SKalle Valo ENDPOINT_0 = 0,
262bdcd8170SKalle Valo ENDPOINT_1 = 1,
263bdcd8170SKalle Valo ENDPOINT_2 = 2,
264bdcd8170SKalle Valo ENDPOINT_3,
265bdcd8170SKalle Valo ENDPOINT_4,
266bdcd8170SKalle Valo ENDPOINT_5,
267bdcd8170SKalle Valo ENDPOINT_6,
268bdcd8170SKalle Valo ENDPOINT_7,
269bdcd8170SKalle Valo ENDPOINT_8,
270bdcd8170SKalle Valo ENDPOINT_MAX,
271bdcd8170SKalle Valo };
272bdcd8170SKalle Valo
273bdcd8170SKalle Valo struct htc_tx_packet_info {
274bdcd8170SKalle Valo u16 tag;
275bdcd8170SKalle Valo int cred_used;
276bdcd8170SKalle Valo u8 flags;
277bdcd8170SKalle Valo int seqno;
278bdcd8170SKalle Valo };
279bdcd8170SKalle Valo
280bdcd8170SKalle Valo struct htc_rx_packet_info {
281bdcd8170SKalle Valo u32 exp_hdr;
282bdcd8170SKalle Valo u32 rx_flags;
283bdcd8170SKalle Valo u32 indicat_flags;
284bdcd8170SKalle Valo };
285bdcd8170SKalle Valo
286bdcd8170SKalle Valo struct htc_target;
287bdcd8170SKalle Valo
288bdcd8170SKalle Valo /* wrapper around endpoint-specific packets */
289bdcd8170SKalle Valo struct htc_packet {
290bdcd8170SKalle Valo struct list_head list;
291bdcd8170SKalle Valo
292bdcd8170SKalle Valo /* caller's per packet specific context */
293bdcd8170SKalle Valo void *pkt_cntxt;
294bdcd8170SKalle Valo
295bdcd8170SKalle Valo /*
296bdcd8170SKalle Valo * the true buffer start , the caller can store the real
297bdcd8170SKalle Valo * buffer start here. In receive callbacks, the HTC layer
298bdcd8170SKalle Valo * sets buf to the start of the payload past the header.
299bdcd8170SKalle Valo * This field allows the caller to reset buf when it recycles
300bdcd8170SKalle Valo * receive packets back to HTC.
301bdcd8170SKalle Valo */
302bdcd8170SKalle Valo u8 *buf_start;
303bdcd8170SKalle Valo
304bdcd8170SKalle Valo /*
305bdcd8170SKalle Valo * Pointer to the start of the buffer. In the transmit
306bdcd8170SKalle Valo * direction this points to the start of the payload. In the
307bdcd8170SKalle Valo * receive direction, however, the buffer when queued up
308bdcd8170SKalle Valo * points to the start of the HTC header but when returned
309bdcd8170SKalle Valo * to the caller points to the start of the payload
310bdcd8170SKalle Valo */
311bdcd8170SKalle Valo u8 *buf;
312bdcd8170SKalle Valo u32 buf_len;
313bdcd8170SKalle Valo
314bdcd8170SKalle Valo /* actual length of payload */
315bdcd8170SKalle Valo u32 act_len;
316bdcd8170SKalle Valo
317bdcd8170SKalle Valo /* endpoint that this packet was sent/recv'd from */
318bdcd8170SKalle Valo enum htc_endpoint_id endpoint;
319bdcd8170SKalle Valo
320bdcd8170SKalle Valo /* completion status */
321bdcd8170SKalle Valo
322bdcd8170SKalle Valo int status;
323bdcd8170SKalle Valo union {
324bdcd8170SKalle Valo struct htc_tx_packet_info tx;
325bdcd8170SKalle Valo struct htc_rx_packet_info rx;
326bdcd8170SKalle Valo } info;
327bdcd8170SKalle Valo
328bdcd8170SKalle Valo void (*completion) (struct htc_target *, struct htc_packet *);
329bdcd8170SKalle Valo struct htc_target *context;
330cfc10f24SKalle Valo
331cfc10f24SKalle Valo /*
332cfc10f24SKalle Valo * optimization for network-oriented data, the HTC packet
333cfc10f24SKalle Valo * can pass the network buffer corresponding to the HTC packet
334cfc10f24SKalle Valo * lower layers may optimized the transfer knowing this is
335cfc10f24SKalle Valo * a network buffer
336cfc10f24SKalle Valo */
337cfc10f24SKalle Valo struct sk_buff *skb;
338bdcd8170SKalle Valo };
339bdcd8170SKalle Valo
340bdcd8170SKalle Valo enum htc_send_full_action {
341bdcd8170SKalle Valo HTC_SEND_FULL_KEEP = 0,
342bdcd8170SKalle Valo HTC_SEND_FULL_DROP = 1,
343bdcd8170SKalle Valo };
344bdcd8170SKalle Valo
345bdcd8170SKalle Valo struct htc_ep_callbacks {
34663de1112SKalle Valo void (*tx_complete) (struct htc_target *, struct htc_packet *);
347bdcd8170SKalle Valo void (*rx) (struct htc_target *, struct htc_packet *);
348bdcd8170SKalle Valo void (*rx_refill) (struct htc_target *, enum htc_endpoint_id endpoint);
349bdcd8170SKalle Valo enum htc_send_full_action (*tx_full) (struct htc_target *,
350bdcd8170SKalle Valo struct htc_packet *);
351bdcd8170SKalle Valo struct htc_packet *(*rx_allocthresh) (struct htc_target *,
352bdcd8170SKalle Valo enum htc_endpoint_id, int);
353900d6b3fSKalle Valo void (*tx_comp_multi) (struct htc_target *, struct list_head *);
354bdcd8170SKalle Valo int rx_alloc_thresh;
355bdcd8170SKalle Valo int rx_refill_thresh;
356bdcd8170SKalle Valo };
357bdcd8170SKalle Valo
358bdcd8170SKalle Valo /* service connection information */
359bdcd8170SKalle Valo struct htc_service_connect_req {
360bdcd8170SKalle Valo u16 svc_id;
361bdcd8170SKalle Valo u16 conn_flags;
362bdcd8170SKalle Valo struct htc_ep_callbacks ep_cb;
363bdcd8170SKalle Valo int max_txq_depth;
364bdcd8170SKalle Valo u32 flags;
365bdcd8170SKalle Valo unsigned int max_rxmsg_sz;
366bdcd8170SKalle Valo };
367bdcd8170SKalle Valo
368bdcd8170SKalle Valo /* service connection response information */
369bdcd8170SKalle Valo struct htc_service_connect_resp {
370bdcd8170SKalle Valo u8 buf_len;
371bdcd8170SKalle Valo u8 act_len;
372bdcd8170SKalle Valo enum htc_endpoint_id endpoint;
373bdcd8170SKalle Valo unsigned int len_max;
374bdcd8170SKalle Valo u8 resp_code;
375bdcd8170SKalle Valo };
376bdcd8170SKalle Valo
377bdcd8170SKalle Valo /* endpoint distributionstructure */
378bdcd8170SKalle Valo struct htc_endpoint_credit_dist {
379bdcd8170SKalle Valo struct list_head list;
380bdcd8170SKalle Valo
381bdcd8170SKalle Valo /* Service ID (set by HTC) */
382bdcd8170SKalle Valo u16 svc_id;
383bdcd8170SKalle Valo
384bdcd8170SKalle Valo /* endpoint for this distributionstruct (set by HTC) */
385bdcd8170SKalle Valo enum htc_endpoint_id endpoint;
386bdcd8170SKalle Valo
387bdcd8170SKalle Valo u32 dist_flags;
388bdcd8170SKalle Valo
389bdcd8170SKalle Valo /*
390bdcd8170SKalle Valo * credits for normal operation, anything above this
391bdcd8170SKalle Valo * indicates the endpoint is over-subscribed.
392bdcd8170SKalle Valo */
393bdcd8170SKalle Valo int cred_norm;
394bdcd8170SKalle Valo
395bdcd8170SKalle Valo /* floor for credit distribution */
396bdcd8170SKalle Valo int cred_min;
397bdcd8170SKalle Valo
398bdcd8170SKalle Valo int cred_assngd;
399bdcd8170SKalle Valo
400bdcd8170SKalle Valo /* current credits available */
401bdcd8170SKalle Valo int credits;
402bdcd8170SKalle Valo
403bdcd8170SKalle Valo /*
404bdcd8170SKalle Valo * pending credits to distribute on this endpoint, this
405bdcd8170SKalle Valo * is set by HTC when credit reports arrive. The credit
406bdcd8170SKalle Valo * distribution functions sets this to zero when it distributes
407bdcd8170SKalle Valo * the credits.
408bdcd8170SKalle Valo */
409bdcd8170SKalle Valo int cred_to_dist;
410bdcd8170SKalle Valo
411bdcd8170SKalle Valo /*
412bdcd8170SKalle Valo * the number of credits that the current pending TX packet needs
413bdcd8170SKalle Valo * to transmit. This is set by HTC when endpoint needs credits in
414bdcd8170SKalle Valo * order to transmit.
415bdcd8170SKalle Valo */
416bdcd8170SKalle Valo int seek_cred;
417bdcd8170SKalle Valo
418bdcd8170SKalle Valo /* size in bytes of each credit */
419bdcd8170SKalle Valo int cred_sz;
420bdcd8170SKalle Valo
421bdcd8170SKalle Valo /* credits required for a maximum sized messages */
422bdcd8170SKalle Valo int cred_per_msg;
423bdcd8170SKalle Valo
424bdcd8170SKalle Valo /* reserved for HTC use */
425e8c39790SKalle Valo struct htc_endpoint *htc_ep;
426bdcd8170SKalle Valo
427bdcd8170SKalle Valo /*
428bdcd8170SKalle Valo * current depth of TX queue , i.e. messages waiting for credits
429bdcd8170SKalle Valo * This field is valid only when HTC_CREDIT_DIST_ACTIVITY_CHANGE
430bdcd8170SKalle Valo * or HTC_CREDIT_DIST_SEND_COMPLETE is indicated on an endpoint
431bdcd8170SKalle Valo * that has non-zero credits to recover.
432bdcd8170SKalle Valo */
433bdcd8170SKalle Valo int txq_depth;
434bdcd8170SKalle Valo };
435bdcd8170SKalle Valo
436bdcd8170SKalle Valo /*
437a0d61f5fSNik Nyby * credit distribution code that is passed into the distribution function,
438bdcd8170SKalle Valo * there are mandatory and optional codes that must be handled
439bdcd8170SKalle Valo */
440bdcd8170SKalle Valo enum htc_credit_dist_reason {
441bdcd8170SKalle Valo HTC_CREDIT_DIST_SEND_COMPLETE = 0,
442bdcd8170SKalle Valo HTC_CREDIT_DIST_ACTIVITY_CHANGE = 1,
443bdcd8170SKalle Valo HTC_CREDIT_DIST_SEEK_CREDITS,
444bdcd8170SKalle Valo };
445bdcd8170SKalle Valo
4463c370398SKalle Valo struct ath6kl_htc_credit_info {
447bdcd8170SKalle Valo int total_avail_credits;
448bdcd8170SKalle Valo int cur_free_credits;
4493c370398SKalle Valo
4503c370398SKalle Valo /* list of lowest priority endpoints */
451bdcd8170SKalle Valo struct list_head lowestpri_ep_dist;
452bdcd8170SKalle Valo };
453bdcd8170SKalle Valo
454bdcd8170SKalle Valo /* endpoint statistics */
455bdcd8170SKalle Valo struct htc_endpoint_stats {
456bdcd8170SKalle Valo /*
457bdcd8170SKalle Valo * number of times the host set the credit-low flag in a send
458bdcd8170SKalle Valo * message on this endpoint
459bdcd8170SKalle Valo */
460bdcd8170SKalle Valo u32 cred_low_indicate;
461bdcd8170SKalle Valo
462bdcd8170SKalle Valo u32 tx_issued;
463bdcd8170SKalle Valo u32 tx_pkt_bundled;
464bdcd8170SKalle Valo u32 tx_bundles;
465bdcd8170SKalle Valo u32 tx_dropped;
466bdcd8170SKalle Valo
467bdcd8170SKalle Valo /* running count of total credit reports received for this endpoint */
468bdcd8170SKalle Valo u32 tx_cred_rpt;
469bdcd8170SKalle Valo
470bdcd8170SKalle Valo /* credit reports received from this endpoint's RX packets */
471bdcd8170SKalle Valo u32 cred_rpt_from_rx;
472bdcd8170SKalle Valo
473bdcd8170SKalle Valo /* credit reports received from RX packets of other endpoints */
474bdcd8170SKalle Valo u32 cred_rpt_from_other;
475bdcd8170SKalle Valo
476bdcd8170SKalle Valo /* credit reports received from endpoint 0 RX packets */
477bdcd8170SKalle Valo u32 cred_rpt_ep0;
478bdcd8170SKalle Valo
479bdcd8170SKalle Valo /* count of credits received via Rx packets on this endpoint */
480bdcd8170SKalle Valo u32 cred_from_rx;
481bdcd8170SKalle Valo
482bdcd8170SKalle Valo /* count of credits received via another endpoint */
483bdcd8170SKalle Valo u32 cred_from_other;
484bdcd8170SKalle Valo
485bdcd8170SKalle Valo /* count of credits received via another endpoint */
486bdcd8170SKalle Valo u32 cred_from_ep0;
487bdcd8170SKalle Valo
488bdcd8170SKalle Valo /* count of consummed credits */
489bdcd8170SKalle Valo u32 cred_cosumd;
490bdcd8170SKalle Valo
491bdcd8170SKalle Valo /* count of credits returned */
492bdcd8170SKalle Valo u32 cred_retnd;
493bdcd8170SKalle Valo
494bdcd8170SKalle Valo u32 rx_pkts;
495bdcd8170SKalle Valo
496bdcd8170SKalle Valo /* count of lookahead records found in Rx msg */
497bdcd8170SKalle Valo u32 rx_lkahds;
498bdcd8170SKalle Valo
499bdcd8170SKalle Valo /* count of recv packets received in a bundle */
500bdcd8170SKalle Valo u32 rx_bundl;
501bdcd8170SKalle Valo
502bdcd8170SKalle Valo /* count of number of bundled lookaheads */
503bdcd8170SKalle Valo u32 rx_bundle_lkahd;
504bdcd8170SKalle Valo
505bdcd8170SKalle Valo /* count of the number of bundle indications from the HTC header */
506bdcd8170SKalle Valo u32 rx_bundle_from_hdr;
507bdcd8170SKalle Valo
508bdcd8170SKalle Valo /* the number of times the recv allocation threshold was hit */
509bdcd8170SKalle Valo u32 rx_alloc_thresh_hit;
510bdcd8170SKalle Valo
511bdcd8170SKalle Valo /* total number of bytes */
512bdcd8170SKalle Valo u32 rxalloc_thresh_byte;
513bdcd8170SKalle Valo };
514bdcd8170SKalle Valo
515bdcd8170SKalle Valo struct htc_endpoint {
516bdcd8170SKalle Valo enum htc_endpoint_id eid;
517bdcd8170SKalle Valo u16 svc_id;
518bdcd8170SKalle Valo struct list_head txq;
519bdcd8170SKalle Valo struct list_head rx_bufq;
520bdcd8170SKalle Valo struct htc_endpoint_credit_dist cred_dist;
521bdcd8170SKalle Valo struct htc_ep_callbacks ep_cb;
522bdcd8170SKalle Valo int max_txq_depth;
523bdcd8170SKalle Valo int len_max;
524bdcd8170SKalle Valo int tx_proc_cnt;
525bdcd8170SKalle Valo int rx_proc_cnt;
526bdcd8170SKalle Valo struct htc_target *target;
527bdcd8170SKalle Valo u8 seqno;
528bdcd8170SKalle Valo u32 conn_flags;
529bdcd8170SKalle Valo struct htc_endpoint_stats ep_st;
5300ea10f2bSChilam Ng u16 tx_drop_packet_threshold;
531636f8288SKalle Valo
532636f8288SKalle Valo struct {
533636f8288SKalle Valo u8 pipeid_ul;
534636f8288SKalle Valo u8 pipeid_dl;
535636f8288SKalle Valo struct list_head tx_lookup_queue;
536636f8288SKalle Valo bool tx_credit_flow_enabled;
537636f8288SKalle Valo } pipe;
538bdcd8170SKalle Valo };
539bdcd8170SKalle Valo
540bdcd8170SKalle Valo struct htc_control_buffer {
541bdcd8170SKalle Valo struct htc_packet packet;
542bdcd8170SKalle Valo u8 *buf;
543bdcd8170SKalle Valo };
544bdcd8170SKalle Valo
545636f8288SKalle Valo struct htc_pipe_txcredit_alloc {
546636f8288SKalle Valo u16 service_id;
547636f8288SKalle Valo u8 credit_alloc;
548636f8288SKalle Valo };
549636f8288SKalle Valo
550636f8288SKalle Valo enum htc_send_queue_result {
551636f8288SKalle Valo HTC_SEND_QUEUE_OK = 0, /* packet was queued */
552636f8288SKalle Valo HTC_SEND_QUEUE_DROP = 1, /* this packet should be dropped */
553636f8288SKalle Valo };
554636f8288SKalle Valo
555e76ac2bfSKalle Valo struct ath6kl_htc_ops {
556e76ac2bfSKalle Valo void* (*create)(struct ath6kl *ar);
557e76ac2bfSKalle Valo int (*wait_target)(struct htc_target *target);
558e76ac2bfSKalle Valo int (*start)(struct htc_target *target);
559e76ac2bfSKalle Valo int (*conn_service)(struct htc_target *target,
560e76ac2bfSKalle Valo struct htc_service_connect_req *req,
561e76ac2bfSKalle Valo struct htc_service_connect_resp *resp);
562e76ac2bfSKalle Valo int (*tx)(struct htc_target *target, struct htc_packet *packet);
563e76ac2bfSKalle Valo void (*stop)(struct htc_target *target);
564e76ac2bfSKalle Valo void (*cleanup)(struct htc_target *target);
565e76ac2bfSKalle Valo void (*flush_txep)(struct htc_target *target,
566e76ac2bfSKalle Valo enum htc_endpoint_id endpoint, u16 tag);
567e76ac2bfSKalle Valo void (*flush_rx_buf)(struct htc_target *target);
568e76ac2bfSKalle Valo void (*activity_changed)(struct htc_target *target,
569e76ac2bfSKalle Valo enum htc_endpoint_id endpoint,
570e76ac2bfSKalle Valo bool active);
571e76ac2bfSKalle Valo int (*get_rxbuf_num)(struct htc_target *target,
572e76ac2bfSKalle Valo enum htc_endpoint_id endpoint);
573e76ac2bfSKalle Valo int (*add_rxbuf_multiple)(struct htc_target *target,
574e76ac2bfSKalle Valo struct list_head *pktq);
575e76ac2bfSKalle Valo int (*credit_setup)(struct htc_target *target,
576e76ac2bfSKalle Valo struct ath6kl_htc_credit_info *cred_info);
577e76ac2bfSKalle Valo int (*tx_complete)(struct ath6kl *ar, struct sk_buff *skb);
578e76ac2bfSKalle Valo int (*rx_complete)(struct ath6kl *ar, struct sk_buff *skb, u8 pipe);
579e76ac2bfSKalle Valo };
580e76ac2bfSKalle Valo
581bdcd8170SKalle Valo struct ath6kl_device;
582bdcd8170SKalle Valo
583bdcd8170SKalle Valo /* our HTC target state */
584bdcd8170SKalle Valo struct htc_target {
585bdcd8170SKalle Valo struct htc_endpoint endpoint[ENDPOINT_MAX];
5863c370398SKalle Valo
5873c370398SKalle Valo /* contains struct htc_endpoint_credit_dist */
588bdcd8170SKalle Valo struct list_head cred_dist_list;
5893c370398SKalle Valo
590bdcd8170SKalle Valo struct list_head free_ctrl_txbuf;
591bdcd8170SKalle Valo struct list_head free_ctrl_rxbuf;
5923c370398SKalle Valo struct ath6kl_htc_credit_info *credit_info;
593bdcd8170SKalle Valo int tgt_creds;
594bdcd8170SKalle Valo unsigned int tgt_cred_sz;
59512eb9444SKalle Valo
59612eb9444SKalle Valo /* protects free_ctrl_txbuf and free_ctrl_rxbuf */
597bdcd8170SKalle Valo spinlock_t htc_lock;
59812eb9444SKalle Valo
59912eb9444SKalle Valo /* FIXME: does this protext rx_bufq and endpoint structures or what? */
600bdcd8170SKalle Valo spinlock_t rx_lock;
60112eb9444SKalle Valo
60212eb9444SKalle Valo /* protects endpoint->txq */
603bdcd8170SKalle Valo spinlock_t tx_lock;
60412eb9444SKalle Valo
605bdcd8170SKalle Valo struct ath6kl_device *dev;
606bdcd8170SKalle Valo u32 htc_flags;
607bdcd8170SKalle Valo u32 rx_st_flags;
608bdcd8170SKalle Valo enum htc_endpoint_id ep_waiting;
609bdcd8170SKalle Valo u8 htc_tgt_ver;
610bdcd8170SKalle Valo
611bdcd8170SKalle Valo /* max messages per bundle for HTC */
612bdcd8170SKalle Valo int msg_per_bndl_max;
613bdcd8170SKalle Valo
614b29072ccSChilam Ng u32 tx_bndl_mask;
615bdcd8170SKalle Valo int rx_bndl_enable;
6163b2f5e51SVasanthakumar Thiagarajan int max_rx_bndl_sz;
6173b2f5e51SVasanthakumar Thiagarajan int max_tx_bndl_sz;
6185be8824fSVasanthakumar Thiagarajan
6195be8824fSVasanthakumar Thiagarajan u32 block_sz;
6205be8824fSVasanthakumar Thiagarajan u32 block_mask;
62150745af7SVasanthakumar Thiagarajan
62250745af7SVasanthakumar Thiagarajan int max_scat_entries;
62350745af7SVasanthakumar Thiagarajan int max_xfer_szper_scatreq;
624fcb82058SVasanthakumar Thiagarajan
625fcb82058SVasanthakumar Thiagarajan int chk_irq_status_cnt;
626b29072ccSChilam Ng
627b29072ccSChilam Ng /* counts the number of Tx without bundling continously per AC */
628b29072ccSChilam Ng u32 ac_tx_count[WMM_NUM_AC];
629636f8288SKalle Valo
630636f8288SKalle Valo struct {
631636f8288SKalle Valo struct htc_packet *htc_packet_pool;
632636f8288SKalle Valo u8 ctrl_response_buf[HTC_MAX_CTRL_MSG_LEN];
633636f8288SKalle Valo int ctrl_response_len;
634636f8288SKalle Valo bool ctrl_response_valid;
635636f8288SKalle Valo struct htc_pipe_txcredit_alloc txcredit_alloc[ENDPOINT_MAX];
636636f8288SKalle Valo } pipe;
637bdcd8170SKalle Valo };
638bdcd8170SKalle Valo
639ad226ec2SKalle Valo int ath6kl_htc_rxmsg_pending_handler(struct htc_target *target,
6404533d901SVasanthakumar Thiagarajan u32 msg_look_ahead, int *n_pkts);
641bdcd8170SKalle Valo
set_htc_pkt_info(struct htc_packet * packet,void * context,u8 * buf,unsigned int len,enum htc_endpoint_id eid,u16 tag)642bdcd8170SKalle Valo static inline void set_htc_pkt_info(struct htc_packet *packet, void *context,
643bdcd8170SKalle Valo u8 *buf, unsigned int len,
644bdcd8170SKalle Valo enum htc_endpoint_id eid, u16 tag)
645bdcd8170SKalle Valo {
646bdcd8170SKalle Valo packet->pkt_cntxt = context;
647bdcd8170SKalle Valo packet->buf = buf;
648bdcd8170SKalle Valo packet->act_len = len;
649bdcd8170SKalle Valo packet->endpoint = eid;
650bdcd8170SKalle Valo packet->info.tx.tag = tag;
651bdcd8170SKalle Valo }
652bdcd8170SKalle Valo
htc_rxpkt_reset(struct htc_packet * packet)653bdcd8170SKalle Valo static inline void htc_rxpkt_reset(struct htc_packet *packet)
654bdcd8170SKalle Valo {
655bdcd8170SKalle Valo packet->buf = packet->buf_start;
656bdcd8170SKalle Valo packet->act_len = 0;
657bdcd8170SKalle Valo }
658bdcd8170SKalle Valo
set_htc_rxpkt_info(struct htc_packet * packet,void * context,u8 * buf,unsigned long len,enum htc_endpoint_id eid)659bdcd8170SKalle Valo static inline void set_htc_rxpkt_info(struct htc_packet *packet, void *context,
660bdcd8170SKalle Valo u8 *buf, unsigned long len,
661bdcd8170SKalle Valo enum htc_endpoint_id eid)
662bdcd8170SKalle Valo {
663bdcd8170SKalle Valo packet->pkt_cntxt = context;
664bdcd8170SKalle Valo packet->buf = buf;
665bdcd8170SKalle Valo packet->buf_start = buf;
666bdcd8170SKalle Valo packet->buf_len = len;
667bdcd8170SKalle Valo packet->endpoint = eid;
668bdcd8170SKalle Valo }
669bdcd8170SKalle Valo
get_queue_depth(struct list_head * queue)670bdcd8170SKalle Valo static inline int get_queue_depth(struct list_head *queue)
671bdcd8170SKalle Valo {
672bdcd8170SKalle Valo struct list_head *tmp_list;
673bdcd8170SKalle Valo int depth = 0;
674bdcd8170SKalle Valo
675bdcd8170SKalle Valo list_for_each(tmp_list, queue)
676bdcd8170SKalle Valo depth++;
677bdcd8170SKalle Valo
678bdcd8170SKalle Valo return depth;
679bdcd8170SKalle Valo }
680bdcd8170SKalle Valo
681636f8288SKalle Valo void ath6kl_htc_pipe_attach(struct ath6kl *ar);
682e76ac2bfSKalle Valo void ath6kl_htc_mbox_attach(struct ath6kl *ar);
683e76ac2bfSKalle Valo
684bdcd8170SKalle Valo #endif
685