Ignore:
Timestamp:
Jan 16, 2006, 3:12:12 PM (14 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, 5, master
Children:
5961b4c7
Parents:
5464eefa
Message:

2006-01-16 Joel Sherrill <joel@…>

  • rtems/asm.h, rtems/score/cpu.h, rtems/score/types.h: Part of a large patch to improve Doxygen output. As a side-effect, grammar and spelling errors were corrected, spacing errors were address, and some variable names were improved.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/score/cpu/no_cpu/rtems/asm.h

    r5464eefa r22b3bed  
    2020 *  of the file is noted.  This file is:
    2121 *
    22  *  COPYRIGHT (c) 1994-1997.
     22 *  COPYRIGHT (c) 1994-2006.
    2323 *  On-Line Applications Research Corporation (OAR).
    2424 *
     
    3939#include <rtems/score/no_cpu.h>
    4040
    41 /*
     41#ifndef __USER_LABEL_PREFIX__
     42/**
    4243 *  Recent versions of GNU cpp define variables which indicate the
    4344 *  need for underscores and percents.  If not using GNU cpp or
    4445 *  the version does not support this, then you will obviously
    4546 *  have to define these as appropriate.
     47 *
     48 *  This symbol is prefixed to all C program symbols.
    4649 */
    47 
    48 #ifndef __USER_LABEL_PREFIX__
    4950#define __USER_LABEL_PREFIX__ _
    5051#endif
    5152
    5253#ifndef __REGISTER_PREFIX__
     54/**
     55 *  Recent versions of GNU cpp define variables which indicate the
     56 *  need for underscores and percents.  If not using GNU cpp or
     57 *  the version does not support this, then you will obviously
     58 *  have to define these as appropriate.
     59 *
     60 *  This symbol is prefixed to all register names.
     61 */
    5362#define __REGISTER_PREFIX__
    5463#endif
     
    5665#include <rtems/concat.h>
    5766
    58 /* Use the right prefix for global labels.  */
    59 
     67/** Use the right prefix for global labels.  */
    6068#define SYM(x) CONCAT1 (__USER_LABEL_PREFIX__, x)
    6169
    62 /* Use the right prefix for registers.  */
    63 
     70/** Use the right prefix for registers.  */
    6471#define REG(x) CONCAT1 (__REGISTER_PREFIX__, x)
    6572
     
    7582
    7683
     84/** This macro is used to denote the beginning of a code declaration. */
    7785#define BEGIN_CODE_DCL .text
     86/** This macro is used to denote the end of a code declaration. */
    7887#define END_CODE_DCL
     88/** This macro is used to denote the beginning of a data declaration section. */
    7989#define BEGIN_DATA_DCL .data
     90/** This macro is used to denote the end of a data declaration section. */
    8091#define END_DATA_DCL
     92/** This macro is used to denote the beginning of a code section. */
    8193#define BEGIN_CODE .text
     94/** This macro is used to denote the end of a code section. */
    8295#define END_CODE
     96/** This macro is used to denote the beginning of a data section. */
    8397#define BEGIN_DATA
     98/** This macro is used to denote the end of a data section. */
    8499#define END_DATA
     100/** This macro is used to denote the beginning of the
     101 *  unitialized data section.
     102 */
    85103#define BEGIN_BSS
     104/** This macro is used to denote the end of the unitialized data section.  */
    86105#define END_BSS
     106/** This macro is used to denote the end of the assembly file.  */
    87107#define END
    88108
    89 /*
    90  *  Following must be tailor for a particular flavor of the C compiler.
     109/**
     110 *  This macro is used to declare a public global symbol.
     111 *
     112 *  @note This must be tailored for a particular flavor of the C compiler.
    91113 *  They may need to put underscores in front of the symbols.
    92114 */
     115#define PUBLIC(sym) .globl SYM (sym)
    93116
    94 #define PUBLIC(sym) .globl SYM (sym)
     117/**
     118 *  This macro is used to prototype a public global symbol.
     119 *
     120 *  @note This must be tailored for a particular flavor of the C compiler.
     121 *  They may need to put underscores in front of the symbols.
     122 */
    95123#define EXTERN(sym) .globl SYM (sym)
    96124
Note: See TracChangeset for help on using the changeset viewer.