xref: /freebsd/sys/dev/ath/ath_rate/amrr/amrr.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2004 INRIA
5  * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer,
13     without modification.
14  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
15  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
16  *    redistribution must be conditioned upon including a substantially
17  *    similar Disclaimer requirement for further binary redistribution.
18  * 3. Neither the names of the above-listed copyright holders nor the names
19  *    of any contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  * Alternatively, this software may be distributed under the terms of the
23  * GNU General Public License ("GPL") version 2 as published by the Free
24  * Software Foundation.
25  *
26  * NO WARRANTY
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
30  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
31  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
32  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
35  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
37  * THE POSSIBILITY OF SUCH DAMAGES.
38  */
39 
40 #ifndef _DEV_ATH_RATE_AMRR_H
41 #define _DEV_ATH_RATE_AMRR_H
42 
43 /* per-device state */
44 struct amrr_softc {
45 	struct ath_ratectrl arc;	/* base state */
46 };
47 
48 /* per-node state */
49 struct amrr_node {
50 	int		amn_rix;	/* current rate index */
51 	int		amn_ticks;	/* time of last update */
52 	int		amn_interval;	/* update interval (ticks) */
53   	/* AMRR statistics for this node */
54   	u_int           amn_tx_try0_cnt;
55   	u_int           amn_tx_try1_cnt;
56   	u_int           amn_tx_try2_cnt;
57   	u_int           amn_tx_try3_cnt;
58   	u_int           amn_tx_failure_cnt;
59         /* AMRR algorithm state for this node */
60   	u_int           amn_success_threshold;
61   	u_int           amn_success;
62   	u_int           amn_recovery;
63 	/* rate index et al. */
64 	u_int8_t	amn_tx_rix0;	/* series 0 rate index */
65 	u_int8_t	amn_tx_rate0;	/* series 0 h/w rate */
66 	u_int8_t	amn_tx_rate1;	/* series 1 h/w rate */
67 	u_int8_t	amn_tx_rate2;	/* series 2 h/w rate */
68 	u_int8_t	amn_tx_rate3;	/* series 3 h/w rate */
69 	u_int8_t	amn_tx_rate0sp;	/* series 0 short preamble h/w rate */
70 	u_int8_t	amn_tx_rate1sp;	/* series 1 short preamble h/w rate */
71 	u_int8_t	amn_tx_rate2sp;	/* series 2 short preamble h/w rate */
72 	u_int8_t	amn_tx_rate3sp;	/* series 3 short preamble h/w rate */
73 	u_int8_t	amn_tx_try0;	/* series 0 try count */
74   	u_int           amn_tx_try1;    /* series 1 try count */
75   	u_int           amn_tx_try2;    /* series 2 try count */
76   	u_int           amn_tx_try3;    /* series 3 try count */
77 };
78 #define	ATH_NODE_AMRR(an)	((struct amrr_node *)&an[1])
79 #endif /* _DEV_ATH_RATE_AMRR_H */
80