serial_mouse

  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 _serial_mouse as _serial_mouse
  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
 57SERIAL_MOUSE_DEVICE_PS2 = _serial_mouse.SERIAL_MOUSE_DEVICE_PS2
 58r"""Standard device file path for a PS2 mouse device."""
 59
 60def serial_mouse_initialize(major, minor, arg):
 61    r"""
 62     This macro defines the serial mouse device driver entry points.
 63
 64    The initialization of the serial mouse driver.
 65
 66    This method initializes the serial mouse driver.
 67
 68    :type major: rtems_device_major_number, in
 69    :param major: is the mouse device major number
 70    :type minor: rtems_device_minor_number, in
 71    :param minor: is the mouse device minor number
 72    :type arg: void, in
 73    :param arg: points to device driver arguments
 74    """
 75    return _serial_mouse.serial_mouse_initialize(major, minor, arg)
 76
 77def serial_mouse_open(major, minor, arg):
 78    r"""
 79    Open device driver entry point for the serial mouse driver.
 80
 81    This method implements the Open device driver entry
 82    point for the serial mouse driver.
 83
 84    :type major: rtems_device_major_number, in
 85    :param major: is the mouse device major number
 86    :type minor: rtems_device_minor_number, in
 87    :param minor: is the mouse device minor number
 88    :type arg: void, in
 89    :param arg: points to device driver arguments
 90    """
 91    return _serial_mouse.serial_mouse_open(major, minor, arg)
 92
 93def serial_mouse_close(major, minor, arg):
 94    r"""
 95    Close device driver entry point for the serial mouse driver.
 96
 97    This method implements the Close device driver entry
 98    point for the serial mouse driver.
 99
100    :type major: rtems_device_major_number, in
101    :param major: is the mouse device major number
102    :type minor: rtems_device_minor_number, in
103    :param minor: is the mouse device minor number
104    :type arg: void, in
105    :param arg: points to device driver arguments
106    """
107    return _serial_mouse.serial_mouse_close(major, minor, arg)
108
109def serial_mouse_read(major, minor, arg):
110    r"""
111    Read device driver entry point for the serial mouse driver.
112
113    This method implements the Read device driver entry
114    point for the serial mouse driver.
115
116    :type major: rtems_device_major_number, in
117    :param major: is the mouse device major number
118    :type minor: rtems_device_minor_number, in
119    :param minor: is the mouse device minor number
120    :type arg: void, in
121    :param arg: points to device driver arguments
122    """
123    return _serial_mouse.serial_mouse_read(major, minor, arg)
124
125def serial_mouse_write(major, minor, arg):
126    r"""
127    Write device driver entry point for the serial mouse driver.
128
129    This method implements the Write device driver entry
130    point for the serial mouse driver.
131
132    :type major: rtems_device_major_number, in
133    :param major: is the mouse device major number
134    :type minor: rtems_device_minor_number, in
135    :param minor: is the mouse device minor number
136    :type arg: void, in
137    :param arg: points to device driver arguments
138    """
139    return _serial_mouse.serial_mouse_write(major, minor, arg)
140
141def serial_mouse_control(major, minor, arg):
142    r"""
143    IO Control device driver entry point for the serial mouse driver.
144
145    This method implements the IO Control device driver entry
146    point for the serial mouse driver.
147
148    :type major: rtems_device_major_number, in
149    :param major: is the mouse device major number
150    :type minor: rtems_device_minor_number, in
151    :param minor: is the mouse device minor number
152    :type arg: void, in
153    :param arg: points to device driver arguments
154    """
155    return _serial_mouse.serial_mouse_control(major, minor, arg)
156
157def bsp_get_serial_mouse_device(name, type):
158    r"""
159    Obtain serial mouse configuration information.
160
161    This method is implemented by the BSP or application and
162    tells the driver what device to open() and what type of
163    mouse is connected.
164
165    :type name: string, in
166    :param name: will point to a string with the device name
167                   of the serial port with the mouse connected.
168    :type type: string, in
169    :param type: will point to a string with the type of mouse connected.
170    """
171    return _serial_mouse.bsp_get_serial_mouse_device(name, type)
SERIAL_MOUSE_DEVICE_PS2 = See C documentation

Standard device file path for a PS2 mouse device.

def serial_mouse_initialize(major, minor, arg):
61def serial_mouse_initialize(major, minor, arg):
62    r"""
63     This macro defines the serial mouse device driver entry points.
64
65    The initialization of the serial mouse driver.
66
67    This method initializes the serial mouse driver.
68
69    :type major: rtems_device_major_number, in
70    :param major: is the mouse device major number
71    :type minor: rtems_device_minor_number, in
72    :param minor: is the mouse device minor number
73    :type arg: void, in
74    :param arg: points to device driver arguments
75    """
76    return _serial_mouse.serial_mouse_initialize(major, minor, arg)

This macro defines the serial mouse device driver entry points.

The initialization of the serial mouse driver.

This method initializes the serial mouse driver.

