packages/compat/uitron/v2_0/cdl/mempoolvar.cdl

   1 # ====================================================================
   2 #
   3 #      mempoolvar.cdl
   4 #
   5 #      uITRON variable 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_MEMPOOLVAR {
  53     display       "Number of variable-size memory pools"
  54     flavor        data
  55     legal_values  1 to 65535
  56     default_value 3
  57     description   "
  58         The number of uITRON Variable-Size Memorypools present in the system.
  59         Valid Variable-Size Memorypool IDs will range from 1 to this value."
  60 }
  61 cdl_component CYGPKG_UITRON_MEMPOOLVAR_CREATE_DELETE {
  62     display       "Support create and delete"
  63     flavor        bool
  64     default_value 1
  65     active_if     (0 < CYGNUM_UITRON_MEMPOOLVAR)
  66     description   "
  67         Support variable-size memory pool create and delete operations
  68         (cre_mpl, del_mpl). Otherwise all variable-size mempools are created,
  69         up to the number specified above."
  70
  71     cdl_option CYGNUM_UITRON_MEMPOOLVAR_INITIALLY {
  72         display       "Number of variable-size mempools created initially"
  73         flavor        data
  74         legal_values  0 to 65535
  75         default_value 3
  76         description   "
  77             The number of variable-size mempools initially created.
  78             This number should not be more than the number
  79             of variable mempools in the system, though setting
  80             it to a large value to mean 'all' is acceptable.
  81             Initially, only variable mempools numbered from
  82             1 to this number exist;
  83             higher numbered ones must be created before use.
  84             All mempools must be initialized to tell
  85             the system what memory to use for each pool."
  86     }
  87 }
  88 cdl_option CYGDAT_UITRON_MEMPOOLVAR_EXTERNS {
  89     display       "Externs for initialization"
  90     flavor        data
  91     default_value {"static char vpool1[ 2000 ], \\\n\
  92                                 vpool2[ 2000 ], \\\n\
  93                                 vpool3[ 2000 ];"}
  94     description   "
  95         Variable mempool initializers may refer to external
  96         objects such as memory for the pool to manage.
  97         Use this option to define or declare any external
  98         objects needed by the pool's static initializer below.
  99         Example: create some memory for a mempool using
 100         'static char vpool1\[2000\];'
 101         to set up a chunk of memory of 2000 bytes.
 102         Note: this option is invoked in the 'outermost' context
 103         of C++ source, where global/static objects are created;
 104         it should contain valid, self-contained, C++ source."
 105 }
 106 cdl_option CYGDAT_UITRON_MEMPOOLVAR_INITIALIZERS {
 107     display       "Static initializers"
 108     flavor        data
 109     default_value {"CYG_UIT_MEMPOOLVAR( vpool1, 2000 ), \\\n\
 110                     CYG_UIT_MEMPOOLVAR( vpool2, 2000 ), \\\n\
 111                     CYG_UIT_MEMPOOLVAR( vpool3, 2000 ),"}
 112     description   "
 113         Variable block memory pools should be statically
 114         initialized: enter a list of initializers
 115         separated by commas, one per line.
 116         An initializer is
 117         'CYG_UIT_MEMPOOLVAR(ADDR,SIZE)'
 118         where addr is the address of memory to manage, and
 119         size is the total size of that memory.
 120         If create and delete operations are supported,
 121         initializers of the form
 122         'CYG_UIT_MEMPOOLVAR_NOEXS(ADDR,SIZE)' should be
 123         used for pools which are not initially created, to tell
 124         the system what memory to use for each pool.
 125         Note: this option is invoked in the context of a
 126         C++ array initializer, between curly brackets.
 127         Ensure that the number of initializers here exactly
 128         matches the total number of variable pools specified."
 129 }