termiosdevice

  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 _termiosdevice as _termiosdevice
  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
 57class rtems_termios_device_context(object):
 58    r"""
 59    Termios device context.
 60
 61    See also: RTEMS_TERMIOS_DEVICE_CONTEXT_INITIALIZER(),
 62    rtems_termios_device_context_initialize() and
 63    rtems_termios_device_install().
 64    """
 65
 66    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 67    __repr__ = _swig_repr
 68    lock = property(_termiosdevice.rtems_termios_device_context_lock_get, doc=r"""lock : rtems_termios_device_context_lock""")
 69    lock_acquire = property(_termiosdevice.rtems_termios_device_context_lock_acquire_get, _termiosdevice.rtems_termios_device_context_lock_acquire_set, doc=r"""lock_acquire : p.f(p.struct rtems_termios_device_context,p.rtems_interrupt_lock_context).void""")
 70    lock_release = property(_termiosdevice.rtems_termios_device_context_lock_release_get, _termiosdevice.rtems_termios_device_context_lock_release_set, doc=r"""lock_release : p.f(p.struct rtems_termios_device_context,p.rtems_interrupt_lock_context).void""")
 71
 72    def __init__(self):
 73        r"""__init__(rtems_termios_device_context self) -> rtems_termios_device_context"""
 74        _termiosdevice.rtems_termios_device_context_swiginit(self, _termiosdevice.new_rtems_termios_device_context())
 75    __swig_destroy__ = _termiosdevice.delete_rtems_termios_device_context
 76
 77# Register rtems_termios_device_context in _termiosdevice:
 78_termiosdevice.rtems_termios_device_context_swigregister(rtems_termios_device_context)
 79class rtems_termios_device_context_lock(object):
 80    r"""Proxy of C rtems_termios_device_context_lock struct."""
 81
 82    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 83    __repr__ = _swig_repr
 84    interrupt = property(_termiosdevice.rtems_termios_device_context_lock_interrupt_get, _termiosdevice.rtems_termios_device_context_lock_interrupt_set, doc=r"""interrupt : rtems_interrupt_lock""")
 85    mutex = property(_termiosdevice.rtems_termios_device_context_lock_mutex_get, _termiosdevice.rtems_termios_device_context_lock_mutex_set, doc=r"""mutex : rtems_mutex""")
 86
 87    def __init__(self):
 88        r"""__init__(rtems_termios_device_context_lock self) -> rtems_termios_device_context_lock"""
 89        _termiosdevice.rtems_termios_device_context_lock_swiginit(self, _termiosdevice.new_rtems_termios_device_context_lock())
 90    __swig_destroy__ = _termiosdevice.delete_rtems_termios_device_context_lock
 91
 92# Register rtems_termios_device_context_lock in _termiosdevice:
 93_termiosdevice.rtems_termios_device_context_lock_swigregister(rtems_termios_device_context_lock)
 94TERMIOS_POLLED = _termiosdevice.TERMIOS_POLLED
 95
 96TERMIOS_IRQ_DRIVEN = _termiosdevice.TERMIOS_IRQ_DRIVEN
 97
 98TERMIOS_TASK_DRIVEN = _termiosdevice.TERMIOS_TASK_DRIVEN
 99