Parameters
  • major: is the mouse device major number
  • minor: is the mouse device minor number
  • arg: points to device driver arguments
def serial_mouse_open(major, minor, arg):
78def serial_mouse_open(major, minor, arg):
79    r"""
80    Open device driver entry point for the serial mouse driver.
81
82    This method implements the Open device driver entry
83    point for the serial mouse driver.
84
85    :type major: rtems_device_major_number, in
86    :param major: is the mouse device major number
87    :type minor: rtems_device_minor_number, in
88    :param minor: is the mouse device minor number
89    :type arg: void, in
90    :param arg: points to device driver arguments
91    """
92    return _serial_mouse.serial_mouse_open(major, minor, arg)

Open device driver entry point for the serial mouse driver.

This method implements the Open device driver entry point for the serial mouse driver.

Parameters
  • major: is the mouse device major number
  • minor: is the mouse device minor number
  • arg: points to device driver arguments
def serial_mouse_close(major, minor, arg):
 94def serial_mouse_close(major, minor, arg):
 95    r"""
 96    Close device driver entry point for the serial mouse driver.
 97
 98    This method implements the Close device driver entry
 99    point for the serial mouse driver.
100
101    :type major: rtems_device_major_number, in
102    :param major: is the mouse device major number
103    :type minor: rtems_device_minor_number, in
104    :param minor: is the mouse device minor number
105    :type arg: void, in
106    :param arg: points to device driver arguments
107    """
108    return _serial_mouse.serial_mouse_close(major, minor, arg)

Close device driver entry point for the serial mouse driver.

This method implements the Close device driver entry point for the serial mouse driver.

Parameters
  • major: is the mouse device major number
  • minor: is the mouse device minor number
  • arg: points to device driver arguments
def serial_mouse_read(major, minor, arg):
110def serial_mouse_read(major, minor, arg):
111    r"""
112    Read device driver entry point for the serial mouse driver.
113
114    This method implements the Read device driver entry
115    point for the serial mouse driver.
116
117    :type major: rtems_device_major_number, in
118    :param major: is the mouse device major number
119    :type minor: rtems_device_minor_number, in
120    :param minor: is the mouse device minor number
121    :type arg: void, in
122    :param arg: points to device driver arguments
123    """
124    return _serial_mouse.serial_mouse_read(major, minor, arg)

Read device driver entry point for the serial mouse driver.

This method implements the Read device driver entry point for the serial mouse driver.

Parameters
  • major: is the mouse device major number
  • minor: is the mouse device minor number
  • arg: points to device driver arguments
def serial_mouse_write(major, minor, arg):
126def serial_mouse_write(major, minor, arg):
127    r"""
128    Write device driver entry point for the serial mouse driver.
129
130    This method implements the Write device driver entry
131    point for the serial mouse driver.
132
133    :type major: rtems_device_major_number, in
134    :param major: is the mouse device major number
135    :type minor: rtems_device_minor_number, in
136    :param minor: is the mouse device minor number
137    :type arg: void, in
138    :param arg: points to device driver arguments
139    """
140    return _serial_mouse.serial_mouse_write(major, minor, arg)

Write device driver entry point for the serial mouse driver.

This method implements the Write device driver entry point for the serial mouse driver.

Parameters
  • major: is the mouse device major number
  • minor: is the mouse device minor number
  • arg: points to device driver arguments
def serial_mouse_control(major, minor, arg):
142def serial_mouse_control(major, minor, arg):
143    r"""
144    IO Control device driver entry point for the serial mouse driver.
145
146    This method implements the IO Control device driver entry
147    point for the serial mouse driver.
148
149    :type major: rtems_device_major_number, in
150    :param major: is the mouse device major number
151    :type minor: rtems_device_minor_number, in
152    :param minor: is the mouse device minor number
153    :type arg: void, in
154    :param arg: points to device driver arguments
155    """
156    return _serial_mouse.serial_mouse_control(major, minor, arg)

IO Control device driver entry point for the serial mouse driver.

This method implements the IO Control device driver entry point for the serial mouse driver.

Parameters
  • major: is the mouse device major number
  • minor: is the mouse device minor number
  • arg: points to device driver arguments
def bsp_get_serial_mouse_device(name, type):
158def bsp_get_serial_mouse_device(name, type):
159    r"""
160    Obtain serial mouse configuration information.
161
162    This method is implemented by the BSP or application and
163    tells the driver what device to open() and what type of
164    mouse is connected.
165
166    :type name: string, in
167    :param name: will point to a string with the device name
168                   of the serial port with the mouse connected.
169    :type type: string, in
170    :param type: will point to a string with the type of mouse connected.
171    """
172    return _serial_mouse.bsp_get_serial_mouse_device(name, type)

Obtain serial mouse configuration information.

This method is implemented by the BSP or application and tells the driver what device to open() and what type of mouse is connected.

Parameters
  • name: will point to a string with the device name of the serial port with the mouse connected.
  • type: will point to a string with the type of mouse connected.