Add ptm:plays service

Author: TuxSH

libctru/include/3ds.h

@@ -68,6 +68,7 @@ extern "C" {
 #include <3ds/services/ptmsysm.h>
 #include <3ds/services/ptmgets.h>
 #include <3ds/services/ptmsets.h>
+#include <3ds/services/ptmplays.h>
 #include <3ds/services/pxidev.h>
 #include <3ds/services/pxipm.h>
 #include <3ds/services/soc.h>

libctru/include/3ds/services/ptmplays.h

@@ -0,0 +1,82 @@
+/**
+ * @file ptmplays.h
+ * @brief PTMPLAYS service. Has access to ptm:u commands, but this is not exposed here.
+ */
+#pragma once
+
+#include <3ds/types.h>
+
+/// Maximum number of play events that can be stored.
+#define PTM_MAX_PLAY_EVENTS 0x11D28u
+
+/// Invalid title ID constant for PTM.
+#define PTM_INVALID_TITLE_ID 0xFFFFFFFFFFFFFFFFull
+
+/// Play event types. "Applet" includes "HOME Menu".
+typedef enum PtmPlayEventType {
+	PTMPLAYEVENT_APPLICATION_LAUNCH         = 0,    ///< Application launch (special meaning for invalid TitleId upon launching DSi title)
+	PTMPLAYEVENT_APPLICATION_EXIT           = 1,    ///< Application exit   (likewise)
+	PTMPLAYEVENT_APPLET_LAUNCH              = 2,    ///< Applet launch
+	PTMPLAYEVENT_APPLET_EXIT                = 3,    ///< Applet exit
+	PTMPLAYEVENT_JUMP_TO_APPLICATION        = 4,    ///< Jump to application
+	PTMPLAYEVENT_LEAVE_APPLICATION          = 5,    ///< Leave application
+	PTMPLAYEVENT_JUMP_TO_APPLET             = 6,    ///< Jump to applet
+	PTMPLAYEVENT_LEAVE_APPLET               = 7,    ///< Leave applet
+	PTMPLAYEVENT_SHELL_CLOSE                = 8,    ///< Shell close (no TitleId)
+	PTMPLAYEVENT_SHELL_OPEN                 = 9,    ///< Shell open (no TitleId)
+	PTMPLAYEVENT_SYSTEM_SHUTDOWN            = 10,   ///< System shutdown (no TitleId)
+	PTMPLAYEVENT_USER_TIME_CHANGE_OLD_TIME  = 11,   ///< User time change - old time (no TitleId, old user time stored in \ref minutesSince2000)
+	PTMPLAYEVENT_USER_TIME_CHANGE_NEW_TIME  = 12,   ///< User time change - new time (no TitleId, new user time stored in \ref minutesSince2000)
+} PtmPlayEventType;
+
+/// Play event entry.
+typedef struct PtmPlayEvent {
+	u32 tidHigh;                    ///< Upper 32 bits of title ID
+	u32 tidLow;                     ///< Lower 32 bits of title ID
+	PtmPlayEventType type   : 4;    ///< Event type
+	u32 minutesSince2000    : 28;   ///< Number of minutes elapsed since 2000-01-01 00:00
+} PtmPlayEvent;
+
+/// Get TitleID from PtmPlayEvent.
+static inline u64 ptmGetPlayEventTitleId(PtmPlayEvent event) {
+	return ((u64)(event.tidHigh) << 32) | event.tidLow;
+}
+
+/// Initializes PTMPLAYS.
+Result ptmPlaysInit(void);
+
+/// Exits PTMPLAYS.
+void ptmPlaysExit(void);
+
+/**
+ * @brief Gets a pointer to the current ptm:plays session handle.
+ * @return A pointer to the current ptm:plays session handle.
+ */
+Handle *ptmPlaysGetSessionHandle(void);
+
+/**
+ * @brief Gets the PlayEvent history (ring buffer).
+ * @param[out] outEndIndex The pointer to write the end index to (ring buffer).
+ * @param[out] outEvents The pointer to write the event entries to.
+ * @param[in] startIndex The start index (offset) to read from (ring buffer).
+ * @param[in] maxEvents The maximum number of events to write to outEvents.
+ */
+Result PTMPLAYS_GetPlayHistory(s32 *outEndIndex, PtmPlayEvent *outEvents, s32 startIndex, s32 maxEvents);
+
+/**
+ * @brief Gets the start index of the PlayEvent history (ring buffer).
+ * @param[out] outStartIndex The pointer to write the start index to (ring buffer).
+ */
+Result PTMPLAYS_GetPlayHistoryStart(s32 *outStartIndex);
+
+/**
+ * @brief Gets the number of entries of the PlayEvent history (ring buffer).
+ * @param[out] outNumEvents The pointer to write the start index to (ring buffer).
+ */
+Result PTMPLAYS_GetPlayHistorySize(s32 *outNumEvents);
+
+/**
+ * @brief Computes (start + numEvents) % PTM_MAX_PLAY_EVENTS with positive remainder.
+ * @param[out] outIndex Result of the index computation.
+ */
+Result PTMPLAYS_CalcPlayHistoryStart(s32 *outIndex, s32 start, s32 numEvents);

libctru/source/services/ptmplays.c

@@ -0,0 +1,91 @@
+#include <string.h>
+#include <3ds/types.h>
+#include <3ds/result.h>
+#include <3ds/svc.h>
+#include <3ds/srv.h>
+#include <3ds/synchronization.h>
+#include <3ds/ipc.h>
+
+#include <3ds/services/ptmplays.h>
+
+static Handle ptmPlaysHandle;
+static int ptmPlaysRefCount;
+
+Result ptmPlaysInit(void)
+{
+	if (AtomicPostIncrement(&ptmPlaysRefCount)) return 0;
+	Result res = srvGetServiceHandle(&ptmPlaysHandle, "ptm:plays");
+	if (R_FAILED(res)) AtomicDecrement(&ptmPlaysRefCount);
+	return res;
+}
+
+void ptmPlaysExit(void)
+{
+	if (AtomicDecrement(&ptmPlaysRefCount)) return;
+	svcCloseHandle(ptmPlaysHandle);
+}
+
+Handle *ptmPlaysGetSessionHandle(void)
+{
+	return &ptmPlaysHandle;
+}
+
+Result PTMPLAYS_GetPlayHistory(s32 *outEndIndex, PtmPlayEvent *outEvents, s32 startIndex, s32 maxEvents)
+{
+	Result ret;
+	u32 *cmdbuf = getThreadCommandBuffer();
+	cmdbuf[0] = IPC_MakeHeader(0x807,2,2); // 0x08070282
+
+	cmdbuf[1] = (u32)startIndex;
+	cmdbuf[2] = (u32)maxEvents;
+	cmdbuf[3] = IPC_Desc_Buffer(sizeof(PtmPlayEvent) * maxEvents, IPC_BUFFER_W);
+	cmdbuf[4] = (u32)outEvents;
+
+	if(R_FAILED(ret = svcSendSyncRequest(ptmPlaysHandle)))return ret;
+
+	*outEndIndex = (s32)cmdbuf[2];
+
+	return (Result)cmdbuf[1];
+}
+
+Result PTMPLAYS_GetPlayHistoryStart(s32 *outStartIndex)
+{
+	Result ret;
+	u32 *cmdbuf = getThreadCommandBuffer();
+	cmdbuf[0] = IPC_MakeHeader(0x808,0,0); // 0x08080000
+
+	if(R_FAILED(ret = svcSendSyncRequest(ptmPlaysHandle)))return ret;
+
+	*outStartIndex = (s32)cmdbuf[2];
+
+	return (Result)cmdbuf[1];
+}
+
+Result PTMPLAYS_GetPlayHistorySize(s32 *outNumEvents)
+{
+	Result ret;
+	u32 *cmdbuf = getThreadCommandBuffer();
+	cmdbuf[0] = IPC_MakeHeader(0x809,0,0); // 0x08090000
+
+	if(R_FAILED(ret = svcSendSyncRequest(ptmPlaysHandle)))return ret;
+
+	*outNumEvents = (s32)cmdbuf[2];
+
+	return (Result)cmdbuf[1];
+}
+
+Result PTMPLAYS_CalcPlayHistoryStart(s32 *outIndex, s32 start, s32 numEvents)
+{
+	Result ret;
+	u32 *cmdbuf = getThreadCommandBuffer();
+	cmdbuf[0] = IPC_MakeHeader(0x80A,2,0); // 0x08090000
+
+	cmdbuf[1] = (u32)start;
+	cmdbuf[2] = (u32)numEvents;
+
+	if(R_FAILED(ret = svcSendSyncRequest(ptmPlaysHandle)))return ret;
+
+	*outIndex = (s32)cmdbuf[2];
+
+	return (Result)cmdbuf[1];
+}