xref: /linux/include/linux/of_reserved_mem.h (revision c56436ef)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __OF_RESERVED_MEM_H
3 #define __OF_RESERVED_MEM_H
4 
5 #include <linux/device.h>
6 #include <linux/of.h>
7 
8 struct of_phandle_args;
9 struct reserved_mem_ops;
10 
11 struct reserved_mem {
12 	const char			*name;
13 	unsigned long			fdt_node;
14 	const struct reserved_mem_ops	*ops;
15 	phys_addr_t			base;
16 	phys_addr_t			size;
17 	void				*priv;
18 };
19 
20 struct reserved_mem_ops {
21 	int	(*device_init)(struct reserved_mem *rmem,
22 			       struct device *dev);
23 	void	(*device_release)(struct reserved_mem *rmem,
24 				  struct device *dev);
25 };
26 
27 typedef int (*reservedmem_of_init_fn)(struct reserved_mem *rmem);
28 
29 #ifdef CONFIG_OF_RESERVED_MEM
30 
31 #define RESERVEDMEM_OF_DECLARE(name, compat, init)			\
32 	_OF_DECLARE(reservedmem, name, compat, init, reservedmem_of_init_fn)
33 
34 int of_reserved_mem_device_init_by_idx(struct device *dev,
35 				       struct device_node *np, int idx);
36 int of_reserved_mem_device_init_by_name(struct device *dev,
37 					struct device_node *np,
38 					const char *name);
39 void of_reserved_mem_device_release(struct device *dev);
40 
41 struct reserved_mem *of_reserved_mem_lookup(struct device_node *np);
42 #else
43 
44 #define RESERVEDMEM_OF_DECLARE(name, compat, init)			\
45 	_OF_DECLARE_STUB(reservedmem, name, compat, init, reservedmem_of_init_fn)
46 
of_reserved_mem_device_init_by_idx(struct device * dev,struct device_node * np,int idx)47 static inline int of_reserved_mem_device_init_by_idx(struct device *dev,
48 					struct device_node *np, int idx)
49 {
50 	return -ENOSYS;
51 }
52 
of_reserved_mem_device_init_by_name(struct device * dev,struct device_node * np,const char * name)53 static inline int of_reserved_mem_device_init_by_name(struct device *dev,
54 						      struct device_node *np,
55 						      const char *name)
56 {
57 	return -ENOSYS;
58 }
59 
of_reserved_mem_device_release(struct device * pdev)60 static inline void of_reserved_mem_device_release(struct device *pdev) { }
61 
of_reserved_mem_lookup(struct device_node * np)62 static inline struct reserved_mem *of_reserved_mem_lookup(struct device_node *np)
63 {
64 	return NULL;
65 }
66 #endif
67 
68 /**
69  * of_reserved_mem_device_init() - assign reserved memory region to given device
70  * @dev:	Pointer to the device to configure
71  *
72  * This function assigns respective DMA-mapping operations based on the first
73  * reserved memory region specified by 'memory-region' property in device tree
74  * node of the given device.
75  *
76  * Returns error code or zero on success.
77  */
of_reserved_mem_device_init(struct device * dev)78 static inline int of_reserved_mem_device_init(struct device *dev)
79 {
80 	return of_reserved_mem_device_init_by_idx(dev, dev->of_node, 0);
81 }
82 
83 #endif /* __OF_RESERVED_MEM_H */
84