2 * Acess2 Kernel - Keyboard Driver
3 * - By John Hodge (thePowersGang)
6 * - Keyboard driver core
8 * TODO: Make the key transation code more general (for non-US layouts)
9 * TODO: Support multiple virtual keyboards
12 #define VERSION VER2(1,0)
16 #include <Input/Keyboard/include/keyboard.h>
17 #include "keymap_int.h"
18 #include "layout_kbdus.h"
20 #include <debug_hooks.h>
22 #define USE_KERNEL_MAGIC 1
25 int Keyboard_Install(char **Arguments);
26 int Keyboard_Cleanup(void);
28 tKeymap *Keyboard_LoadMap(const char *Name);
29 void Keyboard_FreeMap(tKeymap *Keymap);
30 // - "User" side (Actually VT)
31 int Keyboard_IOCtl(tVFS_Node *Node, int ID, void *Data);
33 tKeyboard *Keyboard_CreateInstance(int MaxSym, const char *Name);
34 void Keyboard_RemoveInstance(tKeyboard *Instance);
35 void Keyboard_HandleKey(tKeyboard *Source, Uint32 HIDKeySym);
38 MODULE_DEFINE(0, VERSION, Keyboard, Keyboard_Install, Keyboard_Cleanup, NULL);
39 tVFS_NodeType gKB_NodeType = {
40 .IOCtl = Keyboard_IOCtl
42 tDevFS_Driver gKB_DevInfo = {
44 { .Type = &gKB_NodeType }
47 int giKB_MagicAddress = 0;
48 int giKB_MagicAddressPos = 0;
53 * \brief Initialise the keyboard driver
55 int Keyboard_Install(char **Arguments)
57 /// - Register with DevFS
58 DevFS_AddDevice( &gKB_DevInfo );
63 * \brief Pre-unload cleanup function
65 int Keyboard_Cleanup(void)
67 // TODO: Do I need this?
71 // --- Map Management ---
73 * \brief Load an arbitary keyboard map
74 * \param Name Keymap name (e.g. "en-us")
75 * \return Keymap pointer
77 tKeymap *Keyboard_int_LoadMap(const char *Name)
79 Log_Warning("Keyboard", "TOD: Impliment Keyboard_int_LoadMap");
84 * \brief Unload a keyboard map
85 * \param Keymap Keymap to unload/free
87 void Keyboard_int_FreeMap(tKeymap *Keymap)
91 // --- VFS Interface ---
92 static const char *csaIOCTL_NAMES[] = {DRV_IOCTLNAMES, DRV_KEYBAORD_IOCTLNAMES, NULL};
94 * \brief Keyboard IOCtl
96 int Keyboard_IOCtl(tVFS_Node *Node, int Id, void *Data)
100 BASE_IOCTLS(DRV_TYPE_KEYBOARD, "Keyboard", 0x100, csaIOCTL_NAMES);
102 case KB_IOCTL_SETCALLBACK:
103 if( Threads_GetUID() != 0 ) return -1;
104 if( MM_IsUser( (tVAddr)Data ) ) return -1;
105 if( Node->ImplInt ) return 0; // Can only be set once
106 Node->ImplInt = (Uint)Data;
112 // --- Device Interface ---
114 * Create a new keyboard device instance
115 * TODO: Allow linking to other VFS nodes
116 * See Input/Keyboard/include/keyboard.h
118 tKeyboard *Keyboard_CreateInstance(int MaxSym, const char *Name)
121 int sym_bitmap_size = (MaxSym + 7)/8;
122 int string_size = strlen(Name) + 1;
124 ret = malloc( sizeof(tKeyboard) + sym_bitmap_size + string_size );
129 memset(ret, 0, sizeof(tKeyboard) + sym_bitmap_size );
131 ret->Name = (char*)ret + sizeof(tKeyboard) + sym_bitmap_size;
132 memcpy(ret->Name, Name, string_size);
133 // Set node and default keymap
134 ret->Node = &gKB_DevInfo.RootNode;
135 ret->Keymap = &gKeymap_KBDUS;
141 * Destroy a keyboard instance
142 * - See Input/Keyboard/include/keyboard.h
144 void Keyboard_RemoveInstance(tKeyboard *Instance)
147 Log_Error("Keyboard", "TODO: Implement Keyboard_RemoveInstance");
151 * Handle a key press/release event
152 * - See Input/Keyboard/include/keyboard.h
154 void Keyboard_HandleKey(tKeyboard *Source, Uint32 HIDKeySym)
162 Log_Error("Keyboard", "Passed NULL handle");
165 if( !Source->Node ) {
166 Log_Error("Keyboard", "Passed handle with NULL node");
170 bPressed = !(HIDKeySym & (1 << 31));
171 HIDKeySym &= 0x7FFFFFFF;
173 // - Determine the action (Press, Release or Refire)
175 Uint8 mask = 1 << (HIDKeySym&7);
176 int ofs = HIDKeySym / 8;
177 int oldstate = !!(Source->KeyStates[ofs] & mask);
179 // Get the state of all other devices attached
181 for( tKeyboard *kb = Source->Node->ImplPtr; kb; kb = kb->Next )
183 if( kb == Source ) continue ;
184 if( kb->MaxKeysym <= HIDKeySym ) continue ;
185 otherstate = otherstate || (kb->KeyStates[ofs] & mask);
190 Source->KeyStates[ ofs ] |= mask;
192 Source->KeyStates[ ofs ] &= ~mask;
194 // Get the final flag
197 if( !oldstate && !otherstate )
198 flag = KEY_ACTION_PRESS; // Down
200 flag = KEY_ACTION_REFIRE; // Refire
205 flag = KEY_ACTION_RELEASE; // Up
207 flag = -1; // Do nothing
211 // Translate \a State into layer
212 // TODO: Support non-trivial layouts
213 layer = !!(Source->State & 3);
216 if( flag == KEY_ACTION_RELEASE )
220 // Translate the keysym into a character
221 if( layer >= Source->Keymap->nLayers )
223 else if( HIDKeySym >= Source->Keymap->Layers[layer]->nSyms )
226 trans = Source->Keymap->Layers[layer]->Sym[HIDKeySym];
227 // - No translation in \a layer, fall back to layer=0
228 if(!trans && HIDKeySym < Source->Keymap->Layers[0]->nSyms)
229 trans = Source->Keymap->Layers[0]->Sym[HIDKeySym];
232 // Call callback (only if the action is valid)
235 tKeybardCallback Callback = (void*)Source->Node->ImplInt;
236 Callback( HIDKeySym | KEY_ACTION_RAWSYM );
237 Callback( flag | trans );
240 // TODO: Translate this into agnostic code
243 case KEYSYM_LEFTSHIFT:
244 if(bPressed) Source->State |= 1;
245 else Source->State &= ~1;
247 case KEYSYM_RIGHTSHIFT:
248 if(bPressed) Source->State |= 2;
249 else Source->State &= ~2;
253 // --- Check for Kernel Magic Combos
256 && Source->KeyStates[KEYSYM_LEFTCTRL/8] & (1 << (KEYSYM_LEFTCTRL&7))
257 && Source->KeyStates[KEYSYM_LEFTALT/8] & (1 << (KEYSYM_LEFTALT &7)) )
262 case '0': val = 0; goto _av; case '1': val = 1; goto _av;
263 case '2': val = 2; goto _av; case '3': val = 3; goto _av;
264 case '4': val = 4; goto _av; case '5': val = 5; goto _av;
265 case '6': val = 6; goto _av; case '7': val = 7; goto _av;
266 case '8': val = 8; goto _av; case '9': val = 9; goto _av;
267 case 'a': val = 10; goto _av; case 'b': val = 11; goto _av;
268 case 'c': val = 12; goto _av; case 'd': val = 13; goto _av;
269 case 'e': val = 14; goto _av; case 'f': val = 15; goto _av;
271 if(giKB_MagicAddressPos == BITS/4) break;
272 giKB_MagicAddress |= (Uint)val << giKB_MagicAddressPos;
273 giKB_MagicAddressPos ++;
276 // Instruction Tracing
278 Log("Toggle instruction tracing on %i\n", giKB_MagicAddress);
279 Threads_ToggleTrace( giKB_MagicAddress );
280 giKB_MagicAddress = 0; giKB_MagicAddressPos = 0;
284 case 'p': Threads_Dump(); return;
286 case 'h': Heap_Stats(); return;
288 case 'm': MM_DumpStatistics(); return;
295 #if defined(ARCHDIR_is_x86) || defined(ARCHDIR_is_x86_64)
297 && Source->KeyStates[KEYSYM_LEFTCTRL/8] & (1 << (KEYSYM_LEFTCTRL&7))
298 && Source->KeyStates[KEYSYM_LEFTALT/8] & (1 << (KEYSYM_LEFTALT &7)) )
300 if( HIDKeySym == KEYSYM_DELETE )
302 // Trigger triple fault
303 __asm__ __volatile__ ("lgdt (%esp) ; int $0x0");