Merge tag 'docs-5.15' of git://git.lwn.net/linux
[linux-2.6-microblaze.git] / arch / s390 / include / asm / pci.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __ASM_S390_PCI_H
3 #define __ASM_S390_PCI_H
4
5 #include <linux/pci.h>
6 #include <linux/mutex.h>
7 #include <linux/iommu.h>
8 #include <linux/pci_hotplug.h>
9 #include <asm-generic/pci.h>
10 #include <asm/pci_clp.h>
11 #include <asm/pci_debug.h>
12 #include <asm/sclp.h>
13
14 #define PCIBIOS_MIN_IO          0x1000
15 #define PCIBIOS_MIN_MEM         0x10000000
16
17 #define pcibios_assign_all_busses()     (0)
18
19 void __iomem *pci_iomap(struct pci_dev *, int, unsigned long);
20 void pci_iounmap(struct pci_dev *, void __iomem *);
21 int pci_domain_nr(struct pci_bus *);
22 int pci_proc_domain(struct pci_bus *);
23
24 #define ZPCI_BUS_NR                     0       /* default bus number */
25
26 #define ZPCI_NR_DMA_SPACES              1
27 #define ZPCI_NR_DEVICES                 CONFIG_PCI_NR_FUNCTIONS
28 #define ZPCI_DOMAIN_BITMAP_SIZE         (1 << 16)
29
30 #ifdef PCI
31 #if (ZPCI_NR_DEVICES > ZPCI_DOMAIN_BITMAP_SIZE)
32 # error ZPCI_NR_DEVICES can not be bigger than ZPCI_DOMAIN_BITMAP_SIZE
33 #endif
34 #endif /* PCI */
35
36 /* PCI Function Controls */
37 #define ZPCI_FC_FN_ENABLED              0x80
38 #define ZPCI_FC_ERROR                   0x40
39 #define ZPCI_FC_BLOCKED                 0x20
40 #define ZPCI_FC_DMA_ENABLED             0x10
41
42 #define ZPCI_FMB_DMA_COUNTER_VALID      (1 << 23)
43
44 struct zpci_fmb_fmt0 {
45         u64 dma_rbytes;
46         u64 dma_wbytes;
47 };
48
49 struct zpci_fmb_fmt1 {
50         u64 rx_bytes;
51         u64 rx_packets;
52         u64 tx_bytes;
53         u64 tx_packets;
54 };
55
56 struct zpci_fmb_fmt2 {
57         u64 consumed_work_units;
58         u64 max_work_units;
59 };
60
61 struct zpci_fmb_fmt3 {
62         u64 tx_bytes;
63 };
64
65 struct zpci_fmb {
66         u32 format      : 8;
67         u32 fmt_ind     : 24;
68         u32 samples;
69         u64 last_update;
70         /* common counters */
71         u64 ld_ops;
72         u64 st_ops;
73         u64 stb_ops;
74         u64 rpcit_ops;
75         /* format specific counters */
76         union {
77                 struct zpci_fmb_fmt0 fmt0;
78                 struct zpci_fmb_fmt1 fmt1;
79                 struct zpci_fmb_fmt2 fmt2;
80                 struct zpci_fmb_fmt3 fmt3;
81         };
82 } __packed __aligned(128);
83
84 enum zpci_state {
85         ZPCI_FN_STATE_STANDBY = 0,
86         ZPCI_FN_STATE_CONFIGURED = 1,
87         ZPCI_FN_STATE_RESERVED = 2,
88 };
89
90 struct zpci_bar_struct {
91         struct resource *res;           /* bus resource */
92         void __iomem    *mio_wb;
93         void __iomem    *mio_wt;
94         u32             val;            /* bar start & 3 flag bits */
95         u16             map_idx;        /* index into bar mapping array */
96         u8              size;           /* order 2 exponent */
97 };
98
99 struct s390_domain;
100
101 #define ZPCI_FUNCTIONS_PER_BUS 256
102 struct zpci_bus {
103         struct kref             kref;
104         struct pci_bus          *bus;
105         struct zpci_dev         *function[ZPCI_FUNCTIONS_PER_BUS];
106         struct list_head        resources;
107         struct list_head        bus_next;
108         struct resource         bus_resource;
109         int                     pchid;
110         int                     domain_nr;
111         bool                    multifunction;
112         enum pci_bus_speed      max_bus_speed;
113 };
114
115 /* Private data per function */
116 struct zpci_dev {
117         struct zpci_bus *zbus;
118         struct list_head entry;         /* list of all zpci_devices, needed for hotplug, etc. */
119         struct list_head bus_next;
120         struct kref kref;
121         struct hotplug_slot hotplug_slot;
122
123         enum zpci_state state;
124         u32             fid;            /* function ID, used by sclp */
125         u32             fh;             /* function handle, used by insn's */
126         u16             vfn;            /* virtual function number */
127         u16             pchid;          /* physical channel ID */
128         u8              pfgid;          /* function group ID */
129         u8              pft;            /* pci function type */
130         u8              port;
131         u8              rid_available   : 1;
132         u8              has_hp_slot     : 1;
133         u8              has_resources   : 1;
134         u8              is_physfn       : 1;
135         u8              util_str_avail  : 1;
136         u8              irqs_registered : 1;
137         u8              reserved        : 2;
138         unsigned int    devfn;          /* DEVFN part of the RID*/
139
140         struct mutex lock;
141         u8 pfip[CLP_PFIP_NR_SEGMENTS];  /* pci function internal path */
142         u32 uid;                        /* user defined id */
143         u8 util_str[CLP_UTIL_STR_LEN];  /* utility string */
144
145         /* IRQ stuff */
146         u64             msi_addr;       /* MSI address */
147         unsigned int    max_msi;        /* maximum number of MSI's */
148         unsigned int    msi_first_bit;
149         unsigned int    msi_nr_irqs;
150         struct airq_iv *aibv;           /* adapter interrupt bit vector */
151         unsigned long   aisb;           /* number of the summary bit */
152
153         /* DMA stuff */
154         unsigned long   *dma_table;
155         spinlock_t      dma_table_lock;
156         int             tlb_refresh;
157
158         spinlock_t      iommu_bitmap_lock;
159         unsigned long   *iommu_bitmap;
160         unsigned long   *lazy_bitmap;
161         unsigned long   iommu_size;
162         unsigned long   iommu_pages;
163         unsigned int    next_bit;
164
165         struct iommu_device iommu_dev;  /* IOMMU core handle */
166
167         char res_name[16];
168         bool mio_capable;
169         struct zpci_bar_struct bars[PCI_STD_NUM_BARS];
170
171         u64             start_dma;      /* Start of available DMA addresses */
172         u64             end_dma;        /* End of available DMA addresses */
173         u64             dma_mask;       /* DMA address space mask */
174
175         /* Function measurement block */
176         struct zpci_fmb *fmb;
177         u16             fmb_update;     /* update interval */
178         u16             fmb_length;
179         /* software counters */
180         atomic64_t allocated_pages;
181         atomic64_t mapped_pages;
182         atomic64_t unmapped_pages;
183
184         u8              version;
185         enum pci_bus_speed max_bus_speed;
186
187         struct dentry   *debugfs_dev;
188
189         struct s390_domain *s390_domain; /* s390 IOMMU domain data */
190 };
191
192 static inline bool zdev_enabled(struct zpci_dev *zdev)
193 {
194         return (zdev->fh & (1UL << 31)) ? true : false;
195 }
196
197 extern const struct attribute_group *zpci_attr_groups[];
198 extern unsigned int s390_pci_force_floating __initdata;
199 extern unsigned int s390_pci_no_rid;
200
201 /* -----------------------------------------------------------------------------
202   Prototypes
203 ----------------------------------------------------------------------------- */
204 /* Base stuff */
205 struct zpci_dev *zpci_create_device(u32 fid, u32 fh, enum zpci_state state);
206 int zpci_enable_device(struct zpci_dev *);
207 int zpci_disable_device(struct zpci_dev *);
208 int zpci_scan_configured_device(struct zpci_dev *zdev, u32 fh);
209 int zpci_deconfigure_device(struct zpci_dev *zdev);
210
211 int zpci_register_ioat(struct zpci_dev *, u8, u64, u64, u64);
212 int zpci_unregister_ioat(struct zpci_dev *, u8);
213 void zpci_remove_reserved_devices(void);
214
215 /* CLP */
216 int clp_setup_writeback_mio(void);
217 int clp_scan_pci_devices(void);
218 int clp_query_pci_fn(struct zpci_dev *zdev);
219 int clp_enable_fh(struct zpci_dev *zdev, u32 *fh, u8 nr_dma_as);
220 int clp_disable_fh(struct zpci_dev *zdev, u32 *fh);
221 int clp_get_state(u32 fid, enum zpci_state *state);
222 int clp_refresh_fh(u32 fid, u32 *fh);
223
224 /* UID */
225 void update_uid_checking(bool new);
226
227 /* IOMMU Interface */
228 int zpci_init_iommu(struct zpci_dev *zdev);
229 void zpci_destroy_iommu(struct zpci_dev *zdev);
230
231 #ifdef CONFIG_PCI
232 static inline bool zpci_use_mio(struct zpci_dev *zdev)
233 {
234         return static_branch_likely(&have_mio) && zdev->mio_capable;
235 }
236
237 /* Error handling and recovery */
238 void zpci_event_error(void *);
239 void zpci_event_availability(void *);
240 bool zpci_is_enabled(void);
241 #else /* CONFIG_PCI */
242 static inline void zpci_event_error(void *e) {}
243 static inline void zpci_event_availability(void *e) {}
244 #endif /* CONFIG_PCI */
245
246 #ifdef CONFIG_HOTPLUG_PCI_S390
247 int zpci_init_slot(struct zpci_dev *);
248 void zpci_exit_slot(struct zpci_dev *);
249 #else /* CONFIG_HOTPLUG_PCI_S390 */
250 static inline int zpci_init_slot(struct zpci_dev *zdev)
251 {
252         return 0;
253 }
254 static inline void zpci_exit_slot(struct zpci_dev *zdev) {}
255 #endif /* CONFIG_HOTPLUG_PCI_S390 */
256
257 /* Helpers */
258 static inline struct zpci_dev *to_zpci(struct pci_dev *pdev)
259 {
260         struct zpci_bus *zbus = pdev->sysdata;
261
262         return zbus->function[pdev->devfn];
263 }
264
265 static inline struct zpci_dev *to_zpci_dev(struct device *dev)
266 {
267         return to_zpci(to_pci_dev(dev));
268 }
269
270 struct zpci_dev *get_zdev_by_fid(u32);
271
272 /* DMA */
273 int zpci_dma_init(void);
274 void zpci_dma_exit(void);
275 int zpci_dma_init_device(struct zpci_dev *zdev);
276 int zpci_dma_exit_device(struct zpci_dev *zdev);
277
278 /* IRQ */
279 int __init zpci_irq_init(void);
280 void __init zpci_irq_exit(void);
281
282 int zpci_set_irq(struct zpci_dev *zdev);
283 int zpci_clear_irq(struct zpci_dev *zdev);
284
285 /* FMB */
286 int zpci_fmb_enable_device(struct zpci_dev *);
287 int zpci_fmb_disable_device(struct zpci_dev *);
288
289 /* Debug */
290 int zpci_debug_init(void);
291 void zpci_debug_exit(void);
292 void zpci_debug_init_device(struct zpci_dev *, const char *);
293 void zpci_debug_exit_device(struct zpci_dev *);
294
295 /* Error reporting */
296 int zpci_report_error(struct pci_dev *, struct zpci_report_error_header *);
297
298 #ifdef CONFIG_NUMA
299
300 /* Returns the node based on PCI bus */
301 static inline int __pcibus_to_node(const struct pci_bus *bus)
302 {
303         return NUMA_NO_NODE;
304 }
305
306 static inline const struct cpumask *
307 cpumask_of_pcibus(const struct pci_bus *bus)
308 {
309         return cpu_online_mask;
310 }
311
312 #endif /* CONFIG_NUMA */
313
314 #endif