mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-08-18 16:05:05 +00:00
dc3f6104b8
- And Tab5 keyboard improvements - Usb host keyboard improvements - Symbols - Requires the device.py change from CL-32 PR but that only affects visuals and not build breaking
84 lines
2.6 KiB
C
84 lines
2.6 KiB
C
// SPDX-License-Identifier: Apache-2.0
|
|
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct Device;
|
|
struct DeviceType;
|
|
|
|
typedef void* UsbHidQueueHandle;
|
|
|
|
/** Key values — numerically identical to lv_key_t so no translation is needed. */
|
|
typedef enum {
|
|
USB_HID_KEY_UP = 17,
|
|
USB_HID_KEY_DOWN = 18,
|
|
USB_HID_KEY_RIGHT = 19,
|
|
USB_HID_KEY_LEFT = 20,
|
|
USB_HID_KEY_ESC = 27,
|
|
USB_HID_KEY_DEL = 127,
|
|
USB_HID_KEY_BACKSPACE = 8,
|
|
USB_HID_KEY_ENTER = 10,
|
|
USB_HID_KEY_NEXT = 9,
|
|
USB_HID_KEY_PREV = 11,
|
|
USB_HID_KEY_HOME = 2,
|
|
USB_HID_KEY_END = 3,
|
|
} UsbHidKey;
|
|
|
|
typedef enum {
|
|
USB_HID_EVENT_KEY,
|
|
USB_HID_EVENT_MOUSE_MOVE,
|
|
USB_HID_EVENT_MOUSE_BTN,
|
|
USB_HID_EVENT_SCROLL,
|
|
USB_HID_EVENT_KEYBOARD_CONNECTED,
|
|
USB_HID_EVENT_KEYBOARD_DISCONNECTED,
|
|
USB_HID_EVENT_MOUSE_CONNECTED,
|
|
USB_HID_EVENT_MOUSE_DISCONNECTED,
|
|
} UsbHidEventType;
|
|
|
|
typedef struct {
|
|
UsbHidEventType type;
|
|
union {
|
|
/**
|
|
* @brief A key press or release.
|
|
*
|
|
* `ctrl` and `alt` report the modifiers separately rather than folding them into
|
|
* `key_code`, because the two encodings collide: the C0 control codes a terminal expects
|
|
* for Ctrl chords (Ctrl+C is 0x03, Ctrl+K is 0x0B) overlap the UsbHidKey constants above
|
|
* (USB_HID_KEY_END is 3, USB_HID_KEY_PREV is 11). A consumer wanting control codes derives
|
|
* them here, e.g.
|
|
* `((key_code >= 'a' && key_code <= 'z') || (key_code >= 'A' && key_code <= 'Z')) ?
|
|
* (key_code & 0x1F) : key_code`.
|
|
*/
|
|
struct { uint32_t key_code; bool pressed; bool ctrl; bool alt; } key;
|
|
struct { int32_t dx; int32_t dy; } mouse_move;
|
|
struct { bool button1; bool button2; } mouse_btn;
|
|
struct { int32_t delta; } scroll;
|
|
};
|
|
} UsbHidEvent;
|
|
|
|
struct UsbHidApi {
|
|
bool (*is_connected)(struct Device* device);
|
|
bool (*subscribe)(struct Device* device, UsbHidQueueHandle event_queue);
|
|
void (*unsubscribe)(struct Device* device, UsbHidQueueHandle event_queue);
|
|
};
|
|
|
|
extern const struct DeviceType USB_HOST_HID_TYPE;
|
|
|
|
/** Returns true if any HID device (keyboard or mouse) is currently connected. */
|
|
bool usb_host_hid_is_connected(struct Device* device);
|
|
|
|
/** Subscribe a FreeRTOS queue to receive UsbHidEvent items from the HID driver. */
|
|
bool usb_host_hid_subscribe(struct Device* device, UsbHidQueueHandle event_queue);
|
|
|
|
/** Unsubscribe a previously subscribed queue. */
|
|
void usb_host_hid_unsubscribe(struct Device* device, UsbHidQueueHandle event_queue);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|