apps/usb_keymaps.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2009 Tomer Shalev
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #include "config.h"
  22
  23 #ifdef USB_ENABLE_HID
  24 #include "action.h"
  25 #include "lang.h"
  26 #include "usbstack/usb_hid.h"
  27 //#define LOGF_ENABLE
  28 #include "logf.h"
  29
  30 #define MODIFIER(modifier, key) ((key) | (modifier << 8))
  31
  32 #define ALT(key) MODIFIER(HID_KEYBOARD_LEFT_ALT, key)
  33 #define CTRL(key) MODIFIER(HID_KEYBOARD_LEFT_CONTROL, key)
  34 #define SHIFT(key) MODIFIER(HID_KEYBOARD_LEFT_SHIFT, key)
  35
  36 #define NUM_KEY_MAPPINGS (sizeof(hid_key_mappings) / \
  37         sizeof(hid_key_mappings[0]))
  38
  39 typedef struct
  40 {
  41     int action;
  42     int id;
  43 } mapping_t;
  44
  45 typedef struct
  46 {
  47     int lang_name;
  48     int context;
  49     usage_page_t usage_page;
  50     mapping_t mapping[];
  51 } hid_key_mapping_t;
  52
  53 static const hid_key_mapping_t hid_key_mapping_multimedia = {
  54     LANG_MULTIMEDIA_MODE,
  55     CONTEXT_USB_HID_MODE_MULTIMEDIA,
  56     HID_USAGE_PAGE_CONSUMER,
  57     {
  58         { ACTION_USB_HID_MULTIMEDIA_VOLUME_UP,           HID_CONSUMER_USAGE_VOLUME_INCREMENT },
  59         { ACTION_USB_HID_MULTIMEDIA_VOLUME_DOWN,         HID_CONSUMER_USAGE_VOLUME_DECREMENT },
  60         { ACTION_USB_HID_MULTIMEDIA_VOLUME_MUTE,         HID_CONSUMER_USAGE_MUTE },
  61         { ACTION_USB_HID_MULTIMEDIA_PLAYBACK_PLAY_PAUSE, HID_CONSUMER_USAGE_PLAY_PAUSE },
  62         { ACTION_USB_HID_MULTIMEDIA_PLAYBACK_STOP,       HID_CONSUMER_USAGE_STOP },
  63         { ACTION_USB_HID_MULTIMEDIA_PLAYBACK_TRACK_PREV, HID_CONSUMER_USAGE_SCAN_PREVIOUS_TRACK },
  64         { ACTION_USB_HID_MULTIMEDIA_PLAYBACK_TRACK_NEXT, HID_CONSUMER_USAGE_SCAN_NEXT_TRACK },
  65         { 0,                     0 },
  66     }
  67 };
  68
  69 static const hid_key_mapping_t hid_key_mapping_presentation = {
  70     LANG_PRESENTATION_MODE,
  71     CONTEXT_USB_HID_MODE_PRESENTATION,
  72     HID_USAGE_PAGE_KEYBOARD_KEYPAD,
  73     {
  74         { ACTION_USB_HID_PRESENTATION_SLIDESHOW_START, HID_KEYBOARD_F5 },
  75         { ACTION_USB_HID_PRESENTATION_SLIDESHOW_LEAVE, HID_KEYBOARD_ESCAPE },
  76         { ACTION_USB_HID_PRESENTATION_SLIDE_PREV,      HID_KEYBOARD_P },
  77         { ACTION_USB_HID_PRESENTATION_SLIDE_NEXT,      HID_KEYBOARD_N },
  78         { ACTION_USB_HID_PRESENTATION_SLIDE_FIRST,     HID_KEYBOARD_HOME },
  79         { ACTION_USB_HID_PRESENTATION_SLIDE_LAST,      HID_KEYBOARD_END },
  80         { ACTION_USB_HID_PRESENTATION_SCREEN_BLACK,    HID_KEYBOARD_DOT },
  81         { ACTION_USB_HID_PRESENTATION_SCREEN_WHITE,    HID_KEYBOARD_COMMA },
  82         { ACTION_USB_HID_PRESENTATION_LINK_PREV,       SHIFT(HID_KEYBOARD_TAB) },
  83         { ACTION_USB_HID_PRESENTATION_LINK_NEXT,       HID_KEYBOARD_TAB },
  84         { ACTION_USB_HID_PRESENTATION_MOUSE_CLICK,     HID_KEYBOARD_RETURN },
  85         { ACTION_USB_HID_PRESENTATION_MOUSE_OVER,      SHIFT(HID_KEYBOARD_RETURN) },
  86         { 0,                          0 },
  87     }
  88 };
  89
  90 static const hid_key_mapping_t hid_key_mapping_browser = {
  91     LANG_BROWSER_MODE,
  92     CONTEXT_USB_HID_MODE_BROWSER,
  93     HID_USAGE_PAGE_KEYBOARD_KEYPAD,
  94     {
  95         { ACTION_USB_HID_BROWSER_SCROLL_UP,        HID_KEYBOARD_UP_ARROW },
  96         { ACTION_USB_HID_BROWSER_SCROLL_DOWN,      HID_KEYBOARD_DOWN_ARROW },
  97         { ACTION_USB_HID_BROWSER_SCROLL_UP,        HID_KEYBOARD_PAGE_UP },
  98         { ACTION_USB_HID_BROWSER_SCROLL_DOWN,      HID_KEYBOARD_PAGE_DOWN },
  99         { ACTION_USB_HID_BROWSER_ZOOM_IN,          CTRL(HID_KEYPAD_PLUS) },
 100         { ACTION_USB_HID_BROWSER_ZOOM_OUT,         CTRL(HID_KEYPAD_MINUS) },
 101         { ACTION_USB_HID_BROWSER_ZOOM_RESET,       CTRL(HID_KEYPAD_0_AND_INSERT) },
 102         { ACTION_USB_HID_BROWSER_TAB_PREV,         CTRL(HID_KEYBOARD_PAGE_UP) },
 103         { ACTION_USB_HID_BROWSER_TAB_NEXT,         CTRL(HID_KEYBOARD_PAGE_DOWN) },
 104         { ACTION_USB_HID_BROWSER_TAB_CLOSE,        CTRL(HID_KEYBOARD_W) },
 105         { ACTION_USB_HID_BROWSER_HISTORY_BACK,     ALT(HID_KEYBOARD_LEFT_ARROW) },
 106         { ACTION_USB_HID_BROWSER_HISTORY_FORWARD,  ALT(HID_KEYBOARD_RIGHT_ARROW) },
 107         { ACTION_USB_HID_BROWSER_VIEW_FULL_SCREEN, HID_KEYBOARD_F11 },
 108         { 0,                          0 },
 109     }
 110 };
 111
 112 #ifdef HAVE_USB_HID_MOUSE
 113 static const hid_key_mapping_t hid_key_mapping_mouse = {
 114     LANG_MOUSE_MODE,
 115     CONTEXT_USB_HID_MODE_MOUSE,
 116     HID_USAGE_PAGE_GENERIC_DESKTOP_CONTROLS,
 117     {
 118         /* Cursor move up */
 119         { ACTION_USB_HID_MOUSE_UP,                HID_MOUSE_UP },
 120         { ACTION_USB_HID_MOUSE_UP_REP,            HID_MOUSE_UP_REP },
 121         { ACTION_USB_HID_MOUSE_LDRAG_UP,          HID_MOUSE_LDRAG_UP },
 122         { ACTION_USB_HID_MOUSE_LDRAG_UP_REP,      HID_MOUSE_LDRAG_UP_REP },
 123         { ACTION_USB_HID_MOUSE_RDRAG_UP,          HID_MOUSE_RDRAG_UP },
 124         { ACTION_USB_HID_MOUSE_RDRAG_UP_REP,      HID_MOUSE_RDRAG_UP_REP },
 125         /* Cursor move down */
 126         { ACTION_USB_HID_MOUSE_DOWN,              HID_MOUSE_DOWN },
 127         { ACTION_USB_HID_MOUSE_DOWN_REP,          HID_MOUSE_DOWN_REP },
 128         { ACTION_USB_HID_MOUSE_LDRAG_DOWN,        HID_MOUSE_LDRAG_DOWN },
 129         { ACTION_USB_HID_MOUSE_LDRAG_DOWN_REP,    HID_MOUSE_LDRAG_DOWN_REP },
 130         { ACTION_USB_HID_MOUSE_RDRAG_DOWN,        HID_MOUSE_RDRAG_DOWN },
 131         { ACTION_USB_HID_MOUSE_RDRAG_DOWN_REP,    HID_MOUSE_RDRAG_DOWN_REP },
 132         /* Cursor move left */
 133         { ACTION_USB_HID_MOUSE_LEFT,              HID_MOUSE_LEFT },
 134         { ACTION_USB_HID_MOUSE_LEFT_REP,          HID_MOUSE_LEFT_REP },
 135         { ACTION_USB_HID_MOUSE_LDRAG_LEFT,        HID_MOUSE_LDRAG_LEFT },
 136         { ACTION_USB_HID_MOUSE_LDRAG_LEFT_REP,    HID_MOUSE_LDRAG_LEFT_REP },
 137         { ACTION_USB_HID_MOUSE_RDRAG_LEFT,        HID_MOUSE_RDRAG_LEFT },
 138         { ACTION_USB_HID_MOUSE_RDRAG_LEFT_REP,    HID_MOUSE_RDRAG_LEFT_REP },
 139         /* Cursor move right */
 140         { ACTION_USB_HID_MOUSE_RIGHT,             HID_MOUSE_RIGHT },
 141         { ACTION_USB_HID_MOUSE_RIGHT_REP,         HID_MOUSE_RIGHT_REP },
 142         { ACTION_USB_HID_MOUSE_LDRAG_RIGHT,       HID_MOUSE_LDRAG_RIGHT },
 143         { ACTION_USB_HID_MOUSE_LDRAG_RIGHT_REP,   HID_MOUSE_LDRAG_RIGHT_REP },
 144         { ACTION_USB_HID_MOUSE_RDRAG_RIGHT,       HID_MOUSE_RDRAG_RIGHT },
 145         { ACTION_USB_HID_MOUSE_RDRAG_RIGHT_REP,   HID_MOUSE_RDRAG_RIGHT_REP },
 146         /* Mouse button left-click */
 147         { ACTION_USB_HID_MOUSE_BUTTON_LEFT,       HID_MOUSE_BUTTON_LEFT },
 148         { ACTION_USB_HID_MOUSE_BUTTON_LEFT_REL,   HID_MOUSE_BUTTON_LEFT_REL },
 149         /* Mouse button right-click */
 150         { ACTION_USB_HID_MOUSE_BUTTON_RIGHT,      HID_MOUSE_BUTTON_RIGHT },
 151         { ACTION_USB_HID_MOUSE_BUTTON_RIGHT_REL,  HID_MOUSE_BUTTON_RIGHT_REL },
 152         /* Mouse wheel scroll up */
 153         { ACTION_USB_HID_MOUSE_WHEEL_SCROLL_UP,   HID_MOUSE_SCROLL_UP },
 154         /* Mouse wheel scroll down */
 155         { ACTION_USB_HID_MOUSE_WHEEL_SCROLL_DOWN, HID_MOUSE_SCROLL_DOWN },
 156         { 0,                                     0 },
 157     }
 158 };
 159
 160 #define USB_KEYPAD_MODE_MOUSE 3 /* Value of the mouse setting (hard-coded) */
 161 #endif /* HAVE_USB_HID_MOUSE */
 162
 163 static const hid_key_mapping_t *hid_key_mappings[] =
 164 {
 165     &hid_key_mapping_multimedia,
 166     &hid_key_mapping_presentation,
 167     &hid_key_mapping_browser,
 168 #ifdef HAVE_USB_HID_MOUSE
 169     &hid_key_mapping_mouse,
 170 #endif
 171 };
 172
 173 extern int usb_keypad_mode;
 174
 175 int get_hid_usb_action(void)
 176 {
 177     int action;
 178     const hid_key_mapping_t *key_mapping = hid_key_mappings[usb_keypad_mode];
 179
 180     action = get_action(key_mapping->context, HZ/4);
 181     /* Skip key mappings in a cyclic way */
 182     if (action == ACTION_USB_HID_MODE_SWITCH_NEXT)
 183     {
 184         /* TODO: Use clamp_value_wrap() */
 185         usb_keypad_mode = (usb_keypad_mode + 1) % NUM_KEY_MAPPINGS;
 186     }
 187     else if (action == ACTION_USB_HID_MODE_SWITCH_PREV)
 188     {
 189         /* TODO: Use clamp_value_wrap() */
 190         usb_keypad_mode = (usb_keypad_mode - 1) % NUM_KEY_MAPPINGS;
 191     }
 192     else if (action > ACTION_USB_HID_FIRST && action < ACTION_USB_HID_LAST)
 193     {
 194         const mapping_t *mapping;
 195         const hid_key_mapping_t *key_mapping =
 196             hid_key_mappings[usb_keypad_mode];
 197
 198         for (mapping = key_mapping->mapping; mapping->action; mapping++)
 199         {
 200             if (action == mapping->action)
 201             {
 202                 logf("Action %d", action);
 203                 usb_hid_send(key_mapping->usage_page, mapping->id);
 204                 break;
 205             }
 206         }
 207 #ifdef DEBUG
 208         if (!mapping->action)
 209             logf("Action %d not found", action);
 210 #endif
 211     }
 212
 213     return action;
 214 }
 215
 216 int keypad_mode_name_get(void)
 217 {
 218     return hid_key_mappings[usb_keypad_mode]->lang_name;
 219 }
 220
 221 #endif