Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <9b872036-42ce-2d08-2e98-12bf0abf7095@axentia.se>
Date:   Tue, 23 May 2023 14:16:30 +0200
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Thunderbird/102.6.0
Content-Language: sv-SE
To:     LKML <linux-kernel@vger.kernel.org>
Cc:     Jakub Kicinski <kuba@kernel.org>,
        Dinan Gunawardena <dinan.gunawardena@netronome.com>,
        Kalle Valo <kvalo@kernel.org>,
        Johannes Berg <johannes.berg@intel.com>
From:   Peter Rosin <peda@axentia.se>
Subject: [PATCH] bitfield: suggest using bitwise OR when combining bitfields
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?UkVaUHZKdHIxTmdWYzBDRm9tWjFxaEkxWDMycThXNnJlanRhdktyc1R2L1Iy?=
 =?utf-8?B?NXkvSzcvZkkwRzB4R2pGSFJrNXhNRlYyU2dJMXg4b3dvNHBwUldDVm10UTE2?=
 =?utf-8?B?YzNDN3l5bFFpUlNpY3Y3NXVRR2FjL1RyUXY4RFhFa1FaakVoZEFobEd4b0oz?=
 =?utf-8?B?ZXF1SVM5bWtXS24vTEdHM3pTK21JQ2hSQ1EwREl5bTJDR1JrVnI4L1BZUnkv?=
 =?utf-8?B?OHI5bXJZUlowaFdpZWM4bDVYR0ZxWFpIc0luSTFQTEZ6Qzl4V3VPbDVRVXl1?=
 =?utf-8?B?aTZQZWhEQUY3Ti9jdlJGZnNvSHZKaGZjZWVGU1BSUC9qYk05eTZPNG50U2tv?=
 =?utf-8?B?bVoxUGliaC9OYmVEdWNxTkROR3VQeUl0T21lUDVCQVl0SWpZTkFmbUd0MUZo?=
 =?utf-8?B?U1AzRW55WW5aSzY1MEZsWEJJeHpyR0FkUXhITHloN3QxaTZpQURUMTFpL0NB?=
 =?utf-8?B?Rlh3eXpiaTlFYThPNW5PTWRXa28weStXZHhBODVvcnFTTURsamFCVVBEbXdj?=
 =?utf-8?B?a09NblBEZ1U4UDV1UkV3MzZqMkxjS05JK3d1L2lrL2ZVVjM0RDh6bHdjaUtJ?=
 =?utf-8?B?Z2RwbWpDdSs0RkdJdXdPMEhoak1zSU9mMEdWaXZucDh2NU5iNVBFVjQ3Lzhj?=
 =?utf-8?B?aEJyU2haY01ZUm9za013cTgrZGFVajFXUUZqTkxUTWtaSHRhVUtySlo5Qjly?=
 =?utf-8?B?K3dlNk85MjNxZFpNRUlicmQ2M0ZTV053YjJFTnE0RUFoWlBXY2FyVHp2Vkp5?=
 =?utf-8?B?YnhHdEM1Z0VpSGlJeUxhQWtmUHFxUU9UMkFrZnlsTFR1SDR4dFg0VjAyaEJE?=
 =?utf-8?B?TzNBYVhQempnSWxhcHh2NjdBazNpVEZVYVMyYmpBRi9QekZLZFFteU1qYTUx?=
 =?utf-8?B?QWhEMVdLTFNXWmdqQmsrL0szRUtGQXdPdnhZUGdRdDNrdXJDQ0FKY0dUczBT?=
 =?utf-8?B?NUR4VTlpMU5Dd3JxYnU0Mzd0dkQ4UDVTdmtJeEdKNnVwc3lWMnVKWlBoRFBX?=
 =?utf-8?B?MXorWDZMVXczVGdtQWE5cEVkZnZ2eEh5Y1YrY0xIWWZwbUU1MFJZbGtpMUhi?=
 =?utf-8?B?ZS93QmZrK2UxRlR1bkhsQ2tGWUFBK1JBMnFUWXZBeWNGaDJ1VTBFUkZEY1Nh?=
 =?utf-8?B?M0pVakg3aXdSVzR2MTBOa21Xb3AyUXNrUVB2ald0N0Jtc1lmZHNCS3VyTC8v?=
 =?utf-8?B?VVpzTE1mZ2tIUVBjdm1LTVdzNCtSbWYyYUJBcFRUQ0tJTXFhT0VDRUN5dWZR?=
 =?utf-8?B?Y05hdkluQkxMZTJCTVByYjhmQ2lyYXQzeTFkVzhSMXZoNVJEdFh5ZTlPU3VG?=
 =?utf-8?B?WG1lS2RuTzY0SzR0Qk1PTHRlSk5JY0VGL2t2VnB6VXdYdnI2UXp3L3NmeHJT?=
 =?utf-8?B?b3pveVAwUTY5Y2dTd0srd3lvMGhkQ2tYTERnTG54TWxtdXdKT0NWM3kwV2Nr?=
 =?utf-8?B?cjBlUWV6SjA0N2s4V2ZzaUg5ZHNVTXhLeUZXTFU2bmxhaFVIMmdRN0pMNWsw?=
 =?utf-8?B?bDh6RXJaa3dXTVlCeXlyUG96VnBTUnpPZC9ja1NzVm1xRnppK3p5NkRwamQx?=
 =?utf-8?B?aytVL05LQzdrTVY1a1hvUFBiaExEMFE2VVZMckxKL1hoSnpjVzZaaEpqZVM3?=
 =?utf-8?B?Tlk1V1pxYzVQdEpTVjZ1UndLRU1jTDdwclhreTBtanpLTFoyc1BtM0ZKQzk2?=
 =?utf-8?B?LzhHZUVkdVJld1ZYRnlYN2dtNkhjeUI2L2Y5NlZtclRPY3FUeGFaMnNDaTAz?=
 =?utf-8?B?eCtHT1I5a3Nmd1BDRk12YXM3MDFETlIrdFFIWFBqbXJhQy9kdXYyeXRmMm4x?=
 =?utf-8?B?MFp6MDV4VWszSHJGUjYwbXptOFo3YU9oYjBlRzVqeEs4Nkl4NTVBcXZ1Y3A1?=
 =?utf-8?B?aFprOUdLRXF4SjU5dXJ2TVpRcTltRzl5S0oxazU0OGdRN3FoS2xpb3d2amUr?=
 =?utf-8?B?QzVndi9mcHhzTStHMEF6dUlmOGFQK0ExMTlOc3J3dmhWTmtIV2dIYk5JOTA2?=
 =?utf-8?B?SGNVUmdXLzZNb2NrNyt3S2pqVGNrdUNWak9ScFRjUmZ0aGVlaHI0QkRyTlhi?=
 =?utf-8?B?VkxBdkhON2tjQW9IOTgwZEpPdHlJeDREc2dzNldLQzFvYTBXTkFqSStuT0RR?=
 =?utf-8?Q?cwsiYfFh+OeqEti6rryL2xULG?=
