Changeset 70527f1 in mainline for src/proc/thread.c

Timestamp:

2005-06-03T14:51:05Z (20 years ago)

Author:

Martin Decky <martin@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

673104e

Parents:

ac5d02b

Message:

doxygen-style comments
cleanups

File:

• src/proc/thread.c (modified) (9 diffs)

src/proc/thread.c

@@ -51 +51 @@
 #include <arch/faddr.h>
 
-char *thread_states[] = {"Invalid", "Running", "Sleeping", "Ready", "Entering", "Exiting"};
+char *thread_states[] = {"Invalid", "Running", "Sleeping", "Ready", "Entering", "Exiting"}; /**< Thread states */
 
 spinlock_t threads_lock;
@@ -59 +59 @@
 __u32 last_tid = 0;
 
-/*
- * cushion() is provided to ensure that every thread
+
+/** Thread wrapper
+ *
+ * This wrapper is provided to ensure that every thread
  * makes a call to thread_exit() when its implementing
  * function returns.
  *
- * cpu_priority_high()'d
+ * cpu_priority_high() is assumed.
+ *
  */
 void cushion(void)
@@ -82 +85 @@
 }
 
+
+/** Initialize threads
+ *
+ * Initialize kernel threads support.
+ *
+ */
 void thread_init(void)
 {
@@ -90 +99 @@
 }
 
+
+/** Make thread ready
+ *
+ * Switch thread t to the ready state.
+ *
+ * @param t Thread to make ready.
+ *
+ */
 void thread_ready(thread_t *t)
 {
@@ -109 +126 @@
         spinlock_unlock(&t->lock);
         
-        /*
+        /*
          * Append t to respective ready queue on respective processor.
          */
@@ -134 +151 @@
 }
 
+
+/** Create new thread
+ *
+ * Create a new thread.
+ *
+ * @param func  Thread's implementing function.
+ * @param arg   Thread's implementing function argument.
+ * @param task  Task to which the thread belongs.
+ * @param flags Thread flags.
+ *
+ * @return New thread's structure on success, NULL on failure.
+ *
+ */
 thread_t *thread_create(void (* func)(void *), void *arg, task_t *task, int flags)
 {
@@ -214 +244 @@
 }
 
+
+/** Make thread exiting
+ *
+ * End current thread execution and switch it to the exiting
+ * state. All pending timeouts are executed.
+ *
+ */
 void thread_exit(void)
 {
@@ -231 +268 @@
 }
 
+
+/** Thread sleep
+ *
+ * Suspend execution of the current thread.
+ *
+ * @param sec Number of seconds to sleep.
+ *
+ */
 void thread_sleep(__u32 sec)
 {
         thread_usleep(sec*1000000);
 }
-        
-/*
- * Suspend execution of current thread for usec microseconds.
- */
+
+
+/** Thread usleep
+ *
+ * Suspend execution of the current thread.
+ *
+ * @param usec Number of microseconds to sleep.
+ *
+ */     
 void thread_usleep(__u32 usec)
 {
@@ -248 +298 @@
 }
 
+
+/** Register thread out-of-context invocation
+ *
+ * Register a function and its argument to be executed
+ * on next context switch to the current thread.
+ *
+ * @param call_me      Out-of-context function.
+ * @param call_me_with Out-of-context function argument.
+ *
+ */
 void thread_register_call_me(void (* call_me)(void *), void *call_me_with)
 {