xref: /freebsd/sys/dev/ath/if_ath_misc.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
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_MISC_H__
32 #define	__IF_ATH_MISC_H__
33 
34 /*
35  * This is where definitions for "public things" in if_ath.c
36  * will go for the time being.
37  *
38  * Anything in here should eventually be moved out of if_ath.c
39  * and into something else.
40  */
41 
42 extern int ath_rxbuf;
43 extern int ath_txbuf;
44 extern int ath_txbuf_mgmt;
45 
46 extern int ath_tx_findrix(const struct ath_softc *sc, uint8_t rate);
47 
48 extern struct ath_buf * ath_getbuf(struct ath_softc *sc,
49 	    ath_buf_type_t btype);
50 extern struct ath_buf * _ath_getbuf_locked(struct ath_softc *sc,
51 	    ath_buf_type_t btype);
52 extern struct ath_buf * ath_buf_clone(struct ath_softc *sc,
53 	    struct ath_buf *bf);
54 /* XXX change this to NULL the buffer pointer? */
55 extern void ath_freebuf(struct ath_softc *sc, struct ath_buf *bf);
56 extern void ath_returnbuf_head(struct ath_softc *sc, struct ath_buf *bf);
57 extern void ath_returnbuf_tail(struct ath_softc *sc, struct ath_buf *bf);
58 
59 extern int ath_reset(struct ath_softc *, ATH_RESET_TYPE,
60 	    HAL_RESET_TYPE ah_reset_type);
61 extern void ath_tx_default_comp(struct ath_softc *sc, struct ath_buf *bf,
62 	    int fail);
63 extern void ath_tx_update_ratectrl(struct ath_softc *sc,
64 	    struct ieee80211_node *ni, struct ath_rc_series *rc,
65 	    struct ath_tx_status *ts, int frmlen, int rc_framelen,
66 	    int nframes, int nbad);
67 
68 extern	int ath_hal_gethangstate(struct ath_hal *ah, uint32_t mask,
69 	    uint32_t *hangs);
70 
71 extern void ath_tx_freebuf(struct ath_softc *sc, struct ath_buf *bf,
72     int status);
73 extern	void ath_txq_freeholdingbuf(struct ath_softc *sc,
74 	    struct ath_txq *txq);
75 
76 extern void ath_txqmove(struct ath_txq *dst, struct ath_txq *src);
77 
78 extern void ath_mode_init(struct ath_softc *sc);
79 
80 extern void ath_setdefantenna(struct ath_softc *sc, u_int antenna);
81 
82 extern void ath_setslottime(struct ath_softc *sc);
83 
84 extern	void ath_legacy_attach_comp_func(struct ath_softc *sc);
85 
86 extern	void ath_tx_draintxq(struct ath_softc *sc, struct ath_txq *txq);
87 
88 extern	void ath_legacy_tx_drain(struct ath_softc *sc,
89 	    ATH_RESET_TYPE reset_type);
90 
91 extern	void ath_tx_process_buf_completion(struct ath_softc *sc,
92 	    struct ath_txq *txq, struct ath_tx_status *ts, struct ath_buf *bf);
93 
94 extern	int ath_stoptxdma(struct ath_softc *sc);
95 
96 extern	void ath_tx_update_tim(struct ath_softc *sc,
97 	    struct ieee80211_node *ni, int enable);
98 
99 /*
100  * This is only here so that the RX proc function can call it.
101  * It's very likely that the "start TX after RX" call should be
102  * done via something in if_ath.c, moving "rx tasklet" into
103  * if_ath.c and do the ath_start() call there.  Once that's done,
104  * we can kill this.
105  */
106 extern void ath_start(if_t ifp);
107 extern	void ath_start_task(void *arg, int npending);
108 
109 extern void ath_tx_dump(struct ath_softc *sc, struct ath_txq *txq);
110 
111 /*
112  * Power state tracking.
113  */
114 extern	void _ath_power_setpower(struct ath_softc *sc, int power_state,
115 	    int selfgen, const char *file, int line);
116 extern	void _ath_power_set_selfgen(struct ath_softc *sc,
117 	    int power_state, const char *file, int line);
118 extern	void _ath_power_set_power_state(struct ath_softc *sc,
119 	    int power_state, const char *file, int line);
120 extern	void _ath_power_restore_power_state(struct ath_softc *sc,
121 	    const char *file, int line);
122 
123 #define	ath_power_setpower(sc, ps, sg) _ath_power_setpower(sc, ps, sg, \
124 	    __FILE__, __LINE__)
125 #define	ath_power_setselfgen(sc, ps) _ath_power_set_selfgen(sc, ps, \
126 	    __FILE__, __LINE__)
127 #define	ath_power_set_power_state(sc, ps) \
128 	    _ath_power_set_power_state(sc, ps, __FILE__, __LINE__)
129 #define	ath_power_restore_power_state(sc) \
130 	    _ath_power_restore_power_state(sc, __FILE__, __LINE__)
131 
132 /*
133  * Kick the frame TX task.
134  */
135 static inline void
ath_tx_kick(struct ath_softc * sc)136 ath_tx_kick(struct ath_softc *sc)
137 {
138 
139 	/* XXX NULL for now */
140 }
141 
142 /*
143  * Kick the software TX queue task.
144  */
145 static inline void
ath_tx_swq_kick(struct ath_softc * sc)146 ath_tx_swq_kick(struct ath_softc *sc)
147 {
148 
149 	taskqueue_enqueue(sc->sc_tq, &sc->sc_txqtask);
150 }
151 
152 #endif
153