xref: /OK3568_Linux_fs/kernel/include/linux/of_dma.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * OF helpers for DMA request / controller
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Based on of_gpio.h
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #ifndef __LINUX_OF_DMA_H
11*4882a593Smuzhiyun #define __LINUX_OF_DMA_H
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <linux/of.h>
14*4882a593Smuzhiyun #include <linux/dmaengine.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun struct device_node;
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun struct of_dma {
19*4882a593Smuzhiyun 	struct list_head	of_dma_controllers;
20*4882a593Smuzhiyun 	struct device_node	*of_node;
21*4882a593Smuzhiyun 	struct dma_chan		*(*of_dma_xlate)
22*4882a593Smuzhiyun 				(struct of_phandle_args *, struct of_dma *);
23*4882a593Smuzhiyun 	void			*(*of_dma_route_allocate)
24*4882a593Smuzhiyun 				(struct of_phandle_args *, struct of_dma *);
25*4882a593Smuzhiyun 	struct dma_router	*dma_router;
26*4882a593Smuzhiyun 	void			*of_dma_data;
27*4882a593Smuzhiyun };
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun struct of_dma_filter_info {
30*4882a593Smuzhiyun 	dma_cap_mask_t	dma_cap;
31*4882a593Smuzhiyun 	dma_filter_fn	filter_fn;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #ifdef CONFIG_DMA_OF
35*4882a593Smuzhiyun extern int of_dma_controller_register(struct device_node *np,
36*4882a593Smuzhiyun 		struct dma_chan *(*of_dma_xlate)
37*4882a593Smuzhiyun 		(struct of_phandle_args *, struct of_dma *),
38*4882a593Smuzhiyun 		void *data);
39*4882a593Smuzhiyun extern void of_dma_controller_free(struct device_node *np);
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun extern int of_dma_router_register(struct device_node *np,
42*4882a593Smuzhiyun 		void *(*of_dma_route_allocate)
43*4882a593Smuzhiyun 		(struct of_phandle_args *, struct of_dma *),
44*4882a593Smuzhiyun 		struct dma_router *dma_router);
45*4882a593Smuzhiyun #define of_dma_router_free of_dma_controller_free
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun extern struct dma_chan *of_dma_request_slave_channel(struct device_node *np,
48*4882a593Smuzhiyun 						     const char *name);
49*4882a593Smuzhiyun extern struct dma_chan *of_dma_simple_xlate(struct of_phandle_args *dma_spec,
50*4882a593Smuzhiyun 		struct of_dma *ofdma);
51*4882a593Smuzhiyun extern struct dma_chan *of_dma_xlate_by_chan_id(struct of_phandle_args *dma_spec,
52*4882a593Smuzhiyun 		struct of_dma *ofdma);
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun #else
of_dma_controller_register(struct device_node * np,struct dma_chan * (* of_dma_xlate)(struct of_phandle_args *,struct of_dma *),void * data)55*4882a593Smuzhiyun static inline int of_dma_controller_register(struct device_node *np,
56*4882a593Smuzhiyun 		struct dma_chan *(*of_dma_xlate)
57*4882a593Smuzhiyun 		(struct of_phandle_args *, struct of_dma *),
58*4882a593Smuzhiyun 		void *data)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	return -ENODEV;
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun 
of_dma_controller_free(struct device_node * np)63*4882a593Smuzhiyun static inline void of_dma_controller_free(struct device_node *np)
64*4882a593Smuzhiyun {
65*4882a593Smuzhiyun }
66*4882a593Smuzhiyun 
of_dma_router_register(struct device_node * np,void * (* of_dma_route_allocate)(struct of_phandle_args *,struct of_dma *),struct dma_router * dma_router)67*4882a593Smuzhiyun static inline int of_dma_router_register(struct device_node *np,
68*4882a593Smuzhiyun 		void *(*of_dma_route_allocate)
69*4882a593Smuzhiyun 		(struct of_phandle_args *, struct of_dma *),
70*4882a593Smuzhiyun 		struct dma_router *dma_router)
71*4882a593Smuzhiyun {
72*4882a593Smuzhiyun 	return -ENODEV;
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun #define of_dma_router_free of_dma_controller_free
76*4882a593Smuzhiyun 
of_dma_request_slave_channel(struct device_node * np,const char * name)77*4882a593Smuzhiyun static inline struct dma_chan *of_dma_request_slave_channel(struct device_node *np,
78*4882a593Smuzhiyun 						     const char *name)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun 	return ERR_PTR(-ENODEV);
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun 
of_dma_simple_xlate(struct of_phandle_args * dma_spec,struct of_dma * ofdma)83*4882a593Smuzhiyun static inline struct dma_chan *of_dma_simple_xlate(struct of_phandle_args *dma_spec,
84*4882a593Smuzhiyun 		struct of_dma *ofdma)
85*4882a593Smuzhiyun {
86*4882a593Smuzhiyun 	return NULL;
87*4882a593Smuzhiyun }
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun #define of_dma_xlate_by_chan_id NULL
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun #endif
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun #endif /* __LINUX_OF_DMA_H */
94