termiostypes

  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 _termiostypes as _termiostypes
  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 ttywakeup(object):
 58    r"""Proxy of C ttywakeup struct."""
 59
 60    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 61    __repr__ = _swig_repr
 62    sw_pfn = property(_termiostypes.ttywakeup_sw_pfn_get, _termiostypes.ttywakeup_sw_pfn_set, doc=r"""sw_pfn : p.f(p.struct termios,p.void).void""")
 63    sw_arg = property(_termiostypes.ttywakeup_sw_arg_get, _termiostypes.ttywakeup_sw_arg_set, doc=r"""sw_arg : p.void""")
 64
 65    def __init__(self):
 66        r"""__init__(ttywakeup self) -> ttywakeup"""
 67        _termiostypes.ttywakeup_swiginit(self, _termiostypes.new_ttywakeup())
 68    __swig_destroy__ = _termiostypes.delete_ttywakeup
 69
 70# Register ttywakeup in _termiostypes:
 71_termiostypes.ttywakeup_swigregister(ttywakeup)
 72class rtems_termios_rawbuf(object):
 73    r"""Proxy of C rtems_termios_rawbuf struct."""
 74
 75    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 76    __repr__ = _swig_repr
 77    theBuf = property(_termiostypes.rtems_termios_rawbuf_theBuf_get, _termiostypes.rtems_termios_rawbuf_theBuf_set, doc=r"""theBuf : p.char""")
 78    Head = property(_termiostypes.rtems_termios_rawbuf_Head_get, _termiostypes.rtems_termios_rawbuf_Head_set, doc=r"""Head : q(volatile).unsigned int""")
 79    Tail = property(_termiostypes.rtems_termios_rawbuf_Tail_get, _termiostypes.rtems_termios_rawbuf_Tail_set, doc=r"""Tail : q(volatile).unsigned int""")
 80    Size = property(_termiostypes.rtems_termios_rawbuf_Size_get, _termiostypes.rtems_termios_rawbuf_Size_set, doc=r"""Size : q(volatile).unsigned int""")
 81    Semaphore = property(_termiostypes.rtems_termios_rawbuf_Semaphore_get, _termiostypes.rtems_termios_rawbuf_Semaphore_set, doc=r"""Semaphore : rtems_binary_semaphore""")
 82
 83    def __init__(self):
 84        r"""__init__(rtems_termios_rawbuf self) -> rtems_termios_rawbuf"""
 85        _termiostypes.rtems_termios_rawbuf_swiginit(self, _termiostypes.new_rtems_termios_rawbuf())
 86    __swig_destroy__ = _termiostypes.delete_rtems_termios_rawbuf
 87
 88# Register rtems_termios_rawbuf in _termiostypes:
 89_termiostypes.rtems_termios_rawbuf_swigregister(rtems_termios_rawbuf)
 90class rtems_termios_device_node(object):
 91    r"""
 92    Termios device node for installed devices.
 93
 94    See also: rtems_termios_device_install().
 95    """
 96
 97    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 98    __repr__ = _swig_repr
 99    node = property(_termiostypes.rtems_termios_device_node_node_get, _termiostypes.rtems_termios_device_node_node_set, doc=r"""node : rtems_chain_node""")
