# ========================================================================== #
#                                                                            #
#    KVMD - The main PiKVM daemon.                                           #
#                                                                            #
#    Copyright (C) 2018-2024  Maxim Devaev <mdevaev@gmail.com>               #
#                                                                            #
#    This program is free software: you can redistribute it and/or modify    #
#    it under the terms of the GNU General Public License as published by    #
#    the Free Software Foundation, either version 3 of the License, or       #
#    (at your option) any later version.                                     #
#                                                                            #
#    This program is distributed in the hope that it will be useful,         #
#    but WITHOUT ANY WARRANTY; without even the implied warranty of          #
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           #
#    GNU General Public License for more details.                            #
#                                                                            #
#    You should have received a copy of the GNU General Public License       #
#    along with this program.  If not, see <https://www.gnu.org/licenses/>.  #
#                                                                            #
# ========================================================================== #


from . import Hid


# =====
def make_keyboard_hid(report_id: (int | None)=None) -> Hid:
    return Hid(
        protocol=1,  # Keyboard protocol
        subclass=1,  # Boot interface subclass

        report_length=8,

        report_descriptor=bytes([
            # Logitech descriptor. It's very similar to https://www.kernel.org/doc/Documentation/usb/gadget_hid.txt
            # Dumped using usbhid-dump; parsed using https://eleccelerator.com/usbdescreqparser

            # Keyboard
            0x05, 0x01,  # USAGE_PAGE (Generic Desktop)
            0x09, 0x06,  # USAGE (Keyboard)
            0xA1, 0x01,  # COLLECTION (Application)

            # Report ID
            *([0x85, report_id] if report_id is not None else []),

            # Modifiers
            0x05, 0x07,  # USAGE_PAGE (Keyboard)
            0x19, 0xE0,  # USAGE_MINIMUM (Keyboard LeftControl)
            0x29, 0xE7,  # USAGE_MAXIMUM (Keyboard Right GUI)
            0x15, 0x00,  # LOGICAL_MINIMUM (0)
            0x25, 0x01,  # LOGICAL_MAXIMUM (1)
            0x75, 0x01,  # REPORT_SIZE (1)
            0x95, 0x08,  # REPORT_COUNT (8)
            0x81, 0x02,  # INPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)

            # Reserved byte
            0x95, 0x01,  # REPORT_COUNT (1)
            0x75, 0x08,  # REPORT_SIZE (8)
            0x81, 0x01,  # INPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)

            # LEDs output
            0x95, 0x05,  # REPORT_COUNT (5)
            0x75, 0x01,  # REPORT_SIZE (1)
            0x05, 0x08,  # USAGE_PAGE (LEDs)
            0x19, 0x01,  # USAGE_MINIMUM (Num Lock)
            0x29, 0x05,  # USAGE_MAXIMUM (Kana)
            0x91, 0x02,  # OUTPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)

            # Reserved 3 bits in output
            0x95, 0x01,  # REPORT_COUNT (1)
            0x75, 0x03,  # REPORT_SIZE (3)
            0x91, 0x01,  # OUTPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)

            # 6 keys
            0x95, 0x06,  # REPORT_COUNT (6)
            0x75, 0x08,  # REPORT_SIZE (8)
            0x15, 0x00,  # LOGICAL_MINIMUM (0)
            0x26, 0xFF, 0x00,  # LOGICAL_MAXIMUM (0xFF)
            0x05, 0x07,  # USAGE_PAGE (Keyboard)
            0x19, 0x00,  # USAGE_MINIMUM (Reserved)
            0x2A, 0xFF, 0x00,  # USAGE_MAXIMUM (0xFF)
            0x81, 0x00,  # INPUT (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)

            0xC0,  # END_COLLECTION
        ]),
    )