include/asm-generic/iomap.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __GENERIC_IO_H
   3 #define __GENERIC_IO_H
   4
   5 #include <linux/linkage.h>
   6 #include <asm/byteorder.h>
   7
   8 /*
   9  * These are the "generic" interfaces for doing new-style
  10  * memory-mapped or PIO accesses. Architectures may do
  11  * their own arch-optimized versions, these just act as
  12  * wrappers around the old-style IO register access functions:
  13  * read[bwl]/write[bwl]/in[bwl]/out[bwl]
  14  *
  15  * Don't include this directly, include it from <asm/io.h>.
  16  */
  17
  18 /*
  19  * Read/write from/to an (offsettable) iomem cookie. It might be a PIO
  20  * access or a MMIO access, these functions don't care. The info is
  21  * encoded in the hardware mapping set up by the mapping functions
  22  * (or the cookie itself, depending on implementation and hw).
  23  *
  24  * The generic routines just encode the PIO/MMIO as part of the
  25  * cookie, and coldly assume that the MMIO IO mappings are not
  26  * in the low address range. Architectures for which this is not
  27  * true can't use this generic implementation.
  28  */
  29 extern unsigned int ioread8(const void __iomem *);
  30 extern unsigned int ioread16(const void __iomem *);
  31 extern unsigned int ioread16be(const void __iomem *);
  32 extern unsigned int ioread32(const void __iomem *);
  33 extern unsigned int ioread32be(const void __iomem *);
  34 #ifdef CONFIG_64BIT
  35 extern u64 ioread64(const void __iomem *);
  36 extern u64 ioread64be(const void __iomem *);
  37 #endif
  38
  39 #ifdef readq
  40 #define ioread64_lo_hi ioread64_lo_hi
  41 #define ioread64_hi_lo ioread64_hi_lo
  42 #define ioread64be_lo_hi ioread64be_lo_hi
  43 #define ioread64be_hi_lo ioread64be_hi_lo
  44 extern u64 ioread64_lo_hi(const void __iomem *addr);
  45 extern u64 ioread64_hi_lo(const void __iomem *addr);
  46 extern u64 ioread64be_lo_hi(const void __iomem *addr);
  47 extern u64 ioread64be_hi_lo(const void __iomem *addr);
  48 #endif
  49
  50 extern void iowrite8(u8, void __iomem *);
  51 extern void iowrite16(u16, void __iomem *);
  52 extern void iowrite16be(u16, void __iomem *);
  53 extern void iowrite32(u32, void __iomem *);
  54 extern void iowrite32be(u32, void __iomem *);
  55 #ifdef CONFIG_64BIT
  56 extern void iowrite64(u64, void __iomem *);
  57 extern void iowrite64be(u64, void __iomem *);
  58 #endif
  59
  60 #ifdef writeq
  61 #define iowrite64_lo_hi iowrite64_lo_hi
  62 #define iowrite64_hi_lo iowrite64_hi_lo
  63 #define iowrite64be_lo_hi iowrite64be_lo_hi
  64 #define iowrite64be_hi_lo iowrite64be_hi_lo
  65 extern void iowrite64_lo_hi(u64 val, void __iomem *addr);
  66 extern void iowrite64_hi_lo(u64 val, void __iomem *addr);
  67 extern void iowrite64be_lo_hi(u64 val, void __iomem *addr);
  68 extern void iowrite64be_hi_lo(u64 val, void __iomem *addr);
  69 #endif
  70
  71 /*
  72  * "string" versions of the above. Note that they
  73  * use native byte ordering for the accesses (on
  74  * the assumption that IO and memory agree on a
  75  * byte order, and CPU byteorder is irrelevant).
  76  *
  77  * They do _not_ update the port address. If you
  78  * want MMIO that copies stuff laid out in MMIO
  79  * memory across multiple ports, use "memcpy_toio()"
  80  * and friends.
  81  */
  82 extern void ioread8_rep(const void __iomem *port, void *buf, unsigned long count);
  83 extern void ioread16_rep(const void __iomem *port, void *buf, unsigned long count);
  84 extern void ioread32_rep(const void __iomem *port, void *buf, unsigned long count);
  85
  86 extern void iowrite8_rep(void __iomem *port, const void *buf, unsigned long count);
  87 extern void iowrite16_rep(void __iomem *port, const void *buf, unsigned long count);
  88 extern void iowrite32_rep(void __iomem *port, const void *buf, unsigned long count);
  89
  90 #ifdef CONFIG_HAS_IOPORT_MAP
  91 /* Create a virtual mapping cookie for an IO port range */
  92 extern void __iomem *ioport_map(unsigned long port, unsigned int nr);
  93 extern void ioport_unmap(void __iomem *);
  94 #endif
  95
  96 #ifndef ARCH_HAS_IOREMAP_WC
  97 #define ioremap_wc ioremap
  98 #endif
  99
 100 #ifndef ARCH_HAS_IOREMAP_WT
 101 #define ioremap_wt ioremap
 102 #endif
 103
 104 #ifndef ARCH_HAS_IOREMAP_NP
 105 /* See the comment in asm-generic/io.h about ioremap_np(). */
 106 #define ioremap_np ioremap_np
 107 static inline void __iomem *ioremap_np(phys_addr_t offset, size_t size)
 108 {
 109         return NULL;
 110 }
 111 #endif
 112
 113 #ifdef CONFIG_PCI
 114 /* Destroy a virtual mapping cookie for a PCI BAR (memory or IO) */
 115 struct pci_dev;
 116 extern void pci_iounmap(struct pci_dev *dev, void __iomem *);
 117 #elif defined(CONFIG_GENERIC_IOMAP)
 118 struct pci_dev;
 119 static inline void pci_iounmap(struct pci_dev *dev, void __iomem *addr)
 120 { }
 121 #endif
 122
 123 #include <asm-generic/pci_iomap.h>
 124
 125 #endif