100    major = property(_termiostypes.rtems_termios_device_node_major_get, _termiostypes.rtems_termios_device_node_major_set, doc=r"""major : rtems_device_major_number""")
101    minor = property(_termiostypes.rtems_termios_device_node_minor_get, _termiostypes.rtems_termios_device_node_minor_set, doc=r"""minor : rtems_device_minor_number""")
102    handler = property(_termiostypes.rtems_termios_device_node_handler_get, _termiostypes.rtems_termios_device_node_handler_set, doc=r"""handler : p.q(const).rtems_termios_device_handler""")
103    flow = property(_termiostypes.rtems_termios_device_node_flow_get, _termiostypes.rtems_termios_device_node_flow_set, doc=r"""flow : p.q(const).rtems_termios_device_flow""")
104    context = property(_termiostypes.rtems_termios_device_node_context_get, _termiostypes.rtems_termios_device_node_context_set, doc=r"""context : p.rtems_termios_device_context""")
105    tty = property(_termiostypes.rtems_termios_device_node_tty_get, _termiostypes.rtems_termios_device_node_tty_set, doc=r"""tty : p.struct rtems_termios_tty""")
106
107    def __init__(self):
108        r"""__init__(rtems_termios_device_node self) -> rtems_termios_device_node"""
109        _termiostypes.rtems_termios_device_node_swiginit(self, _termiostypes.new_rtems_termios_device_node())
110    __swig_destroy__ = _termiostypes.delete_rtems_termios_device_node
111
112# Register rtems_termios_device_node in _termiostypes:
113_termiostypes.rtems_termios_device_node_swigregister(rtems_termios_device_node)
114class rtems_termios_tty(object):
115    r"""Proxy of C rtems_termios_tty struct."""
116
117    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
118    __repr__ = _swig_repr
119    forw = property(_termiostypes.rtems_termios_tty_forw_get, _termiostypes.rtems_termios_tty_forw_set, doc=r"""forw : p.struct rtems_termios_tty""")
120    back = property(_termiostypes.rtems_termios_tty_back_get, _termiostypes.rtems_termios_tty_back_set, doc=r"""back : p.struct rtems_termios_tty""")
121    refcount = property(_termiostypes.rtems_termios_tty_refcount_get, _termiostypes.rtems_termios_tty_refcount_set, doc=r"""refcount : int""")
122    major = property(_termiostypes.rtems_termios_tty_major_get, _termiostypes.rtems_termios_tty_major_set, doc=r"""major : rtems_device_major_number""")
123    minor = property(_termiostypes.rtems_termios_tty_minor_get, _termiostypes.rtems_termios_tty_minor_set, doc=r"""minor : rtems_device_minor_number""")
124    isem = property(_termiostypes.rtems_termios_tty_isem_get, _termiostypes.rtems_termios_tty_isem_set, doc=r"""isem : rtems_mutex""")
125    osem = property(_termiostypes.rtems_termios_tty_osem_get, _termiostypes.rtems_termios_tty_osem_set, doc=r"""osem : rtems_mutex""")
126    cbuf = property(_termiostypes.rtems_termios_tty_cbuf_get, _termiostypes.rtems_termios_tty_cbuf_set, doc=r"""cbuf : p.char""")
127    ccount = property(_termiostypes.rtems_termios_tty_ccount_get, _termiostypes.rtems_termios_tty_ccount_set, doc=r"""ccount : int""")
128    cindex = property(_termiostypes.rtems_termios_tty_cindex_get, _termiostypes.rtems_termios_tty_cindex_set, doc=r"""cindex : int""")
129    column = property(_termiostypes.rtems_termios_tty_column_get, _termiostypes.rtems_termios_tty_column_set, doc=r"""column : int""")
130    read_start_column = property(_termiostypes.rtems_termios_tty_read_start_column_get, _termiostypes.rtems_termios_tty_read_start_column_set, doc=r"""read_start_column : int""")
131    termios = property(_termiostypes.rtems_termios_tty_termios_get, _termiostypes.rtems_termios_tty_termios_set, doc=r"""termios : struct termios""")
132    vtimeTicks = property(_termiostypes.rtems_termios_tty_vtimeTicks_get, _termiostypes.rtems_termios_tty_vtimeTicks_set, doc=r"""vtimeTicks : rtems_interval""")
133    rawInBuf = property(_termiostypes.rtems_termios_tty_rawInBuf_get, _termiostypes.rtems_termios_tty_rawInBuf_set, doc=r"""rawInBuf : struct rtems_termios_rawbuf""")
134    rawInBufSemaphoreWait = property(_termiostypes.rtems_termios_tty_rawInBufSemaphoreWait_get, _termiostypes.rtems_termios_tty_rawInBufSemaphoreWait_set, doc=r"""rawInBufSemaphoreWait : bool""")
135    rawInBufSemaphoreTimeout = property(_termiostypes.rtems_termios_tty_rawInBufSemaphoreTimeout_get, _termiostypes.rtems_termios_tty_rawInBufSemaphoreTimeout_set, doc=r"""rawInBufSemaphoreTimeout : rtems_interval""")
136    rawInBufSemaphoreFirstTimeout = property(_termiostypes.rtems_termios_tty_rawInBufSemaphoreFirstTimeout_get, _termiostypes.rtems_termios_tty_rawInBufSemaphoreFirstTimeout_set, doc=r"""rawInBufSemaphoreFirstTimeout : rtems_interval""")
137    rawInBufDropped = property(_termiostypes.rtems_termios_tty_rawInBufDropped_get, _termiostypes.rtems_termios_tty_rawInBufDropped_set, doc=r"""rawInBufDropped : unsigned int""")
138    rawOutBuf = property(_termiostypes.rtems_termios_tty_rawOutBuf_get, _termiostypes.rtems_termios_tty_rawOutBuf_set, doc=r"""rawOutBuf : struct rtems_termios_rawbuf""")
139    t_dqlen = property(_termiostypes.rtems_termios_tty_t_dqlen_get, _termiostypes.rtems_termios_tty_t_dqlen_set, doc=r"""t_dqlen : int""")
140    rawOutBufState = property(_termiostypes.rtems_termios_tty_rawOutBufState_get, _termiostypes.rtems_termios_tty_rawOutBufState_set, doc=r"""rawOutBufState : enum $unnamed1$""")
141    device = property(_termiostypes.rtems_termios_tty_device_get, _termiostypes.rtems_termios_tty_device_set, doc=r"""device : rtems_termios_callbacks""")
142    legacy_device_context = property(_termiostypes.rtems_termios_tty_legacy_device_context_get, _termiostypes.rtems_termios_tty_legacy_device_context_set, doc=r"""Context for legacy devices using the callbacks.""")
143    handler = property(_termiostypes.rtems_termios_tty_handler_get, _termiostypes.rtems_termios_tty_handler_set, doc=r"""The device handler.""")
144    flow = property(_termiostypes.rtems_termios_tty_flow_get, _termiostypes.rtems_termios_tty_flow_set, doc=r"""The device flow control handler.""")
145    flow_ctrl = property(_termiostypes.rtems_termios_tty_flow_ctrl_get, _termiostypes.rtems_termios_tty_flow_ctrl_set, doc=r"""flow_ctrl : q(volatile).unsigned int""")
146    lowwater = property(_termiostypes.rtems_termios_tty_lowwater_get, _termiostypes.rtems_termios_tty_lowwater_set, doc=r"""lowwater : unsigned int""")
147    highwater = property(_termiostypes.rtems_termios_tty_highwater_get, _termiostypes.rtems_termios_tty_highwater_set, doc=r"""highwater : unsigned int""")
148    rxTaskId = property(_termiostypes.rtems_termios_tty_rxTaskId_get, _termiostypes.rtems_termios_tty_rxTaskId_set, doc=r"""rxTaskId : rtems_id""")
149    txTaskId = property(_termiostypes.rtems_termios_tty_txTaskId_get, _termiostypes.rtems_termios_tty_txTaskId_set, doc=r"""txTaskId : rtems_id""")
150    txTaskCharsDequeued = property(_termiostypes.rtems_termios_tty_txTaskCharsDequeued_get, _termiostypes.rtems_termios_tty_txTaskCharsDequeued_set, doc=r"""txTaskCharsDequeued : int""")
151    t_line = property(_termiostypes.rtems_termios_tty_t_line_get, _termiostypes.rtems_termios_tty_t_line_set, doc=r"""t_line : int""")
152    t_sc = property(_termiostypes.rtems_termios_tty_t_sc_get, _termiostypes.rtems_termios_tty_t_sc_set, doc=r"""t_sc : p.void""")
153    tty_snd = property(_termiostypes.rtems_termios_tty_tty_snd_get, _termiostypes.rtems_termios_tty_tty_snd_set, doc=r"""tty_snd : struct ttywakeup""")
154    tty_rcv = property(_termiostypes.rtems_termios_tty_tty_rcv_get, _termiostypes.rtems_termios_tty_tty_rcv_set, doc=r"""tty_rcv : struct ttywakeup""")
155    tty_rcvwakeup = property(_termiostypes.rtems_termios_tty_tty_rcvwakeup_get, _termiostypes.rtems_termios_tty_tty_rcvwakeup_set, doc=r"""tty_rcvwakeup : bool""")
156    device_node = property(_termiostypes.rtems_termios_tty_device_node_get, _termiostypes.rtems_termios_tty_device_node_set, doc=r"""Corresponding device node.""")
157    device_context = property(_termiostypes.rtems_termios_tty_device_context_get, _termiostypes.rtems_termios_tty_device_context_set, doc=r"""Context for device driver.""")
158
159    def __init__(self):
160        r"""__init__(rtems_termios_tty self) -> rtems_termios_tty"""
161        _termiostypes.rtems_termios_tty_swiginit(self, _termiostypes.new_rtems_termios_tty())
162    __swig_destroy__ = _termiostypes.delete_rtems_termios_tty
163
164# Register rtems_termios_tty in _termiostypes:
165_termiostypes.rtems_termios_tty_swigregister(rtems_termios_tty)
166rob_idle = _termiostypes.rob_idle
167
168rob_busy = _termiostypes.rob_busy
169
170rob_wait = _termiostypes.rob_wait
171
172
173
174def rtems_termios_device_install(device_file, handler, flow, context):
175    r"""
176    Installs a Termios device.
177
178    The installed Termios device may be removed via unlink().
179
180    :type device_file: string, in
181    :param device_file: The device file path.
182    :type handler: rtems_termios_device_handler, in
183    :param handler: The device handler.  It must be persistent throughout the
184          installed time of the device.
185    :type flow: rtems_termios_device_flow, in
186    :param flow: The device flow control handler.  The device flow control
187          handler are optional and may be ``NULL``.  If present must be persistent
188          throughout the installed time of the device.
189    :type context: rtems_termios_device_context, in
190    :param context: The device context.  It must be persistent throughout the
191          installed time of the device.
192
193    See also: rtems_termios_get_device_context().
194    """
195    return _termiostypes.rtems_termios_device_install(device_file, handler, flow, context)
196
197def rtems_termios_get_device_context(tty):
198    r"""
199    Returns the device context of an installed Termios device.
200
201    :type tty: :py:class:`rtems_termios_tty`, in
202    :param tty: The Termios control.
203    """
204    return _termiostypes.rtems_termios_get_device_context(tty)
205
206def rtems_termios_set_best_baud(term, baud):
207    r"""
208    Sets the best baud value in the Termios control.
209
210    The valid Termios baud values are between 0 and 460800.  The Termios baud
211    value is chosen which minimizes the difference to the value specified.
212
213    :type term: struct termios, in
214    :param term: The Termios attributes.
215    :type baud: uint32_t, in
216    :param baud: The current baud setting of the device.
217    """
218    return _termiostypes.rtems_termios_set_best_baud(term, baud)
219class rtems_termios_linesw(object):
220    r"""Proxy of C rtems_termios_linesw struct."""
221
222    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
223    __repr__ = _swig_repr
224    l_open = property(_termiostypes.rtems_termios_linesw_l_open_get, _termiostypes.rtems_termios_linesw_l_open_set, doc=r"""l_open : p.f(p.struct rtems_termios_tty).int""")
225    l_close = property(_termiostypes.rtems_termios_linesw_l_close_get, _termiostypes.rtems_termios_linesw_l_close_set, doc=r"""l_close : p.f(p.struct rtems_termios_tty).int""")
226    l_read = property(_termiostypes.rtems_termios_linesw_l_read_get, _termiostypes.rtems_termios_linesw_l_read_set, doc=r"""l_read : p.f(p.struct rtems_termios_tty,p.rtems_libio_rw_args_t).int""")
227    l_write = property(_termiostypes.rtems_termios_linesw_l_write_get, _termiostypes.rtems_termios_linesw_l_write_set, doc=r"""l_write : p.f(p.struct rtems_termios_tty,p.rtems_libio_rw_args_t).int""")
228    l_rint = property(_termiostypes.rtems_termios_linesw_l_rint_get, _termiostypes.rtems_termios_linesw_l_rint_set, doc=r"""l_rint : p.f(int,p.struct rtems_termios_tty).int""")
229    l_start = property(_termiostypes.rtems_termios_linesw_l_start_get, _termiostypes.rtems_termios_linesw_l_start_set, doc=r"""l_start : p.f(p.struct rtems_termios_tty,int).int""")
230    l_ioctl = property(_termiostypes.rtems_termios_linesw_l_ioctl_get, _termiostypes.rtems_termios_linesw_l_ioctl_set, doc=r"""l_ioctl : p.f(p.struct rtems_termios_tty,p.rtems_libio_ioctl_args_t).int""")
231    l_modem = property(_termiostypes.rtems_termios_linesw_l_modem_get, _termiostypes.rtems_termios_linesw_l_modem_set, doc=r"""l_modem : p.f(p.struct rtems_termios_tty,int).int""")
232
233    def __init__(self):
234        r"""__init__(rtems_termios_linesw self) -> rtems_termios_linesw"""
235        _termiostypes.rtems_termios_linesw_swiginit(self, _termiostypes.new_rtems_termios_linesw())
236    __swig_destroy__ = _termiostypes.delete_rtems_termios_linesw
237
238# Register rtems_termios_linesw in _termiostypes:
239_termiostypes.rtems_termios_linesw_swigregister(rtems_termios_linesw)
240
241def rtems_termios_rxirq_occured(tty):
242    r"""
243    rtems_termios_rxirq_occured(rtems_termios_tty tty)
244
245    Parameters
246    ----------
247    tty: struct rtems_termios_tty *
248
249    """
250    return _termiostypes.rtems_termios_rxirq_occured(tty)
251
252def rtems_termios_puts(buf, len, tty):
253    r"""
254    rtems_termios_puts(void const * buf, size_t len, rtems_termios_tty tty)
255
256    Parameters
257    ----------
258    buf: void const *
259    len: size_t
260    tty: struct rtems_termios_tty *
261
262    """
263    return _termiostypes.rtems_termios_puts(buf, len, tty)
264TTYDISC = _termiostypes.TTYDISC
265
266TABLDISC = _termiostypes.TABLDISC
267
268SLIPDISC = _termiostypes.SLIPDISC
269
270PPPDISC = _termiostypes.PPPDISC
271
272MAXLDISC = _termiostypes.MAXLDISC
273
274
275def rtems_termios_number_to_baud(baud):
276    r"""
277    Converts the Integral Baud value *baud* to the Termios Control Flag
278    Representation
279
280
281    """
282    return _termiostypes.rtems_termios_number_to_baud(baud)
283
284def rtems_termios_baud_to_number(baud):
285    r"""
286    Converts the baud flags to an integral baud value.
287
288
289    """
290    return _termiostypes.rtems_termios_baud_to_number(baud)
291
292def rtems_termios_baud_to_index(termios_baud):
293    r""" Convert Bxxx Constant to Index"""
294    return _termiostypes.rtems_termios_baud_to_index(termios_baud)
295
296def rtems_termios_set_initial_baud(tty, baud):
297    r"""Sets the initial *baud* in the Termios context *tty*."""
298    return _termiostypes.rtems_termios_set_initial_baud(tty, baud)
299
300def rtems_termios_kqfilter(iop, kn):
301    r"""
302    Termios kqueue() filter filesystem node handler
303
304    Real implementation is provided by libbsd.
305    """
306    return _termiostypes.rtems_termios_kqfilter(iop, kn)
307
308def rtems_termios_mmap(iop, addr, len, prot, off):
309    r"""
310    Termios mmap() filter filesystem node handler
311
312    Real implementation is provided by libbsd.
313    """
314    return _termiostypes.rtems_termios_mmap(iop, addr, len, prot, off)
315
316def rtems_termios_poll(iop, events):
317    r"""
318    Termios poll() filesystem node handler.
319
320    Real implementation is provided by libbsd.
321    """
322    return _termiostypes.rtems_termios_poll(iop, events)
323OLCUC = _termiostypes.OLCUC
324
325IUCLC = _termiostypes.IUCLC
326
327RTEMS_TERMIOS_NUMBER_BAUD_RATES = _termiostypes.RTEMS_TERMIOS_NUMBER_BAUD_RATES
328
329
330cvar = _termiostypes.cvar
331rtems_termios_baud_table = cvar.rtems_termios_baud_table