Updated documentation

This commit is contained in:
adamdunkels 2006-10-09 11:13:25 +00:00
parent 0aa57dcab5
commit 17c32fa33e

View File

@ -4,10 +4,30 @@
*/
/**
* \defgroup elfloader ELF object code loader
* \defgroup elfloader The Contiki ELF loader
*
* The Contiki ELF loader is able to load and relocate ELF object
* files.
* The Contiki ELF loader links, relocates, and loads ELF
* (Executable Linkable Format) object files into a running Contiki
* system.
*
* ELF is a standard format for relocatable object code and executable
* files. ELF is the standard program format for Linux, Solaris, and
* other operating systems.
*
* An ELF file contains either a standalone executable program or a
* program module. The file contains both the program code, the
* program data, as well as information about how to link, relocate,
* and load the program into a running system.
*
* The ELF file is composed of a set of sections. The sections contain
* program code, data, or relocation information, but can also contain
* debugging information.
*
* To link and relocate an ELF file, the Contiki ELF loader first
* parses the ELF file structure to find the appropriate ELF
* sections. It then allocates memory for the program code and data in
* ROM and RAM, respectively. After allocating memory, the Contiki ELF
* loader starts relocating the code found in the ELF file.
*
* @{
*/
@ -50,7 +70,7 @@
*
* This file is part of the Contiki operating system.
*
* @(#)$Id: elfloader-tmp.h,v 1.1 2006/06/17 22:41:18 adamdunkels Exp $
* @(#)$Id: elfloader-tmp.h,v 1.2 2006/10/09 11:13:25 adamdunkels Exp $
*/
#ifndef __ELFLOADER_H__
#define __ELFLOADER_H__
@ -109,7 +129,7 @@ void elfloader_init(void);
/**
* \brief Load and relocate an ELF file.
* \param fd An open file descriptor.
* \param fd An open CFS file descriptor.
* \return ELFLOADER_OK if loading and relocation worked.
* Otherwise an error value.
*