Changeset cf3d2b37 in rtems for cpukit/include/rtems/malloc.h


Ignore:
Timestamp:
08/10/22 13:20:27 (4 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
4b04589b
Parents:
f6a38fb
git-author:
Sebastian Huber <sebastian.huber@…> (08/10/22 13:20:27)
git-committer:
Sebastian Huber <sebastian.huber@…> (08/10/22 13:41:58)
Message:

rtems/malloc.h: Add API level Doxygen group

The interfaces in the MallocSupport? group belong to the implementation. They
are used by confdefs.h for example.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/malloc.h

    rf6a38fb rcf3d2b37  
    44 * @file
    55 *
    6  * This file defines the interface to RTEMS extensions to the Malloc Family.
     6 * @ingroup MallocSupport
     7 *
     8 * @ingroup RTEMSAPIMalloc
     9 *
     10 * @brief This header file defines interfaces to support and use dynamic memory
     11 *   allocation.
    712 */
    813
     
    4752
    4853/**
    49  *  @defgroup MallocSupport Malloc Support
    50  *
    51  *  @ingroup libcsupport
    52  *
    53  *  @brief RTEMS extensions to the Malloc Family
     54 * @defgroup MallocSupport Malloc Support
     55 *
     56 * @ingroup libcsupport
     57 *
     58 * @brief This group contains interfaces to support dynamic memory allocation.
     59 *
     60 * @{
    5461 */
    5562
     
    6471void _Malloc_Initialize( void );
    6572
     73typedef void *(*rtems_heap_extend_handler)(
     74  Heap_Control *heap,
     75  size_t alloc_size
     76);
     77
     78/**
     79 *  @brief RTEMS Extend Heap via Sbrk
     80 */
     81void *rtems_heap_extend_via_sbrk(
     82  Heap_Control *heap,
     83  size_t alloc_size
     84);
     85
     86void *rtems_heap_null_extend(
     87  Heap_Control *heap,
     88  size_t alloc_size
     89);
     90
     91extern const rtems_heap_extend_handler rtems_malloc_extend_handler;
     92
     93/*
     94 * Malloc Plugin to Dirty Memory at Allocation Time
     95 */
     96typedef void (*rtems_malloc_dirtier_t)(void *, size_t);
     97extern rtems_malloc_dirtier_t rtems_malloc_dirty_helper;
     98
     99/** @} */
     100
     101/**
     102 * @defgroup RTEMSAPIMalloc Dynamic Memory Allocation
     103 *
     104 * @ingroup RTEMSAPI
     105 *
     106 * @brief This group contains non-standard interfaces to use dynamic memory
     107 *   allocation.
     108 *
     109 * @{
     110 */
     111
    66112void rtems_heap_set_sbrk_amount( ptrdiff_t sbrk_amount );
    67 
    68 typedef void *(*rtems_heap_extend_handler)(
    69   Heap_Control *heap,
    70   size_t alloc_size
    71 );
    72 
    73 /**
    74  *  @brief RTEMS Extend Heap via Sbrk
    75  */
    76 void *rtems_heap_extend_via_sbrk(
    77   Heap_Control *heap,
    78   size_t alloc_size
    79 );
    80113
    81114/**
     
    91124  size_t alloc_size
    92125);
    93 
    94 void *rtems_heap_null_extend(
    95   Heap_Control *heap,
    96   size_t alloc_size
    97 );
    98 
    99 extern const rtems_heap_extend_handler rtems_malloc_extend_handler;
    100 
    101 /*
    102  * Malloc Plugin to Dirty Memory at Allocation Time
    103  */
    104 typedef void (*rtems_malloc_dirtier_t)(void *, size_t);
    105 extern rtems_malloc_dirtier_t rtems_malloc_dirty_helper;
    106126
    107127/**
     
    252272void rtems_heap_greedy_free( void *opaque );
    253273
     274/** @} */
     275
    254276#ifdef __cplusplus
    255277}
Note: See TracChangeset for help on using the changeset viewer.