Changeset 9179d0a in mainline for generic/src/main

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/main

Files:

• kinit.c (modified) (1 diff)
• main.c (modified) (1 diff)
• uinit.c (modified) (1 diff)

generic/src/main/kinit.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        kinit.c
+ * @brief       Kernel initialization thread.
+ *
+ * This file contains kinit kernel thread which carries out
+ * high level system initialization.
+ *
+ * This file is responsible for finishing SMP configuration
+ * and creation of userspace init tasks.
  */
 

generic/src/main/main.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        main.c
+ * @brief       Main initialization kernel function for all processors.
+ *
+ * During kernel boot, all processors, after architecture dependent
+ * initialization, start executing code found in this file. After
+ * bringing up all subsystems, control is passed to scheduler().
+ *
+ * The bootstrap processor starts executing main_bsp() while
+ * the application processors start executing main_ap().
+ *
+ * @see scheduler()
+ * @see main_bsp()
+ * @see main_ap()
  */
 

generic/src/main/uinit.c

@@ -27 +27 @@
  */
 
+/**
+ * @file        uinit.c
+ * @brief       Userspace bootstrap thread.
+ *
+ * This file contains uinit kernel thread wich is used to start every
+ * userspace thread including threads created by SYS_THREAD_CREATE syscall.
+ *
+ * @see SYS_THREAD_CREATE
+ */
+ 
 #include <main/uinit.h>
 #include <arch/types.h>