initial files

Author: tank0nf

README.md

@@ -0,0 +1,38 @@
+Steps to run:
+1. gcc -shared -o libdummy_ectool.so -fPIC dummy_ectool.c
+2. python3 fw-fanctrl.py
+
+# Explanation of Files
+## fw-fanctrl.py
+This is the Python main script that works with the dummy_ectool library. It does the following:
+1. Declares functions to read and write the fan speed.
+2. Declares a function to read the fan status.
+3. Contains an example usage block that shows how to call the functions.
+
+## dummy_ectool.py
+This Python script is a wrapper of the libdummy_ectool.so shared library. It:
+1. Loads the shared library using the ctypes module.
+2. Specifies the C function signatures (i.e., argument types and return types).
+3. Offers Python functions that invoke the respective C functions.
+
+## dummy_ectool.c
+This is a C source file that performs the fan control logic. It:
+1. Declares functions to obtain and set the fan speed.
+2. Declares a function to retrieve the fan status.
+3. Utilizes a global variable to emulate the fan speed.
+
+# How the Program Works
+The dummy_ectool.c source file is compiled into a shared library (libdummy_ectool.so) with the gcc compiler. The flags:
+
+-shared: Instructs the compiler to produce a shared library.
+-fPIC: Produces position-independent code, which is necessary for shared libraries.
+
+The dummy_ectool.py script imports the shared library with ctypes.CDLL() and declares the function signatures for the C functions. It also declares argument types and return types.
+
+The fw-fanctrl.py command loads the dummy_ectool module, through which the access to the C functions is allowed. The program then:
+
+Displays the fan status and current speed.
+Sets the fan speed to 3000 RPM and displays the new fan status and speed.
+Tries to set the fan speed to 6000 RPM, causing an error due to the correct range being 0-5000 RPM. This checks for the error handling.
+
+THIS IS ONLY A PROOF OF CONCEPT FOR GSOC AND LARGE SCALE IMPLEMENTATION WILL FOLLOW THROUGH.

dummy_ectool.c

@@ -0,0 +1,37 @@
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdio.h>
+#include <stdlib.h>
+
+// Global variable to simulate fan speed
+static int fan_speed = 2500;
+
+// Function to get the current fan speed
+int get_fan_speed() {
+    return fan_speed;
+}
+
+// Function to set the fan speed (for simulation purposes)
+int set_fan_speed(int speed) {
+    if (speed < 0 || speed > 5000) {
+        fprintf(stderr, "Error: Invalid fan speed. Must be between 0 and 5000.\n");
+        return -1; // Return error code
+    }
+    fan_speed = speed;
+    printf("Fan speed set to: %d\n", fan_speed);
+    return 0; // Success
+}
+
+// Function to check the fan status (running or idle)
+const char* get_fan_status() {
+    if (fan_speed == 0) {
+        return "Idle";
+    }
+    return "Running";
+}
+
+#ifdef __cplusplus
+}
+#endif

dummy_ectool.py

@@ -0,0 +1,24 @@
+import ctypes
+import os
+
+# Explicitly set the absolute path if needed
+lib_path = os.path.abspath("./libdummy_ectool.so")
+lib = ctypes.CDLL(lib_path)
+
+# Define the return types and argument types for the C functions
+lib.get_fan_speed.restype = ctypes.c_int
+lib.set_fan_speed.argtypes = [ctypes.c_int]
+lib.set_fan_speed.restype = ctypes.c_int
+lib.get_fan_status.restype = ctypes.c_char_p
+
+def get_fan_speed():
+    return lib.get_fan_speed()
+
+def set_fan_speed(speed):
+    result = lib.set_fan_speed(speed)
+    if result == -1:
+        raise ValueError("Invalid fan speed. Must be between 0 and 5000.")
+    return result
+
+def get_fan_status():
+    return lib.get_fan_status().decode('utf-8')

fw-fanctrl.py

@@ -0,0 +1,31 @@
+import dummy_ectool
+
+# Function to get the current fan speed
+def get_fan_speed():
+    return dummy_ectool.get_fan_speed()
+
+# Function to set the fan speed
+def set_fan_speed(speed):
+    try:
+        dummy_ectool.set_fan_speed(speed)
+        print(f"Fan speed successfully set to {speed} RPM.")
+    except ValueError as e:
+        print("Error:", e)
+
+# Function to get the fan status
+def get_fan_status():
+    return dummy_ectool.get_fan_status()
+
+# Example usage
+if __name__ == "__main__":
+    # Display current status
+    print("Current Fan Speed:", get_fan_speed())
+    print("Fan Status:", get_fan_status())
+
+    # Set a new fan speed and check status
+    set_fan_speed(3000)
+    print("Updated Fan Speed:", get_fan_speed())
+    print("Fan Status:", get_fan_status())
+
+    # Try setting an invalid speed
+    set_fan_speed(6000)  # This should trigger an error