config

  1# This file was automatically generated by SWIG (https://www.swig.org).
  2# Version 4.2.1
  3#
  4# Do not make changes to this file unless you know what you are doing - modify
  5# the SWIG interface file instead.
  6
  7from sys import version_info as _swig_python_version_info
  8from mock_rtems import _config as _config
  9
 10try:
 11    import builtins as __builtin__
 12except ImportError:
 13    import __builtin__
 14
 15def _swig_repr(self):
 16    try:
 17        strthis = "proxy of " + self.this.__repr__()
 18    except __builtin__.Exception:
 19        strthis = ""
 20    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
 21
 22
 23def _swig_setattr_nondynamic_instance_variable(set):
 24    def set_instance_attr(self, name, value):
 25        if name == "this":
 26            set(self, name, value)
 27        elif name == "thisown":
 28            self.this.own(value)
 29        elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
 30            set(self, name, value)
 31        else:
 32            raise AttributeError("You cannot add instance attributes to %s" % self)
 33    return set_instance_attr
 34
 35
 36def _swig_setattr_nondynamic_class_variable(set):
 37    def set_class_attr(cls, name, value):
 38        if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
 39            set(cls, name, value)
 40        else:
 41            raise AttributeError("You cannot add class attributes to %s" % cls)
 42    return set_class_attr
 43
 44
 45def _swig_add_metaclass(metaclass):
 46    """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
 47    def wrapper(cls):
 48        return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
 49    return wrapper
 50
 51
 52class _SwigNonDynamicMeta(type):
 53    """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
 54    __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
 55
 56
 57
 58def rtems_configuration_get_stack_space_size():
 59    r"""
 60    This flag is used in augment a resource number so that it indicates
 61      an unlimited resource.
 62
 63
 64
 65    Indicates if the task stack allocator is configured to avoid the
 66      RTEMS Workspace for this application.
 67
 68    :rtype: uintptr_t
 69    :return: Returns true, if the task stack allocator is configured to avoid the
 70          RTEMS Workspace for this application, otherwise false.
 71
 72    Title: Notes
 73    The setting is defined by the
 74    CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE application configuration
 75    option.
 76
 77    Title: Constraints
 78
 79    The following constraints apply to this directive:
 80
 81    * The directive may be called from within any runtime context.
 82
 83    * The directive will not cause the calling task to be preempted.
 84
 85
 86
 87
 88    Gets the configured size in bytes of the memory space used to
 89      allocate thread stacks for this application.
 90
 91    :rtype: uintptr_t
 92    :return: Returns the configured size in bytes of the memory space used to
 93          allocate thread stacks for this application.
 94
 95    Title: Notes
 96    The size takes only threads and tasks into account with are known at the
 97    application configuration time.
 98
 99    Title: Constraints
100
101    The following constraints apply to this directive:
102
103    * The directive may be called from within any runtime context.
104
105    * The directive will not cause the calling task to be preempted.
106    """
107    return _config.rtems_configuration_get_stack_space_size()
108
109def rtems_get_build_label():
110    r"""
111    Gets the RTEMS build label.
112
113    The build label is a user-provided string defined by the build configuration
114    through the ``RTEMS_BUILD_LABEL`` build option.  The format of the string is
115    completely user-defined.
116
117    :rtype: string
118    :return: Returns a pointer to the RTEMS build label.
119
120    Title: Notes
121    The build label can be used to distinguish test suite results obtained from
122    different build configurations.  A use case is to record test results with
123    performance data to track performance regressions.  For this a database of
124    performance limits is required.  The build label and the target hash
125    obtained from rtems_get_target_hash() can be used as a key to obtain
126    performance limits.
127
128    Title: Constraints
129
130    The following constraints apply to this directive:
131
132    * The directive may be called from within any runtime context.
133
134    * The directive will not cause the calling task to be preempted.
135    """
136    return _config.rtems_get_build_label()
137
138def rtems_get_copyright_notice():
139    r"""
140    Gets the RTEMS copyright notice.
141
142    :rtype: string
143    :return: Returns a pointer to the RTEMS copyright notice.
144
145    Title: Constraints
146
147    The following constraints apply to this directive:
148
149    * The directive may be called from within any runtime context.
150
151    * The directive will not cause the calling task to be preempted.
152    """
153    return _config.rtems_get_copyright_notice()
154
155def rtems_get_target_hash():
156    r"""
157    Gets the RTEMS target hash.
158
159    The target hash is calculated from BSP-specific values which characterize a
160    target system.  The target hash is encoded as a base64url string.  The
161    target hash algorithm is unspecified.
162
163    :rtype: string
164    :return: Returns a pointer to the RTEMS target hash.
165
166    Title: Notes
167
168    For example, the device tree, settings of the memory controller, processor
169    and bus frequencies, a serial number of a chip may be used to calculate the
170    target hash.
171
172    The target hash can be used to distinguish test suite results obtained from
173    different target systems.  See also rtems_get_build_label().
174
175
176    Title: Constraints
177
178    The following constraints apply to this directive:
179
180    * The directive may be called from within any runtime context.
181
182    * The directive will not cause the calling task to be preempted.
183    """
184    return _config.rtems_get_target_hash()
185
186def rtems_get_version_string():
187    r"""
188    Gets the RTEMS version string.
189
190    :rtype: string
191    :return: Returns a pointer to the RTEMS version string.
192
193    Title: Notes
194    The version string has no particular format.  Parsing the string may break
195    across RTEMS releases.
196
197    Title: Constraints
198
199    The following constraints apply to this directive:
200
201    * The directive may be called from within any runtime context.
202
203    * The directive will not cause the calling task to be preempted.
204    """
205    return _config.rtems_get_version_string()
206
207def rtems_configuration_get_maximum_extensions():
208    r"""
209    Indicates if the RTEMS Workspace is configured to be zeroed during
210      system initialization for this application.
211
212    :rtype: uint32_t
213    :return: Returns true, if the RTEMS Workspace is configured to be zeroed
214          during system initialization for this application, otherwise false.
215
216    Title: Notes
217    The setting is defined by the 'CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY'
218    application configuration option.
219
220    Title: Constraints
221
222    The following constraints apply to this directive:
223
224    * The directive may be called from within any runtime context.
225
226    * The directive will not cause the calling task to be preempted.
227
228
229
230
231    Gets the IDLE task stack size in bytes of this application.
232
233    :rtype: uint32_t
234    :return: Returns the IDLE task stack size in bytes of this application.
235
236    Title: Notes
237    The IDLE task stack size is defined by the
238    CONFIGURE_IDLE_TASK_STACK_SIZE application configuration option.
239
240    Title: Constraints
241
242    The following constraints apply to this directive:
243
244    * The directive may be called from within any runtime context.
245
246    * The directive will not cause the calling task to be preempted.
247
248
249
250
251    Gets the IDLE task body of this application.
252
253    :rtype: uint32_t
254    :return: Returns the IDLE task body of this application.
255
256    Title: Notes
257    The IDLE task body is defined by the 'CONFIGURE_IDLE_TASK_BODY'
258    application configuration option.
259
260    Title: Constraints
261
262    The following constraints apply to this directive:
263
264    * The directive may be called from within any runtime context.
265
266    * The directive will not cause the calling task to be preempted.
267
268
269
270
271    Gets the interrupt stack size in bytes of this application.
272
273    :rtype: uint32_t
274    :return: Returns the interrupt stack size in bytes of this application.
275
276    Title: Notes
277    The interrupt stack size is defined by the
278    CONFIGURE_INTERRUPT_STACK_SIZE application configuration option.
279
280    Title: Constraints
281
282    The following constraints apply to this directive:
283
284    * The directive may be called from within any runtime context.
285
286    * The directive will not cause the calling task to be preempted.
287
288
289
290
291    Gets the resource number of 'RTEMSAPIClassicUserExt' objects
292      configured for this application.
293
294    :rtype: uint32_t
295    :return: Returns the resource number of 'RTEMSAPIClassicUserExt' objects
296          configured for this application.
297
298    Title: Notes
299    The resource number is defined by the 'CONFIGURE_MAXIMUM_USER_EXTENSIONS'
300    application configuration option.  See also rtems_resource_is_unlimited()
301    and rtems_resource_maximum_per_allocation().
302
303    Title: Constraints
304
305    The following constraints apply to this directive:
306
307    * The directive may be called from within any runtime context.
308
309    * The directive will not cause the calling task to be preempted.
310    """
311    return _config.rtems_configuration_get_maximum_extensions()