cyber: initial releasev42.1337

4 files changed, 201 insertions, 0 deletions

diff --git a/include/cyber.h b/include/cyber.h
new file mode 100644
index 0000000..f5ca28b
--- /dev/null
+++ b/include/cyber.h
@@ -0,0 +1,31 @@
+/*
+ * cyber - Add CYBER to your system
+ * Copyright (C) 2017 Felix Morgner
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef CYBER_H
+#define CYBER_H
+
+/**
+ * The name of the CYBER device
+ */
+#define DEV_NAME "cyber"
+
+/**
+ * The class of the CYBER device
+ */
+#define CLS_NAME "cyber"
+
+#endif
diff --git a/include/cyber_device.h b/include/cyber_device.h
new file mode 100644
index 0000000..1da9e37
--- /dev/null
+++ b/include/cyber_device.h
@@ -0,0 +1,62 @@
+/*
+ * cyber - Add CYBER to your system
+ * Copyright (C) 2017 Felix Morgner
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef CYBER_DEVICE_H
+#define CYBER_DEVICE_H
+
+#include <linux/cdev.h>
+#include <linux/device.h>
+#include <linux/fs.h>
+
+/**
+ * This structure holds information about the CYBER device
+ */
+extern struct cyber_device
+{
+	/**
+	 * The kernel character device structure
+	 */
+	struct cdev character;
+
+	/**
+	 * The kernel device structure
+	 */
+	struct device kernel;
+
+	/**
+	 * The kernel device class structure
+	 */
+	struct class class;
+
+	/**
+	 * The kernel device number
+	 */
+	dev_t number;
+
+} device;
+
+/**
+ * Initialize the CYBER device
+ */
+int cyber_device_init(void);
+
+/**
+ * Deinitialize the CYBER device
+ */
+void cyber_device_shutdown(void);
+
+#endif
diff --git a/include/cyber_file.h b/include/cyber_file.h
new file mode 100644
index 0000000..01ea0c7
--- /dev/null
+++ b/include/cyber_file.h
@@ -0,0 +1,75 @@
+/*
+ * cyber - Add CYBER to your system
+ * Copyright (C) 2017 Felix Morgner
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef CYBER_FILE_H
+#define CYBER_FILE_H
+
+#include <linux/fs.h>
+
+/**
+ * Initialize the CYBER file
+ *
+ * @return zero on success, non-zero otherwise
+ */
+int cyber_file_init(void);
+
+/**
+ * Shutdown the CYBER file
+ */
+void cyber_file_shutdown(void);
+
+/**
+ * Handler for CYBER device open events
+ *
+ * @param inode The kernel inode associated with the CYBER device
+ * @param file The kernel file associated with the CYBER device
+ * @return zero on success, non-zero otherwise
+ */
+int cyber_file_open(struct inode * inode, struct file * file);
+
+/**
+ * Handler for CYBER device read events
+ *
+ * @param file The kernel file associated with the CYBER device
+ * @param buffer The user-space target buffer for all the CYBER
+ * @param size The size of the user-space buffer
+ * @param offset The offset into the CYBER
+ * @return The number of bytes that were read, negative on error
+ */
+ssize_t cyber_file_read(struct file * file, char * buffer, size_t size, loff_t * offset);
+
+/**
+ * Handler for CYBER device write events
+ *
+ * @param file The kernel file associated with the CYBER device
+ * @param buffer The user-space source buffer for all the CYBER
+ * @param size The size of the user-space buffer
+ * @param offset The offset into the CYBER
+ * @param The number of bytes that were written, negative on error
+ */
+ssize_t cyber_file_write(struct file * file, char const * buffer, size_t size, loff_t * offset);
+
+/**
+ * Handler for CYBER device close events
+ *
+ * @param inode The kernel inode associated with the CYBER device
+ * @param file The kernel file associated with the CYBER device
+ * @param zero on success, non-zero otherwise
+ */
+int cyber_file_close(struct inode * inode, struct file * file);
+
+#endif
diff --git a/include/cyber_lifecycle.h b/include/cyber_lifecycle.h
new file mode 100644
index 0000000..ea2f6dd
--- /dev/null
+++ b/include/cyber_lifecycle.h
@@ -0,0 +1,33 @@
+/*
+ * cyber - Add CYBER to your system
+ * Copyright (C) 2017 Felix Morgner
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef CYBER_LIFECYCLE_H
+#define CYBER_LIFECYCLE_H
+
+#include <linux/init.h>
+
+/**
+ * The CYBER driver intialization
+ */
+int __init cyber_driver_init(void);
+
+/**
+ * The CYBER driver deinitialization
+ */
+void __exit cyber_driver_exit(void);
+
+#endif