From patchwork Tue Jun 6 08:26:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: tip-bot2 for Thomas Gleixner X-Patchwork-Id: 103668 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp3252735vqr; Tue, 6 Jun 2023 02:09:18 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ73rnZibUfcXqL28p6kd4zlLXrY9w9T6sof61neMLeG3okeeUrMMD+G6PMatpnRXsu2klsn X-Received: by 2002:a92:2805:0:b0:33c:1fe9:a612 with SMTP id l5-20020a922805000000b0033c1fe9a612mr1247043ilf.14.1686042557972; Tue, 06 Jun 2023 02:09:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686042557; cv=none; d=google.com; s=arc-20160816; b=AbEDvJvTx/ax4O4CEfntdmTprUC0mIHE2NXXCln+C4KO+XOoxvrK2XFxu4kIGvGbx/ nJ1aQQoEk3qoGBLAmRaUR/yGd4M6LjBjwSShpGWAKrdK1TWKqZcgzYHVzmhoqUVC65dO 2T6u07ODrZLGloZnu0NXUH6lZcANejgNF7Qq4W12qi0DRQVgvDV2R2iy1/x68nLZoGcs uo7O6uclLmEKwIFrMlTiZvX1hiwzRfwPgM6y944lKRu6uvmcAoXLAI1vPWO14AcPNBaD JoZutlb6hpkf4yjc9IpZLzcRAZ1nohisUyb0Cm0IfG8BDuU6eKWn9J+Ni/0ZOapEixg1 C0ng== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:robot-unsubscribe :robot-id:message-id:mime-version:references:in-reply-to:cc:subject :to:reply-to:sender:from:dkim-signature:dkim-signature:date; bh=e4Mz+yZ5wgoRWfsGdE2qATMR07LuxF6HxmI420vA0vw=; b=UKQFgwC9EfWaQcsTCGL9QU4avSn9mHBpKNUaJriWlq6C7DZSa1zmduA9UY37JYI3nK mbPYgruDccxRi9fMQb7HYM7a4bEWKfyzUs4F1uSNGgek3Akvy8mRqKz9uUaL23m09Grr F1VdOaCQo4kpNNsczKl+egilU3PPslaW9oBJf4PMJeAd5nWPrtRRHmw64WcXaQRdmDGJ 9nhhxzSNv5kR02ub6XwdGWu8Z1rfNZ6uEhxnHMzD2ecSZOFgshLI9qILp7C9zjhXG7bR OIaWks9YMO9mlau36iji7Sytk/zU5meqAZpgtrZDs+G0GLILZkRgEjZ2o0uoUJ3Lvl7b QPTg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=3IJoslHR; dkim=neutral (no key) header.i=@linutronix.de; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id q2-20020a638c42000000b00534e310d0d3si7284806pgn.588.2023.06.06.02.09.05; Tue, 06 Jun 2023 02:09:17 -0700 (PDT) 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; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=3IJoslHR; dkim=neutral (no key) header.i=@linutronix.de; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236657AbjFFI0V (ORCPT + 99 others); Tue, 6 Jun 2023 04:26:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53382 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236617AbjFFI0T (ORCPT ); Tue, 6 Jun 2023 04:26:19 -0400 Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E8FECFA; Tue, 6 Jun 2023 01:26:17 -0700 (PDT) Date: Tue, 06 Jun 2023 08:26:15 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1686039976; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=e4Mz+yZ5wgoRWfsGdE2qATMR07LuxF6HxmI420vA0vw=; b=3IJoslHRT8Bsmg2Sr0pPb+P+nSSonQ30k7Sj5pa0C9bGYRG8UD41zffTNQsXCNlqdPDkXQ 4T8ZD4fN5YZN4QBq9Y4dt12iTSUfmw0XeSObRdFLS76YROnyniM4VZ5XBNQ2v8W5mCuZ+z 1GcZ1NmBcLmdV7vHiFm5hnu+uMP5XFlcjPz1NN29jG9waPz1w3LQ4AG+HYeTnhpimRf1p2 srMfV5YQaVyT8GPwncECuBGbWCGGgGkBWtpiV5p6P47oKYhvaTL7Rzp7PfRsD5qLtAsjgu PKA2SIseDRr0b5ifKLUtenL2YKrtjPU1x0Q4fc1i5VSOZTP4ixvLSt80pBtrmw== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1686039976; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=e4Mz+yZ5wgoRWfsGdE2qATMR07LuxF6HxmI420vA0vw=; b=HhEvGpBwso+sIvSVLaX8ZB0uKku9boYpaz9aSFyP+29bF9x1Kt9dZxhKPH0C5cTVfQfKRb ilQ6x27gq8nPdECg== From: "tip-bot2 for Paul E. McKenney" Sender: tip-bot2@linutronix.de Reply-to: linux-kernel@vger.kernel.org To: linux-tip-commits@vger.kernel.org Subject: [tip: locking/core] locking/atomic: docs: Add atomic operations to the driver basic API documentation Cc: "Paul E. McKenney" , Mark Rutland , "Peter Zijlstra (Intel)" , Kees Cook , x86@kernel.org, linux-kernel@vger.kernel.org In-Reply-To: <20230605070124.3741859-27-mark.rutland@arm.com> References: <20230605070124.3741859-27-mark.rutland@arm.com> MIME-Version: 1.0 Message-ID: <168603997541.404.16590439453491268749.tip-bot2@tip-bot2> Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=ham 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: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1767845742728272112?= X-GMAIL-MSGID: =?utf-8?q?1767943760894416839?= The following commit has been merged into the locking/core branch of tip: Commit-ID: e74f4059d11f36e936b08e98bc96f654c308807a Gitweb: https://git.kernel.org/tip/e74f4059d11f36e936b08e98bc96f654c308807a Author: Paul E. McKenney AuthorDate: Mon, 05 Jun 2023 08:01:23 +01:00 Committer: Peter Zijlstra CommitterDate: Mon, 05 Jun 2023 09:57:24 +02:00 locking/atomic: docs: Add atomic operations to the driver basic API documentation Add the generated atomic headers to driver-api/basics.rst in order to provide documentation for the Linux kernel's atomic operations. At the same time, dtop the x86 atomic header, which provides kerneldoc comments for some arch_atomic*_*() operations. The arch_atomic*_*() operations are now purely an implenentation detail of the raw_atomic*_*() ops, and outside of implementing the atomics, code should use the raw_atomic*_*() forms. [Mark: add atomic-{instrumented,long}.h, update commit message] Signed-off-by: Paul E. McKenney Signed-off-by: Mark Rutland Signed-off-by: Peter Zijlstra (Intel) Reviewed-by: Kees Cook Link: https://lore.kernel.org/r/20230605070124.3741859-27-mark.rutland@arm.com --- Documentation/driver-api/basics.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst index 4b4d8e2..7671b53 100644 --- a/Documentation/driver-api/basics.rst +++ b/Documentation/driver-api/basics.rst @@ -84,7 +84,13 @@ Reference counting Atomics ------- -.. kernel-doc:: arch/x86/include/asm/atomic.h +.. kernel-doc:: include/linux/atomic/atomic-instrumented.h + :internal: + +.. kernel-doc:: include/linux/atomic/atomic-arch-fallback.h + :internal: + +.. kernel-doc:: include/linux/atomic/atomic-long.h :internal: Kernel objects manipulation