xref: /freebsd/sys/dev/ath/if_ath_misc.h (revision 3416500aef140042c64bc149cb1ec6620483bc44)
1 /*-
2  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
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_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 extern void ath_tx_default_comp(struct ath_softc *sc, struct ath_buf *bf,
61 	    int fail);
62 extern void ath_tx_update_ratectrl(struct ath_softc *sc,
63 	    struct ieee80211_node *ni, struct ath_rc_series *rc,
64 	    struct ath_tx_status *ts, int frmlen, int nframes, int nbad);
65 
66 extern	int ath_hal_gethangstate(struct ath_hal *ah, uint32_t mask,
67 	    uint32_t *hangs);
68 
69 extern void ath_tx_freebuf(struct ath_softc *sc, struct ath_buf *bf,
70     int status);
71 extern	void ath_txq_freeholdingbuf(struct ath_softc *sc,
72 	    struct ath_txq *txq);
73 
74 extern void ath_txqmove(struct ath_txq *dst, struct ath_txq *src);
75 
76 extern void ath_mode_init(struct ath_softc *sc);
77 
78 extern void ath_setdefantenna(struct ath_softc *sc, u_int antenna);
79 
80 extern void ath_setslottime(struct ath_softc *sc);
81 
82 extern	void ath_legacy_attach_comp_func(struct ath_softc *sc);
83 
84 extern	void ath_tx_draintxq(struct ath_softc *sc, struct ath_txq *txq);
85 
86 extern	void ath_legacy_tx_drain(struct ath_softc *sc,
87 	    ATH_RESET_TYPE reset_type);
88 
89 extern	void ath_tx_process_buf_completion(struct ath_softc *sc,
90 	    struct ath_txq *txq, struct ath_tx_status *ts, struct ath_buf *bf);
91 
92 extern	int ath_stoptxdma(struct ath_softc *sc);
93 
94 extern	void ath_tx_update_tim(struct ath_softc *sc,
95 	    struct ieee80211_node *ni, int enable);
96 
97 /*
98  * This is only here so that the RX proc function can call it.
99  * It's very likely that the "start TX after RX" call should be
100  * done via something in if_ath.c, moving "rx tasklet" into
101  * if_ath.c and do the ath_start() call there.  Once that's done,
102  * we can kill this.
103  */
104 extern void ath_start(struct ifnet *ifp);
105 extern	void ath_start_task(void *arg, int npending);
106 
107 extern void ath_tx_dump(struct ath_softc *sc, struct ath_txq *txq);
108 
109 /*
110  * Power state tracking.
111  */
112 extern	void _ath_power_setpower(struct ath_softc *sc, int power_state,
113 	    int selfgen, const char *file, int line);
114 extern	void _ath_power_set_selfgen(struct ath_softc *sc,
115 	    int power_state, const char *file, int line);
116 extern	void _ath_power_set_power_state(struct ath_softc *sc,
117 	    int power_state, const char *file, int line);
118 extern	void _ath_power_restore_power_state(struct ath_softc *sc,
119 	    const char *file, int line);
120 
121 #define	ath_power_setpower(sc, ps, sg) _ath_power_setpower(sc, ps, sg, \
122 	    __FILE__, __LINE__)
123 #define	ath_power_setselfgen(sc, ps) _ath_power_set_selfgen(sc, ps, \
124 	    __FILE__, __LINE__)
125 #define	ath_power_set_power_state(sc, ps) \
126 	    _ath_power_set_power_state(sc, ps, __FILE__, __LINE__)
127 #define	ath_power_restore_power_state(sc) \
128 	    _ath_power_restore_power_state(sc, __FILE__, __LINE__)
129 
130 /*
131  * Kick the frame TX task.
132  */
133 static inline void
134 ath_tx_kick(struct ath_softc *sc)
135 {
136 
137 	/* XXX NULL for now */
138 }
139 
140 /*
141  * Kick the software TX queue task.
142  */
143 static inline void
144 ath_tx_swq_kick(struct ath_softc *sc)
145 {
146 
147 	taskqueue_enqueue(sc->sc_tq, &sc->sc_txqtask);
148 }
149 
150 #endif
151