2 * drivers/misc/goldfish_audio.c
4 * Copyright (C) 2007 Google, Inc.
5 * Copyright (C) 2012 Intel, Inc.
7 * This software is licensed under the terms of the GNU General Public
8 * License version 2, as published by the Free Software Foundation, and
9 * may be copied, distributed, and modified under those terms.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
18 #include <linux/module.h>
19 #include <linux/miscdevice.h>
21 #include <linux/platform_device.h>
22 #include <linux/types.h>
23 #include <linux/pci.h>
24 #include <linux/interrupt.h>
26 #include <linux/sched.h>
27 #include <linux/dma-mapping.h>
28 #include <linux/uaccess.h>
30 MODULE_AUTHOR("Google, Inc.");
31 MODULE_DESCRIPTION("Android QEMU Audio Driver");
32 MODULE_LICENSE("GPL");
33 MODULE_VERSION("1.0");
35 struct goldfish_audio {
36 char __iomem *reg_base;
39 wait_queue_head_t wait;
41 char __iomem *buffer_virt; /* combined buffer virtual address */
42 unsigned long buffer_phys; /* combined buffer physical address */
44 char __iomem *write_buffer1; /* write buffer 1 virtual address */
45 char __iomem *write_buffer2; /* write buffer 2 virtual address */
46 char __iomem *read_buffer; /* read buffer virtual address */
48 int read_supported; /* true if we have audio input support */
52 * We will allocate two read buffers and two write buffers.
53 * Having two read buffers facilitate stereo -> mono conversion.
54 * Having two write buffers facilitate interleaved IO.
56 #define READ_BUFFER_SIZE 16384
57 #define WRITE_BUFFER_SIZE 16384
58 #define COMBINED_BUFFER_SIZE ((2 * READ_BUFFER_SIZE) + \
59 (2 * WRITE_BUFFER_SIZE))
61 #define AUDIO_READ(data, addr) (readl(data->reg_base + addr))
62 #define AUDIO_WRITE(data, addr, x) (writel(x, data->reg_base + addr))
65 * temporary variable used between goldfish_audio_probe() and
66 * goldfish_audio_open()
68 static struct goldfish_audio *audio_data;
71 /* audio status register */
72 AUDIO_INT_STATUS = 0x00,
73 /* set this to enable IRQ */
74 AUDIO_INT_ENABLE = 0x04,
75 /* set these to specify buffer addresses */
76 AUDIO_SET_WRITE_BUFFER_1 = 0x08,
77 AUDIO_SET_WRITE_BUFFER_2 = 0x0C,
78 /* set number of bytes in buffer to write */
79 AUDIO_WRITE_BUFFER_1 = 0x10,
80 AUDIO_WRITE_BUFFER_2 = 0x14,
82 /* true if audio input is supported */
83 AUDIO_READ_SUPPORTED = 0x18,
84 /* buffer to use for audio input */
85 AUDIO_SET_READ_BUFFER = 0x1C,
87 /* driver writes number of bytes to read */
88 AUDIO_START_READ = 0x20,
90 /* number of bytes available in read buffer */
91 AUDIO_READ_BUFFER_AVAILABLE = 0x24,
93 /* AUDIO_INT_STATUS bits */
95 /* this bit set when it is safe to write more bytes to the buffer */
96 AUDIO_INT_WRITE_BUFFER_1_EMPTY = 1U << 0,
97 AUDIO_INT_WRITE_BUFFER_2_EMPTY = 1U << 1,
98 AUDIO_INT_READ_BUFFER_FULL = 1U << 2,
100 AUDIO_INT_MASK = AUDIO_INT_WRITE_BUFFER_1_EMPTY |
101 AUDIO_INT_WRITE_BUFFER_2_EMPTY |
102 AUDIO_INT_READ_BUFFER_FULL,
106 static atomic_t open_count = ATOMIC_INIT(0);
109 static ssize_t goldfish_audio_read(struct file *fp, char __user *buf,
110 size_t count, loff_t *pos)
112 struct goldfish_audio *data = fp->private_data;
116 if (!data->read_supported)
120 length = (count > READ_BUFFER_SIZE ? READ_BUFFER_SIZE : count);
121 AUDIO_WRITE(data, AUDIO_START_READ, length);
123 wait_event_interruptible(data->wait,
124 (data->buffer_status & AUDIO_INT_READ_BUFFER_FULL));
126 length = AUDIO_READ(data,
127 AUDIO_READ_BUFFER_AVAILABLE);
129 /* copy data to user space */
130 if (copy_to_user(buf, data->read_buffer, length))
140 static ssize_t goldfish_audio_write(struct file *fp, const char __user *buf,
141 size_t count, loff_t *pos)
143 struct goldfish_audio *data = fp->private_data;
144 unsigned long irq_flags;
149 ssize_t copy = count;
151 if (copy > WRITE_BUFFER_SIZE)
152 copy = WRITE_BUFFER_SIZE;
153 wait_event_interruptible(data->wait, (data->buffer_status &
154 (AUDIO_INT_WRITE_BUFFER_1_EMPTY |
155 AUDIO_INT_WRITE_BUFFER_2_EMPTY)));
157 if ((data->buffer_status & AUDIO_INT_WRITE_BUFFER_1_EMPTY) != 0)
158 kbuf = data->write_buffer1;
160 kbuf = data->write_buffer2;
162 /* copy from user space to the appropriate buffer */
163 if (copy_from_user(kbuf, buf, copy)) {
168 spin_lock_irqsave(&data->lock, irq_flags);
170 * clear the buffer empty flag, and signal the emulator
171 * to start writing the buffer
173 if (kbuf == data->write_buffer1) {
174 data->buffer_status &= ~AUDIO_INT_WRITE_BUFFER_1_EMPTY;
175 AUDIO_WRITE(data, AUDIO_WRITE_BUFFER_1, copy);
177 data->buffer_status &= ~AUDIO_INT_WRITE_BUFFER_2_EMPTY;
178 AUDIO_WRITE(data, AUDIO_WRITE_BUFFER_2, copy);
180 spin_unlock_irqrestore(&data->lock, irq_flags);
189 static int goldfish_audio_open(struct inode *ip, struct file *fp)
194 if (atomic_inc_return(&open_count) == 1) {
195 fp->private_data = audio_data;
196 audio_data->buffer_status = (AUDIO_INT_WRITE_BUFFER_1_EMPTY |
197 AUDIO_INT_WRITE_BUFFER_2_EMPTY);
198 AUDIO_WRITE(audio_data, AUDIO_INT_ENABLE, AUDIO_INT_MASK);
201 atomic_dec(&open_count);
206 static int goldfish_audio_release(struct inode *ip, struct file *fp)
208 atomic_dec(&open_count);
209 /* FIXME: surely this is wrong for the multi-opened case */
210 AUDIO_WRITE(audio_data, AUDIO_INT_ENABLE, 0);
214 static long goldfish_audio_ioctl(struct file *fp, unsigned int cmd,
217 /* temporary workaround, until we switch to the ALSA API */
224 static irqreturn_t goldfish_audio_interrupt(int irq, void *dev_id)
226 unsigned long irq_flags;
227 struct goldfish_audio *data = dev_id;
230 spin_lock_irqsave(&data->lock, irq_flags);
232 /* read buffer status flags */
233 status = AUDIO_READ(data, AUDIO_INT_STATUS);
234 status &= AUDIO_INT_MASK;
236 * if buffers are newly empty, wake up blocked
237 * goldfish_audio_write() call
240 data->buffer_status = status;
241 wake_up(&data->wait);
244 spin_unlock_irqrestore(&data->lock, irq_flags);
245 return status ? IRQ_HANDLED : IRQ_NONE;
248 /* file operations for /dev/eac */
249 static const struct file_operations goldfish_audio_fops = {
250 .owner = THIS_MODULE,
251 .read = goldfish_audio_read,
252 .write = goldfish_audio_write,
253 .open = goldfish_audio_open,
254 .release = goldfish_audio_release,
255 .unlocked_ioctl = goldfish_audio_ioctl,
258 static struct miscdevice goldfish_audio_device = {
259 .minor = MISC_DYNAMIC_MINOR,
261 .fops = &goldfish_audio_fops,
264 static int goldfish_audio_probe(struct platform_device *pdev)
268 struct goldfish_audio *data;
271 data = kzalloc(sizeof(*data), GFP_KERNEL);
274 goto err_data_alloc_failed;
276 spin_lock_init(&data->lock);
277 init_waitqueue_head(&data->wait);
278 platform_set_drvdata(pdev, data);
280 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
282 dev_err(&pdev->dev, "platform_get_resource failed\n");
286 data->reg_base = ioremap(r->start, PAGE_SIZE);
287 if (data->reg_base == NULL) {
292 data->irq = platform_get_irq(pdev, 0);
294 dev_err(&pdev->dev, "platform_get_irq failed\n");
298 data->buffer_virt = dma_alloc_coherent(&pdev->dev,
299 COMBINED_BUFFER_SIZE, &buf_addr, GFP_KERNEL);
300 if (data->buffer_virt == 0) {
302 dev_err(&pdev->dev, "allocate buffer failed\n");
303 goto err_alloc_write_buffer_failed;
305 data->buffer_phys = buf_addr;
306 data->write_buffer1 = data->buffer_virt;
307 data->write_buffer2 = data->buffer_virt + WRITE_BUFFER_SIZE;
308 data->read_buffer = data->buffer_virt + 2 * WRITE_BUFFER_SIZE;
310 ret = request_irq(data->irq, goldfish_audio_interrupt,
311 IRQF_SHARED, pdev->name, data);
313 dev_err(&pdev->dev, "request_irq failed\n");
314 goto err_request_irq_failed;
317 ret = misc_register(&goldfish_audio_device);
320 "misc_register returned %d in goldfish_audio_init\n",
322 goto err_misc_register_failed;
325 AUDIO_WRITE(data, AUDIO_SET_WRITE_BUFFER_1, buf_addr);
326 AUDIO_WRITE(data, AUDIO_SET_WRITE_BUFFER_2,
327 buf_addr + WRITE_BUFFER_SIZE);
329 data->read_supported = AUDIO_READ(data, AUDIO_READ_SUPPORTED);
330 if (data->read_supported)
331 AUDIO_WRITE(data, AUDIO_SET_READ_BUFFER,
332 buf_addr + 2 * WRITE_BUFFER_SIZE);
337 err_misc_register_failed:
338 free_irq(data->irq, data);
339 err_request_irq_failed:
340 dma_free_coherent(&pdev->dev, COMBINED_BUFFER_SIZE,
341 data->buffer_virt, data->buffer_phys);
342 err_alloc_write_buffer_failed:
344 iounmap(data->reg_base);
347 err_data_alloc_failed:
351 static int goldfish_audio_remove(struct platform_device *pdev)
353 struct goldfish_audio *data = platform_get_drvdata(pdev);
355 misc_deregister(&goldfish_audio_device);
356 free_irq(data->irq, data);
357 dma_free_coherent(&pdev->dev, COMBINED_BUFFER_SIZE,
358 data->buffer_virt, data->buffer_phys);
359 iounmap(data->reg_base);
365 static struct platform_driver goldfish_audio_driver = {
366 .probe = goldfish_audio_probe,
367 .remove = goldfish_audio_remove,
369 .name = "goldfish_audio"
373 module_platform_driver(goldfish_audio_driver);