Merge pull request #27 from quic/kernel-samples-dev

Add QRB5165 Kernel-Demo

Author: adpandit

README.md

@@ -83,6 +83,12 @@ Segmentation is to show the effect of object segmentation using Gstreamer comman
 ```
 This app aims to help users to learn how to encode with h264 and decode the video with h264 on the Qualcom platform through this sample app.
 ```
+
+## 15. Kernel-Demo
+```
+The kernel demo uses the kernel API to dynamically load and unload the kernel module to control the LED switch.
+```
+
 ## Getting Started
 * [Quick start guide](https://developer.qualcomm.com/qualcomm-robotics-rb5-kit/quick-start-guide)
 * [Hardware Reference Guide](https://developer.qualcomm.com/qualcomm-robotics-rb5-kit/hardware-reference-guide)

kernel-demo/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2020 Qualcomm Innovation Center, Inc.  All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted
+provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions
+  and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of
+  conditions and the following disclaimer in the documentation and/or other materials
+  provided with the distribution.
+* Neither the name of the copyright holder nor the names of its contributors may be used to
+  endorse or promote products derived from this software without specific prior written
+  permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS
+LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Where there is uncertainty as to how, or
+where, to apply marks, open an OSR to escalate to OSG for review.
+
+SPDX-License-Identifier: BSD-3-Clause-Clear

kernel-demo/Makefile

@@ -0,0 +1,18 @@
+# Copyright (c) 2020 Qualcomm Innovation Center, Inc.  All Rights Reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+KVERS = $(shell uname -r)
+
+# kernel modules
+obj-m := led.o
+
+EXTRA_CFLAGS=-g -O0 -Wno-vla
+
+build: kernel_modules
+
+kernel_modules:
+	make -C /usr/src/header M=$(CURDIR) modules
+
+clean:
+	make -C /usr/src/header M=$(CURDIR) clean

kernel-demo/README.md

@@ -0,0 +1,41 @@
+# Kernel Demo
+# Overview
+The kernel demo uses the kernel API to dynamically load and unload the kernel module to control the LED switch.
+
+## 1.  Init
+### 1.1 Set kernel environment
+```
+$ adb shell
+$ apt-get install bison flex
+```
+### 1.2 Build kernel scripts
+```
+$ cd /usr/src/header
+$ make scripts
+```
+### 1.3 Download source code
+```
+$ cd /data
+$ git clone https://github.com/quic/sample-apps-for-Qualcomm-Robotics-RB5-platform.git
+```
+## 2. Build
+```
+$ cd kernel-demo/
+$ make
+```
+## 3. Run
+
+// Open LED
+```
+$ insmod led.ko
+```
+![image text](image/ledon.png)
+
+// Close LED
+```
+$ rmmod led.ko
+```
+![image text](image/ledoff.png)
+
+## License
+This is licensed under the BSD 3-clause-Clear “New” or “Revised” License. Check out the [LICENSE](LICENSE) for more details.

kernel-demo/image/ledoff.png

@@ -0,0 +1,55 @@
+/* Copyright (c) 2020 Qualcomm Innovation Center, Inc.  All Rights Reserved.
+ *
+ * SPDX-License-Identifier: GPL-2.0-only
+*/
+
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/fs.h>
+#include <linux/uaccess.h>
+
+#define LED_FILE "/sys/class/leds/green/breath"
+
+int LED_Ctrol(char *buff)
+{
+    struct file *fd = NULL;
+    mm_segment_t fs;
+    loff_t pos;
+
+    fd = filp_open(LED_FILE, O_RDWR, 0);
+    if (IS_ERR(fd)) {
+	printk(KERN_ERR "open failed!\n");
+	filp_close(fd, NULL);
+        return -1;
+    }
+
+    fs = get_fs();
+    set_fs(KERNEL_DS);
+    pos = 0;
+    vfs_write(fd, buff, sizeof(buff), &pos);
+    pos = 0;
+
+    filp_close(fd, NULL);
+    set_fs(fs);
+
+    return 0;
+}
+
+static int __init led_init(void)
+{
+    char buff_on[] = {"128"};
+    LED_Ctrol(buff_on);
+    printk(KERN_ALERT "LED ON\n");
+    return 0;
+}
+
+static void __exit led_exit(void)
+{
+    char buff_off[] = {"0"};
+    LED_Ctrol(buff_off);
+    printk(KERN_ALERT "LED OFF\n");
+}
+
+module_init(led_init);
+module_exit(led_exit);
+MODULE_LICENSE("GPL v2");