xref: /OK3568_Linux_fs/kernel/include/linux/ioasid.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef __LINUX_IOASID_H
3*4882a593Smuzhiyun #define __LINUX_IOASID_H
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include <linux/types.h>
6*4882a593Smuzhiyun #include <linux/errno.h>
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #define INVALID_IOASID ((ioasid_t)-1)
9*4882a593Smuzhiyun typedef unsigned int ioasid_t;
10*4882a593Smuzhiyun typedef ioasid_t (*ioasid_alloc_fn_t)(ioasid_t min, ioasid_t max, void *data);
11*4882a593Smuzhiyun typedef void (*ioasid_free_fn_t)(ioasid_t ioasid, void *data);
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun struct ioasid_set {
14*4882a593Smuzhiyun 	int dummy;
15*4882a593Smuzhiyun };
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun /**
18*4882a593Smuzhiyun  * struct ioasid_allocator_ops - IOASID allocator helper functions and data
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  * @alloc:	helper function to allocate IOASID
21*4882a593Smuzhiyun  * @free:	helper function to free IOASID
22*4882a593Smuzhiyun  * @list:	for tracking ops that share helper functions but not data
23*4882a593Smuzhiyun  * @pdata:	data belong to the allocator, provided when calling alloc()
24*4882a593Smuzhiyun  */
25*4882a593Smuzhiyun struct ioasid_allocator_ops {
26*4882a593Smuzhiyun 	ioasid_alloc_fn_t alloc;
27*4882a593Smuzhiyun 	ioasid_free_fn_t free;
28*4882a593Smuzhiyun 	struct list_head list;
29*4882a593Smuzhiyun 	void *pdata;
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun #define DECLARE_IOASID_SET(name) struct ioasid_set name = { 0 }
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #if IS_ENABLED(CONFIG_IOASID)
35*4882a593Smuzhiyun ioasid_t ioasid_alloc(struct ioasid_set *set, ioasid_t min, ioasid_t max,
36*4882a593Smuzhiyun 		      void *private);
37*4882a593Smuzhiyun void ioasid_free(ioasid_t ioasid);
38*4882a593Smuzhiyun void *ioasid_find(struct ioasid_set *set, ioasid_t ioasid,
39*4882a593Smuzhiyun 		  bool (*getter)(void *));
40*4882a593Smuzhiyun int ioasid_register_allocator(struct ioasid_allocator_ops *allocator);
41*4882a593Smuzhiyun void ioasid_unregister_allocator(struct ioasid_allocator_ops *allocator);
42*4882a593Smuzhiyun int ioasid_set_data(ioasid_t ioasid, void *data);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #else /* !CONFIG_IOASID */
ioasid_alloc(struct ioasid_set * set,ioasid_t min,ioasid_t max,void * private)45*4882a593Smuzhiyun static inline ioasid_t ioasid_alloc(struct ioasid_set *set, ioasid_t min,
46*4882a593Smuzhiyun 				    ioasid_t max, void *private)
47*4882a593Smuzhiyun {
48*4882a593Smuzhiyun 	return INVALID_IOASID;
49*4882a593Smuzhiyun }
50*4882a593Smuzhiyun 
ioasid_free(ioasid_t ioasid)51*4882a593Smuzhiyun static inline void ioasid_free(ioasid_t ioasid)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun }
54*4882a593Smuzhiyun 
ioasid_find(struct ioasid_set * set,ioasid_t ioasid,bool (* getter)(void *))55*4882a593Smuzhiyun static inline void *ioasid_find(struct ioasid_set *set, ioasid_t ioasid,
56*4882a593Smuzhiyun 				bool (*getter)(void *))
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun 	return NULL;
59*4882a593Smuzhiyun }
60*4882a593Smuzhiyun 
ioasid_register_allocator(struct ioasid_allocator_ops * allocator)61*4882a593Smuzhiyun static inline int ioasid_register_allocator(struct ioasid_allocator_ops *allocator)
62*4882a593Smuzhiyun {
63*4882a593Smuzhiyun 	return -ENOTSUPP;
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun 
ioasid_unregister_allocator(struct ioasid_allocator_ops * allocator)66*4882a593Smuzhiyun static inline void ioasid_unregister_allocator(struct ioasid_allocator_ops *allocator)
67*4882a593Smuzhiyun {
68*4882a593Smuzhiyun }
69*4882a593Smuzhiyun 
ioasid_set_data(ioasid_t ioasid,void * data)70*4882a593Smuzhiyun static inline int ioasid_set_data(ioasid_t ioasid, void *data)
71*4882a593Smuzhiyun {
72*4882a593Smuzhiyun 	return -ENOTSUPP;
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun #endif /* CONFIG_IOASID */
76*4882a593Smuzhiyun #endif /* __LINUX_IOASID_H */
77