packages/compat/uitron/v2_0/cdl/mempoolfixed.cdl

   1 # ====================================================================
   2 #
   3 #      mempoolfixed.cdl
   4 #
   5 #      uITRON fixed memory pool related configuration data
   6 #
   7 # ====================================================================
   8 #####ECOSGPLCOPYRIGHTBEGIN####
   9 ## -------------------------------------------
  10 ## This file is part of eCos, the Embedded Configurable Operating System.
  11 ## Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  12 ##
  13 ## eCos is free software; you can redistribute it and/or modify it under
  14 ## the terms of the GNU General Public License as published by the Free
  15 ## Software Foundation; either version 2 or (at your option) any later version.
  16 ##
  17 ## eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 ## WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 ## FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 ## for more details.
  21 ##
  22 ## You should have received a copy of the GNU General Public License along
  23 ## with eCos; if not, write to the Free Software Foundation, Inc.,
  24 ## 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 ##
  26 ## As a special exception, if other files instantiate templates or use macros
  27 ## or inline functions from this file, or you compile this file and link it
  28 ## with other works to produce a work based on this file, this file does not
  29 ## by itself cause the resulting work to be covered by the GNU General Public
  30 ## License. However the source code for this file must still be made available
  31 ## in accordance with section (3) of the GNU General Public License.
  32 ##
  33 ## This exception does not invalidate any other reasons why a work based on
  34 ## this file might be covered by the GNU General Public License.
  35 ##
  36 ## Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 ## at http://sources.redhat.com/ecos/ecos-license/
  38 ## -------------------------------------------
  39 #####ECOSGPLCOPYRIGHTEND####
  40 # ====================================================================
  41 ######DESCRIPTIONBEGIN####
  42 #
  43 # Author(s):      jskov
  44 # Original data:  hmt
  45 # Contributors:
  46 # Date:           1999-07-07
  47 #
  48 #####DESCRIPTIONEND####
  49 #
  50 # ====================================================================
  51
  52 cdl_option CYGNUM_UITRON_MEMPOOLFIXED {
  53     display       "Number of fixed-size memorypools"
  54     flavor        data
  55     legal_values  1 to 65535
  56     default_value 3
  57     description   "
  58         The number of uITRON Fixed-Size
  59         Memorypools present in the system.
  60         Valid Fixed-Size Memorypool IDs will range
  61         from 1 to this value."
  62 }
  63 cdl_component CYGPKG_UITRON_MEMPOOLFIXED_CREATE_DELETE {
  64     display       "Support create and delete"
  65     flavor        bool
  66     default_value 1
  67     active_if     (0 < CYGNUM_UITRON_MEMPOOLFIXED)
  68     description   "
  69         Support fixed-size memory pool
  70         create and delete operations
  71         (cre_mpf, del_mpf).
  72         Otherwise all fixed mempools are created,
  73         up to the number specified above."
  74
  75     cdl_option CYGNUM_UITRON_MEMPOOLFIXED_INITIALLY {
  76         display       "Number of fixed mempools created initially"
  77         flavor        data
  78         legal_values  0 to 65535
  79         default_value 3
  80         description   "
  81             The number of fixed mempools initially created.
  82             This number should not be more than the number
  83             of fixed mempools in the system, though setting
  84             it to a large value to mean 'all' is acceptable.
  85             Initially, only fixed mempools numbered from
  86             1 to this number exist;
  87             higher numbered ones must be created before use.
  88             Whilst all mempools must be initialized to tell
  89             the system what memory to use for each pool,
  90             it is only useful to initialize the blocksize of
  91             fixed mempools up to this number;
  92             the blocksize for higher numbered ones
  93             will be defined when they are created."
  94     }
  95 }
  96 cdl_option CYGDAT_UITRON_MEMPOOLFIXED_EXTERNS {
  97     display       "Externs for initialization"
  98     flavor        data
  99     default_value {"static char fpool1[ 2000 ], \\\n\
 100                                 fpool2[ 2000 ], \\\n\
 101                                 fpool3[ 2000 ];"}
 102     description   "
 103         Fixed mempool initializers may refer to external
 104         objects such as memory for the pool to manage.
 105         Use this option to define or declare any external
 106         objects needed by the pool's static initializer below.
 107         Example: create some memory for a mempool using
 108         'static char fpool1\[2000\];'
 109         to set up a chunk of memory of 2000 bytes.
 110         Note: this option is invoked in the 'outermost' context
 111         of C++ source, where global/static objects are created;
 112         it should contain valid, self-contained, C++ source."
 113 }
 114 cdl_option CYGDAT_UITRON_MEMPOOLFIXED_INITIALIZERS {
 115     display       "Static initializers"
 116     flavor        data
 117     default_value {"CYG_UIT_MEMPOOLFIXED( fpool1, 2000,  20 ), \\\n\
 118                     CYG_UIT_MEMPOOLFIXED( fpool2, 2000, 100 ), \\\n\
 119                     CYG_UIT_MEMPOOLFIXED( fpool3, 2000, 500 ),"}
 120     description   "
 121         Fixed block memory pools should be statically
 122         initialized: enter a list of initializers
 123         separated by commas, one per line.
 124         An initializer is
 125         'CYG_UIT_MEMPOOLFIXED(ADDR,SIZE,BLOCK)'
 126         where addr is the address of memory to manage,
 127         size is the total size of that memory, and
 128         block is the block size for allocation by the pool.
 129         If create and delete operations are supported,
 130         initializers of the form
 131         'CYG_UIT_MEMPOOLFIXED_NOEXS(ADDR,SIZE)' should be
 132         used for pools which are not initially created, to tell
 133         the system what memory to use for each pool.
 134         Note: this option is invoked in the context of a
 135         C++ array initializer, between curly brackets.
 136         Ensure that the number of initializers here exactly
 137         matches the total number of fixed pools specified."
 138 }