Zephyr SDL Keyboard GPIO Emulator 바인딩

:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: zephyr,gpio-emul-sdl
.. _dtbinding_zephyr_gpio_emul_sdl:

zephyr,gpio-emul-sdl
####################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

Description
***********



.. code-block:: none

   SDL keyboard GPIO input Emulator

   Simulate GPIO state/interrupts using SDL keyboard events. This node has
   to be a child of a `zephyr,gpio-emul` compatible.
   Add a list of scancodes for the desired keys to be mapped.

   This driver uses USB HID scancodes, they are different from linux key codes,
   and thus do not match Zephyr code values as described in input-event-codes.h.
   Refer to https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf
   section Keyboard/Keypad (p53) for a list of scancode values.

   The following example maps the first 3 numeric keys to GPIO pins:
   - Scancode 30: "Keyboard 1 and !", mapped to gpio0 0
   - Scancode 31: "Keyboard 2 and @", mapped to gpio0 1
   - Scancode 32: "Keyboard 3 and \#", mapped to gpio0 2

   The "typical position" column from HID table suggests to match them
   with standard keycode values 2, 3 and 4, corresponding to
   INPUT_KEY_1, INPUT_KEY_2 and INPUT_KEY_3 in input-event-codes.h.

   /* gpio0 has to be a zephyr,gpio-emul device */
   &gpio0 {
     ngpios = <3>;

     sdl_gpio {
       compatible = "zephyr,gpio-emul-sdl";
       scancodes = <30 31 32>;
     };
   };

   keypad: keypad {
     compatible = "gpio-keys";
     key1: key1 {
       gpios = <&gpio0 0 GPIO_ACTIVE_HIGH>;
     };
     key2: key2 {
       gpios = <&gpio0 1 GPIO_ACTIVE_HIGH>;
     };
     key3: key3 {
       gpios = <&gpio0 2 GPIO_ACTIVE_HIGH>;
     };
   };

   The limitations of usage are:
   - Only active high as we don't get events for keys that aren't pressed
   - Pressing multiple keys is best effort, state will be kept but no events
     are generated once the last key is released

Properties
**********

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``scancodes``
           - ``array``
           - .. code-block:: none

                An array of SDL scancodes mapped to its GPIO index



             This property is **required**.



   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "zephyr,gpio-emul-sdl" compatible.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``wakeup-source``
           - ``boolean``
           - .. code-block:: none

                Property to identify that a device can be used as wake up source.

                When this property is provided a specific flag is set into the
                device that tells the system that the device is capable of
                wake up the system.

                Wake up capable devices are disabled (interruptions will not wake up
                the system) by default but they can be enabled at runtime if necessary.



         * - ``power-domain``
           - ``phandle``
           - .. code-block:: none


                Power domain the device belongs to.

                The device will be notified when the power domain it belongs to is either
                suspended or resumed.



         * - ``zephyr,pm-device-runtime-auto``
           - ``boolean``
           - .. code-block:: none

                Automatically configure the device for runtime power management after the
                init function runs.



         * - ``zephyr,disabling-power-states``
           - ``phandles``
           - .. code-block:: none

                List of power states that will disable this device power.



         * - ``status``
           - ``string``
           - .. code-block:: none

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`dt-important-props` for more information.

         * - ``reg``
           - ``array``
           - .. code-block:: none

                register space


             See :ref:`dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             See :ref:`dt-important-props` for more information.

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                phandle to interrupt controller node


         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device (used as device_get_binding() argument)



             See :ref:`dt-important-props` for more information.

             This property is **deprecated**.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                name of each clock


         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                number of address cells in reg property


         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                number of size cells in reg property


         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channels specifiers


         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of DMA channel specifiers


         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channels specifiers


         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of IO channel specifiers


         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                mailbox / IPM channels specifiers


         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of mailbox / IPM channel specifiers


         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().