/*---------------------------------------------------------------------------*
  Project:  Cafe
  File:     ppc_upid.h

  Copyright (C) Nintendo.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

 *---------------------------------------------------------------------------*/

#ifndef __PPC_UPID_H__
#define __PPC_UPID_H__

// Untyped assembly UPIDs. 
// Illegal to use in C or C++ code.
#define ASM_UPID_ERROR_VALUE    0xFFFFFFFF
#define ASM_UPID_Kernel         0
#define ASM_UPID_Root           1
#define ASM_UPID_CafeMenu       2
#define ASM_UPID_CafeTV         3
#define ASM_UPID_EManual        4
#define ASM_UPID_HomeButtonMenu 5
#define ASM_UPID_ErrorDisplay   6
#define ASM_UPID_MiniMiiverse   7
#define ASM_UPID_Browser        8
#define ASM_UPID_Miiverse       9
#define ASM_UPID_EShop          10
#define ASM_UPID_FLV            11
#define ASM_UPID_DownloadMgr    12
#define ASM_UPID_Reserved13     13
#define ASM_UPID_Reserved14     14
#define ASM_UPID_Game           15

#ifndef _ASSEMBLER

#ifdef __cplusplus
extern "C" {
#endif


/* 
 * PPC Unique Process ID (UPID)
 *  
 * Any given PPC process with a RAMPID can (potentially) have a different 
 * UPID to allow for many, many overlay IDs. 
 *  
 * --- IMPORTANT --- 
 * Illegal to use as an index. Ever. 
 * --- IMPORTANT --- 
 */
typedef struct UPID__ *UPID;

#define UPID_ERROR_VALUE    ((UPID) -1)
#define UPID_Kernel         ((UPID) 0)
#define UPID_Root           ((UPID) 1)
#define UPID_CafeMenu       ((UPID) 2)
#define UPID_CafeTV         ((UPID) 3)
#define UPID_EManual        ((UPID) 4)
#define UPID_HomeButtonMenu ((UPID) 5)
#define UPID_ErrorDisplay   ((UPID) 6)
#define UPID_MiniMiiverse   ((UPID) 7)
#define UPID_Browser        ((UPID) 8)
#define UPID_Miiverse       ((UPID) 9)
#define UPID_EShop          ((UPID) 10)
#define UPID_FLV            ((UPID) 11)
#define UPID_DownloadMgr    ((UPID) 12)
#define UPID_Reserved13     ((UPID) 13)
#define UPID_Reserved14     ((UPID) 14)
#define UPID_Game           ((UPID) 15)

#define UPID_MintU          ((UPID) 16)
#define UPID_CabinetU       ((UPID) 17)

#define UPID_TestOverlay    ((UPID) 31)


#ifdef __cplusplus
}
#endif
#endif // _ASSEMBLER
#endif // __PPC_UPID_H__