Merge pull request #105 from kevinhartman/hid

Digital user input and HID module implementation for PAD

2 files changed, 225 insertions, 10 deletions

diff --git a/src/core/hle/service/hid.cpp b/src/core/hle/service/hid.cpp
index 4e470795f..b6ec1b8ff 100644
--- a/src/core/hle/service/hid.cpp
+++ b/src/core/hle/service/hid.cpp
@@ -14,7 +14,128 @@
 
 namespace HID_User {
 
-Handle g_shared_mem = 0; ///< Handle to shared memory region designated to HID_User service
+// Handle to shared memory region designated to HID_User service
+static Handle shared_mem = 0;
+
+// Event handles
+static Handle event_pad_or_touch_1 = 0;
+static Handle event_pad_or_touch_2 = 0;
+static Handle event_accelerometer = 0;
+static Handle event_gyroscope = 0;
+static Handle event_debug_pad = 0;
+
+// Next Pad state update information
+static PadState next_state = {{0}};
+static u32 next_index = 0;
+static s16 next_circle_x = 0;
+static s16 next_circle_y = 0;
+
+/**
+ * Gets a pointer to the PadData structure inside HID shared memory
+ */
+static inline PadData* GetPadData() {
+    if (0 == shared_mem)
+        return nullptr;
+
+    return reinterpret_cast<PadData*>(Kernel::GetSharedMemoryPointer(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;
+    next_circle_x = next_state.circle_left ? -max_value : 0x0;
+    next_circle_x += next_state.circle_right ? max_value : 0x0;
+    next_circle_y = next_state.circle_down ? -max_value : 0x0;
+    next_circle_y += next_state.circle_up ? max_value : 0x0;
+}
+
+/**
+ * Sets a Pad state (button or button combo) as pressed
+ */
+void PadButtonPress(PadState pad_state) {
+    next_state.hex |= pad_state.hex;
+    UpdateNextCirclePadState();
+}
+
+/**
+ * Sets a Pad state (button or button combo) as released
+ */
+void PadButtonRelease(PadState pad_state) {
+    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 = next_state.hex;
+    pad_data->index = next_index;
+    next_index = (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 = (next_state.hex ^ old_state.hex);
+
+    // Compute what was added
+    PadState additions;
+    additions.hex = changed.hex & 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 = 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 = next_circle_x;
+    current_pad_entry->circle_pad_y = 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(event_pad_or_touch_1);
+    Kernel::SignalEvent(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
@@ -34,12 +155,12 @@ void GetIPCHandles(Service::Interface* self) {
     u32* cmd_buff = Service::GetCommandBuffer();
 
     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[3] = shared_mem;
+    cmd_buff[4] = event_pad_or_touch_1;
+    cmd_buff[5] = event_pad_or_touch_2;
+    cmd_buff[6] = event_accelerometer;
+    cmd_buff[7] = event_gyroscope;
+    cmd_buff[8] = event_debug_pad;
 
     DEBUG_LOG(KERNEL, "called");
 }
@@ -57,11 +178,19 @@ const Interface::FunctionInfo FunctionTable[] = {
     {0x00170000, nullptr,       "GetSoundVolume"},
 };
 
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 // Interface class
 
 Interface::Interface() {
-    g_shared_mem = Kernel::CreateSharedMemory("HID_User:SharedMem"); // Create shared memory object
+    shared_mem = Kernel::CreateSharedMemory("HID_User:SharedMem"); // Create shared memory object
+
+    // Create event handles
+    event_pad_or_touch_1 = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventPadOrTouch1");
+    event_pad_or_touch_2 = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventPadOrTouch2");
+    event_accelerometer = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventAccelerometer");
+    event_gyroscope = Kernel::CreateEvent(RESETTYPE_ONESHOT, "HID_User:EventGyroscope");
+    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 b17fcfa86..a077e25cd 100644
--- a/src/core/hle/service/hid.h
+++ b/src/core/hle/service/hid.h
@@ -5,15 +5,101 @@
 #pragma once
 
 #include "core/hle/service/service.h"
+#include "common/bit_field.h"
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 // Namespace HID_User
 
-// This service is used for interfacing to physical user controls... perhaps "Human Interface 
-// Devices"? Uses include game pad controls, accelerometers, gyroscopes, etc.
+// This service is used for interfacing to physical user controls.
+// Uses include game pad controls, touchscreen, accelerometers, gyroscopes, and debug pad.
 
 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> 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: