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