| 
 | 1 | +// SPDX-License-Identifier: GPL-2.0-only  | 
 | 2 | +/*  | 
 | 3 | + * Sample kfifo int type implementation  | 
 | 4 | + *  | 
 | 5 | + * Copyright (C) 2010 Stefani Seibold <[email protected]>  | 
 | 6 | + */  | 
 | 7 | + | 
 | 8 | +#include <linux/init.h>  | 
 | 9 | +#include <linux/module.h>  | 
 | 10 | +#include <linux/proc_fs.h>  | 
 | 11 | +#include <linux/mutex.h>  | 
 | 12 | +#include <linux/kfifo.h>  | 
 | 13 | + | 
 | 14 | +/*  | 
 | 15 | + * This module shows how to create a int type fifo.  | 
 | 16 | + */  | 
 | 17 | + | 
 | 18 | +/* fifo size in elements (ints) */  | 
 | 19 | +#define FIFO_SIZE	32  | 
 | 20 | + | 
 | 21 | +/* name of the proc entry */  | 
 | 22 | +#define	PROC_FIFO	"int-fifo"  | 
 | 23 | + | 
 | 24 | +/* lock for procfs read access */  | 
 | 25 | +static DEFINE_MUTEX(read_lock);  | 
 | 26 | + | 
 | 27 | +/* lock for procfs write access */  | 
 | 28 | +static DEFINE_MUTEX(write_lock);  | 
 | 29 | + | 
 | 30 | +/*  | 
 | 31 | + * define DYNAMIC in this example for a dynamically allocated fifo.  | 
 | 32 | + *  | 
 | 33 | + * Otherwise the fifo storage will be a part of the fifo structure.  | 
 | 34 | + */  | 
 | 35 | +#if 1  | 
 | 36 | +#define DYNAMIC  | 
 | 37 | +#endif  | 
 | 38 | + | 
 | 39 | +#ifdef DYNAMIC  | 
 | 40 | +static DECLARE_KFIFO_PTR(test, int);  | 
 | 41 | +#else  | 
 | 42 | +static DEFINE_KFIFO(test, int, FIFO_SIZE);  | 
 | 43 | +#endif  | 
 | 44 | + | 
 | 45 | +static const int expected_result[FIFO_SIZE] = {  | 
 | 46 | +	 3,  4,  5,  6,  7,  8,  9,  0,  | 
 | 47 | +	 1, 20, 21, 22, 23, 24, 25, 26,  | 
 | 48 | +	27, 28, 29, 30, 31, 32, 33, 34,  | 
 | 49 | +	35, 36, 37, 38, 39, 40, 41, 42,  | 
 | 50 | +};  | 
 | 51 | + | 
 | 52 | +static int __init testfunc(void)  | 
 | 53 | +{  | 
 | 54 | +	int		buf[6];  | 
 | 55 | +	int		i, j;  | 
 | 56 | +	unsigned int	ret;  | 
 | 57 | + | 
 | 58 | +	printk(KERN_INFO "int fifo test start\n");  | 
 | 59 | + | 
 | 60 | +	/* put values into the fifo */  | 
 | 61 | +	for (i = 0; i != 10; i++)  | 
 | 62 | +		kfifo_put(&test, i);  | 
 | 63 | + | 
 | 64 | +	for (i = 0; i != 10; i++)  | 
 | 65 | +		pr_err("");  | 
 | 66 | + | 
 | 67 | +	/* show the number of used elements */  | 
 | 68 | +	printk(KERN_INFO "fifo len: %u\n", kfifo_len(&test));  | 
 | 69 | + | 
 | 70 | +	/* get max of 2 elements from the fifo */  | 
 | 71 | +	ret = kfifo_out(&test, buf, 2);  | 
 | 72 | +	printk(KERN_INFO "ret: %d\n", ret);  | 
 | 73 | +	/* and put it back to the end of the fifo */  | 
 | 74 | +	ret = kfifo_in(&test, buf, ret);  | 
 | 75 | +	printk(KERN_INFO "ret: %d\n", ret);  | 
 | 76 | + | 
 | 77 | +	/* skip first element of the fifo */  | 
 | 78 | +	printk(KERN_INFO "skip 1st element\n");  | 
 | 79 | +	kfifo_skip(&test);  | 
 | 80 | + | 
 | 81 | +	/* put values into the fifo until is full */  | 
 | 82 | +	for (i = 20; kfifo_put(&test, i); i++)  | 
 | 83 | +		;  | 
 | 84 | + | 
 | 85 | +	printk(KERN_INFO "queue len: %u\n", kfifo_len(&test));  | 
 | 86 | + | 
 | 87 | +	/* show the first value without removing from the fifo */  | 
 | 88 | +	if (kfifo_peek(&test, &i))  | 
 | 89 | +		printk(KERN_INFO "%d\n", i);  | 
 | 90 | + | 
 | 91 | +	/* check the correctness of all values in the fifo */  | 
 | 92 | +	j = 0;  | 
 | 93 | +	while (kfifo_get(&test, &i)) {  | 
 | 94 | +		printk(KERN_INFO "item = %d\n", i);  | 
 | 95 | +		if (i != expected_result[j++]) {  | 
 | 96 | +			printk(KERN_WARNING "value mismatch: test failed\n");  | 
 | 97 | +			return -EIO;  | 
 | 98 | +		}  | 
 | 99 | +	}  | 
 | 100 | +	if (j != ARRAY_SIZE(expected_result)) {  | 
 | 101 | +		printk(KERN_WARNING "size mismatch: test failed\n");  | 
 | 102 | +		return -EIO;  | 
 | 103 | +	}  | 
 | 104 | +	printk(KERN_INFO "test passed\n");  | 
 | 105 | + | 
 | 106 | +	return 0;  | 
 | 107 | +}  | 
 | 108 | + | 
 | 109 | +static ssize_t fifo_write(struct file *file, const char __user *buf,  | 
 | 110 | +						size_t count, loff_t *ppos)  | 
 | 111 | +{  | 
 | 112 | +	int ret;  | 
 | 113 | +	unsigned int copied;  | 
 | 114 | + | 
 | 115 | +	if (mutex_lock_interruptible(&write_lock))  | 
 | 116 | +		return -ERESTARTSYS;  | 
 | 117 | + | 
 | 118 | +	ret = kfifo_from_user(&test, buf, count, &copied);  | 
 | 119 | + | 
 | 120 | +	mutex_unlock(&write_lock);  | 
 | 121 | + | 
 | 122 | +	return ret ? ret : copied;  | 
 | 123 | +}  | 
 | 124 | + | 
 | 125 | +static ssize_t fifo_read(struct file *file, char __user *buf,  | 
 | 126 | +						size_t count, loff_t *ppos)  | 
 | 127 | +{  | 
 | 128 | +	int ret;  | 
 | 129 | +	unsigned int copied;  | 
 | 130 | + | 
 | 131 | +	if (mutex_lock_interruptible(&read_lock))  | 
 | 132 | +		return -ERESTARTSYS;  | 
 | 133 | + | 
 | 134 | +	ret = kfifo_to_user(&test, buf, count, &copied);  | 
 | 135 | + | 
 | 136 | +	mutex_unlock(&read_lock);  | 
 | 137 | + | 
 | 138 | +	return ret ? ret : copied;  | 
 | 139 | +}  | 
 | 140 | + | 
 | 141 | +static const struct proc_ops fifo_proc_ops = {  | 
 | 142 | +	.proc_read	= fifo_read,  | 
 | 143 | +	.proc_write	= fifo_write,  | 
 | 144 | +	.proc_lseek	= noop_llseek,  | 
 | 145 | +};  | 
 | 146 | + | 
 | 147 | +static int __init example_init(void)  | 
 | 148 | +{  | 
 | 149 | +#ifdef DYNAMIC  | 
 | 150 | +	int ret;  | 
 | 151 | + | 
 | 152 | +	ret = kfifo_alloc(&test, FIFO_SIZE, GFP_KERNEL);  | 
 | 153 | +	if (ret) {  | 
 | 154 | +		printk(KERN_ERR "error kfifo_alloc\n");  | 
 | 155 | +		return ret;  | 
 | 156 | +	}  | 
 | 157 | +#endif  | 
 | 158 | +	if (testfunc() < 0) {  | 
 | 159 | +#ifdef DYNAMIC  | 
 | 160 | +		kfifo_free(&test);  | 
 | 161 | +#endif  | 
 | 162 | +		return -EIO;  | 
 | 163 | +	}  | 
 | 164 | + | 
 | 165 | +	if (proc_create(PROC_FIFO, 0, NULL, &fifo_proc_ops) == NULL) {  | 
 | 166 | +#ifdef DYNAMIC  | 
 | 167 | +		kfifo_free(&test);  | 
 | 168 | +#endif  | 
 | 169 | +		return -ENOMEM;  | 
 | 170 | +	}  | 
 | 171 | +	return 0;  | 
 | 172 | +}  | 
 | 173 | + | 
 | 174 | +static void __exit example_exit(void)  | 
 | 175 | +{  | 
 | 176 | +	remove_proc_entry(PROC_FIFO, NULL);  | 
 | 177 | +#ifdef DYNAMIC  | 
 | 178 | +	kfifo_free(&test);  | 
 | 179 | +#endif  | 
 | 180 | +}  | 
 | 181 | + | 
 | 182 | +module_init(example_init);  | 
 | 183 | +module_exit(example_exit);  | 
 | 184 | +MODULE_LICENSE("GPL");  | 
 | 185 | +MODULE_AUTHOR("smalinux");  | 
0 commit comments