1 /* SPDX-License-Identifier: GPL-2.0
2 *
3 * include/asm-sh/dma.h
4 *
5 * Copyright (C) 2003, 2004 Paul Mundt
6 */
7 #ifndef __ASM_SH_DMA_H
8 #define __ASM_SH_DMA_H
9
10 #include <linux/spinlock.h>
11 #include <linux/wait.h>
12 #include <linux/sched.h>
13 #include <linux/device.h>
14 #include <asm-generic/dma.h>
15
16 /*
17 * Read and write modes can mean drastically different things depending on the
18 * channel configuration. Consult your DMAC documentation and module
19 * implementation for further clues.
20 */
21 #define DMA_MODE_READ 0x00
22 #define DMA_MODE_WRITE 0x01
23 #define DMA_MODE_MASK 0x01
24
25 #define DMA_AUTOINIT 0x10
26
27 /*
28 * DMAC (dma_info) flags
29 */
30 enum {
31 DMAC_CHANNELS_CONFIGURED = 0x01,
32 DMAC_CHANNELS_TEI_CAPABLE = 0x02, /* Transfer end interrupt */
33 };
34
35 /*
36 * DMA channel capabilities / flags
37 */
38 enum {
39 DMA_CONFIGURED = 0x01,
40
41 /*
42 * Transfer end interrupt, inherited from DMAC.
43 * wait_queue used in dma_wait_for_completion.
44 */
45 DMA_TEI_CAPABLE = 0x02,
46 };
47
48 extern spinlock_t dma_spin_lock;
49
50 struct dma_channel;
51
52 struct dma_ops {
53 int (*request)(struct dma_channel *chan);
54 void (*free)(struct dma_channel *chan);
55
56 int (*get_residue)(struct dma_channel *chan);
57 int (*xfer)(struct dma_channel *chan);
58 int (*configure)(struct dma_channel *chan, unsigned long flags);
59 };
60
61 struct dma_channel {
62 char dev_id[16]; /* unique name per DMAC of channel */
63
64 unsigned int chan; /* DMAC channel number */
65 unsigned int vchan; /* Virtual channel number */
66
67 unsigned int mode;
68 unsigned int count;
69
70 unsigned long sar;
71 unsigned long dar;
72
73 const char **caps;
74
75 unsigned long flags;
76 atomic_t busy;
77
78 wait_queue_head_t wait_queue;
79
80 struct device dev;
81 void *priv_data;
82 };
83
84 struct dma_info {
85 struct platform_device *pdev;
86
87 const char *name;
88 unsigned int nr_channels;
89 unsigned long flags;
90
91 struct dma_ops *ops;
92 struct dma_channel *channels;
93
94 struct list_head list;
95 int first_channel_nr;
96 int first_vchannel_nr;
97 };
98
99 struct dma_chan_caps {
100 int ch_num;
101 const char **caplist;
102 };
103
104 #define to_dma_channel(channel) container_of(channel, struct dma_channel, dev)
105
106 /* arch/sh/drivers/dma/dma-api.c */
107 extern int dma_xfer(unsigned int chan, unsigned long from,
108 unsigned long to, size_t size, unsigned int mode);
109
110 #define dma_write(chan, from, to, size) \
111 dma_xfer(chan, from, to, size, DMA_MODE_WRITE)
112 #define dma_write_page(chan, from, to) \
113 dma_write(chan, from, to, PAGE_SIZE)
114
115 #define dma_read(chan, from, to, size) \
116 dma_xfer(chan, from, to, size, DMA_MODE_READ)
117 #define dma_read_page(chan, from, to) \
118 dma_read(chan, from, to, PAGE_SIZE)
119
120 extern int get_dma_residue(unsigned int chan);
121 extern struct dma_info *get_dma_info(unsigned int chan);
122 extern struct dma_channel *get_dma_channel(unsigned int chan);
123 extern void dma_wait_for_completion(unsigned int chan);
124 extern void dma_configure_channel(unsigned int chan, unsigned long flags);
125
126 extern int register_dmac(struct dma_info *info);
127 extern void unregister_dmac(struct dma_info *info);
128
129 /* arch/sh/drivers/dma/dma-sysfs.c */
130 extern int dma_create_sysfs_files(struct dma_channel *, struct dma_info *);
131 extern void dma_remove_sysfs_files(struct dma_channel *, struct dma_info *);
132
133 #endif /* __ASM_SH_DMA_H */
134
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.