Initial HID PAD work, with GLFW only.

7 files changed, 310 insertions, 27 deletions

diff --git a/src/citra/emu_window/emu_window_glfw.cpp b/src/citra/emu_window/emu_window_glfw.cpp
index 02f524e0..0a861cff 100644
--- a/src/citra/emu_window/emu_window_glfw.cpp
+++ b/src/citra/emu_window/emu_window_glfw.cpp
@@ -8,8 +8,35 @@
 
 #include "citra/emu_window/emu_window_glfw.h"
 
-static void OnKeyEvent(GLFWwindow* win, int key, int action) {
-    // TODO(bunnei): ImplementMe
+static const KeyMap::DefaultKeyMapping default_key_map[] = {
+    { KeyMap::CitraKey(GLFW_KEY_A), HID_User::PAD_A },
+    { KeyMap::CitraKey(GLFW_KEY_B), HID_User::PAD_B },
+    { KeyMap::CitraKey(GLFW_KEY_BACKSLASH), HID_User::PAD_SELECT },
+    { KeyMap::CitraKey(GLFW_KEY_ENTER), HID_User::PAD_START },
+    { KeyMap::CitraKey(GLFW_KEY_RIGHT), HID_User::PAD_RIGHT },
+    { KeyMap::CitraKey(GLFW_KEY_LEFT), HID_User::PAD_LEFT },
+    { KeyMap::CitraKey(GLFW_KEY_UP), HID_User::PAD_UP },
+    { KeyMap::CitraKey(GLFW_KEY_DOWN), HID_User::PAD_DOWN },
+    { KeyMap::CitraKey(GLFW_KEY_R), HID_User::PAD_R },
+    { KeyMap::CitraKey(GLFW_KEY_L), HID_User::PAD_L },
+    { KeyMap::CitraKey(GLFW_KEY_X), HID_User::PAD_X },
+    { KeyMap::CitraKey(GLFW_KEY_Y), HID_User::PAD_Y },
+    { KeyMap::CitraKey(GLFW_KEY_H), HID_User::PAD_CIRCLE_RIGHT },
+    { KeyMap::CitraKey(GLFW_KEY_F), HID_User::PAD_CIRCLE_LEFT },
+    { KeyMap::CitraKey(GLFW_KEY_T), HID_User::PAD_CIRCLE_UP },
+    { KeyMap::CitraKey(GLFW_KEY_G), HID_User::PAD_CIRCLE_DOWN },
+};
+
+
+static void OnKeyEvent(GLFWwindow* win, int key, int scancode, int action, int mods) {
+    if (action == GLFW_PRESS) {
+        EmuWindow::KeyPressed(KeyMap::CitraKey(key));
+    }
+
+    if (action == GLFW_RELEASE) {
+        EmuWindow::KeyReleased(KeyMap::CitraKey(key));
+    }
+    HID_User::PADUpdateComplete();
 }
 
 static void OnWindowSizeEvent(GLFWwindow* win, int width, int height) {
@@ -20,6 +47,12 @@ static void OnWindowSizeEvent(GLFWwindow* win, int width, int height) {
 
 /// EmuWindow_GLFW constructor
 EmuWindow_GLFW::EmuWindow_GLFW() {
+
+    // Set default key mappings
+    for (int i = 0; i < ARRAY_SIZE(default_key_map); i++) {
+        KeyMap::SetKeyMapping(default_key_map[i].key, default_key_map[i].state);
+    }
+
     // Initialize the window
     if(glfwInit() != GL_TRUE) {
         printf("Failed to initialize GLFW! Exiting...");
@@ -45,7 +78,7 @@ EmuWindow_GLFW::EmuWindow_GLFW() {
     
     // Setup callbacks
     glfwSetWindowUserPointer(m_render_window, this);
-    //glfwSetKeyCallback(m_render_window, OnKeyEvent);
+    glfwSetKeyCallback(m_render_window, OnKeyEvent);
     //glfwSetWindowSizeCallback(m_render_window, OnWindowSizeEvent);
 
     DoneCurrent();
diff --git a/src/common/CMakeLists.txt b/src/common/CMakeLists.txt
index 3a82f5b8..4ae34bea 100644
--- a/src/common/CMakeLists.txt
+++ b/src/common/CMakeLists.txt
@@ -8,6 +8,7 @@ set(SRCS
             file_search.cpp
             file_util.cpp
             hash.cpp
+            key_map.cpp
             log_manager.cpp
             math_util.cpp
             mem_arena.cpp
@@ -39,6 +40,7 @@ set(HEADERS
             file_search.h
             file_util.h
             hash.h
+            key_map.h
             linear_disk_cache.h
             log.h
             log_manager.h
diff --git a/src/common/emu_window.h b/src/common/emu_window.h
index 5e2c33d7..90fbd933 100644
--- a/src/common/emu_window.h
+++ b/src/common/emu_window.h
@@ -7,6 +7,9 @@
 #include "common/common.h"
 #include "common/scm_rev.h"
 
+#include "common/key_map.h"
+#include "core/hle/service/hid.h"
+
 // Abstraction class used to provide an interface between emulation code and the frontend (e.g. SDL, 
 //  QGLWidget, GLFW, etc...)
 class EmuWindow
@@ -32,6 +35,22 @@ public:
     /// Releases (dunno if this is the "right" word) the GLFW context from the caller thread
     virtual void DoneCurrent() = 0;
 
+    static void KeyPressed(KeyMap::CitraKey key) {
+        HID_User::PADState mapped_key = KeyMap::Get3DSKey(key);
+
+        if (mapped_key.hex != HID_User::PAD_NONE.hex) {
+            HID_User::PADButtonPress(mapped_key);
+        }
+    }
+
+    static void KeyReleased(KeyMap::CitraKey key) {
+        HID_User::PADState mapped_key = KeyMap::Get3DSKey(key);
+
+        if (mapped_key.hex != HID_User::PAD_NONE.hex) {
+            HID_User::PADButtonRelease(mapped_key);
+        }
+    }
+
     Config GetConfig() const { 
         return m_config;
     }
diff --git a/src/common/key_map.cpp b/src/common/key_map.cpp
new file mode 100644
index 00000000..5941a105
--- /dev/null
+++ b/src/common/key_map.cpp
@@ -0,0 +1,21 @@
+// Copyright 2013 Dolphin Emulator Project
+// Licensed under GPLv2
+// Refer to the license.txt file included.
+
+#include "key_map.h"
+#include <map>
+
+
+namespace KeyMap {
+
+std::map<CitraKey, HID_User::PADState> g_key_map;
+
+void SetKeyMapping(CitraKey key, HID_User::PADState padState) {
+    g_key_map[key].hex = padState.hex;
+}
+
+HID_User::PADState Get3DSKey(CitraKey key) {
+    return g_key_map[key];
+}
+
+}
diff --git a/src/common/key_map.h b/src/common/key_map.h
new file mode 100644
index 00000000..7e94df61
--- /dev/null
+++ b/src/common/key_map.h
@@ -0,0 +1,35 @@
+// Copyright 2013 Dolphin Emulator Project
+// Licensed under GPLv2
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include "core/hle/service/hid.h"
+
+namespace KeyMap {
+
+class CitraKey {
+public:
+    CitraKey() : keyCode(0) {}
+    CitraKey(int code) : keyCode(code) {}
+
+    int keyCode;
+
+    bool operator < (const CitraKey &other) const {
+        return keyCode < other.keyCode;
+    }
+
+    bool operator == (const CitraKey &other) const {
+        return keyCode == other.keyCode;
+    }
+};
+
+struct DefaultKeyMapping {
+    KeyMap::CitraKey key;
+    HID_User::PADState state;
+};
+
+void SetKeyMapping(CitraKey key, HID_User::PADState padState);
+HID_User::PADState Get3DSKey(CitraKey key);
+
+}
diff --git a/src/core/hle/service/hid.cpp b/src/core/hle/service/hid.cpp
index 6a4895c9..1ef39fce 100644
--- a/src/core/hle/service/hid.cpp
+++ b/src/core/hle/service/hid.cpp
@@ -16,6 +16,121 @@ namespace HID_User {
 
 Handle g_shared_mem = 0; ///< Handle to shared memory region designated to HID_User service
 
+// Event handles
+Handle g_event_pad_or_touch_1 = 0;
+Handle g_event_pad_or_touch_2 = 0;
+Handle g_event_accelerometer = 0;
+Handle g_event_gyroscope = 0;
+Handle g_event_debug_pad = 0;
+
+// Next PAD state update information
+PADState g_next_state = {{0}};
+u32 g_next_index = 0;
+s16 g_next_circle_x = 0;
+s16 g_next_circle_y = 0;
+
+/** Gets a pointer to the PADData structure inside HID shared memory
+ */
+static inline PADData* GetPADData() {
+    if (0 == g_shared_mem)
+        return nullptr;
+
+    return reinterpret_cast<PADData*>(Kernel::GetSharedMemoryPointer(g_shared_mem, 0));
+}
+
+/** Circle PAD from keys.
+ *
+ *  This is implemented as "pushed all the way to an edge (max) or centered (0)".
+ *
+ *  Indicate the circle pad is pushed completely to the edge in 1 of 8 directions.
+ */
+void UpdateNextCirclePADState() {
+    static const s16 max_value = 0x9C;
+    g_next_circle_x = g_next_state.circle_left ? -max_value : 0x0;
+    g_next_circle_x += g_next_state.circle_right ? max_value : 0x0;
+    g_next_circle_y = g_next_state.circle_down ? -max_value : 0x0;
+    g_next_circle_y += g_next_state.circle_up ? max_value : 0x0;
+}
+
+/** Sets a PAD state (button or button combo) as pressed
+ */
+void PADButtonPress(PADState pad_state) {
+    g_next_state.hex |= pad_state.hex;
+    UpdateNextCirclePADState();
+}
+
+/** Sets a PAD state (button or button combo) as released
+ */
+void PADButtonRelease(PADState pad_state) {
+    g_next_state.hex &= ~pad_state.hex;
+    UpdateNextCirclePADState();
+}
+
+/** Called after all PAD changes to be included in this update have been made,
+ *  including both PAD key changes and analog circle PAD changes.
+ */
+void PADUpdateComplete() {
+    PADData* pad_data = GetPADData();
+
+    // Update PADData struct
+    pad_data->current_state.hex = g_next_state.hex;
+    pad_data->index = g_next_index;
+    g_next_index = (g_next_index + 1) % pad_data->entries.size();
+
+    // Get the previous PAD state
+    u32 last_entry_index = (pad_data->index - 1) % pad_data->entries.size();
+    PADState old_state = pad_data->entries[last_entry_index].current_state;
+
+    // Compute bitmask with 1s for bits different from the old state
+    PADState changed;
+    changed.hex = (g_next_state.hex ^ old_state.hex);
+
+    // Compute what was added
+    PADState additions;
+    additions.hex = changed.hex & g_next_state.hex;
+
+    // Compute what was removed
+    PADState removals;
+    removals.hex = changed.hex & old_state.hex;
+
+    // Get the current PAD entry
+    PADDataEntry* current_pad_entry = &pad_data->entries[pad_data->index];
+
+    // Update entry properties
+    current_pad_entry->current_state.hex = g_next_state.hex;
+    current_pad_entry->delta_additions.hex = additions.hex;
+    current_pad_entry->delta_removals.hex = removals.hex;
+
+    // Set circle PAD
+    current_pad_entry->circle_pad_x = g_next_circle_x;
+    current_pad_entry->circle_pad_y = g_next_circle_y;
+
+    // If we just updated index 0, provide a new timestamp
+    if (pad_data->index == 0) {
+        pad_data->index_reset_ticks_previous = pad_data->index_reset_ticks;
+        pad_data->index_reset_ticks = (s64)Core::g_app_core->GetTicks();
+    }
+
+    // Signal both handles when there's an update to PAD or touch
+    Kernel::SignalEvent(g_event_pad_or_touch_1);
+    Kernel::SignalEvent(g_event_pad_or_touch_2);
+}
+
+
+// TODO(peachum):
+// Add a method for setting analog input from joystick device for the circle PAD.
+//
+// This method should:
+//     * Be called after both PADButton<Press, Release>().
+//     * Be called before PADUpdateComplete()
+//     * Set current PADEntry.circle_pad_<axis> using analog data
+//     * Set PadData.raw_circle_pad_data
+//     * Set PadData.current_state.circle_right = 1 if current PADEntry.circle_pad_x >= 41
+//     * Set PadData.current_state.circle_up = 1 if current PADEntry.circle_pad_y >= 41
+//     * Set PadData.current_state.circle_left = 1 if current PADEntry.circle_pad_x <= -41
+//     * Set PadData.current_state.circle_right = 1 if current PADEntry.circle_pad_y <= -41
+
+
 /**
  * HID_User::GetIPCHandles service function
  *  Inputs:
@@ -35,11 +150,11 @@ void GetIPCHandles(Service::Interface* self) {
 
     cmd_buff[1] = 0; // No error
     cmd_buff[3] = g_shared_mem;
-    cmd_buff[4] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventA");
-    cmd_buff[5] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventB");
-    cmd_buff[6] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventC");
-    cmd_buff[7] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventGyroscope");
-    cmd_buff[8] = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventD");
+    cmd_buff[4] = g_event_pad_or_touch_1;
+    cmd_buff[5] = g_event_pad_or_touch_2;
+    cmd_buff[6] = g_event_accelerometer;
+    cmd_buff[7] = g_event_gyroscope;
+    cmd_buff[8] = g_event_debug_pad;
 
     DEBUG_LOG(KERNEL, "called");
 }
@@ -58,14 +173,19 @@ const Interface::FunctionInfo FunctionTable[] = {
 };
 
 
-
-
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 // Interface class
 
 Interface::Interface() {
     g_shared_mem = Kernel::CreateSharedMemory("HID_User:SharedMem"); // Create shared memory object
 
+    // Create event handles
+    g_event_pad_or_touch_1 = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventPADOrTouch1");
+    g_event_pad_or_touch_2 = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventPADOrTouch2");
+    g_event_accelerometer = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventAccelerometer");
+    g_event_gyroscope = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventGyroscope");
+    g_event_debug_pad = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventDebugPAD");
+
     Register(FunctionTable, ARRAY_SIZE(FunctionTable));
 }
 
diff --git a/src/core/hle/service/hid.h b/src/core/hle/service/hid.h
index 6ddf2f80..f5f76f0f 100644
--- a/src/core/hle/service/hid.h
+++ b/src/core/hle/service/hid.h
@@ -15,30 +15,83 @@
 
 namespace HID_User {
 
+/// Structure of a PAD controller state
 struct PADState {
     union {
         u32 hex;
 
-        BitField<0, 1, u32> A;
-        BitField<1, 1, u32> B;
-        BitField<2, 1, u32> Select;
-        BitField<3, 1, u32> Start;
-        BitField<4, 1, u32> Right;
-        BitField<5, 1, u32> Left;
-        BitField<6, 1, u32> Up;
-        BitField<7, 1, u32> Down;
-        BitField<8, 1, u32> R;
-        BitField<9, 1, u32> L;
-        BitField<10, 1, u32> X;
-        BitField<11, 1, u32> Y;
-
-        BitField<28, 1, u32> CircleRight;
-        BitField<29, 1, u32> CircleLeft;
-        BitField<30, 1, u32> CircleUp;
-        BitField<31, 1, u32> CircleDown;
+        BitField<0, 1, u32> a;
+        BitField<1, 1, u32> b;
+        BitField<2, 1, u32> select;
+        BitField<3, 1, u32> start;
+        BitField<4, 1, u32> right;
+        BitField<5, 1, u32> left;
+        BitField<6, 1, u32> up;
+        BitField<7, 1, u32> down;
+        BitField<8, 1, u32> r;
+        BitField<9, 1, u32> l;
+        BitField<10, 1, u32> x;
+        BitField<11, 1, u32> y;
+
+        BitField<28, 1, u32> circle_right;
+        BitField<29, 1, u32> circle_left;
+        BitField<30, 1, u32> circle_up;
+        BitField<31, 1, u32> circle_down;
     };
 };
 
+/// Structure of a single entry in the PADData's PAD state history array
+struct PADDataEntry {
+    PADState current_state;
+    PADState delta_additions;
+    PADState delta_removals;
+
+    s16 circle_pad_x;
+    s16 circle_pad_y;
+};
+
+/// Structure of all data related to the 3DS Pad
+struct PADData {
+    s64 index_reset_ticks;
+    s64 index_reset_ticks_previous;
+    u32 index; // the index of the last updated PAD state history element
+
+    u32 pad1;
+    u32 pad2;
+
+    PADState current_state; // same as entries[index].current_state
+    u32 raw_circle_pad_data;
+
+    u32 pad3;
+
+    std::array<PADDataEntry, 8> entries; // PAD state history
+};
+
+// Pre-defined PADStates for single button presses
+const PADState PAD_NONE         = {{0}};
+const PADState PAD_A            = {{1u << 0}};
+const PADState PAD_B            = {{1u << 1}};
+const PADState PAD_SELECT       = {{1u << 2}};
+const PADState PAD_START        = {{1u << 3}};
+const PADState PAD_RIGHT        = {{1u << 4}};
+const PADState PAD_LEFT         = {{1u << 5}};
+const PADState PAD_UP           = {{1u << 6}};
+const PADState PAD_DOWN         = {{1u << 7}};
+const PADState PAD_R            = {{1u << 8}};
+const PADState PAD_L            = {{1u << 9}};
+const PADState PAD_X            = {{1u << 10}};
+const PADState PAD_Y            = {{1u << 11}};
+const PADState PAD_CIRCLE_RIGHT = {{1u << 28}};
+const PADState PAD_CIRCLE_LEFT  = {{1u << 29}};
+const PADState PAD_CIRCLE_UP    = {{1u << 30}};
+const PADState PAD_CIRCLE_DOWN  = {{1u << 31}};
+
+// Methods for updating the HID module's state
+void PADButtonPress(PADState pad_state);
+void PADButtonRelease(PADState pad_state);
+void PADUpdateComplete();
+
+/// HID service interface
 class Interface : public Service::Interface {
 public: