Changeset 997f223 in rtems


Ignore:
Timestamp:
Dec 24, 2013, 6:06:55 PM (5 years ago)
Author:
Daniel Ramirez <javamonn@…>
Branches:
4.11, master
Children:
5b4c479
Parents:
c51645f
git-author:
Daniel Ramirez <javamonn@…> (12/24/13 18:06:55)
git-committer:
Gedare Bloom <gedare@…> (12/24/13 18:19:15)
Message:

bfin_eZKit533: added new doxygen

Location:
c/src/lib/libbsp/bfin/eZKit533/include
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • c/src/lib/libbsp/bfin/eZKit533/include/bsp.h

    rc51645f r997f223  
     1/**
     2 * @file
     3 * @ingroup bfin_ezkit533
     4 * @brief Global BSP definitions.
     5 */
     6
    17/*  bsp.h
    28 *
     
    3137#include <rtems/bfin/bf533.h>
    3238
    33 /*
    34  * PLL and clock setup values:
     39/**
     40 * @defgroup bfin_ezkit533 eZKit533 Support
     41 * @ingroup bsp_bfin
     42 * @brief eZKit533 Board Support Package
     43 * @{
    3544 */
    3645
    37 /*
    38  *  PLL configuration for ezkit533
     46/**
     47 * @name PLL and clock setup values:
     48 * @brief  PLL configuration for ezkit533
    3949 *
    4050 *  XTL   =  27 MHz
     
    4353 *  CCLK  = 391 MHz
    4454 *  SCLK  = 130 MHz
     55 *
     56 * @{
     57 *
    4558 */
    4659
    47 #define PLL_CSEL    0x0000      /* CCLK = VCO      */
    48 #define PLL_SSEL    0x0003      /* SCLK = CCLK/3   */
    49 #define PLL_MSEL    0x3A00      /* VCO = 29xCLKIN  */
    50 #define PLL_DF      0x0001      /* CLKIN = XTL/2   */
     60#define PLL_CSEL    0x0000      ///< @brief CCLK = VCO      */
     61#define PLL_SSEL    0x0003      ///< @brief SCLK = CCLK/3   */
     62#define PLL_MSEL    0x3A00      ///< @brief VCO = 29xCLKIN  */
     63#define PLL_DF      0x0001      ///< @brief CLKIN = XTL/2   */
    5164
    52 #define CCLK        391000000   /* CORE CLOCK     */
    53 #define SCLK        130000000   /* SYSTEM CLOCK   */
     65#define CCLK        391000000   ///< @brief CORE CLOCK     */
     66#define SCLK        130000000   ///< @brief SYSTEM CLOCK   */
    5467
    55 /*
    56  * UART setup values
     68/** @} */
     69
     70/**
     71 * @name UART setup values
     72 * @{
    5773 */
    58 #define BAUDRATE    57600       /* Console Baudrate   */
    59 #define WORD_5BITS  0x00        /* 5 bits word        */
    60 #define WORD_6BITS  0x01        /* 6 bits word        */
    61 #define WORD_7BITS  0x02        /* 7 bits word        */
    62 #define WORD_8BITS  0x03        /* 8 bits word        */
    63 #define EVEN_PARITY 0x18        /* Enable EVEN parity */
    64 #define ODD_PARITY  0x08        /* Enable ODD parity  */
    65 #define TWO_STP_BIT 0x04        /* 2 stop bits        */
    6674
    67 /*
    68  * Ezkit flash ports
     75#define BAUDRATE    57600       ///< @brief Console Baudrate   */
     76#define WORD_5BITS  0x00        ///< @brief 5 bits word        */
     77#define WORD_6BITS  0x01        ///< @brief 6 bits word        */
     78#define WORD_7BITS  0x02        ///< @brief 7 bits word        */
     79#define WORD_8BITS  0x03        ///< @brief 8 bits word        */
     80#define EVEN_PARITY 0x18        ///< @brief Enable EVEN parity */
     81#define ODD_PARITY  0x08        ///< @brief Enable ODD parity  */
     82#define TWO_STP_BIT 0x04        ///< @brief 2 stop bits        */
     83
     84/** @} */
     85
     86/**
     87 * @name Ezkit flash ports
     88 * @{
    6989 */
     90
    7091#define FlashA_PortB_Dir  0x20270007L
    7192#define FlashA_PortB_Data 0x20270005L
    7293
    73 /*
    74  * Blackfin environment memory map
     94/** @} */
     95
     96/**
     97 * @brief Blackfin environment memory map
    7598 */
    7699#define L1_DATA_SRAM_A 0xff800000L
     
    78101#define FIFOLENGTH 0x100
    79102
    80 /*
    81  * Simple spin delay in microsecond units for device drivers.
     103/**
     104 * @brief Simple spin delay in microsecond units for device drivers.
    82105 *  This is very dependent on the clock speed of the target.
    83106 */
     
    87110  }
    88111
    89 /* Constants */
     112/**
     113 * @name Constants
     114 * @{
     115 */
    90116
    91117#define RAM_START 0
    92118#define RAM_END   0x100000
    93119
    94 /* functions */
     120/** @} */
    95121
    96 /*
    97  * Helper Function to use the EzKits LEDS.
     122/**
     123 * @name functions
     124 * @{
     125 */
     126
     127/**
     128 * @brief Helper Function to use the EzKits LEDS.
    98129 * Can be used by the Application.
    99130 */
    100131void setLED (uint8_t value);
    101132
    102 /*
    103  * Helper Function to use the EzKits LEDS
     133/**
     134 * @brief Helper Function to use the EzKits LEDS
    104135 */
    105136uint8_t getLED (void);
    106137
    107 rtems_isr_entry set_vector(                     /* returns old vector */
    108   rtems_isr_entry     handler,                  /* isr routine        */
    109   rtems_vector_number vector,                   /* vector number      */
    110   int                 type                      /* RTEMS or RAW intr  */
     138rtems_isr_entry set_vector(                     ///< @brief returns old vector */
     139  rtems_isr_entry     handler,                  ///< @brief isr routine        */
     140  rtems_vector_number vector,                   ///< @brief vector number      */
     141  int                 type                      ///< @brief RTEMS or RAW intr  */
    111142);
     143
     144/** @} */
     145
     146/** @} */
    112147
    113148#ifdef __cplusplus
  • c/src/lib/libbsp/bfin/eZKit533/include/cplb.h

    rc51645f r997f223  
     1/**
     2 * @file
     3 * @ingroup ezkit533_cplb
     4 * @brief CPLB configurations.
     5 */
     6
    17/*  cplb.h
    28 *
     
    1016#ifndef _CPLB_H
    1117#define _CPLB_H
     18
     19/**
     20 * @defgroup ezkit533_cplb CPLB Configuration
     21 * @ingroup bfin_ezkit533
     22 * @brief CPLB Configuration
     23 * @{
     24 */
    1225
    1326/* CPLB configurations */
     
    3043#define CPLB_DDOCACHE_WB        CPLB_DNOCACHE | CPLB_DEF_CACHE_WB
    3144
     45/** @} */
     46
    3247#endif /* _CPLB_H */
  • c/src/lib/libbsp/bfin/eZKit533/include/tm27.h

    rc51645f r997f223  
     1/**
     2 * @file
     3 * @ingroup ezkit533_tm27
     4 * @brief Interrupt mechanisms for the tm27 test.
     5 */
     6
    17/*
    28 *  tm27.h
     
    1319#ifndef __tm27_h
    1420#define __tm27_h
     21
     22/**
     23 * @defgroup ezkit533_tm27 TM27 Test Support
     24 * @ingroup bfin_ezkit533
     25 * @brief Interrupt Mechanisms for TM27
     26 * @{
     27 */
    1528
    1629/*
     
    3144#define Lower_tm27_intr() /* empty */
    3245
     46/** @} */
     47
    3348#endif
Note: See TracChangeset for help on using the changeset viewer.