categories_lite.h

/*
 *  this file is part of Game Categories Lite
 *
 *  Copyright (C) 2011  Bubbletune
 *  Copyright (C) 2011  Codestation
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef CATEGORY_LITE_
#define CATEGORY_LITE_

#include <pspsdk.h>
#include "gcpatches.h"

int sceKernelGetCompiledSdkVersion();

#define MAKE_CALL(a, f) _sw(0x0C000000 | (((u32)(f) >> 2)  & 0x03ffffff), a);
#define MAKE_JUMP(a, f) _sw(0x08000000 | (((u32)(f) & 0x0ffffffc) >> 2), a);
#define MAKE_STUB(a, f) {u32 addr = a; _sw(0x08000000 | (((u32)(f) & 0x0ffffffc) >> 2), addr); _sw(0, addr+4); }
#define U_EXTRACT_CALL(x) ((((u32)_lw((u32)x)) & ~0x0C000000) << 2)
#define ClearCachesForUser sceKernelGetCompiledSdkVersion
#define NOP_OPCODE 0
#define ISSET(v, m)  (((v) & (m)) == (m))

// useful to know who is the caller
#define GET_RA(x) __asm__("move %0,$ra" : "=r"((x)))

#define UNUSED __attribute__((unused))

#define ITEMSOF(arr) (sizeof(arr) / sizeof(0[arr]))

// uncomment this once the oldplugin of Pro is gone
//#define DEVICE_MEMORY_STICK "ms0:"
//#define DEVICE_INTERNAL_STORAGE "ef0:"

/* Avoid that "Old Plugin Support (PSP-Go only)" screw us */
#define XOR_KEY 0xDEADC0DE
#define XORED_MEMORY_STICK 0xE49DB3B3
#define XORED_INTERNAL_STORAGE 0xE49DA6BB

#define PSPGO_MULTIMS_SENTINEL 1000
#define PSPMS_MULTIMS_SENTINEL 100

#define PSPGO_UNCAT_SENTINEL 2000
#define PSPMS_UNCAT_SENTINEL 200

#define PSPGO_CONTEXT_SENTINEL 0x90000
#define PSPMS_CONTEXT_SENTINEL 0x70000

typedef struct {
    void *next;
    int location;
    u64 mtime;
    char letter;
    char name;
} Category;

typedef struct {
    void *unk; // 0
    int id; // 4
    const char *regkey; // 8
    const char *text; // 12
    const char *subtitle; // 16
    const char *page; // 20
} SceSysconfItem; // 24

typedef struct {
    char text[48];
    int play_sound;
    int action;
    int action_arg;
} SceContextItem; // 60

typedef struct {
    int id; // 0
    int relocate; // 4
    int action; // 8
    int action_arg; // 12
    SceContextItem *context; // 16
    char *subtitle; // 20
    int unk; // 24
    char play_sound; // 28
    char memstick; // 29
    char umd_icon; // 30
    char image[4]; // 31
    char image_shadow[4]; // 35
    char image_glow[4]; // 39
    char text[37]; // 43
} SceVshItem; // 80

typedef struct {
    char *name;
    void *callback;
    u32 unknown;
} SceCallbackItem;

typedef struct {
    u8 id; //00
    u8 type; //01
    u16 unk1; //02
    u32 label; //04
    u32 param; //08
    u32 first_child; //0c
    int child_count; //10
    u32 next_entry; // 14
    u32 prev_entry; //18
    u32 parent; //1c
    u32 unknown[2]; //20
} SceRcoEntry;

typedef struct {
    void *unknown;
    int option;
    const char *text;
} SceGameContext;

typedef struct {
    u8 unk0[0xF0];
    char gametitle[0x80];
    u32 unk1;
    char gamecode[0xA];
    u8 unk2[0x5E];
    char firmware[0x5];
    u8 unk3[0x3];
    char category[0x3];
    u8 unk4;
} SfoInfo620;

typedef struct {
    u8 unk0[0x68];
    char gametitle[0x80];
    u32 unk1;
    char gamecode[0xA];
    u8 unk2[0x5E];
    char firmware[0x5];
    u8 unk3[0x3];
    char category[0x3];
    u8 unk4;
} SfoInfo630;

typedef union _sfo {
    SfoInfo620 sfo620;
    SfoInfo630 sfo630;
} SfoInfo;

enum CategoryLocation {
    MEMORY_STICK,
    INTERNAL_STORAGE,
    INVALID = -1,
};

enum GameCategoriesModes {
    MODE_MULTI_MS,
    MODE_CONTEXT_MENU,
    MODE_FOLDER,
};

typedef union _dpath {
    u32 *device;
    const char *path;
} dpath;

#define SET_DEVICENAME(p, l) { \
    dpath __d; \
    __d.path = (p); \
    *__d.device = XOR_KEY; \
    *__d.device ^= (l) == MEMORY_STICK ? XORED_MEMORY_STICK : XORED_INTERNAL_STORAGE; \
}

// Functions in: multims.c
void PatchVshmain(u32 text_addr);
void PatchGameText(u32 text_addr);

// Functions in: vshitem.c
void PatchPaf(u32 text_addr);
void PatchVshCommonGui(u32 text_addr);

// Functions in: sysconf.c
void PatchSysconf(u32 text_addr);
void PatchVshmainForSysconf(u32 text_addr);
void PatchPafForSysconf(u32 text_addr);
void PatchExecuteActionForSysconf(int action, int action_arg);

// Functions in: context.c
void PatchVshmainForContext(u32 text_addr);

// Functions in: gcread.c
void PatchGamePluginForGCread(u32 text_addr);

// Functions in: selection.c
void PatchSelection(u32 text_addr);

// Functions in: category.c
int CountCategories(Category *head[], int location);
void ClearCategories(Category *head[], int location);
int AddCategory(Category *head[], const char *category, u64 mtime, int location);
Category *GetNextCategory(Category *head[], Category *prev, int location);
Category *FindCategory(Category *head[], const char *category, int location);
void IndexCategories(Category *head[], const char *path, int location);
int is_game_folder(const char *base, const char *path);
int has_directories(const char *base, const char *path);

// Functions in: gcpatches.c
void ResolveNIDs();
GCPatches *GetPatches(int fw_group);

// Functions in: clearcache.S
void ClearCaches();

#endif /* CATEGORY_LITE_ */