Changeset 9179d0a in mainline for generic/src/proc

Timestamp:

2006-04-27T17:13:49Z (20 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

040e4e9

Parents:

eaa202a

Message:

Add some @file doxygen comments and improve already existing comments.

Location:

generic/src/proc

Files:

• scheduler.c (modified) (1 diff)
• task.c (modified) (3 diffs)
• the.c (modified) (1 diff)
• thread.c (modified) (1 diff)

generic/src/proc/scheduler.c

@@ -25 +25 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file        scheduler.c
+ * @brief       Scheduler and load balancing.
+ *
+ * This file contains the scheduler and kcpulb kernel thread wich
+ * performs load-balancing of per-CPU run queues.
  */
 

generic/src/proc/task.c

@@ -25 +25 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file        task.c
+ * @brief       Task management.
  */
 
@@ -116 +121 @@
 /** Create new task with 1 thread and run it
  *
- * @param programe_addr Address of program executable image.
+ * @param program_addr Address of program executable image.
  * @param name Program name. 
  *
@@ -164 +169 @@
 /** Syscall for reading task ID from userspace.
  *
- * @param uaddr Userspace address of 8-byte buffer where to store current task ID.
+ * @param uspace_task_id Userspace address of 8-byte buffer where to store current task ID.
  *
  * @return Always returns 0.

generic/src/proc/the.c

@@ -25 +25 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file        the.c
+ * @brief       THE structure functions.
+ *
+ * This file contains functions to manage the THE structure.
+ * The THE structure exists at the base address of every kernel
+ * stack and carries information about current settings
+ * (e.g. current CPU, current thread, task and address space
+ * and current preemption counter).
  */
 

generic/src/proc/thread.c

@@ -25 +25 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file        thread.c
+ * @brief       Thread management functions.
  */