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