From patchwork Mon May 22 12:24:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mark Rutland X-Patchwork-Id: 97418 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp1425325vqo; Mon, 22 May 2023 05:55:28 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6njXpfvCaBipp2iitdg352IbvyuLrhY6dFg+rY6oRYWxsooQ6svWv6A4iFC+PWSkQ/m6NA X-Received: by 2002:a05:6a20:440d:b0:ec:8f81:e9f7 with SMTP id ce13-20020a056a20440d00b000ec8f81e9f7mr13699031pzb.16.1684760128456; Mon, 22 May 2023 05:55:28 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1684760128; cv=none; d=google.com; s=arc-20160816; b=mQW/TPgJL946xaLAbySvrprbOFT2KeofMLP4iJca3Al9IDPvfPIFDzGJb2W1s9j9x3 weCgrGkY9V+0YFUCJa4D0b3EGKLfOVwdrVRcwJPdHZAYUqFUdwmFZUbBwMCWs980EQfo g/V+FR8Ne+MyhNIjGv8v10ZliIyNILNrt/kPD1PhCSIkNoiR8OtkSpBF2t+UQlyB6h8A puadZPmTrV864F9kYsvCrM4i5DqXY0xKd9z7WPggyN9r9phNwxLxScAKcX2Akd8Fqj1q RpkNYJR4y0lgQKDum4YHjCHYCBykjdJgrNwKVz9HuSW6zGpfkzGH0Hpsgeo2UiI+Eu+S w6qA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=hsij5K+YWec1UvQIOA03/MurzcbKVEwQCONQnWcymaQ=; b=MH1OJKDylfLwGmvtn61+qctKSYforUNHBmAA6rO1EHF32tpop2mPhylcxucrVnlORR 9gtC11zGHWbDLRXRY1IgtxtBVUagQMdrZMrYJjM0IZ4TCGsMBLjaxbiJRH/LETyU4qkw D0+CT0EKg/dbDRWGR+mTB1p9HUnGGO29p5QiiSLTwQaBEFhup3BXmr1itatZK4LfvwXo oATOYBs5zwuYX9JbHuTZRC3v49hAF7jk1rDuFyJo/MLwPMmeXfB8+ERRvtULhVFFEoO/ z7FMCiqWpl2M7mA5xsFBtndpIigcddCHqKnq45uJPizycza/D1WcBtg2/0Y3jC1UdqcB wRNg== ARC-Authentication-Results: i=1; mx.google.com; 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=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id o23-20020a17090ac71700b0024df9227b1asi6789918pjt.167.2023.05.22.05.55.13; Mon, 22 May 2023 05:55:28 -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; 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=fail (p=NONE sp=NONE dis=NONE) header.from=arm.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234145AbjEVM3K (ORCPT + 99 others); Mon, 22 May 2023 08:29:10 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32942 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232305AbjEVM1e (ORCPT ); Mon, 22 May 2023 08:27:34 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 4B2BB18C; Mon, 22 May 2023 05:25:40 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 29A4D11FB; Mon, 22 May 2023 05:26:25 -0700 (PDT) Received: from lakrids.cambridge.arm.com (usa-sjc-imap-foss1.foss.arm.com [10.121.207.14]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 762E43F59C; Mon, 22 May 2023 05:25:38 -0700 (PDT) From: Mark Rutland To: linux-kernel@vger.kernel.org Cc: akiyks@gmail.com, boqun.feng@gmail.com, corbet@lwn.net, keescook@chromium.org, linux-arch@vger.kernel.org, linux@armlinux.org.uk, linux-doc@vger.kernel.org, mark.rutland@arm.com, paulmck@kernel.org, peterz@infradead.org, sstabellini@kernel.org, will@kernel.org Subject: [PATCH 25/26] locking/atomic: docs: Add atomic operations to the driver basic API documentation Date: Mon, 22 May 2023 13:24:28 +0100 Message-Id: <20230522122429.1915021-26-mark.rutland@arm.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230522122429.1915021-1-mark.rutland@arm.com> References: <20230522122429.1915021-1-mark.rutland@arm.com> MIME-Version: 1.0 X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE 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?1766599036230280401?= X-GMAIL-MSGID: =?utf-8?q?1766599036230280401?= From: "Paul E. McKenney" Add the generated atomic headers to driver-api/basics.rst in order to provide documentation for the Linux kernel's atomic operations. Signed-off-by: Paul E. McKenney Cc: Jonathan Corbet Cc: Kees Cook Cc: Akira Yokosawa Cc: Will Deacon Cc: Peter Zijlstra Cc: Boqun Feng Cc: Mark Rutland Cc: Reviewed-by: Kees Cook [Mark: add atomic-long.h] Signed-off-by: Mark Rutland --- Documentation/driver-api/basics.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/driver-api/basics.rst b/Documentation/driver-api/basics.rst index 4b4d8e28d3be4..a1fbd97fb79fb 100644 --- a/Documentation/driver-api/basics.rst +++ b/Documentation/driver-api/basics.rst @@ -87,6 +87,12 @@ Atomics .. kernel-doc:: arch/x86/include/asm/atomic.h :internal: +.. kernel-doc:: include/linux/atomic/atomic-arch-fallback.h + :internal: + +.. kernel-doc:: include/linux/atomic/atomic-long.h + :internal: + Kernel objects manipulation ---------------------------