keymap.h File Reference

Keyboard mappings. More...

#include <stdint.h>
#include <ipxe/tables.h>

Go to the source code of this file.

Data Structures
struct	keymap_key
	A remapped key. More...
struct	keymap
	A keyboard mapping. More...

Macros
#define	KEYMAP   __table ( struct keymap, "keymap" )
	Keyboard mapping table.
#define	__keymap_default   __table_entry ( KEYMAP, 01 )
	Define a default keyboard mapping.
#define	__keymap   __table_entry ( KEYMAP, 02 )
	Define a keyboard mapping.
#define	KEYMAP_MASK   0xff
	Mappable character mask.
#define	KEYMAP_PSEUDO   0x80
	Pseudo key flag.
#define	KEYMAP_CTRL   0x01000000
	Ctrl key flag.
#define	KEYMAP_CAPSLOCK   0x02000000
	CapsLock key flag.
#define	KEYMAP_CAPSLOCK_UNDO   0x04000000
	Undo CapsLock key flag.
#define	KEYMAP_CAPSLOCK_REDO   ( KEYMAP_CAPSLOCK | KEYMAP_CAPSLOCK_UNDO )
	Undo and redo CapsLock key flags.
#define	KEYMAP_ALTGR   0x08000000
	AltGr key flag.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
unsigned int	key_remap (unsigned int character)
	Remap a key.
struct keymap *	keymap_find (const char *name)
	Find keyboard map by name.
void	keymap_set (struct keymap *keymap)
	Set keyboard map.

Detailed Description

Keyboard mappings.

Definition in file keymap.h.

Macro Definition Documentation

KEYMAP

#define KEYMAP   __table ( struct keymap, "keymap" )

Keyboard mapping table.

Definition at line 41 of file keymap.h.

Referenced by keymap_find(), and TABLE_START().

__keymap_default

#define __keymap_default   __table_entry ( KEYMAP, 01 )

Define a default keyboard mapping.

Definition at line 44 of file keymap.h.

__keymap

#define __keymap   __table_entry ( KEYMAP, 02 )

Define a keyboard mapping.

Definition at line 47 of file keymap.h.

KEYMAP_MASK

#define KEYMAP_MASK   0xff

Mappable character mask.

Definition at line 50 of file keymap.h.

Referenced by key_remap().

KEYMAP_PSEUDO

#define KEYMAP_PSEUDO   0x80

Pseudo key flag.

Definition at line 53 of file keymap.h.

Referenced by bios_getchar(), and usbkbd_map().

KEYMAP_CTRL

#define KEYMAP_CTRL   0x01000000

Ctrl key flag.

Definition at line 56 of file keymap.h.

Referenced by bios_getchar(), efi_getchar(), key_remap(), and usbkbd_map().

KEYMAP_CAPSLOCK

#define KEYMAP_CAPSLOCK   0x02000000

CapsLock key flag.

Definition at line 59 of file keymap.h.

Referenced by key_remap(), and usbkbd_map().

KEYMAP_CAPSLOCK_UNDO

#define KEYMAP_CAPSLOCK_UNDO   0x04000000

Undo CapsLock key flag.

Used when the keyboard driver has already interpreted the CapsLock key, in which case the effect needs to be undone before remapping in order to correctly handle keyboard mappings that swap alphabetic and non-alphabetic keys.

Definition at line 68 of file keymap.h.

Referenced by key_remap().

KEYMAP_CAPSLOCK_REDO

#define KEYMAP_CAPSLOCK_REDO   ( KEYMAP_CAPSLOCK | KEYMAP_CAPSLOCK_UNDO )

Undo and redo CapsLock key flags.

Definition at line 71 of file keymap.h.

Referenced by bios_getchar(), and efi_getchar().

KEYMAP_ALTGR

#define KEYMAP_ALTGR   0x08000000

AltGr key flag.

Definition at line 74 of file keymap.h.

Referenced by bios_getchar(), efi_getchar(), key_remap(), and usbkbd_map().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

key_remap()

unsigned int key_remap ( unsigned int character )

extern

Remap a key.

Parameters

character

Character read from console

Return values

mapped

Mapped character

Definition at line 62 of file keymap.c.

                                                  {
        struct keymap *keymap = keymap_current;
        unsigned int mapped = ( character & KEYMAP_MASK );
        struct keymap_key *key;
 
        /* Invert case before remapping if applicable */
        if ( ( character & KEYMAP_CAPSLOCK_UNDO ) && isalpha ( mapped ) )
                mapped ^= CASE_TOGGLE;
 
        /* Select remapping table */
        key = ( ( character & KEYMAP_ALTGR ) ? keymap->altgr : keymap->basic );
 
        /* Remap via table */
        for ( ; key->from ; key++ ) {
                if ( mapped == key->from ) {
                        mapped = key->to;
                        break;
                }
        }
 
        /* Handle Ctrl-<key> and CapsLock */
        if ( isalpha ( mapped ) ) {
                if ( character & KEYMAP_CTRL ) {
                        mapped &= CTRL_MASK;
                } else if ( character & KEYMAP_CAPSLOCK ) {
                        mapped ^= CASE_TOGGLE;
                }
        }
 
        /* Clear flags */
        mapped &= ASCII_MASK;
 
        DBGC2 ( &keymap_current, "KEYMAP mapped %04x => %02x\n",
                character, mapped );
        return mapped;
}

References keymap::altgr, ASCII_MASK, keymap::basic, CASE_TOGGLE, CTRL_MASK, DBGC2, isalpha(), key, KEYMAP_ALTGR, KEYMAP_CAPSLOCK, KEYMAP_CAPSLOCK_UNDO, KEYMAP_CTRL, keymap_current, and KEYMAP_MASK.

Referenced by bios_getchar(), efi_getchar(), and usbkbd_map().

keymap_find()

struct keymap * keymap_find ( const char * name )

extern

Find keyboard map by name.

Parameters

name	Keyboard map name

Return values

keymap

Keyboard map, or NULL if not found

Definition at line 105 of file keymap.c.

                                                 {
        struct keymap *keymap;
 
        /* Find matching keyboard map */
        for_each_table_entry ( keymap, KEYMAP ) {
                if ( strcmp ( keymap->name, name ) == 0 )
                        return keymap;
        }
 
        return NULL;
}

References for_each_table_entry, KEYMAP, keymap::name, name, NULL, and strcmp().

Referenced by keymap_apply().

keymap_set()

void keymap_set ( struct keymap * keymap )

extern

Set keyboard map.

Parameters

keymap

Keyboard map, or NULL to use default

Definition at line 122 of file keymap.c.

                                          {
 
        /* Use default keymap if none specified */
        if ( ! keymap )
                keymap = keymap_start;
 
        /* Set new keyboard map */
        if ( keymap != keymap_current )
                DBGC ( &keymap_current, "KEYMAP using \"%s\"\n", keymap->name );
        keymap_current = keymap;
}

References DBGC, keymap_current, and keymap::name.

Referenced by keymap_apply().