xref: /linux/drivers/dma/idxd/idxd.h (revision e7d759f31ca295d589f7420719c311870bb3166f)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright(c) 2019 Intel Corporation. All rights rsvd. */
3 #ifndef _IDXD_H_
4 #define _IDXD_H_
5 
6 #include <linux/sbitmap.h>
7 #include <linux/dmaengine.h>
8 #include <linux/percpu-rwsem.h>
9 #include <linux/wait.h>
10 #include <linux/cdev.h>
11 #include <linux/idr.h>
12 #include <linux/pci.h>
13 #include <linux/bitmap.h>
14 #include <linux/perf_event.h>
15 #include <linux/iommu.h>
16 #include <linux/crypto.h>
17 #include <uapi/linux/idxd.h>
18 #include "registers.h"
19 
20 #define IDXD_DRIVER_VERSION	"1.00"
21 
22 extern struct kmem_cache *idxd_desc_pool;
23 extern bool tc_override;
24 
25 struct idxd_wq;
26 struct idxd_dev;
27 
28 enum idxd_dev_type {
29 	IDXD_DEV_NONE = -1,
30 	IDXD_DEV_DSA = 0,
31 	IDXD_DEV_IAX,
32 	IDXD_DEV_WQ,
33 	IDXD_DEV_GROUP,
34 	IDXD_DEV_ENGINE,
35 	IDXD_DEV_CDEV,
36 	IDXD_DEV_CDEV_FILE,
37 	IDXD_DEV_MAX_TYPE,
38 };
39 
40 struct idxd_dev {
41 	struct device conf_dev;
42 	enum idxd_dev_type type;
43 };
44 
45 #define IDXD_REG_TIMEOUT	50
46 #define IDXD_DRAIN_TIMEOUT	5000
47 
48 enum idxd_type {
49 	IDXD_TYPE_UNKNOWN = -1,
50 	IDXD_TYPE_DSA = 0,
51 	IDXD_TYPE_IAX,
52 	IDXD_TYPE_MAX,
53 };
54 
55 #define IDXD_NAME_SIZE		128
56 #define IDXD_PMU_EVENT_MAX	64
57 
58 #define IDXD_ENQCMDS_RETRIES		32
59 #define IDXD_ENQCMDS_MAX_RETRIES	64
60 
61 enum idxd_complete_type {
62 	IDXD_COMPLETE_NORMAL = 0,
63 	IDXD_COMPLETE_ABORT,
64 	IDXD_COMPLETE_DEV_FAIL,
65 };
66 
67 struct idxd_desc;
68 
69 struct idxd_device_driver {
70 	const char *name;
71 	enum idxd_dev_type *type;
72 	int (*probe)(struct idxd_dev *idxd_dev);
73 	void (*remove)(struct idxd_dev *idxd_dev);
74 	void (*desc_complete)(struct idxd_desc *desc,
75 			      enum idxd_complete_type comp_type,
76 			      bool free_desc,
77 			      void *ctx, u32 *status);
78 	struct device_driver drv;
79 };
80 
81 extern struct idxd_device_driver dsa_drv;
82 extern struct idxd_device_driver idxd_drv;
83 extern struct idxd_device_driver idxd_dmaengine_drv;
84 extern struct idxd_device_driver idxd_user_drv;
85 
86 #define INVALID_INT_HANDLE	-1
87 struct idxd_irq_entry {
88 	int id;
89 	int vector;
90 	struct llist_head pending_llist;
91 	struct list_head work_list;
92 	/*
93 	 * Lock to protect access between irq thread process descriptor
94 	 * and irq thread processing error descriptor.
95 	 */
96 	spinlock_t list_lock;
97 	int int_handle;
98 	ioasid_t pasid;
99 };
100 
101 struct idxd_group {
102 	struct idxd_dev idxd_dev;
103 	struct idxd_device *idxd;
104 	struct grpcfg grpcfg;
105 	int id;
106 	int num_engines;
107 	int num_wqs;
108 	bool use_rdbuf_limit;
109 	u8 rdbufs_allowed;
110 	u8 rdbufs_reserved;
111 	int tc_a;
112 	int tc_b;
113 	int desc_progress_limit;
114 	int batch_progress_limit;
115 };
116 
117 struct idxd_pmu {
118 	struct idxd_device *idxd;
119 
120 	struct perf_event *event_list[IDXD_PMU_EVENT_MAX];
121 	int n_events;
122 
123 	DECLARE_BITMAP(used_mask, IDXD_PMU_EVENT_MAX);
124 
125 	struct pmu pmu;
126 	char name[IDXD_NAME_SIZE];
127 	int cpu;
128 
129 	int n_counters;
130 	int counter_width;
131 	int n_event_categories;
132 
133 	bool per_counter_caps_supported;
134 	unsigned long supported_event_categories;
135 
136 	unsigned long supported_filters;
137 	int n_filters;
138 
139 	struct hlist_node cpuhp_node;
140 };
141 
142 #define IDXD_MAX_PRIORITY	0xf
143 
144 enum {
145 	COUNTER_FAULTS = 0,
146 	COUNTER_FAULT_FAILS,
147 	COUNTER_MAX
148 };
149 
150 enum idxd_wq_state {
151 	IDXD_WQ_DISABLED = 0,
152 	IDXD_WQ_ENABLED,
153 };
154 
155 enum idxd_wq_flag {
156 	WQ_FLAG_DEDICATED = 0,
157 	WQ_FLAG_BLOCK_ON_FAULT,
158 	WQ_FLAG_ATS_DISABLE,
159 	WQ_FLAG_PRS_DISABLE,
160 };
161 
162 enum idxd_wq_type {
163 	IDXD_WQT_NONE = 0,
164 	IDXD_WQT_KERNEL,
165 	IDXD_WQT_USER,
166 };
167 
168 struct idxd_cdev {
169 	struct idxd_wq *wq;
170 	struct cdev cdev;
171 	struct idxd_dev idxd_dev;
172 	int minor;
173 };
174 
175 #define DRIVER_NAME_SIZE		128
176 
177 #define IDXD_ALLOCATED_BATCH_SIZE	128U
178 #define WQ_NAME_SIZE   1024
179 #define WQ_TYPE_SIZE   10
180 
181 #define WQ_DEFAULT_QUEUE_DEPTH		16
182 #define WQ_DEFAULT_MAX_XFER		SZ_2M
183 #define WQ_DEFAULT_MAX_BATCH		32
184 
185 enum idxd_op_type {
186 	IDXD_OP_BLOCK = 0,
187 	IDXD_OP_NONBLOCK = 1,
188 };
189 
190 struct idxd_dma_chan {
191 	struct dma_chan chan;
192 	struct idxd_wq *wq;
193 };
194 
195 struct idxd_wq {
196 	void __iomem *portal;
197 	u32 portal_offset;
198 	unsigned int enqcmds_retries;
199 	struct percpu_ref wq_active;
200 	struct completion wq_dead;
201 	struct completion wq_resurrect;
202 	struct idxd_dev idxd_dev;
203 	struct idxd_cdev *idxd_cdev;
204 	struct wait_queue_head err_queue;
205 	struct workqueue_struct *wq;
206 	struct idxd_device *idxd;
207 	int id;
208 	struct idxd_irq_entry ie;
209 	enum idxd_wq_type type;
210 	struct idxd_group *group;
211 	int client_count;
212 	struct mutex wq_lock;	/* mutex for workqueue */
213 	u32 size;
214 	u32 threshold;
215 	u32 priority;
216 	enum idxd_wq_state state;
217 	unsigned long flags;
218 	union wqcfg *wqcfg;
219 	unsigned long *opcap_bmap;
220 
221 	struct dsa_hw_desc **hw_descs;
222 	int num_descs;
223 	union {
224 		struct dsa_completion_record *compls;
225 		struct iax_completion_record *iax_compls;
226 	};
227 	dma_addr_t compls_addr;
228 	int compls_size;
229 	struct idxd_desc **descs;
230 	struct sbitmap_queue sbq;
231 	struct idxd_dma_chan *idxd_chan;
232 	char name[WQ_NAME_SIZE + 1];
233 	u64 max_xfer_bytes;
234 	u32 max_batch_size;
235 
236 	/* Lock to protect upasid_xa access. */
237 	struct mutex uc_lock;
238 	struct xarray upasid_xa;
239 
240 	char driver_name[DRIVER_NAME_SIZE + 1];
241 };
242 
243 struct idxd_engine {
244 	struct idxd_dev idxd_dev;
245 	int id;
246 	struct idxd_group *group;
247 	struct idxd_device *idxd;
248 };
249 
250 /* shadow registers */
251 struct idxd_hw {
252 	u32 version;
253 	union gen_cap_reg gen_cap;
254 	union wq_cap_reg wq_cap;
255 	union group_cap_reg group_cap;
256 	union engine_cap_reg engine_cap;
257 	struct opcap opcap;
258 	u32 cmd_cap;
259 	union iaa_cap_reg iaa_cap;
260 };
261 
262 enum idxd_device_state {
263 	IDXD_DEV_HALTED = -1,
264 	IDXD_DEV_DISABLED = 0,
265 	IDXD_DEV_ENABLED,
266 };
267 
268 enum idxd_device_flag {
269 	IDXD_FLAG_CONFIGURABLE = 0,
270 	IDXD_FLAG_CMD_RUNNING,
271 	IDXD_FLAG_PASID_ENABLED,
272 	IDXD_FLAG_USER_PASID_ENABLED,
273 };
274 
275 struct idxd_dma_dev {
276 	struct idxd_device *idxd;
277 	struct dma_device dma;
278 };
279 
280 typedef int (*load_device_defaults_fn_t) (struct idxd_device *idxd);
281 
282 struct idxd_driver_data {
283 	const char *name_prefix;
284 	enum idxd_type type;
285 	struct device_type *dev_type;
286 	int compl_size;
287 	int align;
288 	int evl_cr_off;
289 	int cr_status_off;
290 	int cr_result_off;
291 	load_device_defaults_fn_t load_device_defaults;
292 };
293 
294 struct idxd_evl {
295 	/* Lock to protect event log access. */
296 	spinlock_t lock;
297 	void *log;
298 	dma_addr_t dma;
299 	/* Total size of event log = number of entries * entry size. */
300 	unsigned int log_size;
301 	/* The number of entries in the event log. */
302 	u16 size;
303 	u16 head;
304 	unsigned long *bmap;
305 	bool batch_fail[IDXD_MAX_BATCH_IDENT];
306 };
307 
308 struct idxd_evl_fault {
309 	struct work_struct work;
310 	struct idxd_wq *wq;
311 	u8 status;
312 
313 	/* make this last member always */
314 	struct __evl_entry entry[];
315 };
316 
317 struct idxd_device {
318 	struct idxd_dev idxd_dev;
319 	struct idxd_driver_data *data;
320 	struct list_head list;
321 	struct idxd_hw hw;
322 	enum idxd_device_state state;
323 	unsigned long flags;
324 	int id;
325 	int major;
326 	u32 cmd_status;
327 	struct idxd_irq_entry ie;	/* misc irq, msix 0 */
328 
329 	struct pci_dev *pdev;
330 	void __iomem *reg_base;
331 
332 	spinlock_t dev_lock;	/* spinlock for device */
333 	spinlock_t cmd_lock;	/* spinlock for device commands */
334 	struct completion *cmd_done;
335 	struct idxd_group **groups;
336 	struct idxd_wq **wqs;
337 	struct idxd_engine **engines;
338 
339 	struct iommu_sva *sva;
340 	unsigned int pasid;
341 
342 	int num_groups;
343 	int irq_cnt;
344 	bool request_int_handles;
345 
346 	u32 msix_perm_offset;
347 	u32 wqcfg_offset;
348 	u32 grpcfg_offset;
349 	u32 perfmon_offset;
350 
351 	u64 max_xfer_bytes;
352 	u32 max_batch_size;
353 	int max_groups;
354 	int max_engines;
355 	int max_rdbufs;
356 	int max_wqs;
357 	int max_wq_size;
358 	int rdbuf_limit;
359 	int nr_rdbufs;		/* non-reserved read buffers */
360 	unsigned int wqcfg_size;
361 	unsigned long *wq_enable_map;
362 
363 	union sw_err_reg sw_err;
364 	wait_queue_head_t cmd_waitq;
365 
366 	struct idxd_dma_dev *idxd_dma;
367 	struct workqueue_struct *wq;
368 	struct work_struct work;
369 
370 	struct idxd_pmu *idxd_pmu;
371 
372 	unsigned long *opcap_bmap;
373 	struct idxd_evl *evl;
374 	struct kmem_cache *evl_cache;
375 
376 	struct dentry *dbgfs_dir;
377 	struct dentry *dbgfs_evl_file;
378 };
379 
380 static inline unsigned int evl_ent_size(struct idxd_device *idxd)
381 {
382 	return idxd->hw.gen_cap.evl_support ?
383 	       (32 * (1 << idxd->hw.gen_cap.evl_support)) : 0;
384 }
385 
386 static inline unsigned int evl_size(struct idxd_device *idxd)
387 {
388 	return idxd->evl->size * evl_ent_size(idxd);
389 }
390 
391 struct crypto_ctx {
392 	struct acomp_req *req;
393 	struct crypto_tfm *tfm;
394 	dma_addr_t src_addr;
395 	dma_addr_t dst_addr;
396 	bool compress;
397 };
398 
399 /* IDXD software descriptor */
400 struct idxd_desc {
401 	union {
402 		struct dsa_hw_desc *hw;
403 		struct iax_hw_desc *iax_hw;
404 	};
405 	dma_addr_t desc_dma;
406 	union {
407 		struct dsa_completion_record *completion;
408 		struct iax_completion_record *iax_completion;
409 	};
410 	dma_addr_t compl_dma;
411 	union {
412 		struct dma_async_tx_descriptor txd;
413 		struct crypto_ctx crypto;
414 	};
415 	struct llist_node llnode;
416 	struct list_head list;
417 	int id;
418 	int cpu;
419 	struct idxd_wq *wq;
420 };
421 
422 /*
423  * This is software defined error for the completion status. We overload the error code
424  * that will never appear in completion status and only SWERR register.
425  */
426 enum idxd_completion_status {
427 	IDXD_COMP_DESC_ABORT = 0xff,
428 };
429 
430 #define idxd_confdev(idxd) &idxd->idxd_dev.conf_dev
431 #define wq_confdev(wq) &wq->idxd_dev.conf_dev
432 #define engine_confdev(engine) &engine->idxd_dev.conf_dev
433 #define group_confdev(group) &group->idxd_dev.conf_dev
434 #define cdev_dev(cdev) &cdev->idxd_dev.conf_dev
435 #define user_ctx_dev(ctx) (&(ctx)->idxd_dev.conf_dev)
436 
437 #define confdev_to_idxd_dev(dev) container_of(dev, struct idxd_dev, conf_dev)
438 #define idxd_dev_to_idxd(idxd_dev) container_of(idxd_dev, struct idxd_device, idxd_dev)
439 #define idxd_dev_to_wq(idxd_dev) container_of(idxd_dev, struct idxd_wq, idxd_dev)
440 
441 static inline struct idxd_device_driver *wq_to_idxd_drv(struct idxd_wq *wq)
442 {
443 	struct device *dev = wq_confdev(wq);
444 	struct idxd_device_driver *idxd_drv =
445 		container_of(dev->driver, struct idxd_device_driver, drv);
446 
447 	return idxd_drv;
448 }
449 
450 static inline struct idxd_device *confdev_to_idxd(struct device *dev)
451 {
452 	struct idxd_dev *idxd_dev = confdev_to_idxd_dev(dev);
453 
454 	return idxd_dev_to_idxd(idxd_dev);
455 }
456 
457 static inline struct idxd_wq *confdev_to_wq(struct device *dev)
458 {
459 	struct idxd_dev *idxd_dev = confdev_to_idxd_dev(dev);
460 
461 	return idxd_dev_to_wq(idxd_dev);
462 }
463 
464 static inline struct idxd_engine *confdev_to_engine(struct device *dev)
465 {
466 	struct idxd_dev *idxd_dev = confdev_to_idxd_dev(dev);
467 
468 	return container_of(idxd_dev, struct idxd_engine, idxd_dev);
469 }
470 
471 static inline struct idxd_group *confdev_to_group(struct device *dev)
472 {
473 	struct idxd_dev *idxd_dev = confdev_to_idxd_dev(dev);
474 
475 	return container_of(idxd_dev, struct idxd_group, idxd_dev);
476 }
477 
478 static inline struct idxd_cdev *dev_to_cdev(struct device *dev)
479 {
480 	struct idxd_dev *idxd_dev = confdev_to_idxd_dev(dev);
481 
482 	return container_of(idxd_dev, struct idxd_cdev, idxd_dev);
483 }
484 
485 static inline void idxd_dev_set_type(struct idxd_dev *idev, int type)
486 {
487 	if (type >= IDXD_DEV_MAX_TYPE) {
488 		idev->type = IDXD_DEV_NONE;
489 		return;
490 	}
491 
492 	idev->type = type;
493 }
494 
495 static inline struct idxd_irq_entry *idxd_get_ie(struct idxd_device *idxd, int idx)
496 {
497 	return (idx == 0) ? &idxd->ie : &idxd->wqs[idx - 1]->ie;
498 }
499 
500 static inline struct idxd_wq *ie_to_wq(struct idxd_irq_entry *ie)
501 {
502 	return container_of(ie, struct idxd_wq, ie);
503 }
504 
505 static inline struct idxd_device *ie_to_idxd(struct idxd_irq_entry *ie)
506 {
507 	return container_of(ie, struct idxd_device, ie);
508 }
509 
510 static inline void idxd_set_user_intr(struct idxd_device *idxd, bool enable)
511 {
512 	union gencfg_reg reg;
513 
514 	reg.bits = ioread32(idxd->reg_base + IDXD_GENCFG_OFFSET);
515 	reg.user_int_en = enable;
516 	iowrite32(reg.bits, idxd->reg_base + IDXD_GENCFG_OFFSET);
517 }
518 
519 extern struct bus_type dsa_bus_type;
520 
521 extern bool support_enqcmd;
522 extern struct ida idxd_ida;
523 extern struct device_type dsa_device_type;
524 extern struct device_type iax_device_type;
525 extern struct device_type idxd_wq_device_type;
526 extern struct device_type idxd_engine_device_type;
527 extern struct device_type idxd_group_device_type;
528 
529 static inline bool is_dsa_dev(struct idxd_dev *idxd_dev)
530 {
531 	return idxd_dev->type == IDXD_DEV_DSA;
532 }
533 
534 static inline bool is_iax_dev(struct idxd_dev *idxd_dev)
535 {
536 	return idxd_dev->type == IDXD_DEV_IAX;
537 }
538 
539 static inline bool is_idxd_dev(struct idxd_dev *idxd_dev)
540 {
541 	return is_dsa_dev(idxd_dev) || is_iax_dev(idxd_dev);
542 }
543 
544 static inline bool is_idxd_wq_dev(struct idxd_dev *idxd_dev)
545 {
546 	return idxd_dev->type == IDXD_DEV_WQ;
547 }
548 
549 static inline bool is_idxd_wq_dmaengine(struct idxd_wq *wq)
550 {
551 	if (wq->type == IDXD_WQT_KERNEL && strcmp(wq->name, "dmaengine") == 0)
552 		return true;
553 	return false;
554 }
555 
556 static inline bool is_idxd_wq_user(struct idxd_wq *wq)
557 {
558 	return wq->type == IDXD_WQT_USER;
559 }
560 
561 static inline bool is_idxd_wq_kernel(struct idxd_wq *wq)
562 {
563 	return wq->type == IDXD_WQT_KERNEL;
564 }
565 
566 static inline bool wq_dedicated(struct idxd_wq *wq)
567 {
568 	return test_bit(WQ_FLAG_DEDICATED, &wq->flags);
569 }
570 
571 static inline bool wq_shared(struct idxd_wq *wq)
572 {
573 	return !test_bit(WQ_FLAG_DEDICATED, &wq->flags);
574 }
575 
576 static inline bool device_pasid_enabled(struct idxd_device *idxd)
577 {
578 	return test_bit(IDXD_FLAG_PASID_ENABLED, &idxd->flags);
579 }
580 
581 static inline bool device_user_pasid_enabled(struct idxd_device *idxd)
582 {
583 	return test_bit(IDXD_FLAG_USER_PASID_ENABLED, &idxd->flags);
584 }
585 
586 static inline bool wq_pasid_enabled(struct idxd_wq *wq)
587 {
588 	return (is_idxd_wq_kernel(wq) && device_pasid_enabled(wq->idxd)) ||
589 	       (is_idxd_wq_user(wq) && device_user_pasid_enabled(wq->idxd));
590 }
591 
592 static inline bool wq_shared_supported(struct idxd_wq *wq)
593 {
594 	return (support_enqcmd && wq_pasid_enabled(wq));
595 }
596 
597 enum idxd_portal_prot {
598 	IDXD_PORTAL_UNLIMITED = 0,
599 	IDXD_PORTAL_LIMITED,
600 };
601 
602 enum idxd_interrupt_type {
603 	IDXD_IRQ_MSIX = 0,
604 	IDXD_IRQ_IMS,
605 };
606 
607 static inline int idxd_get_wq_portal_offset(enum idxd_portal_prot prot)
608 {
609 	return prot * 0x1000;
610 }
611 
612 static inline int idxd_get_wq_portal_full_offset(int wq_id,
613 						 enum idxd_portal_prot prot)
614 {
615 	return ((wq_id * 4) << PAGE_SHIFT) + idxd_get_wq_portal_offset(prot);
616 }
617 
618 #define IDXD_PORTAL_MASK	(PAGE_SIZE - 1)
619 
620 /*
621  * Even though this function can be accessed by multiple threads, it is safe to use.
622  * At worst the address gets used more than once before it gets incremented. We don't
623  * hit a threshold until iops becomes many million times a second. So the occasional
624  * reuse of the same address is tolerable compare to using an atomic variable. This is
625  * safe on a system that has atomic load/store for 32bit integers. Given that this is an
626  * Intel iEP device, that should not be a problem.
627  */
628 static inline void __iomem *idxd_wq_portal_addr(struct idxd_wq *wq)
629 {
630 	int ofs = wq->portal_offset;
631 
632 	wq->portal_offset = (ofs + sizeof(struct dsa_raw_desc)) & IDXD_PORTAL_MASK;
633 	return wq->portal + ofs;
634 }
635 
636 static inline void idxd_wq_get(struct idxd_wq *wq)
637 {
638 	wq->client_count++;
639 }
640 
641 static inline void idxd_wq_put(struct idxd_wq *wq)
642 {
643 	wq->client_count--;
644 }
645 
646 static inline int idxd_wq_refcount(struct idxd_wq *wq)
647 {
648 	return wq->client_count;
649 };
650 
651 static inline void idxd_wq_set_private(struct idxd_wq *wq, void *private)
652 {
653 	dev_set_drvdata(wq_confdev(wq), private);
654 }
655 
656 static inline void *idxd_wq_get_private(struct idxd_wq *wq)
657 {
658 	return dev_get_drvdata(wq_confdev(wq));
659 }
660 
661 /*
662  * Intel IAA does not support batch processing.
663  * The max batch size of device, max batch size of wq and
664  * max batch shift of wqcfg should be always 0 on IAA.
665  */
666 static inline void idxd_set_max_batch_size(int idxd_type, struct idxd_device *idxd,
667 					   u32 max_batch_size)
668 {
669 	if (idxd_type == IDXD_TYPE_IAX)
670 		idxd->max_batch_size = 0;
671 	else
672 		idxd->max_batch_size = max_batch_size;
673 }
674 
675 static inline void idxd_wq_set_max_batch_size(int idxd_type, struct idxd_wq *wq,
676 					      u32 max_batch_size)
677 {
678 	if (idxd_type == IDXD_TYPE_IAX)
679 		wq->max_batch_size = 0;
680 	else
681 		wq->max_batch_size = max_batch_size;
682 }
683 
684 static inline void idxd_wqcfg_set_max_batch_shift(int idxd_type, union wqcfg *wqcfg,
685 						  u32 max_batch_shift)
686 {
687 	if (idxd_type == IDXD_TYPE_IAX)
688 		wqcfg->max_batch_shift = 0;
689 	else
690 		wqcfg->max_batch_shift = max_batch_shift;
691 }
692 
693 static inline int idxd_wq_driver_name_match(struct idxd_wq *wq, struct device *dev)
694 {
695 	return (strncmp(wq->driver_name, dev->driver->name, strlen(dev->driver->name)) == 0);
696 }
697 
698 #define MODULE_ALIAS_IDXD_DEVICE(type) MODULE_ALIAS("idxd:t" __stringify(type) "*")
699 #define IDXD_DEVICES_MODALIAS_FMT "idxd:t%d"
700 
701 int __must_check __idxd_driver_register(struct idxd_device_driver *idxd_drv,
702 					struct module *module, const char *mod_name);
703 #define idxd_driver_register(driver) \
704 	__idxd_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
705 
706 void idxd_driver_unregister(struct idxd_device_driver *idxd_drv);
707 
708 #define module_idxd_driver(__idxd_driver) \
709 	module_driver(__idxd_driver, idxd_driver_register, idxd_driver_unregister)
710 
711 void idxd_free_desc(struct idxd_wq *wq, struct idxd_desc *desc);
712 void idxd_dma_complete_txd(struct idxd_desc *desc,
713 			   enum idxd_complete_type comp_type,
714 			   bool free_desc, void *ctx, u32 *status);
715 
716 static inline void idxd_desc_complete(struct idxd_desc *desc,
717 				      enum idxd_complete_type comp_type,
718 				      bool free_desc)
719 {
720 	struct idxd_device_driver *drv;
721 	u32 status;
722 
723 	drv = wq_to_idxd_drv(desc->wq);
724 	if (drv->desc_complete)
725 		drv->desc_complete(desc, comp_type, free_desc,
726 				   &desc->txd, &status);
727 }
728 
729 int idxd_register_bus_type(void);
730 void idxd_unregister_bus_type(void);
731 int idxd_register_devices(struct idxd_device *idxd);
732 void idxd_unregister_devices(struct idxd_device *idxd);
733 void idxd_wqs_quiesce(struct idxd_device *idxd);
734 bool idxd_queue_int_handle_resubmit(struct idxd_desc *desc);
735 void multi_u64_to_bmap(unsigned long *bmap, u64 *val, int count);
736 int idxd_load_iaa_device_defaults(struct idxd_device *idxd);
737 
738 /* device interrupt control */
739 irqreturn_t idxd_misc_thread(int vec, void *data);
740 irqreturn_t idxd_wq_thread(int irq, void *data);
741 void idxd_mask_error_interrupts(struct idxd_device *idxd);
742 void idxd_unmask_error_interrupts(struct idxd_device *idxd);
743 
744 /* device control */
745 int idxd_device_drv_probe(struct idxd_dev *idxd_dev);
746 void idxd_device_drv_remove(struct idxd_dev *idxd_dev);
747 int idxd_drv_enable_wq(struct idxd_wq *wq);
748 void idxd_drv_disable_wq(struct idxd_wq *wq);
749 int idxd_device_init_reset(struct idxd_device *idxd);
750 int idxd_device_enable(struct idxd_device *idxd);
751 int idxd_device_disable(struct idxd_device *idxd);
752 void idxd_device_reset(struct idxd_device *idxd);
753 void idxd_device_clear_state(struct idxd_device *idxd);
754 int idxd_device_config(struct idxd_device *idxd);
755 void idxd_device_drain_pasid(struct idxd_device *idxd, int pasid);
756 int idxd_device_load_config(struct idxd_device *idxd);
757 int idxd_device_request_int_handle(struct idxd_device *idxd, int idx, int *handle,
758 				   enum idxd_interrupt_type irq_type);
759 int idxd_device_release_int_handle(struct idxd_device *idxd, int handle,
760 				   enum idxd_interrupt_type irq_type);
761 
762 /* work queue control */
763 void idxd_wqs_unmap_portal(struct idxd_device *idxd);
764 int idxd_wq_alloc_resources(struct idxd_wq *wq);
765 void idxd_wq_free_resources(struct idxd_wq *wq);
766 int idxd_wq_enable(struct idxd_wq *wq);
767 int idxd_wq_disable(struct idxd_wq *wq, bool reset_config);
768 void idxd_wq_drain(struct idxd_wq *wq);
769 void idxd_wq_reset(struct idxd_wq *wq);
770 int idxd_wq_map_portal(struct idxd_wq *wq);
771 void idxd_wq_unmap_portal(struct idxd_wq *wq);
772 int idxd_wq_set_pasid(struct idxd_wq *wq, int pasid);
773 int idxd_wq_disable_pasid(struct idxd_wq *wq);
774 void __idxd_wq_quiesce(struct idxd_wq *wq);
775 void idxd_wq_quiesce(struct idxd_wq *wq);
776 int idxd_wq_init_percpu_ref(struct idxd_wq *wq);
777 void idxd_wq_free_irq(struct idxd_wq *wq);
778 int idxd_wq_request_irq(struct idxd_wq *wq);
779 
780 /* submission */
781 int idxd_submit_desc(struct idxd_wq *wq, struct idxd_desc *desc);
782 struct idxd_desc *idxd_alloc_desc(struct idxd_wq *wq, enum idxd_op_type optype);
783 int idxd_enqcmds(struct idxd_wq *wq, void __iomem *portal, const void *desc);
784 
785 /* dmaengine */
786 int idxd_register_dma_device(struct idxd_device *idxd);
787 void idxd_unregister_dma_device(struct idxd_device *idxd);
788 
789 /* cdev */
790 int idxd_cdev_register(void);
791 void idxd_cdev_remove(void);
792 int idxd_cdev_get_major(struct idxd_device *idxd);
793 int idxd_wq_add_cdev(struct idxd_wq *wq);
794 void idxd_wq_del_cdev(struct idxd_wq *wq);
795 int idxd_copy_cr(struct idxd_wq *wq, ioasid_t pasid, unsigned long addr,
796 		 void *buf, int len);
797 void idxd_user_counter_increment(struct idxd_wq *wq, u32 pasid, int index);
798 
799 /* perfmon */
800 #if IS_ENABLED(CONFIG_INTEL_IDXD_PERFMON)
801 int perfmon_pmu_init(struct idxd_device *idxd);
802 void perfmon_pmu_remove(struct idxd_device *idxd);
803 void perfmon_counter_overflow(struct idxd_device *idxd);
804 void perfmon_init(void);
805 void perfmon_exit(void);
806 #else
807 static inline int perfmon_pmu_init(struct idxd_device *idxd) { return 0; }
808 static inline void perfmon_pmu_remove(struct idxd_device *idxd) {}
809 static inline void perfmon_counter_overflow(struct idxd_device *idxd) {}
810 static inline void perfmon_init(void) {}
811 static inline void perfmon_exit(void) {}
812 #endif
813 
814 /* debugfs */
815 int idxd_device_init_debugfs(struct idxd_device *idxd);
816 void idxd_device_remove_debugfs(struct idxd_device *idxd);
817 int idxd_init_debugfs(void);
818 void idxd_remove_debugfs(void);
819 
820 #endif
821