X-Git-Url: http://rtime.felk.cvut.cz/gitweb/can-benchmark.git/blobdiff_plain/597f695d267970a7dd260f938e50efadc4fefa7d..b83118bb4a39f5a8540c1f776e0af0420737afd0:/rtems/gw/libs/load.h

diff --git a/rtems/gw/libs/load.h b/rtems/gw/libs/load.h
index b355c24..1cb6af9 100644
--- a/rtems/gw/libs/load.h
+++ b/rtems/gw/libs/load.h
@@ -1,7 +1,35 @@
+/*
+* Implements simple producer/consumer thread pair to cause load on the CPU.
+* 
+* Used in benchmarking the CAN gateway.
+*
+* Co-opted from http://support.dce.felk.cvut.cz/pos/cv3/src/semaphore.html. 
+*/
 #ifndef __CPU_LOAD_H_
 #define __CPU_LOAD_H_
 
+
+/*
+* This function starts threads loading the CPU and creates associated semaphores. 
+* 
+* Has a guard to prevent starting again, before it was stopped.
+*
+* No error handling currently, only tries to report errors.
+*
+* 0 if successfull, 1 otherwise.
+*/
 int start_thread_load();
+
+/*
+* This function stops threads loading the CPU and destroys associated semaphores. 
+*
+* Has a guard against attempting to stop the threads if they are not running.
+* 
+* No error handling currently, only tries to report errors.
+*
+* 0 if successfull, 1 otherwise.
+*/
 int end_thread_load();
 
-#endif
\ No newline at end of file
+#endif
+