xref: /freebsd/sys/dev/ath/if_ath_alq.h (revision 526e1dc1c0d052b9d2a6cd6da7a16eb09c971c54)
1 /*-
2  * Copyright (c) 2012 Adrian Chadd
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  * $FreeBSD$
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 /*
96  * These will always be logged, regardless.
97  */
98 #define	ATH_ALQ_LOG_ALWAYS_MASK		0x00000001
99 
100 #define	ATH_ALQ_FILENAME_LEN	128
101 #define	ATH_ALQ_DEVNAME_LEN	32
102 
103 struct if_ath_alq {
104 	uint32_t	sc_alq_debug;		/* Debug flags to report */
105 	struct alq *	sc_alq_alq;		/* alq state */
106 	unsigned int	sc_alq_qsize;		/* queue size */
107 	unsigned int	sc_alq_numlost;		/* number of "lost" entries */
108 	int		sc_alq_isactive;
109 	char		sc_alq_devname[ATH_ALQ_DEVNAME_LEN];
110 	char		sc_alq_filename[ATH_ALQ_FILENAME_LEN];
111 	struct if_ath_alq_init_state sc_alq_cfg;
112 };
113 
114 /* 128 bytes in total */
115 #define	ATH_ALQ_PAYLOAD_LEN		112
116 
117 struct if_ath_alq_hdr {
118 	uint64_t	threadid;
119 	uint32_t	tstamp;
120 	uint16_t	op;
121 	uint16_t	len;	/* Length of (optional) payload */
122 };
123 
124 struct if_ath_alq_payload {
125 	struct if_ath_alq_hdr hdr;
126 	char		payload[];
127 };
128 
129 #ifdef	_KERNEL
130 static inline int
131 if_ath_alq_checkdebug(struct if_ath_alq *alq, uint16_t op)
132 {
133 
134 	return ((alq->sc_alq_debug | ATH_ALQ_LOG_ALWAYS_MASK)
135 	    & (1 << (op - 1)));
136 }
137 
138 extern	void if_ath_alq_init(struct if_ath_alq *alq, const char *devname);
139 extern	void if_ath_alq_setcfg(struct if_ath_alq *alq, uint32_t macVer,
140 	    uint32_t macRev, uint32_t phyRev, uint32_t halMagic);
141 extern	void if_ath_alq_tidyup(struct if_ath_alq *alq);
142 extern	int if_ath_alq_start(struct if_ath_alq *alq);
143 extern	int if_ath_alq_stop(struct if_ath_alq *alq);
144 extern	void if_ath_alq_post(struct if_ath_alq *alq, uint16_t op,
145 	    uint16_t len, const char *buf);
146 #endif	/* _KERNEL */
147 
148 #endif
149