1 From 47c1d1988df17bf39bbf3a188d78792eaa693068 Mon Sep 17 00:00:00 2001
2 From: popcornmix <popcornmix@gmail.com>
3 Date: Fri, 28 Oct 2016 15:36:43 +0100
4 Subject: [PATCH] vc_mem: Add vc_mem driver for querying firmware
7 Content-Type: text/plain; charset=UTF-8
8 Content-Transfer-Encoding: 8bit
10 Signed-off-by: popcornmix <popcornmix@gmail.com>
14 Make the vc_mem module available for ARCH_BCM2835 by moving it.
16 Signed-off-by: Noralf Trønnes <noralf@tronnes.org>
18 char: vc_mem: Fix up compat ioctls for 64bit kernel
20 compat_ioctl wasn't defined, so 32bit user/64bit kernel
22 VC_MEM_IOC_MEM_PHYS_ADDR was defined with parameter size
23 unsigned long, so the ioctl cmd changes between sizes.
25 Signed-off-by: Dave Stevenson <dave.stevenson@raspberrypi.org>
27 char: vc_mem: Fix all coding style issues.
29 Cleans up all checkpatch errors in vc_mem.c and vc_mem.h
30 No functional change to the code.
32 Signed-off-by: Dave Stevenson <dave.stevenson@raspberrypi.org>
34 char: vc_mem: Delete dead code
36 There are no error exists once device_create has succeeded, and
37 therefore no need to call device_destroy from vc_mem_init.
39 Signed-off-by: Phil Elwell <phil@raspberrypi.com>
41 drivers/char/broadcom/Kconfig | 18 ++
42 drivers/char/broadcom/Makefile | 1 +
43 drivers/char/broadcom/vc_mem.c | 373 ++++++++++++++++++++++++++++++++
44 include/linux/broadcom/vc_mem.h | 39 ++++
45 4 files changed, 431 insertions(+)
46 create mode 100644 drivers/char/broadcom/Kconfig
47 create mode 100644 drivers/char/broadcom/Makefile
48 create mode 100644 drivers/char/broadcom/vc_mem.c
49 create mode 100644 include/linux/broadcom/vc_mem.h
52 +++ b/drivers/char/broadcom/Kconfig
55 +# Broadcom char driver config
58 +menuconfig BRCM_CHAR_DRIVERS
59 + bool "Broadcom Char Drivers"
61 + Broadcom's char drivers
66 + bool "Videocore Memory"
69 + Helper for videocore memory access and total size allocation.
73 +++ b/drivers/char/broadcom/Makefile
75 +obj-$(CONFIG_BCM2708_VCMEM) += vc_mem.o
77 +++ b/drivers/char/broadcom/vc_mem.c
80 + * Copyright 2010 - 2011 Broadcom Corporation. All rights reserved.
82 + * Unless you and Broadcom execute a separate written software license
83 + * agreement governing use of this software, this software is licensed to you
84 + * under the terms of the GNU General Public License version 2, available at
85 + * http://www.broadcom.com/licenses/GPLv2.php (the "GPL").
87 + * Notwithstanding the above, under no circumstances may you combine this
88 + * software in any way with any other Broadcom software provided under a
89 + * license other than the GPL, without Broadcom's express prior written
93 +#include <linux/kernel.h>
94 +#include <linux/module.h>
95 +#include <linux/fs.h>
96 +#include <linux/device.h>
97 +#include <linux/cdev.h>
98 +#include <linux/mm.h>
99 +#include <linux/slab.h>
100 +#include <linux/debugfs.h>
101 +#include <linux/uaccess.h>
102 +#include <linux/dma-mapping.h>
103 +#include <linux/broadcom/vc_mem.h>
105 +#define DRIVER_NAME "vc-mem"
107 +/* Device (/dev) related variables */
108 +static dev_t vc_mem_devnum;
109 +static struct class *vc_mem_class;
110 +static struct cdev vc_mem_cdev;
111 +static int vc_mem_inited;
113 +#ifdef CONFIG_DEBUG_FS
114 +static struct dentry *vc_mem_debugfs_entry;
118 + * Videocore memory addresses and size
120 + * Drivers that wish to know the videocore memory addresses and sizes should
121 + * use these variables instead of the MM_IO_BASE and MM_ADDR_IO defines in
122 + * headers. This allows the other drivers to not be tied down to a a certain
123 + * address/size at compile time.
125 + * In the future, the goal is to have the videocore memory virtual address and
126 + * size be calculated at boot time rather than at compile time. The decision of
127 + * where the videocore memory resides and its size would be in the hands of the
128 + * bootloader (and/or kernel). When that happens, the values of these variables
129 + * would be calculated and assigned in the init function.
131 +/* In the 2835 VC in mapped above ARM, but ARM has full access to VC space */
132 +unsigned long mm_vc_mem_phys_addr;
133 +EXPORT_SYMBOL(mm_vc_mem_phys_addr);
134 +unsigned int mm_vc_mem_size;
135 +EXPORT_SYMBOL(mm_vc_mem_size);
136 +unsigned int mm_vc_mem_base;
137 +EXPORT_SYMBOL(mm_vc_mem_base);
139 +static uint phys_addr;
140 +static uint mem_size;
141 +static uint mem_base;
144 +vc_mem_open(struct inode *inode, struct file *file)
148 + pr_debug("%s: called file = 0x%p\n", __func__, file);
154 +vc_mem_release(struct inode *inode, struct file *file)
158 + pr_debug("%s: called file = 0x%p\n", __func__, file);
164 +vc_mem_get_size(void)
169 +vc_mem_get_base(void)
174 +vc_mem_get_current_size(void)
176 + return mm_vc_mem_size;
178 +EXPORT_SYMBOL_GPL(vc_mem_get_current_size);
181 +vc_mem_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
188 + pr_debug("%s: called file = 0x%p, cmd %08x\n", __func__, file, cmd);
191 + case VC_MEM_IOC_MEM_PHYS_ADDR:
193 + pr_debug("%s: VC_MEM_IOC_MEM_PHYS_ADDR=0x%p\n",
194 + __func__, (void *)mm_vc_mem_phys_addr);
196 + if (copy_to_user((void *)arg, &mm_vc_mem_phys_addr,
197 + sizeof(mm_vc_mem_phys_addr))) {
202 + case VC_MEM_IOC_MEM_SIZE:
204 + /* Get the videocore memory size first */
207 + pr_debug("%s: VC_MEM_IOC_MEM_SIZE=%x\n", __func__,
210 + if (copy_to_user((void *)arg, &mm_vc_mem_size,
211 + sizeof(mm_vc_mem_size))) {
216 + case VC_MEM_IOC_MEM_BASE:
218 + /* Get the videocore memory base */
221 + pr_debug("%s: VC_MEM_IOC_MEM_BASE=%x\n", __func__,
224 + if (copy_to_user((void *)arg, &mm_vc_mem_base,
225 + sizeof(mm_vc_mem_base))) {
230 + case VC_MEM_IOC_MEM_LOAD:
232 + /* Get the videocore memory base */
235 + pr_debug("%s: VC_MEM_IOC_MEM_LOAD=%x\n", __func__,
238 + if (copy_to_user((void *)arg, &mm_vc_mem_base,
239 + sizeof(mm_vc_mem_base))) {
249 + pr_debug("%s: file = 0x%p returning %d\n", __func__, file, rc);
254 +#ifdef CONFIG_COMPAT
256 +vc_mem_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
261 + case VC_MEM_IOC_MEM_PHYS_ADDR32:
262 + pr_debug("%s: VC_MEM_IOC_MEM_PHYS_ADDR32=0x%p\n",
263 + __func__, (void *)mm_vc_mem_phys_addr);
265 + /* This isn't correct, but will cover us for now as
266 + * VideoCore is 32bit only.
268 + if (copy_to_user((void *)arg, &mm_vc_mem_phys_addr,
269 + sizeof(compat_ulong_t)))
275 + rc = vc_mem_ioctl(file, cmd, arg);
284 +vc_mem_mmap(struct file *filp, struct vm_area_struct *vma)
287 + unsigned long length = vma->vm_end - vma->vm_start;
288 + unsigned long offset = vma->vm_pgoff << PAGE_SHIFT;
290 + pr_debug("%s: vm_start = 0x%08lx vm_end = 0x%08lx vm_pgoff = 0x%08lx\n",
291 + __func__, (long)vma->vm_start, (long)vma->vm_end,
292 + (long)vma->vm_pgoff);
294 + if (offset + length > mm_vc_mem_size) {
295 + pr_err("%s: length %ld is too big\n", __func__, length);
298 + /* Do not cache the memory map */
299 + vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
301 + rc = remap_pfn_range(vma, vma->vm_start,
302 + (mm_vc_mem_phys_addr >> PAGE_SHIFT) +
303 + vma->vm_pgoff, length, vma->vm_page_prot);
305 + pr_err("%s: remap_pfn_range failed (rc=%d)\n", __func__, rc);
310 +/* File Operations for the driver. */
311 +static const struct file_operations vc_mem_fops = {
312 + .owner = THIS_MODULE,
313 + .open = vc_mem_open,
314 + .release = vc_mem_release,
315 + .unlocked_ioctl = vc_mem_ioctl,
316 +#ifdef CONFIG_COMPAT
317 + .compat_ioctl = vc_mem_compat_ioctl,
319 + .mmap = vc_mem_mmap,
322 +#ifdef CONFIG_DEBUG_FS
323 +static void vc_mem_debugfs_deinit(void)
325 + debugfs_remove_recursive(vc_mem_debugfs_entry);
326 + vc_mem_debugfs_entry = NULL;
330 +static int vc_mem_debugfs_init(
331 + struct device *dev)
333 + vc_mem_debugfs_entry = debugfs_create_dir(DRIVER_NAME, NULL);
334 + if (!vc_mem_debugfs_entry) {
335 + dev_warn(dev, "could not create debugfs entry\n");
339 + debugfs_create_x32("vc_mem_phys_addr",
341 + vc_mem_debugfs_entry,
342 + (u32 *)&mm_vc_mem_phys_addr);
343 + debugfs_create_x32("vc_mem_size",
345 + vc_mem_debugfs_entry,
346 + (u32 *)&mm_vc_mem_size);
347 + debugfs_create_x32("vc_mem_base",
349 + vc_mem_debugfs_entry,
350 + (u32 *)&mm_vc_mem_base);
355 +#endif /* CONFIG_DEBUG_FS */
357 +/* Module load/unload functions */
363 + struct device *dev;
365 + pr_debug("%s: called\n", __func__);
367 + mm_vc_mem_phys_addr = phys_addr;
368 + mm_vc_mem_size = mem_size;
369 + mm_vc_mem_base = mem_base;
373 + pr_info("vc-mem: phys_addr:0x%08lx mem_base=0x%08x mem_size:0x%08x(%u MiB)\n",
374 + mm_vc_mem_phys_addr, mm_vc_mem_base, mm_vc_mem_size,
375 + mm_vc_mem_size / (1024 * 1024));
377 + rc = alloc_chrdev_region(&vc_mem_devnum, 0, 1, DRIVER_NAME);
379 + pr_err("%s: alloc_chrdev_region failed (rc=%d)\n",
384 + cdev_init(&vc_mem_cdev, &vc_mem_fops);
385 + rc = cdev_add(&vc_mem_cdev, vc_mem_devnum, 1);
387 + pr_err("%s: cdev_add failed (rc=%d)\n", __func__, rc);
388 + goto out_unregister;
391 + vc_mem_class = class_create(THIS_MODULE, DRIVER_NAME);
392 + if (IS_ERR(vc_mem_class)) {
393 + rc = PTR_ERR(vc_mem_class);
394 + pr_err("%s: class_create failed (rc=%d)\n", __func__, rc);
398 + dev = device_create(vc_mem_class, NULL, vc_mem_devnum, NULL,
402 + pr_err("%s: device_create failed (rc=%d)\n", __func__, rc);
403 + goto out_class_destroy;
406 +#ifdef CONFIG_DEBUG_FS
407 + /* don't fail if the debug entries cannot be created */
408 + vc_mem_debugfs_init(dev);
415 + class_destroy(vc_mem_class);
416 + vc_mem_class = NULL;
419 + cdev_del(&vc_mem_cdev);
422 + unregister_chrdev_region(vc_mem_devnum, 1);
431 + pr_debug("%s: called\n", __func__);
433 + if (vc_mem_inited) {
435 + vc_mem_debugfs_deinit();
437 + device_destroy(vc_mem_class, vc_mem_devnum);
438 + class_destroy(vc_mem_class);
439 + cdev_del(&vc_mem_cdev);
440 + unregister_chrdev_region(vc_mem_devnum, 1);
444 +module_init(vc_mem_init);
445 +module_exit(vc_mem_exit);
446 +MODULE_LICENSE("GPL");
447 +MODULE_AUTHOR("Broadcom Corporation");
449 +module_param(phys_addr, uint, 0644);
450 +module_param(mem_size, uint, 0644);
451 +module_param(mem_base, uint, 0644);
453 +++ b/include/linux/broadcom/vc_mem.h
456 + * Copyright 2010 - 2011 Broadcom Corporation. All rights reserved.
458 + * Unless you and Broadcom execute a separate written software license
459 + * agreement governing use of this software, this software is licensed to you
460 + * under the terms of the GNU General Public License version 2, available at
461 + * http://www.broadcom.com/licenses/GPLv2.php (the "GPL").
463 + * Notwithstanding the above, under no circumstances may you combine this
464 + * software in any way with any other Broadcom software provided under a
465 + * license other than the GPL, without Broadcom's express prior written
472 +#include <linux/ioctl.h>
474 +#define VC_MEM_IOC_MAGIC 'v'
476 +#define VC_MEM_IOC_MEM_PHYS_ADDR _IOR(VC_MEM_IOC_MAGIC, 0, unsigned long)
477 +#define VC_MEM_IOC_MEM_SIZE _IOR(VC_MEM_IOC_MAGIC, 1, unsigned int)
478 +#define VC_MEM_IOC_MEM_BASE _IOR(VC_MEM_IOC_MAGIC, 2, unsigned int)
479 +#define VC_MEM_IOC_MEM_LOAD _IOR(VC_MEM_IOC_MAGIC, 3, unsigned int)
482 +#define VC_MEM_TO_ARM_ADDR_MASK 0x3FFFFFFF
484 +extern unsigned long mm_vc_mem_phys_addr;
485 +extern unsigned int mm_vc_mem_size;
486 +extern int vc_mem_get_current_size(void);
489 +#ifdef CONFIG_COMPAT
490 +#define VC_MEM_IOC_MEM_PHYS_ADDR32 _IOR(VC_MEM_IOC_MAGIC, 0, compat_ulong_t)
493 +#endif /* _VC_MEM_H */