X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=KernelLand%2FModules%2FInput%2FKeyboard%2Finclude%2Fkeyboard.h;fp=KernelLand%2FModules%2FInput%2FKeyboard%2Finclude%2Fkeyboard.h;h=d8a14f653e72ef49979eb0c35e1c440340363925;hb=66cb73e82a05896035f605c96fde8b8a68e07bb9;hp=c57539987ea2f8aa43e2c0461450590a9b706723;hpb=b3bb6d8aa7d46606a0532e2317c296da54b440d8;p=tpg%2Facess2.git

diff --git a/KernelLand/Modules/Input/Keyboard/include/keyboard.h b/KernelLand/Modules/Input/Keyboard/include/keyboard.h
index c5753998..d8a14f65 100644
--- a/KernelLand/Modules/Input/Keyboard/include/keyboard.h
+++ b/KernelLand/Modules/Input/Keyboard/include/keyboard.h
@@ -10,11 +10,39 @@
 
 #include <api_drv_keyboard.h>
 
+/**
+ * \brief Keyboard instance
+ *
+ * Used to refer to a keyboard state (current key states, keymap and destination
+ * node)
+ */
 typedef struct sKeyboard	tKeyboard;
 
+/**
+ * \brief Create a keyboard instance
+ * \param MaxSym	Maximum key symbol that could be passed to Keyboard_HandleKey
+ * \param Ident 	Identifier for this keyboard (e.g. "PS2Keyboard")
+ * \return Keyboard instance pointer
+ * 
+ * The \a MaxSym parameter is used to create a bitmap of key states
+ */
 extern tKeyboard	*Keyboard_CreateInstance(int MaxSym, const char *Ident);
+/**
+ * \brief De-register and free a keyboard instance
+ * \param Instance	Value returned by Keyboard_CreateInstance
+ */
 extern void	Keyboard_RemoveInstance(tKeyboard *Instance);
-extern void	Keyboard_HandleKey(tKeyboard *Source, Uint32 HIDKeySym);
+/**
+ * \brief Handle a key press/release event from the driver
+ * \param Instance	Keyboard instance returned by Keyboard_CreateInstance
+ * \param HIDKeySym	USB HID Key symbol (KEYSYM_* in Kernel/include/keysym.h), bit 31 denotes release
+ *
+ * The value in \a HIDKeySym is a USB HID key symbol, but this could come from anywhere.
+ * The topmost bit of the 32-bit value is used to denote the key being released, if it is set
+ * the key state is cleared and a release event is passed along. Otherwise it is set, 
+ * and a refire or a press event is passed (depending on the original key state)
+ */
+extern void	Keyboard_HandleKey(tKeyboard *Instance, Uint32 HIDKeySym);
 
 #endif