From patchwork Fri Oct 6 15:06:34 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andy Shevchenko X-Patchwork-Id: 149290 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:a888:0:b0:403:3b70:6f57 with SMTP id x8csp396082vqo; Fri, 6 Oct 2023 08:07:01 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHtMc87b0QIGpYyZFaKWGLGUO3ORJuQqCdkPzSkji7iU4TX/G6TXBfWCcswoo1FYRbGOBnB X-Received: by 2002:a05:6a20:4287:b0:16b:aad0:effe with SMTP id o7-20020a056a20428700b0016baad0effemr2118697pzj.62.1696604820994; Fri, 06 Oct 2023 08:07:00 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696604820; cv=none; d=google.com; s=arc-20160816; b=KV24WztUQLbczef3BO3/CU1VfyVQeitCsb8aU8nU+EEw7b6UYw3tMj3ApQKEWZmt1w 8M+TSeWnlED3XgeqBzJ1GHYh7JGcaJiAup7wsqHGd+AoskvKZo3LE7XfBlW/mDo+VvMV naMtTbRyPghW+mM/6Jo81gZa3FmDHvGor17BVd3noaoViYcEB3K0Q2wY38+r4k66Mb86 lri+BYECdnNmPpwFiR3Qxh3Ri6emdvYWZcjg0FBooLFTPs9bK3X9PL9xYHzAcvmFXbtF 3YJ0hj1DX6qTQ8anfgCaRW0pGXA1QHhZwhBSqueY3q3+SWFYbKH0+QnnMJTWV+BKr9kC D/Xg== 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 :message-id:date:subject:cc:to:from:dkim-signature; bh=OwMu3WZVVRES1Z84xStuXeQNmEAe0HVHjf6tiBa7ctU=; fh=dIFZ7Dl+7lmgfvviXDrjZ3ZS12tBDdByvHB6JrAZV0Y=; b=FCLdjrAXEBwOCJpKGyaALBN+W0Decb1oQaJbRx7ZtoLZt4DYbLF1KJlFpxrq1akj7W pULJucO3iDEC45bdamA/H1AJwibk6EQXmtyQNn1bZt42J5Gc288ZQXJEYkk/OA8gLZSP tWI0/MQ3c5q/yaskzkfcRm3kUv9PzQVkbYngVOwD+5S7FII99wPIGzbOm+iTkjtS0y7A febIxNd1yfB2vnTMFsyvQ+1+DH2pZn04Wl6EQh0+rbS46mDW7TRCI9lNNNsm9aQbjnOU 3XYUevaVYa3yCr1Fmo7LFjnVv+Wujz1v4hTijtQRoHemKmLV/6V7nXwch3TmTW9qJ8oE HARA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=WN7pWWPJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: from snail.vger.email (snail.vger.email. [23.128.96.37]) by mx.google.com with ESMTPS id k185-20020a6384c2000000b00578db71453esi3886331pgd.468.2023.10.06.08.07.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Oct 2023 08:07:00 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37; Authentication-Results: mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=WN7pWWPJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by snail.vger.email (Postfix) with ESMTP id 18D9E80E712B; Fri, 6 Oct 2023 08:07:00 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232694AbjJFPGq (ORCPT + 18 others); Fri, 6 Oct 2023 11:06:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33450 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232611AbjJFPGo (ORCPT ); Fri, 6 Oct 2023 11:06:44 -0400 Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.43]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 03868A6; Fri, 6 Oct 2023 08:06:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1696604803; x=1728140803; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=gNgwqDPrxhz8wCl3Okr47BvVxVZ4M+5ATpm+bjH86Rc=; b=WN7pWWPJDQpmmFMV+n52UU1g/oIKyq3EXbggq7Srn0vRvXezisd7Wlzr bEyLSDM9K8wFCyVhQrE6uwf+oaJvUJ/DSWvRxponIRE1eUeMBBmjHwAfc N/SWknu52lpS5BklsavYmPvcQy2mpIlOpGcrWloJPAeQx+rywkgLF1Ftd mVRilQKqnzqlRj/QgQYRIMWdiXK83dPQmFE0diLZNKiBKAKsfJNUFW2Go nKS35pV674RP/vvsRAUTFFNdZ6qNTR/IeM8Z9XvTK6NcmJHM8FSt9iUeH aZYC52r35bD0+5dCIH/sZ/XYSUL3rTo0XhsICjzkFN/BVNibpWU12wS6G Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10855"; a="470034212" X-IronPort-AV: E=Sophos;i="6.03,204,1694761200"; d="scan'208";a="470034212" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Oct 2023 08:06:43 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10855"; a="702079788" X-IronPort-AV: E=Sophos;i="6.03,204,1694761200"; d="scan'208";a="702079788" Received: from black.fi.intel.com ([10.237.72.28]) by orsmga003.jf.intel.com with ESMTP; 06 Oct 2023 08:06:41 -0700 Received: by black.fi.intel.com (Postfix, from userid 1003) id B2831430; Fri, 6 Oct 2023 18:06:39 +0300 (EEST) From: Andy Shevchenko To: Yang Yingliang , Andy Shevchenko , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Jonathan Corbet , Bjorn Helgaas Subject: [resend, PATCH v1 1/1] PCI: Update the devres documentation regarding to pcim_*() Date: Fri, 6 Oct 2023 18:06:34 +0300 Message-Id: <20231006150634.3444251-1-andriy.shevchenko@linux.intel.com> X-Mailer: git-send-email 2.40.0.1.gaa8946217a0b MIME-Version: 1.0 X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_NONE 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-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Fri, 06 Oct 2023 08:07:00 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779019096249275956 X-GMAIL-MSGID: 1779019096249275956 There were many changes to PCI core in scope of managed resources APIs. Update documentation to list the current state of affairs. Signed-off-by: Andy Shevchenko Acked-by: Bjorn Helgaas --- Documentation/driver-api/driver-model/devres.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst index 8be086b3f829..c5f99d834ec5 100644 --- a/Documentation/driver-api/driver-model/devres.rst +++ b/Documentation/driver-api/driver-model/devres.rst @@ -322,10 +322,8 @@ IOMAP devm_platform_ioremap_resource_byname() devm_platform_get_and_ioremap_resource() devm_iounmap() - pcim_iomap() - pcim_iomap_regions() : do request_region() and iomap() on multiple BARs - pcim_iomap_table() : array of mapped addresses indexed by BAR - pcim_iounmap() + + Note: For the PCI devices the specific pcim_*() functions may be used, see below. IRQ devm_free_irq() @@ -392,8 +390,16 @@ PCI devm_pci_alloc_host_bridge() : managed PCI host bridge allocation devm_pci_remap_cfgspace() : ioremap PCI configuration space devm_pci_remap_cfg_resource() : ioremap PCI configuration space resource + pcim_enable_device() : after success, all PCI ops become managed + pcim_iomap() : do iomap() on a single BAR + pcim_iomap_regions() : do request_region() and iomap() on multiple BARs + pcim_iomap_regions_request_all() : do request_region() on all and iomap() on multiple BARs + pcim_iomap_table() : array of mapped addresses indexed by BAR + pcim_iounmap() : do iounmap() on a single BAR + pcim_iounmap_regions() : do iounmap() and release_region() on multiple BARs pcim_pin_device() : keep PCI device enabled after release + pcim_set_mwi() : enable Memory-Write-Invalidate PCI transaction PHY devm_usb_get_phy()