2010-04-07 15:29:13 +00:00
|
|
|
/*-
|
2023-05-10 15:40:58 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2017-11-27 15:23:17 +00:00
|
|
|
*
|
2010-04-07 15:29:13 +00:00
|
|
|
* Copyright (c) 2010 Rui Paulo <rpaulo@FreeBSD.org>
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
|
|
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
2021-03-07 17:35:58 +00:00
|
|
|
#ifndef _NET80211_IEEE80211_RATECTL_H_
|
|
|
|
#define _NET80211_IEEE80211_RATECTL_H_
|
|
|
|
|
2010-04-07 15:29:13 +00:00
|
|
|
enum ieee80211_ratealgs {
|
2010-10-19 18:49:26 +00:00
|
|
|
IEEE80211_RATECTL_AMRR = 0,
|
2010-04-07 15:29:13 +00:00
|
|
|
IEEE80211_RATECTL_RSSADAPT = 1,
|
|
|
|
IEEE80211_RATECTL_ONOE = 2,
|
|
|
|
IEEE80211_RATECTL_SAMPLE = 3,
|
2010-10-19 18:49:26 +00:00
|
|
|
IEEE80211_RATECTL_NONE = 4,
|
2010-04-07 15:29:13 +00:00
|
|
|
IEEE80211_RATECTL_MAX
|
|
|
|
};
|
|
|
|
|
2016-10-02 20:35:55 +00:00
|
|
|
/* used fields for tx_complete() events */
|
|
|
|
#define IEEE80211_RATECTL_STATUS_PKTLEN 0x00000001
|
|
|
|
#define IEEE80211_RATECTL_STATUS_FINAL_RATE 0x00000002
|
|
|
|
#define IEEE80211_RATECTL_STATUS_SHORT_RETRY 0x00000004
|
|
|
|
#define IEEE80211_RATECTL_STATUS_LONG_RETRY 0x00000008
|
|
|
|
#define IEEE80211_RATECTL_STATUS_RSSI 0x00000010
|
|
|
|
|
|
|
|
/* failure reason */
|
|
|
|
enum ieee80211_ratectl_tx_fail_reason {
|
|
|
|
IEEE80211_RATECTL_TX_SUCCESS = 0,
|
|
|
|
IEEE80211_RATECTL_TX_FAIL_SHORT = 1, /* too many RTS retries */
|
|
|
|
IEEE80211_RATECTL_TX_FAIL_LONG = 2, /* too many retries */
|
|
|
|
IEEE80211_RATECTL_TX_FAIL_EXPIRED = 3, /* lifetime expired */
|
|
|
|
IEEE80211_RATECTL_TX_FAIL_UNSPECIFIED = 4, /* another reason */
|
|
|
|
};
|
|
|
|
#define IEEE80211_RATECTL_TX_FAIL_MAX \
|
|
|
|
(IEEE80211_RATECTL_TX_FAIL_UNSPECIFIED + 1)
|
|
|
|
|
|
|
|
struct ieee80211_ratectl_tx_status {
|
|
|
|
uint32_t flags; /* mark used fields */
|
|
|
|
enum ieee80211_ratectl_tx_fail_reason status; /* Tx status */
|
|
|
|
|
|
|
|
int pktlen; /* frame length */
|
|
|
|
int final_rate; /* transmission rate */
|
|
|
|
uint_fast8_t short_retries; /* RTS/CTS retries */
|
|
|
|
uint_fast8_t long_retries; /* ACK retries */
|
|
|
|
int8_t rssi; /* ACK RSSI */
|
|
|
|
|
|
|
|
uint8_t spare[15]; /* for future use */
|
|
|
|
};
|
|
|
|
|
|
|
|
/* used fields for tx_update() events */
|
|
|
|
#define IEEE80211_RATECTL_TX_STATS_NODE 0x00000001
|
|
|
|
#define IEEE80211_RATECTL_TX_STATS_RETRIES 0x00000002
|
|
|
|
|
|
|
|
struct ieee80211_ratectl_tx_stats {
|
|
|
|
uint32_t flags; /* mark used fields */
|
|
|
|
|
|
|
|
struct ieee80211_node *ni; /* receiver */
|
|
|
|
int nframes; /* transmitted frames */
|
|
|
|
int nsuccess; /* ACKed frames */
|
|
|
|
int nretries; /* number of retries */
|
|
|
|
};
|
2010-04-07 15:29:13 +00:00
|
|
|
|
|
|
|
struct ieee80211_ratectl {
|
|
|
|
const char *ir_name;
|
|
|
|
int (*ir_attach)(const struct ieee80211vap *);
|
|
|
|
void (*ir_detach)(const struct ieee80211vap *);
|
|
|
|
void (*ir_init)(struct ieee80211vap *);
|
|
|
|
void (*ir_deinit)(struct ieee80211vap *);
|
|
|
|
void (*ir_node_init)(struct ieee80211_node *);
|
|
|
|
void (*ir_node_deinit)(struct ieee80211_node *);
|
|
|
|
int (*ir_rate)(struct ieee80211_node *, void *, uint32_t);
|
2016-10-02 20:35:55 +00:00
|
|
|
void (*ir_tx_complete)(const struct ieee80211_node *,
|
|
|
|
const struct ieee80211_ratectl_tx_status *);
|
|
|
|
void (*ir_tx_update)(struct ieee80211vap *,
|
|
|
|
struct ieee80211_ratectl_tx_stats *);
|
2010-04-07 15:29:13 +00:00
|
|
|
void (*ir_setinterval)(const struct ieee80211vap *, int);
|
2016-03-16 02:07:04 +00:00
|
|
|
void (*ir_node_stats)(struct ieee80211_node *ni, struct sbuf *s);
|
2010-04-07 15:29:13 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
void ieee80211_ratectl_register(int, const struct ieee80211_ratectl *);
|
|
|
|
void ieee80211_ratectl_unregister(int);
|
2010-11-06 18:17:20 +00:00
|
|
|
void ieee80211_ratectl_init(struct ieee80211vap *);
|
2010-04-07 15:29:13 +00:00
|
|
|
void ieee80211_ratectl_set(struct ieee80211vap *, int);
|
|
|
|
|
|
|
|
MALLOC_DECLARE(M_80211_RATECTL);
|
|
|
|
|
2015-01-11 18:43:45 +00:00
|
|
|
static __inline void
|
2010-04-07 15:29:13 +00:00
|
|
|
ieee80211_ratectl_deinit(struct ieee80211vap *vap)
|
|
|
|
{
|
|
|
|
vap->iv_rate->ir_deinit(vap);
|
|
|
|
}
|
|
|
|
|
2015-01-11 18:43:45 +00:00
|
|
|
static __inline void
|
2010-04-07 15:29:13 +00:00
|
|
|
ieee80211_ratectl_node_init(struct ieee80211_node *ni)
|
|
|
|
{
|
|
|
|
const struct ieee80211vap *vap = ni->ni_vap;
|
|
|
|
|
|
|
|
vap->iv_rate->ir_node_init(ni);
|
|
|
|
}
|
|
|
|
|
2015-01-11 18:43:45 +00:00
|
|
|
static __inline void
|
2010-04-07 15:29:13 +00:00
|
|
|
ieee80211_ratectl_node_deinit(struct ieee80211_node *ni)
|
|
|
|
{
|
|
|
|
const struct ieee80211vap *vap = ni->ni_vap;
|
|
|
|
|
|
|
|
vap->iv_rate->ir_node_deinit(ni);
|
|
|
|
}
|
|
|
|
|
|
|
|
static int __inline
|
|
|
|
ieee80211_ratectl_rate(struct ieee80211_node *ni, void *arg, uint32_t iarg)
|
|
|
|
{
|
|
|
|
const struct ieee80211vap *vap = ni->ni_vap;
|
|
|
|
|
|
|
|
return vap->iv_rate->ir_rate(ni, arg, iarg);
|
|
|
|
}
|
|
|
|
|
2015-01-11 18:43:45 +00:00
|
|
|
static __inline void
|
2016-10-02 20:35:55 +00:00
|
|
|
ieee80211_ratectl_tx_complete(const struct ieee80211_node *ni,
|
|
|
|
const struct ieee80211_ratectl_tx_status *status)
|
2010-04-07 15:29:13 +00:00
|
|
|
{
|
2016-10-02 20:35:55 +00:00
|
|
|
const struct ieee80211vap *vap = ni->ni_vap;
|
|
|
|
|
|
|
|
vap->iv_rate->ir_tx_complete(ni, status);
|
2010-04-07 15:29:13 +00:00
|
|
|
}
|
|
|
|
|
2015-01-11 18:43:45 +00:00
|
|
|
static __inline void
|
2016-10-02 20:35:55 +00:00
|
|
|
ieee80211_ratectl_tx_update(struct ieee80211vap *vap,
|
|
|
|
struct ieee80211_ratectl_tx_stats *stats)
|
2010-04-07 15:29:13 +00:00
|
|
|
{
|
|
|
|
if (vap->iv_rate->ir_tx_update == NULL)
|
|
|
|
return;
|
2016-10-02 20:35:55 +00:00
|
|
|
vap->iv_rate->ir_tx_update(vap, stats);
|
2010-04-07 15:29:13 +00:00
|
|
|
}
|
|
|
|
|
2015-01-11 18:43:45 +00:00
|
|
|
static __inline void
|
2010-04-07 15:29:13 +00:00
|
|
|
ieee80211_ratectl_setinterval(const struct ieee80211vap *vap, int msecs)
|
|
|
|
{
|
|
|
|
if (vap->iv_rate->ir_setinterval == NULL)
|
|
|
|
return;
|
|
|
|
vap->iv_rate->ir_setinterval(vap, msecs);
|
|
|
|
}
|
2016-03-16 02:07:04 +00:00
|
|
|
|
|
|
|
static __inline void
|
|
|
|
ieee80211_ratectl_node_stats(struct ieee80211_node *ni, struct sbuf *s)
|
|
|
|
{
|
|
|
|
const struct ieee80211vap *vap = ni->ni_vap;
|
|
|
|
|
|
|
|
if (vap->iv_rate->ir_node_stats == NULL)
|
|
|
|
return;
|
|
|
|
vap->iv_rate->ir_node_stats(ni, s);
|
|
|
|
}
|
2021-03-07 17:35:58 +00:00
|
|
|
|
|
|
|
#endif /* _NET80211_IEEE80211_RATECTL_H_ */
|