From patchwork Fri Dec 20 11:29:55 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 13916628 X-Patchwork-Delegate: geert@linux-m68k.org Received: from mail.zeus03.de (zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C11991C5F22 for ; Fri, 20 Dec 2024 11:30:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734694233; cv=none; b=uApbtw79xrqUOGhPUx5cdprXnPLoR6uFcye2QcY5NKsJPEGwYQdh5gQuswncdLXErGdQ+Itdh4Y5BDg7CFKK8gUORdbv4dPSQH5a/1NZ115M0Ejb1AcCPrruewjIYK6qjjzehQe0uhHgZCqYery3C2/vfz2kVH+6AEbG1SXRkvM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1734694233; c=relaxed/simple; bh=eqGHK14hiiHm06pTZF2RCIe0dz2FSZkRJZ81635i/Kg=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=WlNa09h9gac6sSO+dw0RXGmDfXfuUtintwY6bNDkJRxaIWUPims+5RMYNx9988s5wFca41qz4T+wBKSwLOV2I7YNQjq5D7VEVgOb5oVkisw5X87trECNNkbCg2hqvx87/K0IfAWlxopx0c/et2HOu9uSlbLO8UxY/DqnGoU9S+o= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=HG7IkTzX; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="HG7IkTzX" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; s=k1; bh=uWx7Khj94+L0maCjBS9mNDc9rvpKoRkC0PwJFVrpB/4=; b=HG7IkT zXozOs/ChC8zGZ+i12XO18fIY3hnQc8eyHLWrtufHdJ8zDz5jSjdQKViFekG2KKX 8nSG5kAVJSsHUyGu4JeV2cWv+JPmWxYvvuAxz9GuhvzoL2hBwpEstwi9Fv4kzSj4 cB2HgfKUbEF0IZ6r2uFfJsIwau6C5y4Q4nTqq0QGNgZFy8MWAUvAMxPZga8+UMMs G4LEpc6XPAGuB+3sgDDL9ayg2VRX2p5K2vDMNhB4WZFCUk/C8stxEz3B0xzuEkyI oNtxyrEKJyOWRZrNx4noAY2RlKn5rSf4EEiD5rZv8BL8Vfw3RwNqybvtcwDPvMO2 v3MXz4+ubhLSbreA== Received: (qmail 989678 invoked from network); 20 Dec 2024 12:30:19 +0100 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 20 Dec 2024 12:30:19 +0100 X-UD-Smtp-Session: l3s3148p1@bi+9+LEpXpAujnsY From: Wolfram Sang To: linux-renesas-soc@vger.kernel.org Cc: Yury Norov , Wolfram Sang , Guenter Roeck , Geert Uytterhoeven , Kuan-Wei Chiu , Rasmus Villemoes Subject: [PATCH RFT 1/5] bitops: add generic parity calculation for u8 Date: Fri, 20 Dec 2024 12:29:55 +0100 Message-Id: <20241220113000.17537-2-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20241220113000.17537-1-wsa+renesas@sang-engineering.com> References: <20241220113000.17537-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-renesas-soc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 There are multiple open coded implementations for getting the parity of a byte in the kernel, even using different approaches. Take the pretty efficient version from SPD5118 driver and make it generally available by putting it into the bitops header. As long as there is just one parity calculation helper, the creation of a distinct 'parity.h' header was discarded. Also, the usage of hweight8() for architectures having a popcnt instruction is postponed until a use case within hot paths is desired. The motivation for this patch is the frequent use of odd parity in the I3C specification and to simplify drivers there. Changes compared to the original SPD5118 version are the addition of kernel documentation, switching the return type from bool to int, and renaming the argument of the function. Signed-off-by: Wolfram Sang Tested-by: Guenter Roeck Reviewed-by: Geert Uytterhoeven Acked-by: Yury Norov Reviewed-by: Kuan-Wei Chiu Tested-by: Kuan-Wei Chiu --- include/linux/bitops.h | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/include/linux/bitops.h b/include/linux/bitops.h index ba35bbf07798..4ed430934ffc 100644 --- a/include/linux/bitops.h +++ b/include/linux/bitops.h @@ -229,6 +229,37 @@ static inline int get_count_order_long(unsigned long l) return (int)fls_long(--l); } +/** + * get_parity8 - get the parity of an u8 value + * @value: the value to be examined + * + * Determine the parity of the u8 argument. + * + * Returns: + * 0 for even parity, 1 for odd parity + * + * Note: This function informs you about the current parity. Example to bail + * out when parity is odd: + * + * if (get_parity8(val) == 1) + * return -EBADMSG; + * + * If you need to calculate a parity bit, you need to draw the conclusion from + * this result yourself. Example to enforce odd parity, parity bit is bit 7: + * + * if (get_parity8(val) == 0) + * val |= BIT(7); + */ +static inline int get_parity8(u8 val) +{ + /* + * One explanation of this algorithm: + * https://funloop.org/codex/problem/parity/README.html + */ + val ^= val >> 4; + return (0x6996 >> (val & 0xf)) & 1; +} + /** * __ffs64 - find first set bit in a 64 bit word * @word: The 64 bit word