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"
21 #define USE_KERNEL_MAGIC 1
25 extern void Threads_ToggleTrace(int TID);
26 extern void Threads_Dump(void);
27 extern void Heap_Stats(void);
31 int Keyboard_Install(char **Arguments);
32 void Keyboard_Cleanup(void);
34 tKeymap *Keyboard_LoadMap(const char *Name);
35 void Keyboard_FreeMap(tKeymap *Keymap);
36 // - "User" side (Actually VT)
37 int Keyboard_IOCtl(tVFS_Node *Node, int ID, void *Data);
39 tKeyboard *Keyboard_CreateInstance(int MaxSym, const char *Name);
40 void Keyboard_RemoveInstance(tKeyboard *Instance);
41 void Keyboard_HandleKey(tKeyboard *Source, Uint32 HIDKeySym);
44 MODULE_DEFINE(0, VERSION, Keyboard, Keyboard_Install, Keyboard_Cleanup, NULL);
45 tVFS_NodeType gKB_NodeType = {
46 .IOCtl = Keyboard_IOCtl
48 tDevFS_Driver gKB_DevInfo = {
50 { .Type = &gKB_NodeType }
53 int giKB_MagicAddress = 0;
54 int giKB_MagicAddressPos = 0;
59 * \brief Initialise the keyboard driver
61 int Keyboard_Install(char **Arguments)
63 /// - Register with DevFS
64 DevFS_AddDevice( &gKB_DevInfo );
69 * \brief Pre-unload cleanup function
71 void Keyboard_Cleanup(void)
73 // TODO: Do I need this?
76 // --- Map Management ---
78 * \brief Load an arbitary keyboard map
79 * \param Name Keymap name (e.g. "en-us")
80 * \return Keymap pointer
82 tKeymap *Keyboard_int_LoadMap(const char *Name)
84 Log_Warning("Keyboard", "TOD: Impliment Keyboard_int_LoadMap");
89 * \brief Unload a keyboard map
90 * \param Keymap Keymap to unload/free
92 void Keyboard_int_FreeMap(tKeymap *Keymap)
96 // --- VFS Interface ---
97 static const char *csaIOCTL_NAMES[] = {DRV_IOCTLNAMES, DRV_KEYBAORD_IOCTLNAMES, NULL};
99 * \brief Keyboard IOCtl
101 int Keyboard_IOCtl(tVFS_Node *Node, int Id, void *Data)
105 BASE_IOCTLS(DRV_TYPE_KEYBOARD, "Keyboard", 0x100, csaIOCTL_NAMES);
107 case KB_IOCTL_SETCALLBACK:
108 if( Threads_GetUID() != 0 ) return -1;
109 if( MM_IsUser( (tVAddr)Data ) ) return -1;
110 if( Node->ImplInt ) return 0; // Can only be set once
111 Node->ImplInt = (Uint)Data;
117 // --- Device Interface ---
119 * Create a new keyboard device instance
120 * TODO: Allow linking to other VFS nodes
121 * See Input/Keyboard/include/keyboard.h
123 tKeyboard *Keyboard_CreateInstance(int MaxSym, const char *Name)
126 int sym_bitmap_size = (MaxSym + 7)/8;
127 int string_size = strlen(Name) + 1;
129 ret = malloc( sizeof(tKeyboard) + sym_bitmap_size + string_size );
134 memset(ret, 0, sizeof(tKeyboard) + sym_bitmap_size );
136 ret->Name = (char*)ret + sizeof(tKeyboard) + sym_bitmap_size;
137 memcpy(ret->Name, Name, string_size);
138 // Set node and default keymap
139 ret->Node = &gKB_DevInfo.RootNode;
140 ret->Keymap = &gKeymap_KBDUS;
146 * Destroy a keyboard instance
147 * - See Input/Keyboard/include/keyboard.h
149 void Keyboard_RemoveInstance(tKeyboard *Instance)
152 Log_Error("Keyboard", "TODO: Implement Keyboard_RemoveInstance");
156 * Handle a key press/release event
157 * - See Input/Keyboard/include/keyboard.h
159 void Keyboard_HandleKey(tKeyboard *Source, Uint32 HIDKeySym)
166 bPressed = !(HIDKeySym & (1 << 31));
167 HIDKeySym &= 0x7FFFFFFF;
169 // - Determine the action (Press, Release or Refire)
171 Uint8 mask = 1 << (HIDKeySym&7);
172 int ofs = HIDKeySym / 8;
173 int oldstate = !!(Source->KeyStates[ofs] & mask);
175 // Get the state of all other devices attached
177 for( tKeyboard *kb = Source->Node->ImplPtr; kb; kb = kb->Next )
179 if( kb == Source ) continue ;
180 if( kb->MaxKeysym <= HIDKeySym ) continue ;
181 otherstate = otherstate || (kb->KeyStates[ofs] & mask);
186 Source->KeyStates[ ofs ] |= mask;
188 Source->KeyStates[ ofs ] &= ~mask;
190 // Get the final flag
193 if( !oldstate && !otherstate )
194 flag = KEY_ACTION_PRESS; // Down
196 flag = KEY_ACTION_REFIRE; // Refire
201 flag = KEY_ACTION_RELEASE; // Up
203 flag = -1; // Do nothing
207 // Translate \a State into layer
208 // TODO: Support non-trivial layouts
209 layer = !!(Source->State & 3);
212 if( flag == KEY_ACTION_RELEASE )
216 // Translate the keysym into a character
217 if( layer >= Source->Keymap->nLayers )
219 else if( HIDKeySym >= Source->Keymap->Layers[layer]->nSyms )
222 trans = Source->Keymap->Layers[layer]->Sym[HIDKeySym];
223 // - No translation in \a layer, fall back to layer=0
224 if(!trans && HIDKeySym < Source->Keymap->Layers[0]->nSyms)
225 trans = Source->Keymap->Layers[0]->Sym[HIDKeySym];
228 // Call callback (only if the action is valid)
231 tKeybardCallback Callback = (void*)Source->Node->ImplInt;
232 Callback( HIDKeySym | KEY_ACTION_RAWSYM );
233 Callback( flag | trans );
236 // TODO: Translate this into agnostic code
239 case KEYSYM_LEFTSHIFT:
240 if(bPressed) Source->State |= 1;
241 else Source->State &= ~1;
243 case KEYSYM_RIGHTSHIFT:
244 if(bPressed) Source->State |= 2;
245 else Source->State &= ~2;
249 // --- Check for Kernel Magic Combos
252 && Source->KeyStates[KEYSYM_LEFTCTRL/8] & (1 << (KEYSYM_LEFTCTRL&7))
253 && Source->KeyStates[KEYSYM_LEFTALT/8] & (1 << (KEYSYM_LEFTALT &7)) )
258 case '0': val = 0; goto _av; case '1': val = 1; goto _av;
259 case '2': val = 2; goto _av; case '3': val = 3; goto _av;
260 case '4': val = 4; goto _av; case '5': val = 5; goto _av;
261 case '6': val = 6; goto _av; case '7': val = 7; goto _av;
262 case '8': val = 8; goto _av; case '9': val = 9; goto _av;
263 case 'a': val = 10; goto _av; case 'b': val = 11; goto _av;
264 case 'c': val = 12; goto _av; case 'd': val = 13; goto _av;
265 case 'e': val = 14; goto _av; case 'f': val = 15; goto _av;
267 if(giKB_MagicAddressPos == BITS/4) break;
268 giKB_MagicAddress |= (Uint)val << giKB_MagicAddressPos;
269 giKB_MagicAddressPos ++;
272 // Instruction Tracing
274 Log("Toggle instruction tracing on %i\n", giKB_MagicAddress);
275 Threads_ToggleTrace( giKB_MagicAddress );
276 giKB_MagicAddress = 0; giKB_MagicAddressPos = 0;
280 case 'p': Threads_Dump(); return;
282 case 'h': Heap_Stats(); return;
284 case 'm': MM_DumpStatistics(); return;