Changeset 8224d2af in rtems


Ignore:
Timestamp:
Dec 22, 2013, 9:55:40 PM (5 years ago)
Author:
Daniel Ramirez <javamonn@…>
Branches:
4.11, master
Children:
c541862e
Parents:
b7212b9
git-author:
Daniel Ramirez <javamonn@…> (12/22/13 21:55:40)
git-committer:
Gedare Bloom <gedare@…> (12/23/13 02:46:35)
Message:

arm_stm32f4: added new doxygen

Location:
c/src/lib/libbsp/arm/stm32f4/include
Files:
14 edited

Legend:

Unmodified
Added
Removed
  • c/src/lib/libbsp/arm/stm32f4/include/bsp.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup arm_stm34f4
     4 * @brief Global BSP definitions.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    1117 * found in the file LICENSE in this distribution or at
    1218 * http://www.rtems.com/license/LICENSE.
     19 */
     20
     21/**
     22 * @defgroup arm_stm32f4 STM32F4 Support
     23 * @ingroup bsp_arm
     24 * @brief STM32f4 Support Package
     25 * @{
    1326 */
    1427
     
    3548#define BSP_ARMV7M_SYSTICK_FREQUENCY STM32F4_HCLK
    3649
     50/** @} */
     51
    3752#ifdef __cplusplus
    3853}
  • c/src/lib/libbsp/arm/stm32f4/include/i2c.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_i2c I2C Support
     4 * @brief I2C-module.
     5 */
     6
    17/*
    28 * Copyright (c) 2013 Christian Mauderer.  All rights reserved.
     
    3036#endif /* __cplusplus */
    3137
     38/**
     39 * @defgroup stm32f4_i2c I2C Support
     40 * @ingroup arm_stm32f4
     41 * @brief I2C Module
     42 * @{
     43 */
     44
    3245typedef struct {
    33   /* The address of the slave without the read write bit. A 7-Bit address should
    34    * be placed in the bits [6..0] */
     46  /**
     47   * @brief The address of the slave without the read write bit.
     48   * A 7-Bit address should be placed in the bits [6..0]
     49   */
    3550  uint16_t addr;
    36   /* Read (true) or write (false) data */
     51  /** @brief Read (true) or write (false) data */
    3752  bool read;
    38   /* Size of data to read or write */
     53  /** @brief Size of data to read or write */
    3954  size_t len;
    40   /* Buffer for data */
     55  /** @brief Buffer for data */
    4156  uint8_t *buf;
    4257} stm32f4_i2c_message;
     
    5570} stm32f4_i2c_bus_entry;
    5671
    57 /* Initialise the i2c module. */
     72/** @brief Initialise the i2c module. */
    5873rtems_status_code stm32f4_i2c_init(stm32f4_i2c_bus_entry *e);
    5974
    60 /* Process a i2c message */
     75/** @brief Process a i2c message */
    6176rtems_status_code stm32f4_i2c_process_message(
    6277  stm32f4_i2c_bus_entry *e,
     
    6479);
    6580
    66 /* Set another baud rate than the default one */
     81/** @brief Set another baud rate than the default one */
    6782rtems_status_code stm32f4_i2c_set_bitrate(
    6883  stm32f4_i2c_bus_entry *e,
     
    7388extern stm32f4_i2c_bus_entry *const stm32f4_i2c2;
    7489
     90/** @} */
     91
    7592#ifdef __cplusplus
    7693}
  • c/src/lib/libbsp/arm/stm32f4/include/io.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_io
     4 * @brief IO support.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    2430#endif /* __cplusplus */
    2531
     32/**
     33 * @defgroup stm32f4_io IO Support
     34 * @ingroup arm_stm32f4
     35 * @brief IO Support
     36 * @{
     37 */
     38
    2639#define STM32F4_GPIO_PIN(port, index) ((((port) << 4) | (index)) & 0xff)
    2740
     
    3144
    3245#ifdef STM32F4_FAMILY_F4XXXX
     46
     47/**
     48 * @name Family F4XXXX
     49 * @{
     50 */
    3351
    3452typedef enum {
     
    114132  { { 0xff, 0xff, 0x3, 0x1, 0x3, 0x3, 0x1, 0xf, 0xf } }
    115133
     134/** @} */
     135
    116136#endif /* STM32F4_FAMILY_F4XXXX */
    117137#ifdef STM32F4_FAMILY_F10XXX
     138
     139/**
     140 * @name Family F10XXX
     141 * @{
     142 */
    118143
    119144typedef enum {
     
    238263  { { 0xff, 0xff, 0x3, 0x3, 0x1, 0xff, 0x7 } }
    239264
     265/** @} */
     266
    240267#endif /* STM32F4_FAMILY_F10XXX */
    241268
     
    257284
    258285#ifdef STM32F4_FAMILY_F4XXXX
     286
     287/**
     288 * @name Family F4XXXX
     289 * @{
     290 */
    259291
    260292#define STM32F4_PIN_USART(port, idx, altfunc) \
     
    297329#define STM32F4_PIN_USART6_RX_PC7 STM32F4_PIN_USART(2, 7, STM32F4_GPIO_AF_USART6)
    298330
     331/** @} */
     332
    299333#endif /* STM32F4_FAMILY_F4XXXX */
    300334#ifdef STM32F4_FAMILY_F10XXX
     335
     336/**
     337 * @name Family F10XXX
     338 * @{
     339 */
    301340
    302341#define STM32F4_PIN_USART_TX(port, idx, remapvalue) \
     
    367406#define STM32F4_PIN_I2C2_SDA      STM32F4_PIN_I2C(1, 11, STM32F4_GPIO_REMAP_DONT_CHANGE)
    368407
     408/** @} */
     409
    369410#endif /* STM32F4_FAMILY_F10XXX */
    370411
  • c/src/lib/libbsp/arm/stm32f4/include/irq.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_interrupt
     4 * @brief Interrupt definitions.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    3137
    3238#endif /* ASM */
     39
     40/**
     41 * @defgroup stm32f4_interrupt Interrupt Support
     42 * @ingroup arm_stm32f4
     43 * @brief Interrupt Support
     44 * @{
     45 */
    3346
    3447#define STM32F4_IRQ_WWDG 0
     
    124137#define BSP_INTERRUPT_VECTOR_MAX 81
    125138
     139/** @} */
     140
    126141#endif /* LIBBSP_ARM_STM32F4_IRQ_H */
  • c/src/lib/libbsp/arm/stm32f4/include/rcc.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_rcc
     4 * @brief RCC support.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    2329#endif /* __cplusplus */
    2430
     31/**
     32 * @defgroup stm32f4_rcc RCC Support
     33 * @ingroup arm_stm32f4
     34 * @brief RCC Support
     35 * @{
     36 */
     37
    2538#define STM32F4_RCC_INDEX(reg, idx) (((reg) << 5) | (idx))
    2639
    2740typedef enum {
    2841#ifdef STM32F4_FAMILY_F4XXXX
     42
     43  /**
     44   * @name Family F4XXXX
     45   * @{
     46   */
     47
    2948  STM32F4_RCC_OTGHS = STM32F4_RCC_INDEX(0, 29),
    3049  STM32F4_RCC_ETHMAC = STM32F4_RCC_INDEX(0, 25),
     
    87106  STM32F4_RCC_TIM8 = STM32F4_RCC_INDEX(5, 1),
    88107  STM32F4_RCC_TIM1 = STM32F4_RCC_INDEX(5, 0),
     108
     109  /** @} */
     110
    89111#endif /* STM32F4_FAMILY_F4XXXX */
    90112#ifdef STM32F4_FAMILY_F10XXX
     113
     114  /**
     115   * @name Family F10
     116   * @{
     117   */
     118
    91119  STM32F4_RCC_DMA1 = STM32F4_RCC_INDEX(0, 0),
    92120  STM32F4_RCC_DMA2 = STM32F4_RCC_INDEX(0, 1),
     
    144172  STM32F4_RCC_PWR = STM32F4_RCC_INDEX(2, 28),
    145173  STM32F4_RCC_DAC = STM32F4_RCC_INDEX(2, 29),
     174
     175  /** @} */
     176
    146177#endif /* STM32F4_FAMILY_F10XXX */
    147178} stm32f4_rcc_index;
     
    157188#endif /* STM32F4_FAMILY_F4XXXX */
    158189
     190/** @} */
     191
    159192#ifdef __cplusplus
    160193}
  • c/src/lib/libbsp/arm/stm32f4/include/stm32_i2c.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32_i2c
     4 * @brief STM32 I2C support.
     5 */
     6
    17/*
    28 * Copyright (c) 2013 Christian Mauderer.  All rights reserved.
     
    1723
    1824#include <bsp/utility.h>
     25
     26/**
     27 * @defgroup stm32_i2c STM32 I2C Support
     28 * @ingroup stm32f4_i2c
     29 * @brief STM32 I2C Support
     30 * @{
     31 */
    1932
    2033typedef struct {
     
    96109} stm32f4_i2c;
    97110
     111/** @} */
     112
    98113#endif /* LIBBSP_ARM_STM32F4_STM32_I2C_H */
  • c/src/lib/libbsp/arm/stm32f4/include/stm32_usart.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32_usart
     4 * @brief STM32 USART support
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    1723
    1824#include <bsp/utility.h>
     25
     26/**
     27 * @defgroup stm32_usart STM32 USART Support
     28 * @ingroup stm32f4_usart
     29 * @brief STM32 USART Support
     30 * @{
     31 */
    1932
    2033typedef struct {
     
    93106} stm32f4_usart;
    94107
     108/** @} */
     109
    95110#endif /* LIBBSP_ARM_STM32F4_STM32_USART_H */
  • c/src/lib/libbsp/arm/stm32f4/include/stm32f10xxx_exti.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_exti
     4 * @brief STM32F10XXX EXTI support
     5 */
     6
    17/*
    28 * Copyright (c) 2013 Christian Mauderer.  All rights reserved.
     
    1824#include <bsp/utility.h>
    1925
     26/**
     27 * @defgroup stm32f4_exti EXTI Support
     28 * @ingroup arm_stm32f4
     29 * @brief STM32F10XXX EXTI Support
     30 * @{
     31 */
     32
    2033typedef struct {
    2134        uint32_t imr;
     
    3346} stm32f4_exti;
    3447
     48/** @} */
     49
    3550#endif /* LIBBSP_ARM_STM32F4_STM32F10XXX_EXTI_H */
  • c/src/lib/libbsp/arm/stm32f4/include/stm32f10xxx_gpio.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_gpio
     4 * @brief STM32F10XXX GPIO support.
     5 */
     6
    17/*
    28 * Copyright (c) 2013 Christian Mauderer.  All rights reserved.
     
    1824#include <bsp/utility.h>
    1925
     26/**
     27 * @defgroup stm32f4_gpio GPIO Support
     28 * @ingroup stm32f4_io
     29 * @brief GPIO Support
     30 * @{
     31 */
     32
    2033typedef struct {
    2134        uint32_t cr[2];
     
    3447} stm32f4_afio;
    3548
     49/** @} */
     50
    3651#endif /* LIBBSP_ARM_STM32F4_STM32F10XXX_GPIO_H */
  • c/src/lib/libbsp/arm/stm32f4/include/stm32f10xxx_rcc.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f10xxx_rcc
     4 * @brief STM32F10XXX RCC support.
     5 */
     6
    17/*
    28 * Copyright (c) 2013 Christian Mauderer.  All rights reserved.
     
    1824#include <bsp/utility.h>
    1925
     26/**
     27 * @defgroup stm32f10xxx_rcc STM32F10XXX RCC Support
     28 * @ingroup stm32f4_rcc
     29 * @brief STM32F10XXX RCC Support
     30 * @{
     31 */
     32
    2033typedef struct {
    2134        uint32_t cr;
     
    3144} stm32f4_rcc;
    3245
     46/** @} */
     47
    3348#endif /* LIBBSP_ARM_STM32F4_STM32F10XXX_RCC_H */
  • c/src/lib/libbsp/arm/stm32f4/include/stm32f4.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_reg
     4 * @brief Register definitions.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    2329#ifdef STM32F4_FAMILY_F4XXXX
    2430
     31/**
     32 * @defgroup stm32f4_reg Register Defintions
     33 * @ingroup arm_stm32f4
     34 * @brief Register Definitions
     35 * @{
     36 */
     37
     38/**
     39 * @name STM32f4XXXX GPIO
     40 * @{
     41 */
     42
    2543#include <bsp/stm32f4xxxx_gpio.h>
    2644#define STM32F4_GPIO(i) ((volatile stm32f4_gpio *) (STM32F4_BASE + 0x40020000) + (i))
     45
     46/** @} */
     47
     48/**
     49 * @name STM32F4XXXX RCC
     50 * @{
     51 */
    2752
    2853#include <bsp/stm32f4xxxx_rcc.h>
    2954#define STM32F4_RCC ((volatile stm32f4_rcc *) (STM32F4_BASE + 0x40023800))
    3055
     56/** @} */
     57
    3158#include <bsp/stm32_i2c.h>
     59
     60/**
     61 * @name STM32 I2C
     62 * @{
     63 */
     64
    3265#define STM32F4_I2C3 ((volatile stm32f4_i2c *) (STM32F4_BASE + 0x40005C00))
    3366#define STM32F4_I2C2 ((volatile stm32f4_i2c *) (STM32F4_BASE + 0x40005800))
    3467#define STM32F4_I2C1 ((volatile stm32f4_i2c *) (STM32F4_BASE + 0x40005400))
     68
     69/** @} */
     70
     71/**
     72 * @name STM32 USART
     73 * @{
     74 */
    3575
    3676#include <bsp/stm32_usart.h>
     
    4282#define STM32F4_USART_6 ((volatile stm32f4_usart *) (STM32F4_BASE + 0x40011400))
    4383
     84/** @} */
     85
    4486#endif /* STM32F4_FAMILY_F4XXXX */
    4587
    4688#ifdef STM32F4_FAMILY_F10XXX
    4789
     90/**
     91 * @name STM32F10 EXTI
     92 * @{
     93 */
     94
    4895#include <bsp/stm32f10xxx_exti.h>
    4996#define STM32F4_EXTI ((volatile stm32f4_exti *) (STM32F4_BASE + 0x40010400))
     97
     98/** @} */
     99
     100/**
     101 * @name STM32F10XXX GPIO
     102 * @{
     103 */
    50104
    51105#include <bsp/stm32f10xxx_gpio.h>
     
    53107#define STM32F4_AFIO ((volatile stm32f4_afio *) (STM32F4_BASE + 0x40010000))
    54108
     109/** @} */
     110
     111/**
     112 * @name STM32F10XXX RCC
     113 * @{
     114 */
     115
    55116#include <bsp/stm32f10xxx_rcc.h>
    56117#define STM32F4_RCC ((volatile stm32f4_rcc *) (STM32F4_BASE + 0x40021000))
     118
     119/** @} */
     120
     121/**
     122 * @name STM32 I2C
     123 * @{
     124 */
    57125
    58126#include <bsp/stm32_i2c.h>
    59127#define STM32F4_I2C2 ((volatile stm32f4_i2c *) (STM32F4_BASE + 0x40005800))
    60128#define STM32F4_I2C1 ((volatile stm32f4_i2c *) (STM32F4_BASE + 0x40005400))
     129
     130/** @} */
     131
     132/**
     133 * @name STM32 USART
     134 * @{
     135 */
    61136
    62137#include <bsp/stm32_usart.h>
     
    67142#define STM32F4_USART_5 ((volatile stm32f4_usart *) (STM32F4_BASE + 0x40005000))
    68143
     144/** @} */
     145
     146/** @} */
     147
    69148#endif /* STM32F4_FAMILY_F10XXX */
    70149
  • c/src/lib/libbsp/arm/stm32f4/include/stm32f4xxxx_gpio.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_gpio
     4 * @brief STM32F4XXXX GPIO support.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
  • c/src/lib/libbsp/arm/stm32f4/include/stm32f4xxxx_rcc.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4xxxx_rcc
     4 * @brief STM32F4XXXX RCC support.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    1723
    1824#include <bsp/utility.h>
     25
     26/**
     27 * @defgroup stm32f4xxxx_rcc STM32F4XXXX RCC Support
     28 * @ingroup stm32f4_rcc
     29 * @brief STM32F4XXXX RCC Support
     30 * @{
     31 */
    1932
    2033typedef struct {
     
    4255} stm32f4_rcc;
    4356
     57/** @} */
     58
    4459#endif /* LIBBSP_ARM_STM32F4_STM32F4XXXX_RCC_H */
  • c/src/lib/libbsp/arm/stm32f4/include/usart.h

    rb7212b9 r8224d2af  
     1/**
     2 * @file
     3 * @ingroup stm32f4_usart
     4 * @brief USART (universal synchronous/asynchronous receiver/transmitter) support.
     5 */
     6
    17/*
    28 * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
     
    1824#include <libchip/serial.h>
    1925
     26/**
     27 * @defgroup stm32f4_usart USART Support
     28 * @ingroup arm_stm32f4
     29 * @brief USART Support
     30 * @{
     31 */
     32
    2033#ifdef __cplusplus
    2134extern "C" {
     
    2437extern const console_fns stm32f4_usart_fns;
    2538
     39/** @} */
     40
    2641#ifdef __cplusplus
    2742}
Note: See TracChangeset for help on using the changeset viewer.