From patchwork Mon Mar 20 18:43:00 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bjorn Helgaas X-Patchwork-Id: 9635193 X-Patchwork-Delegate: bhelgaas@google.com Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 7285560132 for ; Mon, 20 Mar 2017 18:43:47 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 692C22521E for ; Mon, 20 Mar 2017 18:43:47 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5C2972623D; Mon, 20 Mar 2017 18:43:47 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 00A752521E for ; Mon, 20 Mar 2017 18:43:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932635AbdCTSnL (ORCPT ); Mon, 20 Mar 2017 14:43:11 -0400 Received: from mail.kernel.org ([198.145.29.136]:51928 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932627AbdCTSnJ (ORCPT ); Mon, 20 Mar 2017 14:43:09 -0400 Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 3CF0120295; Mon, 20 Mar 2017 18:43:02 +0000 (UTC) Received: from localhost (unknown [69.55.156.165]) (using TLSv1.2 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 34F9C201C8; Mon, 20 Mar 2017 18:43:01 +0000 (UTC) Subject: [PATCH v2 3/4] asm-generic/io.h: Simplify ioremap() comments From: Bjorn Helgaas To: Arnd Bergmann Cc: linux-arch@vger.kernel.org, linux-pci@vger.kernel.org, "Luis R. Rodriguez" , linux-kernel@vger.kernel.org Date: Mon, 20 Mar 2017 13:43:00 -0500 Message-ID: <20170320184300.4858.47081.stgit@bhelgaas-glaptop.roam.corp.google.com> In-Reply-To: <20170320182014.4858.22352.stgit@bhelgaas-glaptop.roam.corp.google.com> References: <20170320182014.4858.22352.stgit@bhelgaas-glaptop.roam.corp.google.com> User-Agent: StGit/0.17.1-dirty MIME-Version: 1.0 X-Virus-Scanned: ClamAV using ClamSMTP Sender: linux-pci-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Simplify ioremap() comments to make it clear that arches with an MMU *must* implement ioremap() and iounmap(), and that the default implementations only apply to non-MMU arches. It's obvious how to override the defaults; no need to educate people here. Remove the ancient "struct page" comment that doesn't seem related to anything here. Signed-off-by: Bjorn Helgaas Reviewed-by: Arnd Bergmann --- include/asm-generic/io.h | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h index e0a331a22346..3f8a7e589071 100644 --- a/include/asm-generic/io.h +++ b/include/asm-generic/io.h @@ -780,8 +780,7 @@ static inline void pci_iounmap(struct pci_dev *dev, void __iomem *p) #endif /* CONFIG_GENERIC_IOMAP */ /* - * Change virtual addresses to physical addresses and vv. - * These are pretty trivial + * Change virtual addresses to physical addresses and vice versa. */ #ifndef virt_to_phys #define virt_to_phys virt_to_phys @@ -802,18 +801,11 @@ static inline void *phys_to_virt(unsigned long address) /** * DOC: ioremap() and ioremap_*() variants * - * If you have an MMU your architecture is expected to have both ioremap() - * and iounmap() implemented otherwise the asm-generic helpers will provide a - * direct mapping. + * If you have an MMU, your architecture must implement both ioremap() and + * iounmap(). * - * There are ioremap_*() call variants, if you have no MMU we naturally will - * default to direct mapping for all of them, you can override these defaults. - * If you have an MMU you are highly encouraged to provide your own - * ioremap variant implementation as there currently is no safe architecture - * agnostic default. To avoid possible improper behaviour default asm-generic - * ioremap_*() variants all return NULL when an MMU is available. If you've - * defined your own ioremap_*() variant you must then declare your own - * ioremap_*() variant as defined to itself to avoid the default NULL return. + * It must also implement variants such as ioremap_uc(). The default + * implementation here returns failure (NULL) to avoid improper behavior. */ #ifdef CONFIG_MMU @@ -829,10 +821,8 @@ static inline void __iomem *ioremap_uc(phys_addr_t offset, size_t size) #else /* !CONFIG_MMU */ /* - * Change "struct page" to physical address. - * - * This implementation is for the no-MMU case only... if you have an MMU - * you'll need to provide your own definitions. + * If you don't have an MMU, the default implementations here provide + * direct identity mapping. You can override these if necessary. */ #ifndef ioremap