X-OriginatorOrg: axentia.se
X-MS-Exchange-CrossTenant-Network-Message-Id: c39eba5f-f4e2-4cdd-7ecc-08db5b878baf
X-MS-Exchange-CrossTenant-AuthSource: VI1PR02MB4445.eurprd02.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 May 2023 12:16:32.7645
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4ee68585-03e1-4785-942a-df9c1871a234
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 4obz8hsVbUA26ImGa/v8YrVgHAr2oOkb+jcJZEnjIuOexYk5VEpCxWsKLFgNkdKh
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DU0PR02MB10042
X-Spam-Status: No, score=-1.7 required=5.0 tests=BAYES_00,DKIM_INVALID,
        DKIM_SIGNED,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,
        T_SCC_BODY_TEXT_LINE,T_SPF_TEMPERROR,URIBL_BLOCKED autolearn=no
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Logical OR fails to deliver the desired result. Most of the time.

Fixes: 3e9b3112ec74 ("add basic register-field manipulation macros")
Fixes: e2192de59e45 ("bitfield: add FIELD_PREP_CONST()")
Signed-off-by: Peter Rosin <peda@axentia.se>
---
 include/linux/bitfield.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/bitfield.h b/include/linux/bitfield.h
index ebfa12f69501..d70fc96585e2 100644
--- a/include/linux/bitfield.h
+++ b/include/linux/bitfield.h
@@ -107,7 +107,7 @@
  * @_val:  value to put in the field
  *
  * FIELD_PREP() masks and shifts up the value.  The result should
- * be combined with other fields of the bitfield using logical OR.
+ * be combined with other fields of the bitfield using bitwise OR.
  */
 #define FIELD_PREP(_mask, _val)						\
 	({								\
@@ -123,7 +123,7 @@
  * @_val:  value to put in the field
  *
  * FIELD_PREP_CONST() masks and shifts up the value.  The result should
- * be combined with other fields of the bitfield using logical OR.
+ * be combined with other fields of the bitfield using bitwise OR.
  *
  * Unlike FIELD_PREP() this is a constant expression and can therefore
  * be used in initializers. Error checking is less comfortable for this
-- 
2.20.1