xref: /freebsd/sys/dev/ath/if_ath_alq.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2012 Adrian Chadd
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer,
12  *    without modification.
13  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
15  *    redistribution must be conditioned upon including a substantially
16  *    similar Disclaimer requirement for further binary redistribution.
17  *
18  * NO WARRANTY
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
22  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
24  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
27  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29  * THE POSSIBILITY OF SUCH DAMAGES.
30  */
31 #ifndef	__IF_ATH_ALQ_H__
32 #define	__IF_ATH_ALQ_H__
33 
34 #define	ATH_ALQ_INIT_STATE		1
35 struct if_ath_alq_init_state {
36 	uint32_t	sc_mac_version;
37 	uint32_t	sc_mac_revision;
38 	uint32_t	sc_phy_rev;
39 	uint32_t	sc_hal_magic;
40 };
41 
42 #define	ATH_ALQ_EDMA_TXSTATUS		2
43 #define	ATH_ALQ_EDMA_RXSTATUS		3
44 #define	ATH_ALQ_EDMA_TXDESC		4
45 
46 #define	ATH_ALQ_TDMA_BEACON_STATE	5
47 struct if_ath_alq_tdma_beacon_state {
48 	uint64_t	rx_tsf;		/* RX TSF of beacon frame */
49 	uint64_t	beacon_tsf;	/* TSF inside beacon frame */
50 	uint64_t	tsf64;
51 	uint64_t	nextslot_tsf;
52 	uint32_t	nextslot_tu;
53 	uint32_t	txtime;
54 };
55 
56 #define	ATH_ALQ_TDMA_TIMER_CONFIG	6
57 struct if_ath_alq_tdma_timer_config {
58 	uint32_t	tdma_slot;
59 	uint32_t	tdma_slotlen;
60 	uint32_t	tdma_slotcnt;
61 	uint32_t	tdma_bintval;
62 	uint32_t	tdma_guard;
63 	uint32_t	tdma_scbintval;
64 	uint32_t	tdma_dbaprep;
65 };
66 
67 #define	ATH_ALQ_TDMA_SLOT_CALC		7
68 struct if_ath_alq_tdma_slot_calc {
69 	uint64_t	nexttbtt;
70 	uint64_t	next_slot;
71 	int32_t		tsfdelta;
72 	int32_t		avg_plus;
73 	int32_t		avg_minus;
74 };
75 
76 #define	ATH_ALQ_TDMA_TSF_ADJUST		8
77 struct if_ath_alq_tdma_tsf_adjust {
78 	uint64_t	tsf64_old;
79 	uint64_t	tsf64_new;
80 	int32_t		tsfdelta;
81 };
82 
83 #define	ATH_ALQ_TDMA_TIMER_SET		9
84 struct if_ath_alq_tdma_timer_set {
85 	uint32_t	bt_intval;
86 	uint32_t	bt_nexttbtt;
87 	uint32_t	bt_nextdba;
88 	uint32_t	bt_nextswba;
89 	uint32_t	bt_nextatim;
90 	uint32_t	bt_flags;
91 	uint32_t	sc_tdmadbaprep;
92 	uint32_t	sc_tdmaswbaprep;
93 };
94 
95 #define	ATH_ALQ_INTR_STATUS		10
96 struct if_ath_alq_interrupt {
97 	uint32_t	intr_status;
98 	uint32_t	intr_state[8];
99 	uint32_t	intr_syncstate;
100 };
101 
102 #define	ATH_ALQ_MIB_COUNTERS		11
103 struct if_ath_alq_mib_counters {
104 	uint32_t	valid;
105 	uint32_t	tx_busy;
106 	uint32_t	rx_busy;
107 	uint32_t	chan_busy;
108 	uint32_t	ext_chan_busy;
109 	uint32_t	cycle_count;
110 };
111 
112 #define	ATH_ALQ_MISSED_BEACON		12
113 #define	ATH_ALQ_STUCK_BEACON		13
114 #define	ATH_ALQ_RESUME_BEACON		14
115 
116 #define	ATH_ALQ_TX_FIFO_PUSH		15
117 struct if_ath_alq_tx_fifo_push {
118 	uint32_t	txq;
119 	uint32_t	nframes;
120 	uint32_t	fifo_depth;
121 	uint32_t	frame_cnt;
122 };
123 
124 /*
125  * These will always be logged, regardless.
126  */
127 #define	ATH_ALQ_LOG_ALWAYS_MASK		0x00000001
128 
129 #define	ATH_ALQ_FILENAME_LEN	128
130 #define	ATH_ALQ_DEVNAME_LEN	32
131 
132 struct if_ath_alq {
133 	uint32_t	sc_alq_debug;		/* Debug flags to report */
134 	struct alq *	sc_alq_alq;		/* alq state */
135 	unsigned int	sc_alq_qsize;		/* queue size */
136 	unsigned int	sc_alq_numlost;		/* number of "lost" entries */
137 	int		sc_alq_isactive;
138 	char		sc_alq_devname[ATH_ALQ_DEVNAME_LEN];
139 	char		sc_alq_filename[ATH_ALQ_FILENAME_LEN];
140 	struct if_ath_alq_init_state sc_alq_cfg;
141 };
142 
143 /* 128 bytes in total */
144 #define	ATH_ALQ_PAYLOAD_LEN		112
145 
146 struct if_ath_alq_hdr {
147 	uint64_t	threadid;
148 	uint32_t	tstamp_sec;
149 	uint32_t	tstamp_usec;
150 	uint16_t	op;
151 	uint16_t	len;	/* Length of (optional) payload */
152 };
153 
154 struct if_ath_alq_payload {
155 	struct if_ath_alq_hdr hdr;
156 	char		payload[];
157 };
158 
159 #ifdef	_KERNEL
160 static inline int
if_ath_alq_checkdebug(struct if_ath_alq * alq,uint16_t op)161 if_ath_alq_checkdebug(struct if_ath_alq *alq, uint16_t op)
162 {
163 
164 	return ((alq->sc_alq_debug | ATH_ALQ_LOG_ALWAYS_MASK)
165 	    & (1 << (op - 1)));
166 }
167 
168 extern	void if_ath_alq_init(struct if_ath_alq *alq, const char *devname);
169 extern	void if_ath_alq_setcfg(struct if_ath_alq *alq, uint32_t macVer,
170 	    uint32_t macRev, uint32_t phyRev, uint32_t halMagic);
171 extern	void if_ath_alq_tidyup(struct if_ath_alq *alq);
172 extern	int if_ath_alq_start(struct if_ath_alq *alq);
173 extern	int if_ath_alq_stop(struct if_ath_alq *alq);
174 extern	void if_ath_alq_post(struct if_ath_alq *alq, uint16_t op,
175 	    uint16_t len, const char *buf);
176 
177 /* XXX maybe doesn't belong here? */
178 static inline void
if_ath_alq_post_intr(struct if_ath_alq * alq,uint32_t status,uint32_t * state,uint32_t sync_state)179 if_ath_alq_post_intr(struct if_ath_alq *alq, uint32_t status,
180     uint32_t *state, uint32_t sync_state)
181 {
182 	int i;
183 	struct if_ath_alq_interrupt intr;
184 
185 	if (! if_ath_alq_checkdebug(alq, ATH_ALQ_INTR_STATUS))
186 		return;
187 
188 	intr.intr_status = htobe32(status);
189 	for (i = 0; i < 8; i++)
190 		intr.intr_state[i] = htobe32(state[i]);
191 	intr.intr_syncstate = htobe32(sync_state);
192 
193 	if_ath_alq_post(alq, ATH_ALQ_INTR_STATUS, sizeof(intr),
194 	    (const char *) &intr);
195 }
196 
197 #endif	/* _KERNEL */
198 
199 #endif
200