Changeset b355e190 in rtems


Ignore:
Timestamp:
Dec 18, 2015, 6:54:39 AM (4 years ago)
Author:
jfjhh <alex.striff1@…>
Branches:
master
Children:
34a2ec92
Parents:
867b99f
git-author:
jfjhh <alex.striff1@…> (12/18/15 06:54:39)
git-committer:
Gedare Bloom <gedare@…> (12/19/15 03:04:02)
Message:

doc: Epiphany BSP SIM headers

Location:
c/src/lib/libbsp/epiphany/epiphany_sim/include
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • c/src/lib/libbsp/epiphany/epiphany_sim/include/bsp.h

    r867b99f rb355e190  
     1/**
     2 * @defgroup bsp_epiphany Epiphany
     3 *
     4 * @ingroup bsp_epiphany
     5 *
     6 * @brief Epiphany Support Package
     7 */
     8
    19/*
    2  *
    310 * Copyright (c) 2015 University of York.
    411 * Hesham ALMatary <hmka501@york.ac.uk>
     
    4552#endif
    4653
    47 /* Constants */
     54/**
     55 * @name Constants
     56 *
     57 * @{
     58 */
    4859Thread clock_driver_sim_idle_body(uintptr_t);
    4960#define BSP_IDLE_TASK_BODY clock_driver_sim_idle_body
     61/** @} */
    5062
    5163#ifdef __cplusplus
     
    5365#endif
    5466
    55 #endif /* LIBBSP_EPIPHANY_PARALLELLA_H */
     67#endif /* LIBBSP_EPIPHANY_EPIPHANY_SIM_H */
  • c/src/lib/libbsp/epiphany/epiphany_sim/include/bspopts.h

    r867b99f rb355e190  
     1/**
     2 * @ingroup bsp_epiphany
     3 *
     4 * @brief Epiphany BSP Options
     5 */
     6
    17/*
    28 *
     
    3137/* include/bspopts.h.in.  Generated from configure.ac by autoheader.  */
    3238
    33 /* If defined, then the BSP Framework will put a non-zero pattern into the
    34    RTEMS Workspace and C program heap. This should assist in finding code that
    35    assumes memory starts set to zero. */
     39#ifndef LIBBSP_EPIPHANY_EPIPHANY_SIM_OPTS_H
     40#define LIBBSP_EPIPHANY_EPIPHANY_SIM_OPTS_H
     41
     42/**
     43 * @name Options
     44 *
     45 * @{
     46 */
     47
     48/**
     49 * @brief Dirties memory to test for programs that assume zeroed memory.
     50 *
     51 * If defined, then the BSP Framework will put a non-zero pattern into the
     52 * RTEMS Workspace and C program heap. This should assist in finding code that
     53 * assumes memory starts set to zero.
     54 */
    3655#undef BSP_DIRTY_MEMORY
    3756
    38 /* If defined, print a message and wait until pressed before resetting board
    39    when application exits. */
     57/**
     58 * @brief Print and wait for key press for reset.
     59 *
     60 * If defined, print a message and wait until pressed before resetting board
     61 * when application exits.
     62 */
    4063#undef BSP_PRESS_KEY_FOR_RESET
    4164
    42 /* If defined, prints the exception context when an unexpected exception
    43    occurs. */
     65/**
     66 * @brief Prints exception context upon unexpected exceptions
     67 *
     68 * If defined, prints the exception context when an unexpected exception occurs.
     69 */
    4470#undef BSP_PRINT_EXCEPTION_CONTEXT
    4571
    46 /* If defined, reset the board when the application exits. */
     72/**
     73 * @brief Resets on application exit.
     74 *
     75 * If defined, reset the board when the application exits.
     76 */
    4777#undef BSP_RESET_BOARD_AT_EXIT
    4878
    49 /* reset vector address for BSP start */
     79/**
     80 * @brief Reset vector address for BSP start
     81 */
    5082#undef BSP_START_RESET_VECTOR
    5183
    52 /* Define to the address where bug reports for this package should be sent. */
     84/**
     85 * @brief Define to the address where bug reports for this package should be
     86 * sent.
     87 */
    5388#undef PACKAGE_BUGREPORT
    5489
    55 /* Define to the full name of this package. */
     90/**
     91 * @brief Define to the full name of this package.
     92 */
    5693#undef PACKAGE_NAME
    5794
    58 /* Define to the full name and version of this package. */
     95/**
     96 * @brief Define to the full name and version of this package.
     97 */
    5998#undef PACKAGE_STRING
    6099
    61 /* Define to the one symbol short name of this package. */
     100/**
     101 * @brief Define to the one symbol short name of this package.
     102 */
    62103#undef PACKAGE_TARNAME
    63104
    64 /* Define to the home page for this package. */
     105/**
     106 * @brief Define to the home page for this package.
     107 */
    65108#undef PACKAGE_URL
    66109
    67 /* Define to the version of this package. */
     110/**
     111 * @brief Define to the version of this package.
     112 */
    68113#undef PACKAGE_VERSION
     114
     115/** @} */
     116
     117#endif /* LIBBSP_EPIPHANY_EPIPHANY_SIM_OPTS_H */
  • c/src/lib/libbsp/epiphany/epiphany_sim/include/tm27.h

    r867b99f rb355e190  
     1/**
     2 * @ingroup bsp_epiphany
     3 *
     4 * @brief Epiphany Time Test 27 Routines
     5 */
     6
    17/*
    28 *
     
    3339#endif
    3440
    35 #ifndef __tm27_h
    36 #define __tm27_h
     41#ifndef LIBBSP_EPIPHANY_EPIPHANY_SIM_TM27_H
     42#define LIBBSP_EPIPHANY_EPIPHANY_SIM_TM27_H
    3743
    3844/**
    3945 * @name Interrupt mechanisms for Time Test 27
     46 *
    4047 * @{
    4148 */
     
    5158#define Lower_tm27_intr() /* empty */
    5259
    53 #endif
     60/** @} */
     61
     62#endif /* LIBBSP_EPIPHANY_EPIPHANY_SIM_TM27_H */
Note: See TracChangeset for help on using the changeset viewer.