From owner-dev-commits-src-branches@freebsd.org Sun Jul 18 00:36:40 2021 Return-Path: Delivered-To: dev-commits-src-branches@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 1E60E65F0F7; Sun, 18 Jul 2021 00:36:40 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4GS5dM12wMz4Rb5; Sun, 18 Jul 2021 00:36:39 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 6E7381A697; Sun, 18 Jul 2021 00:36:36 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 16I0aaF1049337; Sun, 18 Jul 2021 00:36:36 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 16I0aabq049336; Sun, 18 Jul 2021 00:36:36 GMT (envelope-from git) Date: Sun, 18 Jul 2021 00:36:36 GMT Message-Id: <202107180036.16I0aabq049336@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: "Bjoern A. Zeeb" Subject: git: 3da0b61e0630 - stable/13 - LinuxKPI: add Exponentially Weighted Moving Average implementation MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bz X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: 3da0b61e06301c9a397a8c5463f7aee61de21a0a Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-branches@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commits to the stable branches of the FreeBSD src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 18 Jul 2021 00:36:40 -0000 The branch stable/13 has been updated by bz: URL: https://cgit.FreeBSD.org/src/commit/?id=3da0b61e06301c9a397a8c5463f7aee61de21a0a commit 3da0b61e06301c9a397a8c5463f7aee61de21a0a Author: Bjoern A. Zeeb AuthorDate: 2021-05-24 17:42:25 +0000 Commit: Bjoern A. Zeeb CommitDate: 2021-07-18 00:35:02 +0000 LinuxKPI: add Exponentially Weighted Moving Average implementation Add DECLARE_EWMA() which expands to a per-name EWMA implementation as used by multiple wireless drivers. Sposnored by: The FreeBSD Foundation Reviewed by: hselasky, cperciva, dwmalone Differential Revision: https://reviews.freebsd.org/D30415 (cherry picked from commit 32f753f27032849de685c15c471034cbc945a544) --- sys/compat/linuxkpi/common/include/linux/average.h | 92 ++++++++++++++++++++++ 1 file changed, 92 insertions(+) diff --git a/sys/compat/linuxkpi/common/include/linux/average.h b/sys/compat/linuxkpi/common/include/linux/average.h new file mode 100644 index 000000000000..4291bf2d85be --- /dev/null +++ b/sys/compat/linuxkpi/common/include/linux/average.h @@ -0,0 +1,92 @@ +/*- + * SPDX-License-Identifier: BSD-2-Clause + * + * Copyright (c) 2020-2021 The FreeBSD Foundation + * + * This software was developed by Björn Zeeb under sponsorship from + * the FreeBSD Foundation. + * + * 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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. + * + * $FreeBSD$ + */ + +#ifndef __LKPI_LINUX_AVERAGE_H +#define __LKPI_LINUX_AVERAGE_H + +#include +#include +#include +#include + +/* EWMA stands for Exponentially Weighted Moving Average. */ +/* + * Z_t = d X_t + (1 - d) * Z_(t-1); 0 < d <= 1, t >= 1; Roberts (1959). + * t : observation number in time. + * d : weight for current observation. + * Xt : observations over time. + * Zt : EWMA value after observation t. + * + * wmba_*_read seems to return up-to [u]long values; have to deal with 32/64bit. + * According to the ath5k.h change log this seems to be a fix-(_p)recision impl. + * assert 2/4 bits for frac. + * Also all (_d) values seem to be pow2 which simplifies maths (shift by + * d = ilog2(_d) instead of doing division (d = 1/_d)). Keep it this way until + * we hit the CTASSERT. + */ + +#define DECLARE_EWMA(_name, _p, _d) \ + \ + CTASSERT((sizeof(unsigned long) <= 4) ? (_p < 30) : (_p < 60)); \ + CTASSERT(_d > 0 && powerof2(_d)); \ + \ + struct ewma_ ## _name { \ + unsigned long zt; \ + }; \ + \ + static __inline void \ + ewma_ ## _name ## _init(struct ewma_ ## _name *ewma) \ + { \ + /* No target (no historical data). */ \ + ewma->zt = 0; \ + } \ + \ + static __inline void \ + ewma_ ## _name ## _add(struct ewma_ ## _name *ewma, unsigned long x) \ + { \ + unsigned long ztm1 = ewma->zt; /* Z_(t-1). */ \ + int d = ilog2(_d); \ + \ + if (ewma->zt == 0) \ + ewma->zt = x << (_p); \ + else \ + ewma->zt = ((x << (_p)) >> d) + \ + (((ztm1 << d) - ztm1) >> d); \ + } \ + \ + static __inline unsigned long \ + ewma_ ## _name ## _read(struct ewma_ ## _name *ewma) \ + { \ + return (ewma->zt >> (_p)); \ + } \ + +#endif /* __LKPI_LINUX_AVERAGE_H */