[PATCH v3 03/11] mm/ioremap: change the return value of io[re|un]map_allowed and rename

[PATCH v3 03/11] mm/ioremap: change the return value of io[re|un]map_allowed and rename

[Baoquan He]

Currently, hooks ioremap_allowed() and iounmap_allowed() are used to
check if it's qualified to do ioremap, and now this is done on ARM64.
However, in oder to convert more architectures to take GENERIC_IOREMAP
method, several more things need be done in those two hooks:
 1) The io address mapping need be handled specifically on architectures,
    e.g arc, ia64, s390;
 2) The original physical address passed into ioremap_prot() need be
    fixed up, e.g arc;
 3) The 'prot' passed into ioremap_prot() need be adjusted, e.g on arc
    and xtensa.

To handle these three issues,

 1) Rename ioremap_allowed() and iounmap_allowed() to arch_ioremap()
    and arch_iounmap() since the old name can't reflect their
    functionality after change;
 2) Change the return value of arch_ioremap() so that arch can add
    specifical io address mapping handling inside and return the maped
    address. Now their returned value means:
    ===
    arch_ioremap() return a bool,
      - IS_ERR means return an error
      - 0 means continue to remap
      - a non-zero, non-IS_ERR pointer is returned directly
    arch_iounmap() return a bool,
      - true means continue to vunmap
      - false means skip vunmap and return directly
 3) change the interface of arch_ioremap() so that the mapped address and
    adjusted 'prot' flag can be passed out. While at it, the invocation
    of arch_ioremap() need be moved to the beginning of ioremap_prot()
    because architectures like sh, openrisc, ia64, need do the ARCH
    specific io address mapping on the original physical address. And in
    the later patch, the address fix up code in arch_ioremap() also need
    be done on the original addre on some architectures.

This is preparation for later patch.

Signed-off-by: Baoquan He <bhe@redhat.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: linux-arch@vger.kernel.org
Cc: Kefeng Wang <wangkefeng.wang@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
---
 arch/arm64/include/asm/io.h |  5 +++--
 arch/arm64/mm/ioremap.c     | 16 +++++++++++-----
 include/asm-generic/io.h    | 27 ++++++++++++++-------------
 mm/ioremap.c                | 13 +++++++++----
 4 files changed, 37 insertions(+), 24 deletions(-)

diff --git a/arch/arm64/include/asm/io.h b/arch/arm64/include/asm/io.h
index 877495a0fd0c..6a5578ddbbf6 100644
--- a/arch/arm64/include/asm/io.h
+++ b/arch/arm64/include/asm/io.h
@@ -139,8 +139,9 @@ extern void __memset_io(volatile void __iomem *, int, size_t);
  * I/O memory mapping functions.
  */
 
-bool ioremap_allowed(phys_addr_t phys_addr, size_t size, unsigned long prot);
-#define ioremap_allowed ioremap_allowed
+void __iomem *
+arch_ioremap(phys_addr_t *paddr, size_t size, unsigned long *prot_val);
+#define arch_ioremap arch_ioremap
 
 #define _PAGE_IOREMAP PROT_DEVICE_nGnRE
 
diff --git a/arch/arm64/mm/ioremap.c b/arch/arm64/mm/ioremap.c
index c5af103d4ad4..ef75ffef4dbc 100644
--- a/arch/arm64/mm/ioremap.c
+++ b/arch/arm64/mm/ioremap.c
@@ -3,19 +3,25 @@
 #include <linux/mm.h>
 #include <linux/io.h>
 
-bool ioremap_allowed(phys_addr_t phys_addr, size_t size, unsigned long prot)
+void __iomem *
+arch_ioremap(phys_addr_t *paddr, size_t size, unsigned long *prot_val)
 {
-	unsigned long last_addr = phys_addr + size - 1;
+	unsigned long last_addr, offset, phys_addr = *paddr;
+
+	offset = phys_addr & (~PAGE_MASK);
+	phys_addr -= offset;
+	size = PAGE_ALIGN(size + offset);
+	last_addr = phys_addr + size - 1;
 
 	/* Don't allow outside PHYS_MASK */
 	if (last_addr & ~PHYS_MASK)
-		return false;
+		return IOMEM_ERR_PTR(-EINVAL);
 
 	/* Don't allow RAM to be mapped. */
 	if (WARN_ON(pfn_is_map_memory(__phys_to_pfn(phys_addr))))
-		return false;
+		return IOMEM_ERR_PTR(-EINVAL);
 
-	return true;
+	return NULL;
 }
 
 /*
diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
index a68f8fbf423b..2ae16906f3be 100644
--- a/include/asm-generic/io.h
+++ b/include/asm-generic/io.h
@@ -1049,25 +1049,26 @@ static inline void iounmap(volatile void __iomem *addr)
 
 /*
  * Arch code can implement the following two hooks when using GENERIC_IOREMAP
- * ioremap_allowed() return a bool,
- *   - true means continue to remap
- *   - false means skip remap and return directly
- * iounmap_allowed() return a bool,
+ * arch_ioremap() return a bool,
+ *   - IS_ERR means return an error
+ *   - NULL means continue to remap
+ *   - a non-NULL, non-IS_ERR pointer is returned directly
+ * arch_iounmap() return a bool,
  *   - true means continue to vunmap
- *   - false means skip vunmap and return directly
+ *   - false code means skip vunmap and return directly
  */
