media

  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 _media as _media
  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
 57RTEMS_MEDIA_MOUNT_BASE = _media.RTEMS_MEDIA_MOUNT_BASE
 58r"""*"""
 59RTEMS_MEDIA_DELIMITER = _media.RTEMS_MEDIA_DELIMITER
 60
 61RTEMS_MEDIA_EVENT_DISK_ATTACH = _media.RTEMS_MEDIA_EVENT_DISK_ATTACH
 62
 63RTEMS_MEDIA_EVENT_DISK_DETACH = _media.RTEMS_MEDIA_EVENT_DISK_DETACH
 64
 65RTEMS_MEDIA_EVENT_MOUNT = _media.RTEMS_MEDIA_EVENT_MOUNT
 66
 67RTEMS_MEDIA_EVENT_UNMOUNT = _media.RTEMS_MEDIA_EVENT_UNMOUNT
 68
 69RTEMS_MEDIA_EVENT_PARTITION_INQUIRY = _media.RTEMS_MEDIA_EVENT_PARTITION_INQUIRY
 70
 71RTEMS_MEDIA_EVENT_PARTITION_ATTACH = _media.RTEMS_MEDIA_EVENT_PARTITION_ATTACH
 72
 73RTEMS_MEDIA_EVENT_PARTITION_DETACH = _media.RTEMS_MEDIA_EVENT_PARTITION_DETACH
 74
 75RTEMS_MEDIA_EVENT_ERROR = _media.RTEMS_MEDIA_EVENT_ERROR
 76
 77RTEMS_MEDIA_STATE_INQUIRY = _media.RTEMS_MEDIA_STATE_INQUIRY
 78
 79RTEMS_MEDIA_STATE_READY = _media.RTEMS_MEDIA_STATE_READY
 80
 81RTEMS_MEDIA_STATE_ABORTED = _media.RTEMS_MEDIA_STATE_ABORTED
 82
 83RTEMS_MEDIA_STATE_SUCCESS = _media.RTEMS_MEDIA_STATE_SUCCESS
 84
 85RTEMS_MEDIA_STATE_FAILED = _media.RTEMS_MEDIA_STATE_FAILED
 86
 87RTEMS_MEDIA_ERROR_DISK_UNKNOWN = _media.RTEMS_MEDIA_ERROR_DISK_UNKNOWN
 88
 89RTEMS_MEDIA_ERROR_DISK_EXISTS = _media.RTEMS_MEDIA_ERROR_DISK_EXISTS
 90
 91RTEMS_MEDIA_ERROR_DISK_OR_PARTITION_UNKNOWN = _media.RTEMS_MEDIA_ERROR_DISK_OR_PARTITION_UNKNOWN
 92
 93RTEMS_MEDIA_ERROR_DISK_OR_PARTITION_EXISTS = _media.RTEMS_MEDIA_ERROR_DISK_OR_PARTITION_EXISTS
 94
 95RTEMS_MEDIA_ERROR_PARTITION_UNKNOWN = _media.RTEMS_MEDIA_ERROR_PARTITION_UNKNOWN
 96
 97RTEMS_MEDIA_ERROR_PARTITION_ORPHAN = _media.RTEMS_MEDIA_ERROR_PARTITION_ORPHAN
 98
 99RTEMS_MEDIA_ERROR_PARTITION_DETACH_WITH_MOUNT = _media.RTEMS_MEDIA_ERROR_PARTITION_DETACH_WITH_MOUNT