100TERMIOS_IRQ_SERVER_DRIVEN = _termiosdevice.TERMIOS_IRQ_SERVER_DRIVEN
101
102class rtems_termios_device_handler(object):
103    r"""
104    Termios device handler.
105
106    See also: rtems_termios_device_install().
107    """
108
109    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
110    __repr__ = _swig_repr
111    first_open = property(_termiosdevice.rtems_termios_device_handler_first_open_get, _termiosdevice.rtems_termios_device_handler_first_open_set, doc=r"""
112    First open of this device.
113
114    :param tty: The Termios control.  This parameter may be passed to
115          interrupt service routines since it must be provided for the
116          rtems_termios_enqueue_raw_characters() and
117          rtems_termios_dequeue_characters() functions.
118    :param context: The Termios device context.
119    :param term: The current Termios attributes.
120    :param args: The open/close arguments.  This is parameter provided to
121          support legacy drivers.  It must not be used by new drivers.
122
123    See also: rtems_termios_get_device_context() and rtems_termios_set_best_baud().
124    """)
125    last_close = property(_termiosdevice.rtems_termios_device_handler_last_close_get, _termiosdevice.rtems_termios_device_handler_last_close_set, doc=r"""
126    Last close of this device.
127
128    :param tty: The Termios control.
129    :param context: The Termios device context.
130    :param args: The open/close arguments.  This is parameter provided to
131          support legacy drivers.  It must not be used by new drivers.
132    """)
133    poll_read = property(_termiosdevice.rtems_termios_device_handler_poll_read_get, _termiosdevice.rtems_termios_device_handler_poll_read_set, doc=r"""
134    Polled read.
135
136    In case mode is TERMIOS_IRQ_DRIVEN, TERMIOS_IRQ_SERVER_DRIVEN or
137    TERMIOS_TASK_DRIVEN, then data is received via
138    rtems_termios_enqueue_raw_characters().
139
140    :param context: The Termios device context.
141    """)
142    write = property(_termiosdevice.rtems_termios_device_handler_write_get, _termiosdevice.rtems_termios_device_handler_write_set, doc=r"""
143    Polled write in case mode is TERMIOS_POLLED or write support
144    otherwise.
145
146    :param context: The Termios device context.
147    :param buf: The output buffer.
148    :param len: The output buffer length in characters.
149    """)
150    set_attributes = property(_termiosdevice.rtems_termios_device_handler_set_attributes_get, _termiosdevice.rtems_termios_device_handler_set_attributes_set, doc=r"""
151    Set attributes after a Termios settings change.
152
153    :param context: The Termios device context.
154    :param term: The new Termios attributes.
155    """)
156    ioctl = property(_termiosdevice.rtems_termios_device_handler_ioctl_get, _termiosdevice.rtems_termios_device_handler_ioctl_set, doc=r"""
157    IO control handler.
158
159    Invoked in case the Termios layer cannot deal with the IO request.
160
161    :param context: The Termios device context.
162    :param request: The IO control request.
163    :param buffer: The IO control buffer.
164    """)
165    mode = property(_termiosdevice.rtems_termios_device_handler_mode_get, _termiosdevice.rtems_termios_device_handler_mode_set, doc=r"""Termios device mode.""")
166
167    def __init__(self):
168        r"""__init__(rtems_termios_device_handler self) -> rtems_termios_device_handler"""
169        _termiosdevice.rtems_termios_device_handler_swiginit(self, _termiosdevice.new_rtems_termios_device_handler())
170    __swig_destroy__ = _termiosdevice.delete_rtems_termios_device_handler
171
172# Register rtems_termios_device_handler in _termiosdevice:
173_termiosdevice.rtems_termios_device_handler_swigregister(rtems_termios_device_handler)
174class rtems_termios_device_flow(object):
175    r"""
176    Termios device flow control handler.
177
178    See also: rtems_termios_device_install().
179    """
180
181    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
182    __repr__ = _swig_repr
183    stop_remote_tx = property(_termiosdevice.rtems_termios_device_flow_stop_remote_tx_get, _termiosdevice.rtems_termios_device_flow_stop_remote_tx_set, doc=r"""
184    Indicate to stop remote transmitter.
185
186    :param context: The Termios device context.
187    """)
188    start_remote_tx = property(_termiosdevice.rtems_termios_device_flow_start_remote_tx_get, _termiosdevice.rtems_termios_device_flow_start_remote_tx_set, doc=r"""
189    Indicate to start remote transmitter.
190
191    :param context: The Termios device context.
192    """)
193
194    def __init__(self):
195        r"""__init__(rtems_termios_device_flow self) -> rtems_termios_device_flow"""
196        _termiosdevice.rtems_termios_device_flow_swiginit(self, _termiosdevice.new_rtems_termios_device_flow())
197    __swig_destroy__ = _termiosdevice.delete_rtems_termios_device_flow
198
199# Register rtems_termios_device_flow in _termiosdevice:
200_termiosdevice.rtems_termios_device_flow_swigregister(rtems_termios_device_flow)
201
202def rtems_termios_device_lock_acquire_default(ctx, lock_context):
203    r"""
204    rtems_termios_device_lock_acquire_default(rtems_termios_device_context ctx, rtems_interrupt_lock_context * lock_context)
205
206    Parameters
207    ----------
208    ctx: rtems_termios_device_context *
209    lock_context: rtems_interrupt_lock_context *
210
211    """
212    return _termiosdevice.rtems_termios_device_lock_acquire_default(ctx, lock_context)
213
214def rtems_termios_device_lock_release_default(ctx, lock_context):
215    r"""
216    rtems_termios_device_lock_release_default(rtems_termios_device_context ctx, rtems_interrupt_lock_context * lock_context)
217
218    Parameters
219    ----------
220    ctx: rtems_termios_device_context *
221    lock_context: rtems_interrupt_lock_context *
222
223    """
224    return _termiosdevice.rtems_termios_device_lock_release_default(ctx, lock_context)
225
226def rtems_termios_device_context_initialize(context, name):
227    r"""
228    Initializes a device context.
229
230    :type context: :py:class:`rtems_termios_device_context`, in
231    :param context: The Termios device context.
232    :type name: string, in
233    :param name: The name for the interrupt lock.  This name must be a
234          string persistent throughout the life time of this lock.  The name is only
235          used if profiling is enabled.
236    """
237    return _termiosdevice.rtems_termios_device_context_initialize(context, name)
238
239def rtems_termios_device_lock_acquire(context, lock_context):
240    r"""
241    Initializer for static initialization of Termios device contexts.
242
243    :param name: The name for the interrupt lock.  It must be a string.  The name
244          is only used if profiling is enabled.
245
246    Acquires the device lock.
247
248    :type context: :py:class:`rtems_termios_device_context`, in
249    :param context: The device context.
250    :type lock_context: rtems_interrupt_lock_context, in
251    :param lock_context: The local interrupt lock context for an acquire and
252          release pair.
253    """
254    return _termiosdevice.rtems_termios_device_lock_acquire(context, lock_context)
255
256def rtems_termios_device_lock_release(context, lock_context):
257    r"""
258    Releases the device lock.
259
260    :type context: :py:class:`rtems_termios_device_context`, in
261    :param context: The device context.
262    :type lock_context: rtems_interrupt_lock_context, in
263    :param lock_context: The local interrupt lock context for an acquire and
264          release pair.
265    """
266    return _termiosdevice.rtems_termios_device_lock_release(context, lock_context)