Changeset 7f0837c in mainline


Ignore:
Timestamp:
2006-04-24T12:59:11Z (19 years ago)
Author:
Jakub Jermar <jakub@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
fd8af4b
Parents:
24f3874
Message:

Remove the outdated TODO file.
Improve doxygen comments here and there.

Files:
1 deleted
15 edited

Legend:

Unmodified
Added
Removed

  • genarch/src/mm/page_ht.c

    r24f3874 r7f0837c  
    155155/** Map page to frame using page hash table.
    156156 *
    157  * Map virtual address 'page' to physical address 'frame'
    158  * using 'flags'.
     157 * Map virtual address @page to physical address @frame
     158 * using @flags.
    159159 *
    160160 * The page table must be locked and interrupts must be disabled.
    161161 *
    162  * @param as Address space to which page belongs.
     162 * @param as Address space to which @page belongs.
    163163 * @param page Virtual address of the page to be mapped.
    164164 * @param frame Physical address of memory frame to which the mapping is done.
    … …  
    191191/** Remove mapping of page from page hash table.
    192192 *
    193  * Remove any mapping of 'page' within address space 'as'.
     193 * Remove any mapping of @page within address space @as.
    194194 * TLB shootdown should follow in order to make effects of
    195195 * this call visible.
    … …  
    218218 * The page table must be locked and interrupts must be disabled.
    219219 *
    220  * @param as Address space to wich page belongs.
     220 * @param as Address space to wich @page belongs.
    221221 * @param page Virtual page.
    222222 *

  • genarch/src/mm/page_pt.c

    r24f3874 r7f0837c  
    5050/** Map page to frame using hierarchical page tables.
    5151 *
    52  * Map virtual address 'page' to physical address 'frame'
    53  * using 'flags'.
     52 * Map virtual address @page to physical address @frame
     53 * using @flags.
    5454 *
    5555 * The page table must be locked and interrupts must be disabled.
    … …  
    108108 * The page table must be locked and interrupts must be disabled.
    109109 *
    110  * @param as Address space to wich page belongs.
     110 * @param as Address space to wich @page belongs.
    111111 * @param page Virtual address of the page to be demapped.
    112112 */
    … …  
    228228 * The page table must be locked and interrupts must be disabled.
    229229 *
    230  * @param as Address space to which page belongs.
     230 * @param as Address space to which @page belongs.
    231231 * @param page Virtual page.
    232232 *

  • generic/include/mm/buddy.h

    r24f3874 r7f0837c  
    4242        void (*set_order)(buddy_system_t *, link_t *, __u8);            /**< Set order of block passed as argument. */
    4343        __u8 (*get_order)(buddy_system_t *, link_t *);                  /**< Return order of block passed as argument. */
    44         void (*mark_busy)(buddy_system_t *, link_t *);                  /**< Mark block as busy */
    45         void (*mark_available)(buddy_system_t *, link_t *);             /**< Mark block as busy */
     44        void (*mark_busy)(buddy_system_t *, link_t *);                  /**< Mark block as busy. */
     45        void (*mark_available)(buddy_system_t *, link_t *);             /**< Mark block as available. */
    4646        /** Find parent of block that has given order  */
    4747        link_t *(* find_block)(buddy_system_t *, link_t *, __u8);

  • generic/src/debug/print.c

    r24f3874 r7f0837c  
    8181}
    8282
    83 /** Print one string without appending '\n' to the end
    84  *
    85  * Dont use this function directly - printflock is not locked here
     83/** Print one string without appending '\n' to the end.
     84 *
     85 * Do not use this function directly - printflock is not locked here.
    8686 *
    8787 */
    … …  
    9999}
    100100
    101 /** Print count characters from buffer to output
    102  *
     101/** Print count characters from buffer to output.
     102 *
     103 * @param buffer Address of the buffer with charaters to be printed.
     104 * @param count Number of characters to be printed.
     105 *
     106 * @return Number of characters printed.
    103107 */
    104108static int putnchars(const char *buffer, __native count)
    … …  
    119123/** Print one formatted character
    120124 *
    121  * @param c character to print
     125 * @param c Character to print.
    122126 * @param width
    123127 * @param flags
    124  * @return number of printed characters or EOF
     128 * @return Number of printed characters or EOF.
    125129 */
    126130static int print_char(char c, int width, __u64 flags)
    … …  
    350354}
    351355
    352 /** General formatted text print
    353  *
    354  * Print string formatted according to the fmt parameter
     356/** Print formatted string.
     357 *
     358 * Print string formatted according to the @fmt parameter
    355359 * and variadic arguments. Each formatting directive
    356360 * must have the following form:
    … …  
    362366 * -    Align to left.
    363367 * +    Print positive sign just as negative.
    364  *   (space)    If printed number is positive and '+' flag is not set, print space in place of sign.
    365  * 0    Print 0 as padding instead of spaces. Zeroes are placed between sign and the rest of number.
     368 *   (space)    If the printed number is positive and '+' flag is not set, print space in place of sign.
     369 * 0    Print 0 as padding instead of spaces. Zeroes are placed between sign and the rest of the number.
    366370 *      This flag is ignored if '-' flag is specified.
    367371 *
    … …  
    369373 * Specify minimal width of printed argument. If it is bigger, width is ignored.
    370374 * If width is specified with a '*' character instead of number, width is taken from parameter list.
    371  * Int parameter expected before parameter for processed conversion specification.
     375 * And integer parameter is expected before parameter for processed conversion specification.
    372376 * If this value is negative its absolute value is taken and the '-' flag is set.
    373377 *
    … …  
    391395 * CONVERSIONS:
    392396 *
    393  * %    Print percentage character.
     397 * %    Print percentage character itself.
    394398 *
    395399 * c    Print single character.
    … …  
    398402 *
    399403 * P, p Print value of a pointer. Void * value is expected and it is printed in hexadecimal notation with prefix
    400  * ( as with %#X or %#x for 32bit or %#X / %#x for 64bit long pointers).
     404 * (as with %#X or %#x for 32bit or %#X / %#x for 64bit long pointers).
    401405 *
    402406 * b    Print value as unsigned binary number. Prefix is not printed by default. (Nonstandard extension.)
    … …  
    408412 * u    Print unsigned decimal number.
    409413 *
    410  * X, x Print hexadecimal number with upper- or lower-case. Prefix is not printed by default. 
    411  *
    412  * All other characters from fmt except the formatting directives
     414 * X, x Print hexadecimal number with upper- or lower-case. Prefix is not printed by default.
     415 *
     416 * All other characters from @fmt except the formatting directives
    413417 * are printed in verbatim.
    414418 *
    415419 * @param fmt Formatting NULL terminated string.
    416  * @return count of printed characters or negative value on fail.
     420 * @return Number of printed characters or negative value on failure.
    417421 */
    418422int printf(const char *fmt, ...)

  • generic/src/main/main.c

    r24f3874 r7f0837c  
    9696#define CONFIG_STACK_SIZE       ((1<<STACK_FRAMES)*STACK_SIZE)
    9797
    98 /** Bootstrap CPU main kernel routine
     98/** Main kernel routine for bootstrap CPU.
    9999 *
    100100 * Initializes the kernel by bootstrap CPU.
    … …  
    138138
    139139
    140 /** Bootstrap CPU main kernel routine stack wrapper
     140/** Main kernel routine for bootstrap CPU using new stack.
    141141 *
    142142 * Second part of main_bsp().
    … …  
    225225
    226226#ifdef CONFIG_SMP
    227 /** Application CPUs main kernel routine
     227/** Main kernel routine for application CPUs.
    228228 *
    229229 * Executed by application processors, temporary stack
    … …  
    276276
    277277
    278 /** Application CPUs main kernel routine stack wrapper
     278/** Main kernel routine for application CPUs using new stack.
    279279 *
    280280 * Second part of main_ap().

  • generic/src/mm/buddy.c

    r24f3874 r7f0837c  
    4646 * Allocate memory for and initialize new buddy system.
    4747 *
    48  * @param b Preallocated buddy system control data
     48 * @param b Preallocated buddy system control data.
    4949 * @param max_order The biggest allocable size will be 2^max_order.
    5050 * @param op Operations for new buddy system.

  • generic/src/mm/page.c

    r24f3874 r7f0837c  
    7474/** Insert mapping of page to frame.
    7575 *
    76  * Map virtual address 'page' to physical address 'frame'
    77  * using 'flags'. Allocate and setup any missing page tables.
     76 * Map virtual address @page to physical address @frame
     77 * using @flags. Allocate and setup any missing page tables.
    7878 *
    7979 * The page table must be locked and interrupts must be disabled.
    … …  
    9494/** Remove mapping of page.
    9595 *
    96  * Remove any mapping of 'page' within address space 'as'.
     96 * Remove any mapping of @page within address space @as.
    9797 * TLB shootdown should follow in order to make effects of
    9898 * this call visible.

  • generic/src/proc/scheduler.c

    r24f3874 r7f0837c  
    240240 * When the function decides to relink rq's, it reconnects
    241241 * respective pointers so that in result threads with 'pri'
    242  * greater or equal 'start' are moved to a higher-priority queue.
     242 * greater or equal @start are moved to a higher-priority queue.
    243243 *
    244244 * @param start Threshold priority.

  • generic/src/proc/task.c

    r24f3874 r7f0837c  
    116116 * @param name Program name.
    117117 *
    118  * @return Task of the running program or NULL on error
     118 * @return Task of the running program or NULL on error.
    119119 */
    120120task_t * task_run_program(void *program_addr, char *name)
    … …  
    226226        spinlock_unlock(&tasks_lock);
    227227        interrupts_restore(ipl);
    228        
    229 }
     228}

  • generic/src/synch/condvar.c

    r24f3874 r7f0837c  
    7777 *
    7878 * For exact description of possible combinations of
    79  * 'usec' and 'trywait', see comment for waitq_sleep_timeout().
     79 * @usec and @trywait, see comment for waitq_sleep_timeout().
    8080 *
    8181 * @return See comment for waitq_sleep_timeout().

  • generic/src/synch/futex.c

    r24f3874 r7f0837c  
    9494 * @param uaddr Userspace address of the futex counter.
    9595 * @param usec If non-zero, number of microseconds this thread is willing to sleep.
    96  * @param trydown If usec is zero and trydown is non-zero, conditional operation will be attempted.
     96 * @param trydown If @usec is zero and trydown is non-zero, conditional operation will be attempted.
    9797 *
    9898 * @return One of ESYNCH_TIMEOUT, ESYNCH_OK_ATOMIC and ESYNCH_OK_BLOCKED. See synch.h.
    … …  
    219219/** Compute hash index into futex hash table.
    220220 *
     221 * @param key Address where the @key (i.e. physical address of futex counter) is stored.
     222 *
     223 * @return Index into futex hash table.
     224 */
     225index_t futex_ht_hash(__native *key)
     226{
     227        return *key & (FUTEX_HT_SIZE-1);
     228}
     229
     230/** Compare futex hash table item with a key.
     231 *
    221232 * @param key Address where the key (i.e. physical address of futex counter) is stored.
    222233 *
    223  * @return Index into futex hash table.
    224  */
    225 index_t futex_ht_hash(__native *key)
    226 {
    227         return *key & (FUTEX_HT_SIZE-1);
    228 }
    229 
    230 /** Compare futex hash table item with a key.
    231  *
    232  * @param key Address where the key (i.e. physical address of futex counter) is stored.
    233  *
    234  * @return True if the item matches the key. False otherwise.
     234 * @return True if the item matches the @key. False otherwise.
    235235 */
    236236bool futex_ht_compare(__native *key, count_t keys, link_t *item)

  • generic/src/synch/mutex.c

    r24f3874 r7f0837c  
    5252 *
    5353 * For exact description of possible combinations of
    54  * 'usec' and 'trylock', see comment for waitq_sleep_timeout().
     54 * @usec and @trylock, see comment for waitq_sleep_timeout().
    5555 *
    5656 * @return See comment for waitq_sleep_timeout().

  • generic/src/synch/rwlock.c

    r24f3874 r7f0837c  
    9292 *
    9393 * For exact description of possible combinations of
    94  * 'usec' and 'trylock', see comment for waitq_sleep_timeout().
     94 * @usec and @trylock, see comment for waitq_sleep_timeout().
    9595 *
    9696 * @return See comment for waitq_sleep_timeout().
    … …  
    146146 *
    147147 * For exact description of possible combinations of
    148  * 'usec' and 'trylock', see comment for waitq_sleep_timeout().
     148 * @usec and @trylock, see comment for waitq_sleep_timeout().
    149149 *
    150150 * @return See comment for waitq_sleep_timeout().

  • generic/src/synch/semaphore.c

    r24f3874 r7f0837c  
    6666 *
    6767 * For exact description of possible combinations of
    68  * 'usec' and 'trydown', see comment for waitq_sleep_timeout().
     68 * @usec and @trydown, see comment for waitq_sleep_timeout().
    6969 *
    7070 * @return See comment for waitq_sleep_timeout().

  • generic/src/synch/waitq.c

    r24f3874 r7f0837c  
    161161 * @param nonblocking Blocking vs. non-blocking operation mode switch.
    162162 *
    163  * If usec is greater than zero, regardless of the value of nonblocking,
     163 * If @usec is greater than zero, regardless of the value of @nonblocking,
    164164 * the call will not return until either timeout or wakeup comes.
    165165 *
    166  * If usec is zero and nonblocking is zero (false), the call
     166 * If @usec is zero and @nonblocking is zero (false), the call
    167167 * will not return until wakeup comes.
    168168 *
    169  * If usec is zero and nonblocking is non-zero (true), the call will
     169 * If @usec is zero and @nonblocking is non-zero (true), the call will
    170170 * immediately return, reporting either success or failure.
    171171 *
Note: See TracChangeset for help on using the changeset viewer.