xref: /freebsd/sys/dev/ath/if_ath_misc.h (revision fcb560670601b2a4d87bb31d7531c8dcc37ee71b)
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 /* unaligned little endian access */
43 #define LE_READ_2(p)							\
44 	((u_int16_t)							\
45 	 ((((u_int8_t *)(p))[0]      ) | (((u_int8_t *)(p))[1] <<  8)))
46 #define LE_READ_4(p)							\
47 	((u_int32_t)							\
48 	 ((((u_int8_t *)(p))[0]      ) | (((u_int8_t *)(p))[1] <<  8) |	\
49 	  (((u_int8_t *)(p))[2] << 16) | (((u_int8_t *)(p))[3] << 24)))
50 
51 extern int ath_rxbuf;
52 extern int ath_txbuf;
53 extern int ath_txbuf_mgmt;
54 
55 extern int ath_tx_findrix(const struct ath_softc *sc, uint8_t rate);
56 
57 extern struct ath_buf * ath_getbuf(struct ath_softc *sc,
58 	    ath_buf_type_t btype);
59 extern struct ath_buf * _ath_getbuf_locked(struct ath_softc *sc,
60 	    ath_buf_type_t btype);
61 extern struct ath_buf * ath_buf_clone(struct ath_softc *sc,
62 	    struct ath_buf *bf);
63 /* XXX change this to NULL the buffer pointer? */
64 extern void ath_freebuf(struct ath_softc *sc, struct ath_buf *bf);
65 extern void ath_returnbuf_head(struct ath_softc *sc, struct ath_buf *bf);
66 extern void ath_returnbuf_tail(struct ath_softc *sc, struct ath_buf *bf);
67 
68 extern int ath_reset(struct ifnet *, ATH_RESET_TYPE);
69 extern void ath_tx_default_comp(struct ath_softc *sc, struct ath_buf *bf,
70 	    int fail);
71 extern void ath_tx_update_ratectrl(struct ath_softc *sc,
72 	    struct ieee80211_node *ni, struct ath_rc_series *rc,
73 	    struct ath_tx_status *ts, int frmlen, int nframes, int nbad);
74 
75 extern	int ath_hal_gethangstate(struct ath_hal *ah, uint32_t mask,
76 	    uint32_t *hangs);
77 
78 extern void ath_tx_freebuf(struct ath_softc *sc, struct ath_buf *bf,
79     int status);
80 extern	void ath_txq_freeholdingbuf(struct ath_softc *sc,
81 	    struct ath_txq *txq);
82 
83 extern void ath_txqmove(struct ath_txq *dst, struct ath_txq *src);
84 
85 extern void ath_mode_init(struct ath_softc *sc);
86 
87 extern void ath_setdefantenna(struct ath_softc *sc, u_int antenna);
88 
89 extern void ath_setslottime(struct ath_softc *sc);
90 
91 extern	int ath_descdma_alloc_desc(struct ath_softc *sc,
92 	    struct ath_descdma *dd, ath_bufhead *head, const char *name,
93 	    int ds_size, int ndesc);
94 extern	int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
95 	    ath_bufhead *head, const char *name, int ds_size, int nbuf,
96 	    int ndesc);
97 extern	int ath_descdma_setup_rx_edma(struct ath_softc *sc,
98 	    struct ath_descdma *dd, ath_bufhead *head, const char *name,
99 	    int nbuf, int desclen);
100 extern	void ath_descdma_cleanup(struct ath_softc *sc,
101 	    struct ath_descdma *dd, ath_bufhead *head);
102 
103 extern	void ath_legacy_attach_comp_func(struct ath_softc *sc);
104 
105 extern	void ath_tx_draintxq(struct ath_softc *sc, struct ath_txq *txq);
106 
107 extern	void ath_legacy_tx_drain(struct ath_softc *sc,
108 	    ATH_RESET_TYPE reset_type);
109 
110 extern	void ath_tx_process_buf_completion(struct ath_softc *sc,
111 	    struct ath_txq *txq, struct ath_tx_status *ts, struct ath_buf *bf);
112 
113 extern	int ath_stoptxdma(struct ath_softc *sc);
114 
115 extern	void ath_tx_update_tim(struct ath_softc *sc,
116 	    struct ieee80211_node *ni, int enable);
117 
118 /*
119  * This is only here so that the RX proc function can call it.
120  * It's very likely that the "start TX after RX" call should be
121  * done via something in if_ath.c, moving "rx tasklet" into
122  * if_ath.c and do the ath_start() call there.  Once that's done,
123  * we can kill this.
124  */
125 extern void ath_start(struct ifnet *ifp);
126 extern	void ath_start_task(void *arg, int npending);
127 
128 extern void ath_tx_dump(struct ath_softc *sc, struct ath_txq *txq);
129 
130 /*
131  * Power state tracking.
132  */
133 extern	void _ath_power_setpower(struct ath_softc *sc, int power_state, const char *file, int line);
134 extern	void _ath_power_set_selfgen(struct ath_softc *sc, int power_state, const char *file, int line);
135 extern	void _ath_power_set_power_state(struct ath_softc *sc, int power_state, const char *file, int line);
136 extern	void _ath_power_restore_power_state(struct ath_softc *sc, const char *file, int line);
137 
138 #define	ath_power_setpower(sc, ps) _ath_power_setpower(sc, ps, __FILE__, __LINE__)
139 #define	ath_power_setselfgen(sc, ps) _ath_power_set_selfgen(sc, ps, __FILE__, __LINE__)
140 #define	ath_power_set_power_state(sc, ps) _ath_power_set_power_state(sc, ps, __FILE__, __LINE__)
141 #define	ath_power_restore_power_state(sc) _ath_power_restore_power_state(sc, __FILE__, __LINE__)
142 
143 /*
144  * Kick the frame TX task.
145  */
146 static inline void
147 ath_tx_kick(struct ath_softc *sc)
148 {
149 
150 	/* XXX NULL for now */
151 }
152 
153 /*
154  * Kick the software TX queue task.
155  */
156 static inline void
157 ath_tx_swq_kick(struct ath_softc *sc)
158 {
159 
160 	taskqueue_enqueue(sc->sc_tq, &sc->sc_txqtask);
161 }
162 
163 #endif
164