100
101RTEMS_MEDIA_ERROR_PARTITION_WITH_UNKNOWN_DISK = _media.RTEMS_MEDIA_ERROR_PARTITION_WITH_UNKNOWN_DISK
102
103RTEMS_MEDIA_ERROR_MOUNT_POINT_UNKNOWN = _media.RTEMS_MEDIA_ERROR_MOUNT_POINT_UNKNOWN
104
105RTEMS_MEDIA_ERROR_MOUNT_POINT_EXISTS = _media.RTEMS_MEDIA_ERROR_MOUNT_POINT_EXISTS
106
107RTEMS_MEDIA_ERROR_MOUNT_POINT_ORPHAN = _media.RTEMS_MEDIA_ERROR_MOUNT_POINT_ORPHAN
108
109
110def rtems_media_initialize():
111    r"""
112    *
113    Initializes the media manager.
114
115    Calling this function more than once will have no effects.  There is no
116    protection against concurrent access.
117    """
118    return _media.rtems_media_initialize()
119
120def rtems_media_listener_add(listener, listener_arg):
121    r"""Adds the *listener* with argument *listener_arg*."""
122    return _media.rtems_media_listener_add(listener, listener_arg)
123
124def rtems_media_listener_remove(listener, listener_arg):
125    r"""Removes the *listener* with argument *listener_arg*."""
126    return _media.rtems_media_listener_remove(listener, listener_arg)
127
128def rtems_media_post_event(event, src, dest, worker, worker_arg):
129    r"""
130    Posts the *event* with source *src*.
131
132    The *worker* will be called with the *worker_arg* argument.
133
134    The destination will be returned in *dest* in case of success.  It will be
135    allocated with malloc() and should be freed if not needed anymore.
136
137    The work will be done by the calling thread.  You can avoid this if you use
138    the media server via rtems_media_server_post_event().
139    """
140    return _media.rtems_media_post_event(event, src, dest, worker, worker_arg)
141
142def rtems_media_server_initialize(priority, stack_size, modes, attributes):
143    r"""
144     *
145    Initializes the media manager and media server.
146
147    It creates a server task with the *priority*, *stack_size*, *modes*, and
148    *attributes* parameters.
149
150    Calling this function more than once will have no effects.  There is no
151    protection against concurrent access.
152    """
153    return _media.rtems_media_server_initialize(priority, stack_size, modes, attributes)
154
155def rtems_media_server_post_event(event, src, worker, worker_arg):
156    r"""
157    Sends an event message to the media server.
158
159    See also: See rtems_media_post_event().
160    """
161    return _media.rtems_media_server_post_event(event, src, worker, worker_arg)
162
163def rtems_media_server_disk_attach(driver_name, worker, worker_arg):
164    r"""See rtems_media_server_post_event()."""
165    return _media.rtems_media_server_disk_attach(driver_name, worker, worker_arg)
166
167def rtems_media_server_disk_detach(disk_path):
168    r"""See rtems_media_server_post_event()."""
169    return _media.rtems_media_server_disk_detach(disk_path)
170
171def rtems_media_create_path(prefix, name, major):
172    r"""
173     *
174    Creates a new path as "prefix/name-major".
175
176    :rtype: string
177    :return: New string, or ``NULL`` if no memory is available.
178    """
179    return _media.rtems_media_create_path(prefix, name, major)
180
181def rtems_media_replace_prefix(new_prefix, path):
182    r"""
183    Replaces the prefix of the *path* with *new_prefix*.
184
185    The prefix is everything up to the last '/'.
186
187    :rtype: string
188    :return: New string, or ``NULL`` if no memory is available.
189    """
190    return _media.rtems_media_replace_prefix(new_prefix, path)
191
192def rtems_media_append_minor(path, minor):
193    r"""
194    Appends the *minor* number to the *path* resulting in "path-minor".
195
196    :rtype: string
197    :return: New string, or ``NULL`` if no memory is available.
198    """
199    return _media.rtems_media_append_minor(path, minor)
200
201def rtems_media_get_device_identifier(device_path, device_identifier):
202    r"""
203     *
204    Returns the device identifier for the device located at
205    *device_path* in *device_identifier*.
206    """
207    return _media.rtems_media_get_device_identifier(device_path, device_identifier)
208
209def rtems_media_event_description(event):
210    r"""
211    rtems_media_event_description(rtems_media_event event) -> char const *
212
213    Parameters
214    ----------
215    event: enum rtems_media_event
216
217    """
218    return _media.rtems_media_event_description(event)
219
220def rtems_media_state_description(state):
221    r"""
222    rtems_media_state_description(rtems_media_state state) -> char const *
223
224    Parameters
225    ----------
226    state: enum rtems_media_state
227
228    """
229    return _media.rtems_media_state_description(state)