-#ifndef ioremap_allowed
-#define ioremap_allowed ioremap_allowed
-static inline bool ioremap_allowed(phys_addr_t phys_addr, size_t size,
-				   unsigned long prot)
+#ifndef arch_ioremap
+#define arch_ioremap arch_ioremap
+static inline void __iomem *arch_ioremap(phys_addr_t *paddr, size_t size,
+				   unsigned long *prot_val)
 {
-	return true;
+	return NULL;
 }
 #endif
 
-#ifndef iounmap_allowed
-#define iounmap_allowed iounmap_allowed
-static inline bool iounmap_allowed(void *addr)
+#ifndef arch_iounmap
+#define arch_iounmap arch_iounmap
+static inline bool arch_iounmap(void __iomem *addr)
 {
 	return true;
 }
diff --git a/mm/ioremap.c b/mm/ioremap.c
index 8652426282cc..fd1f0b33f4fd 100644
--- a/mm/ioremap.c
+++ b/mm/ioremap.c
@@ -17,6 +17,14 @@ void __iomem *ioremap_prot(phys_addr_t phys_addr, size_t size,
 	unsigned long offset, vaddr;
 	phys_addr_t last_addr;
 	struct vm_struct *area;
+	void __iomem *ioaddr;
+
+	ioaddr = arch_ioremap(&phys_addr, size, &prot);
+	if (IS_ERR(ioaddr))
+		return NULL;
+
+	if (ioaddr)
+		return ioaddr;
 
 	/* Disallow wrap-around or zero size */
 	last_addr = phys_addr + size - 1;
@@ -28,9 +36,6 @@ void __iomem *ioremap_prot(phys_addr_t phys_addr, size_t size,
 	phys_addr -= offset;
 	size = PAGE_ALIGN(size + offset);
 
-	if (!ioremap_allowed(phys_addr, size, prot))
-		return NULL;
-
 	area = get_vm_area_caller(size, VM_IOREMAP,
 			__builtin_return_address(0));
 	if (!area)
@@ -52,7 +57,7 @@ void iounmap(volatile void __iomem *addr)
 {
 	void *vaddr = (void *)((unsigned long)addr & PAGE_MASK);
 
-	if (!iounmap_allowed(vaddr))
+	if (!arch_iounmap((void __iomem *)addr))
 		return;
 
 	if (is_vmalloc_addr(vaddr))
-- 
2.34.1

Re: [PATCH v3 03/11] mm/ioremap: change the return value of io[re|un]map_allowed and rename

[Kefeng Wang]

On 2022/10/9 18:31, Baoquan He wrote:
> Currently, hooks ioremap_allowed() and iounmap_allowed() are used to
> check if it's qualified to do ioremap, and now this is done on ARM64.
> However, in oder to convert more architectures to take GENERIC_IOREMAP
> method, several more things need be done in those two hooks:
>   1) The io address mapping need be handled specifically on architectures,
>      e.g arc, ia64, s390;
>   2) The original physical address passed into ioremap_prot() need be
>      fixed up, e.g arc;
>   3) The 'prot' passed into ioremap_prot() need be adjusted, e.g on arc
>      and xtensa.
>
> To handle these three issues,
>
>   1) Rename ioremap_allowed() and iounmap_allowed() to arch_ioremap()
>      and arch_iounmap() since the old name can't reflect their
>      functionality after change;
>   2) Change the return value of arch_ioremap() so that arch can add
>      specifical io address mapping handling inside and return the maped
>      address. Now their returned value means:
>      ===
>      arch_ioremap() return a bool,
pointer?
>        - IS_ERR means return an error
>        - 0 means continue to remap
>        - a non-zero, non-IS_ERR pointer is returned directly
>      arch_iounmap() return a bool,
>        - true means continue to vunmap
>        - false means skip vunmap and return directly
...
>   /*
> diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
> index a68f8fbf423b..2ae16906f3be 100644
> --- a/include/asm-generic/io.h
> +++ b/include/asm-generic/io.h
> @@ -1049,25 +1049,26 @@ static inline void iounmap(volatile void __iomem *addr)
>   
>   /*
>    * Arch code can implement the following two hooks when using GENERIC_IOREMAP
> - * ioremap_allowed() return a bool,
> - *   - true means continue to remap
> - *   - false means skip remap and return directly
> - * iounmap_allowed() return a bool,
> + * arch_ioremap() return a bool,
ditto...
>   	area = get_vm_area_caller(size, VM_IOREMAP,
>   			__builtin_return_address(0));
>   	if (!area)
> @@ -52,7 +57,7 @@ void iounmap(volatile void __iomem *addr)
>   {
>   	void *vaddr = (void *)((unsigned long)addr & PAGE_MASK);
>   
> -	if (!iounmap_allowed(vaddr))
> +	if (!arch_iounmap((void __iomem *)addr))
vaddr?
>   		return;
>   
>   	if (is_vmalloc_addr(vaddr))

Re: [PATCH v3 03/11] mm/ioremap: change the return value of io[re|un]map_allowed and rename

[Baoquan He]

On 10/09/22 at 07:13pm, Kefeng Wang wrote:
> 
> On 2022/10/9 18:31, Baoquan He wrote:
> > Currently, hooks ioremap_allowed() and iounmap_allowed() are used to
> > check if it's qualified to do ioremap, and now this is done on ARM64.
> > However, in oder to convert more architectures to take GENERIC_IOREMAP
> > method, several more things need be done in those two hooks:
> >   1) The io address mapping need be handled specifically on architectures,
> >      e.g arc, ia64, s390;
> >   2) The original physical address passed into ioremap_prot() need be
> >      fixed up, e.g arc;
> >   3) The 'prot' passed into ioremap_prot() need be adjusted, e.g on arc
> >      and xtensa.
> > 
> > To handle these three issues,
> > 
> >   1) Rename ioremap_allowed() and iounmap_allowed() to arch_ioremap()
> >      and arch_iounmap() since the old name can't reflect their
> >      functionality after change;
> >   2) Change the return value of arch_ioremap() so that arch can add
> >      specifical io address mapping handling inside and return the maped
> >      address. Now their returned value means:
> >      ===
> >      arch_ioremap() return a bool,
> pointer?

Right, I forgot fixing it again. Thanks.

> >        - IS_ERR means return an error
> >        - 0 means continue to remap
> >        - a non-zero, non-IS_ERR pointer is returned directly
> >      arch_iounmap() return a bool,
> >        - true means continue to vunmap
> >        - false means skip vunmap and return directly
> ...
> >   /*
> > diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
> > index a68f8fbf423b..2ae16906f3be 100644
> > --- a/include/asm-generic/io.h
> > +++ b/include/asm-generic/io.h
> > @@ -1049,25 +1049,26 @@ static inline void iounmap(volatile void __iomem *addr)
> >   /*
> >    * Arch code can implement the following two hooks when using GENERIC_IOREMAP
> > - * ioremap_allowed() return a bool,
> > - *   - true means continue to remap
> > - *   - false means skip remap and return directly
> > - * iounmap_allowed() return a bool,
> > + * arch_ioremap() return a bool,
> ditto...

Will change.

> >   	area = get_vm_area_caller(size, VM_IOREMAP,
> >   			__builtin_return_address(0));
> >   	if (!area)
> > @@ -52,7 +57,7 @@ void iounmap(volatile void __iomem *addr)
> >   {
> >   	void *vaddr = (void *)((unsigned long)addr & PAGE_MASK);
> > -	if (!iounmap_allowed(vaddr))
> > +	if (!arch_iounmap((void __iomem *)addr))
> vaddr?

No, it's intentional. Alexander suggested this, both of you discussed
this in v1, see below thread.

https://lore.kernel.org/all/Yu4mYxpV0GWRTjQp@li-4a3a4a4c-28e5-11b2-a85c-a8d192c6f089.ibm.com/T/#u

> >   		return;
> >   	if (is_vmalloc_addr(vaddr))
> 

Re: [PATCH v3 03/11] mm/ioremap: change the return value of io[re|un]map_allowed and rename

[Kefeng Wang]

On 2022/10/10 8:25, Baoquan He wrote:
> On 10/09/22 at 07:13pm, Kefeng Wang wrote:
>> On 2022/10/9 18:31, Baoquan He wrote:
>>> Currently, hooks ioremap_allowed() and iounmap_allowed() are used to
>>> check if it's qualified to do ioremap, and now this is done on ARM64.
>>> However, in oder to convert more architectures to take GENERIC_IOREMAP
>>> method, several more things need be done in those two hooks:
>>>    1) The io address mapping need be handled specifically on architectures,
>>>       e.g arc, ia64, s390;
>>>    2) The original physical address passed into ioremap_prot() need be
>>>       fixed up, e.g arc;
>>>    3) The 'prot' passed into ioremap_prot() need be adjusted, e.g on arc
>>>       and xtensa.
>>>
>>> To handle these three issues,
>>>
>>>    1) Rename ioremap_allowed() and iounmap_allowed() to arch_ioremap()
>>>       and arch_iounmap() since the old name can't reflect their
>>>       functionality after change;
>>>    2) Change the return value of arch_ioremap() so that arch can add
>>>       specifical io address mapping handling inside and return the maped
>>>       address. Now their returned value means:
>>>       ===
>>>       arch_ioremap() return a bool,
>> pointer?
> Right, I forgot fixing it again. Thanks.
>
>>>         - IS_ERR means return an error
>>>         - 0 means continue to remap
>>>         - a non-zero, non-IS_ERR pointer is returned directly
>>>       arch_iounmap() return a bool,
>>>         - true means continue to vunmap
>>>         - false means skip vunmap and return directly
>> ...
>>>    /*
>>> diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
>>> index a68f8fbf423b..2ae16906f3be 100644
>>> --- a/include/asm-generic/io.h
>>> +++ b/include/asm-generic/io.h
>>> @@ -1049,25 +1049,26 @@ static inline void iounmap(volatile void __iomem *addr)
>>>    /*
>>>     * Arch code can implement the following two hooks when using GENERIC_IOREMAP
>>> - * ioremap_allowed() return a bool,
>>> - *   - true means continue to remap
>>> - *   - false means skip remap and return directly
>>> - * iounmap_allowed() return a bool,
>>> + * arch_ioremap() return a bool,
>> ditto...
> Will change.
>
>>>    	area = get_vm_area_caller(size, VM_IOREMAP,
>>>    			__builtin_return_address(0));
>>>    	if (!area)
>>> @@ -52,7 +57,7 @@ void iounmap(volatile void __iomem *addr)
>>>    {
>>>    	void *vaddr = (void *)((unsigned long)addr & PAGE_MASK);
>>> -	if (!iounmap_allowed(vaddr))
>>> +	if (!arch_iounmap((void __iomem *)addr))
>> vaddr?
> No, it's intentional. Alexander suggested this, both of you discussed
> this in v1, see below thread.
ok, please ignore it.
> https://lore.kernel.org/all/Yu4mYxpV0GWRTjQp@li-4a3a4a4c-28e5-11b2-a85c-a8d192c6f089.ibm.com/T/#u
>
>>>    		return;
>>>    	if (is_vmalloc_addr(vaddr))
>
> .

[PATCH v3 04/11] mm: ioremap: allow ARCH to have its own ioremap definition

[Baoquan He]

Architectures like xtensa, arc, can be converted to GENERIC_IOREMAP,
to take standard ioremap_prot() and ioremap_xxx() way. But they have
ARCH specific handling for ioremap() method, than standard ioremap()
method.

In oder to convert them to take GENERIC_IOREMAP method, allow these
architecutres to have their own ioremap definition.

This is a preparation patch, no functionality change.

Signed-off-by: Baoquan He <bhe@redhat.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: linux-arch@vger.kernel.org
Cc: Kefeng Wang <wangkefeng.wang@huawei.com>
---
 include/asm-generic/io.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/asm-generic/io.h b/include/asm-generic/io.h
index 2ae16906f3be..8878914579d8 100644
--- a/include/asm-generic/io.h
+++ b/include/asm-generic/io.h
@@ -1078,11 +1078,14 @@ void __iomem *ioremap_prot(phys_addr_t phys_addr, size_t size,
 			   unsigned long prot);
 void iounmap(volatile void __iomem *addr);
 
+#ifndef ioremap
+#define ioremap ioremap
 static inline void __iomem *ioremap(phys_addr_t addr, size_t size)
 {
 	/* _PAGE_IOREMAP needs to be supplied by the architecture */
 	return ioremap_prot(addr, size, _PAGE_IOREMAP);
 }
+#endif
 #endif /* !CONFIG_MMU || CONFIG_GENERIC_IOREMAP */
 
 #ifndef ioremap_wc
-- 
2.34.1