libcdvd-common.h

Go to the documentation of this file.

/*
# _____     ___ ____     ___ ____
#  ____|   |    ____|   |        | |____|
# |     ___|   |____ ___|    ____| |    \    PS2DEV Open Source Project.
#-----------------------------------------------------------------------
# Copyright 2001-2004, ps2dev - http://www.ps2dev.org
# Licenced under Academic Free License version 2.0
# Review ps2sdk README & LICENSE files for further details.
*/

 
#ifndef __LIBCDVD_COMMON_H__
#define __LIBCDVD_COMMON_H__
 
#include <tamtypes.h>
 
/* File open modes */
#define SCE_CdSTREAM 0x40000000
 
enum SCECdvdSectorType {
    /* Game CD and DVD sector types.  */
    SCECdSecS2048 = 0,
    SCECdSecS2328,
    SCECdSecS2340,
 
    /* CDDA sector types.  */
    SCECdSecS2352 = 0,
    SCECdSecS2368,
    SCECdSecS2448,
};
 
enum SCECdvdSpinValue {
    SCECdSpinMax = 0,
    SCECdSpinStm = 0,
    SCECdSpinDvdDL0 = 0,

    SCECdSpinNom = 1,
    SCECdSpinX1,
    // Note: These modes were taken from the PS2Linux libcdvd.h file, and they don't appear in any other Sony libcdvd.h file.
    SCECdSpinX2,
    SCECdSpinX4,
    SCECdSpinX12,
    SCECdSpinNm2 = 10,
    SCECdSpin1p6,
    SCECdSpinMx = 20,
};
 
enum SCECdvdMModeMediaType {
    SCECdMmodeCd = 1,
    SCECdMmodeDvd
};
 
enum SCECdvdErrorCode {
    SCECdErFAIL = -1,
    SCECdErNO = 0x00,
    SCECdErABRT,

    SCECdErCMD = 0x10,
    SCECdErOPENS,
    SCECdErNODISC,
    SCECdErNORDY,
    SCECdErCUD,

    SCECdErIPI = 0x20,
    SCECdErILI,
    SCECdErPRM,

    SCECdErREAD = 0x30,
    SCECdErTRMOPN,
    SCECdErEOM,
    SCECdErSFRMTNG = 0x38,

    SCECdErREADCF = 0xFD,
    SCECdErREADCFR
};
 
enum SCECdvdMediaType {
    SCECdGDTFUNCFAIL = -1,
    SCECdNODISC      = 0x00,
    SCECdDETCT,
    SCECdDETCTCD,
    SCECdDETCTDVDS,
    SCECdDETCTDVDD,
    SCECdUNKNOWN,

    SCECdPSCD = 0x10,
    SCECdPSCDDA,
    SCECdPS2CD,
    SCECdPS2CDDA,
    SCECdPS2DVD,

    SCECdDVDVR = 0xFC,
    SCECdCDDA = 0xFD,
    SCECdDVDV,
    SCECdIllegalMedia
};
 
enum SCECdvdInterruptCode {
    CdlNoIntr = 0x00,
    CdlDataReady,
    SCECdComplete,
    CdlAcknowledge,
    CdlDataEnd,
    CdlDiskError,
    SCECdNotReady
 
};
 
// Tray request modes
enum SCECdvdTrayReqMode {
    SCECdTrayOpen = 0,
    SCECdTrayClose,
    SCECdTrayCheck
};
 
// Drive states
enum SCECdvdDriveState {
    SCECdStatStop = 0x00,
    SCECdStatShellOpen,
    SCECdStatSpin,
    SCECdStatRead  = 0x06,
    SCECdStatPause = 0x0A,
    SCECdStatSeek  = 0x12,
    SCECdStatEmg   = 0x20,
};
 
typedef struct
{
    u8 stat;
    u8 second;
    u8 minute;
    u8 hour;
    u8 pad;
    u8 day;
    u8 month;
    u8 year;
} sceCdCLOCK;
 
typedef struct
{
    u32 lsn;
    u32 size;
    char name[16];
    u8 date[8];
} sceCdlFILE;
 
// location structure, used with sceCdIntToPos() and sceCdPosToInt()
typedef struct
{
    u8 minute;
    u8 second;
    u8 sector;
    u8 track;
} sceCdlLOCCD;
 
typedef struct
{
    u8 trycount;
    u8 spindlctrl;
    u8 datapattern;
    u8 pad;
} sceCdRMode;
 
typedef struct
{
    u32 lbn;
    u32 sectors;
    u32 buffer;
} sceCdRChain;
 
// macros for converting between an integer and a BCD number
#ifndef btoi
#define btoi(b) ((b) / 16 * 10 + (b) % 16) // BCD to int
#endif
#ifndef itob
#define itob(i) ((i) / 10 * 16 + (i) % 10) // int to BCD
#endif

#define CdlMAXTOC 100
 
enum SCECdvdCallbackReason {
    SCECdFuncRead = 1,
    SCECdFuncReadCDDA,
    SCECdFuncGetToc,
    SCECdFuncSeek,
    SCECdFuncStandby,
    SCECdFuncStop,
    SCECdFuncPause,
    SCECdFuncBreak
};

typedef void (*sceCdCBFunc)(int reason);
 
enum SCECdvdInitMode {
    SCECdINIT = 0x00,
    SCECdINoD,
    SCECdEXIT = 0x05
};
 
// Low-level filesystem properties for sceCdSearchFile()
#define CdlMAXFILE  64
#define CdlMAXDIR   128
#define CdlMAXLEVEL 8
 
enum SCECdvdFanSpeed {
    SCECdvdFanSpeedMinimum = 0x00,
    SCECdvdFanSpeedMedium,
    SCECdvdFanSpeedMaximum,
};
 
// LED definitions for sceCdSetLEDsMode()
#define CdlLEDPowerRed 1
#define CdlLEDPowerGreen 2
#define CdlLEDPowerYellow 4
#define CdlLEDEjectBlue 8
 
// Remote control disable definitions for sceRemote2_7()
#define CdlRCDisablePowerReset 1
#define CdlRCDisablePowerOff 2
#define CdlRCDisableReset 4
#define CdlRCDisableEject 8
#define CdlRCDisablePowerOn 0x10
 
// Flag definitions for sceCdCLOCK.stat
#define CdlRTCStatClockStopDetected 1
#define CdlRTCStatClockBatteryMonitoringVoltageProblem 2
#define CdlRTCStatCTLRegProblem 4
#define CdlRTCStatCommandError 128
 
// Value definitions for the wakeupreason argument of sceCdReadWakeUpTime
#define CdlWakeUpReasonMainPowerOn 0
#define CdlWakeUpReasonMainReset 1
#define CdlWakeUpReasonMainTimer 2
#define CdlWakeUpReasonMainDevice 3
 
// Value definitions for the return value of sceCdGetWakeUpReason
#define CdlWakeUpReasonExtraSupportHard 0
#define CdlWakeUpReasonExtraReset 1
#define CdlWakeUpReasonExtraGameReset 2
#define CdlWakeUpReasonExtraTimer 3
#define CdlWakeUpReasonExtraPowerOn 4
#define CdlWakeUpReasonExtraSlotIn 7
#define CdlWakeUpReasonExtraBackGround 8
 
// For streaming operations (Use with sceCdStRead())
enum SCECdvdStreamMode {
    STMNBLK = 0,
    STMBLK
};
 
// EE read modes (Used with sceCdSetEEReadMode()).
#define SCECdNoCheckReady      0x00000001
#define SCECdNoWriteBackDCache 0x00000002
 
#ifdef __cplusplus
extern "C" {
#endif
 
// **** N-Command Functions ****

extern int sceCdRead(u32 lbn, u32 sectors, void *buffer, sceCdRMode *mode);
extern int sceCdReadDVDV(u32 lbn, u32 sectors, void *buffer, sceCdRMode *mode);
extern int sceCdReadCDDA(u32 lbn, u32 sectors, void *buffer, sceCdRMode *mode);

extern int sceCdGetToc(u8 *toc);

extern int sceCdGetToc2(u8 *toc, int param);

extern int sceCdSeek(u32 lbn);

extern int sceCdStandby(void);

extern int sceCdStop(void);

extern int sceCdPause(void);

extern int sceCdReadChain(sceCdRChain *tag, sceCdRMode *mode);

extern int sceCdApplyNCmd(u8 cmdNum, const void* inBuff, u16 inBuffSize);
 
// **** S-Command functions ****

extern int sceCdReadClock(sceCdCLOCK *clock);

extern int sceCdWriteClock(sceCdCLOCK *clock);

extern int sceCdGetDiskType(void);

extern int sceCdGetError(void);

extern int sceCdTrayReq(int param, u32 *traychk);

extern int sceCdStatus(void);

extern int sceCdBreak(void);

extern int sceCdCancelPOffRdy(u32 *result);

extern int sceCdBlueLEDCtl(u8 control, u32 *result);

extern int sceCdPowerOff(u32 *result);

extern int sceCdMmode(int media);

extern int sceCdChangeThreadPriority(int priority);

extern int sceCdApplySCmd(u8 cmdNum, const void *inBuff, u16 inBuffSize, void *outBuff);
 
// **** Streaming Functions ****

extern int sceCdStStart(u32 lbn, sceCdRMode *mode);

extern int sceCdStRead(u32 sectors, u32 *buffer, u32 mode, u32 *error);

extern int sceCdStStop(void);

extern int sceCdStSeek(u32 lbn);

extern int sceCdStInit(u32 bufmax, u32 bankmax, void *buffer);

extern int sceCdStStat(void);

extern int sceCdStPause(void);

extern int sceCdStResume(void);
 
// **** Other Functions ****

extern int sceCdInit(int mode);

extern int sceCdSync(int mode);

extern int sceCdSearchFile(sceCdlFILE *file, const char *name);

extern int sceCdDiskReady(int mode);

extern sceCdlLOCCD *sceCdIntToPos(u32 i, sceCdlLOCCD *p);

extern u32 sceCdPosToInt(sceCdlLOCCD *p);

extern u32 sceCdGetReadPos(void);

extern int sceCdInitEeCB(int priority, void *stackAddr, int stackSize);

extern sceCdCBFunc sceCdCallback(sceCdCBFunc function);

extern int sceCdReadSUBQ(void *buffer, u32 *status);
 
// **** System functions ****

extern int sceCdForbidDVDP(u32 *result);

extern int sceCdAutoAdjustCtrl(int mode, u32 *result);

extern int sceCdDecSet(unsigned char enable_xor, unsigned char enable_shift, unsigned char shiftval);

extern int sceCdReadKey(unsigned char arg1, unsigned char arg2, unsigned int command, unsigned char *key);

extern int sceCdDoesUniqueKeyExist(u32 *status);

extern int sceCdSetHDMode(u32 mode);

extern int sceCdOpenConfig(int block, int mode, int NumBlocks, u32 *status);

extern int sceCdCloseConfig(u32 *result);

extern int sceCdReadConfig(void *buffer, u32 *result);

extern int sceCdWriteConfig(const void *buffer, u32 *result);

extern int sceCdReadNVM(u32 address, u16 *data, u8 *result);

extern int sceCdWriteNVM(u32 address, u16 data, u8 *result);

extern int sceCdRI(u8 *buffer, u32 *result);

extern int sceCdWI(const u8 *buffer, u32 *result);

extern int sceCdReadConsoleID(u8 *buffer, u32 *result);

extern int sceCdWriteConsoleID(const u8 *buffer, u32 *status);

extern int sceCdCtrlADout(int mode, u32 *status);

extern int sceCdMV(u8 *buffer, u32 *status);

extern int sceCdBootCertify(const u8 *romname);

extern int sceCdRM(char *buffer, u32 *status);

extern int sceCdWM(const char *buffer, u32 *status);

extern int sceCdForbidRead(u32 *result);
 
// **** Extra Functions ****

extern int sceCdReadFull(unsigned int lsn, unsigned int sectors, void *buf, sceCdRMode *mode);

extern int sceCdStSeekF(unsigned int lsn);

extern void *sceCdPOffCallback(void (*func)(void *userdata), void *userdata);

extern int sceCdSetTimeout(int param, int timeout);

extern int sceCdReadModelID(unsigned int *id);

extern int sceCdReadDvdDualInfo(int *on_dual, unsigned int *layer1_start);

extern int sceCdLayerSearchFile(sceCdlFILE *fp, const char *path, int layer);

extern int sceCdStatus2(void);

extern int sceCdRE(unsigned int lsn, unsigned int sectors, void *buf, sceCdRMode *mode);

extern int sceCdReadGUID(u64 *guid);

extern int sceCdRcBypassCtl(int mode, u32 *status);

extern int sceCdReadWakeUpTime(sceCdCLOCK *clock, u16 *userdata, u32 *wakeupreason, int *flags);

extern int sceCdWriteWakeUpTime(const sceCdCLOCK *clock, u16 userdata, int flags);

extern int sceRemote2_7(u16 param, u32 *status);

extern int sceRemote2_7Get(u32 *param, u32 *status);

extern int sceCdSetLEDsMode(u32 param, u32 *result);

extern int sceCdReadPS1BootParam(u8 *out, u32 *result);

extern int sceCdSetFanProfile(u8 param, u32 *result);

extern int sceCdSendSCmd1D(int *arg1, unsigned int *arg2, unsigned int *arg3, u32 *status);

extern int sceCdChgSys(u32 arg1);

extern int sceCdNoticeGameStart(u8 arg1, u32 *result);

extern int sceCdXLEDCtl(u8 arg1, u8 arg2, u32 *result1, u32 *result2);

extern int sceCdBuzzerCtl(u32 *result);

extern int sceCdXBSPowerCtl(u8 arg1, u8 arg2, u32 *result1, u32 *result2);

extern int sceCdSetMediumRemoval(u8 arg1, u32 *result);

extern int sceCdGetMediumRemoval(u32 *result1, u32 *result2);

extern int sceCdXDVRPReset(u8 arg1, u32 *result);

extern int sceCdGetWakeUpReason(void);

extern int sceCdReadRegionParams(u32 *arg1, u32 *result);

extern int sceCdWriteRegionParams(u8 arg1, u32 *arg2, u8 *arg3, u32 *result);

extern int cdvdman_152_get_temperature(u32 *param, u32 *status);

extern int cdvdman_167_atapi2dragon(u8 *inbuf, u32 *status);

extern int cdvdman_169_dragon2atapi(u8 *outbuf, u32 *status);
 
// Compatibility names for older ps2sdk versions.
 
// sceCdlFILE renames
#define CdvdFileSpec_t sceCdlFILE
#define cd_file_t      sceCdlFILE
// Structure member names are the same
 
// sceCdRMode renames
#define CdvdReadMode_t sceCdRMode
#define cd_read_mode_t sceCdRMode
// Structure member names differ:
// retries -> trycount
// readSpeed -> spindlctrl
// sectorType -> datapattern
 
// SCECdvdSectorType renames
#define SCECdvdSectorTypes SCECdvdSectorType
#define CdvdSectorType_t   SCECdvdSectorType
#define CDVD_SECTOR_2048   SCECdSecS2048
#define CDVD_SECTOR_2328   SCECdSecS2328
#define CDVD_SECTOR_2340   SCECdSecS2340
#define CDVD_SECTOR_2352   SCECdSecS2352
#define CDVD_SECTOR_2368   SCECdSecS2368
#define CDVD_SECTOR_2448   SCECdSecS2448
#define CdSecS2048         SCECdSecS2048
#define CdSecS2328         SCECdSecS2328
#define CdSecS2340         SCECdSecS2340
 
// SCECdvdSpinValue renames
#define SCECdvdSpinValues SCECdvdSpinValue
#define CDVD_SPIN_MAX     SCECdSpinMax
#define CDVD_SPIN_NORMAL  SCECdSpinNom
#define CDVD_SPIN_STREAM  SCECdSpinStm
#define CDVD_SPIN_DVD0    SCECdSpinDvdDL0
#define CdSpinMax         SCECdSpinMax
#define CdSpinNom         SCECdSpinNom
#define CdSpinStm         SCECdSpinStm
 
// SCECdvdErrorCode renames
#define SCECdvdErrorCodes SCECdvdErrorCode
#define CDVD_ERR_FAIL     SCECdErFAIL
#define CDVD_ERR_NO       SCECdErNO
#define CDVD_ERR_ABRT     SCECdErABRT
#define CDVD_ERR_CMD      SCECdErCMD
#define CDVD_ERR_OPENS    SCECdErOPENS
#define CDVD_ERR_NODISC   SCECdErNODISC
#define CDVD_ERR_NORDY    SCECdErNORDY
#define CDVD_ERR_CUD      SCECdErCUD
#define CDVD_ERR_IPI      SCECdErIPI
#define CDVD_ERR_ILI      SCECdErILI
#define CDVD_ERR_PRM      SCECdErPRM
#define CDVD_ERR_READ     SCECdErREAD
#define CDVD_ERR_TRMOPN   SCECdErTRMOPN
#define CDVD_ERR_EOM      SCECdErEOM
#define CDVD_ERR_READCF   SCECdErREADCF
#define CDVD_ERR_READCFR  SCECdErREADCFR
 
// SCECdvdMediaType renames
#define SCECdvdMediaTypes          SCECdvdMediaType
#define CdvdDiscType_t             SCECdvdMediaType
#define CDVD_TYPE_NODISK           SCECdNODISC
#define CDVD_TYPE_DETECT           SCECdDETCT
#define CDVD_TYPE_DETECT_CD        SCECdDETCTCD
#define CDVD_TYPE_DETECT_DVDSINGLE SCECdDETCTDVDS
#define CDVD_TYPE_DETECT_DVDDUAL   SCECdDETCTDVDD
#define CDVD_TYPE_UNKNOWN          SCECdUNKNOWN
#define CDVD_TYPE_PS1CD            SCECdPSCD
#define CDVD_TYPE_PS1CDDA          SCECdPSCDDA
#define CDVD_TYPE_PS2CD            SCECdPS2CD
#define CDVD_TYPE_PS2CDDA          SCECdPS2CDDA
#define CDVD_TYPE_PS2DVD           SCECdPS2DVD
#define CDVD_TYPE_CDDA             SCECdCDDA
#define CDVD_TYPE_DVDVIDEO         SCECdDVDV
#define CDVD_TYPE_ILLEGAL          SCECdIllegalMedia
 
// SCECdvdDriveState renames
#define SCECdvdDriveStates SCECdvdDriveState
#define CDVD_STAT_STOP     SCECdStatStop
#define CDVD_STAT_OPEN     SCECdStatShellOpen
#define CDVD_STAT_SPIN     SCECdStatSpin
#define CDVD_STAT_READ     SCECdStatRead
#define CDVD_STAT_PAUSE    SCECdStatPause
#define CDVD_STAT_SEEK     SCECdStatSeek
#define CDVD_STAT_ERROR    SCECdStatEmg
 
// SCECdvdMModeMediaType renames
#define SCECdvdMModeMediaTypes SCECdvdMModeMediaType
#define CdvdMediaMode_t        SCECdvdMModeMediaType
#define CDVD_MEDIA_MODE_CD     SCECdMmodeCd
#define CDVD_MEDIA_MODE_DVD    SCECdMmodeDvd
#define CdMmodeCd              SCECdMmodeCd
#define CdMmodeDvd             SCECdMmodeDvd
 
// sceCdlLOCCD renames
#define CdvdLocation_t sceCdlLOCCD
#define cd_location_t  sceCdlLOCCD
// Structure member names are the same
 
// SCECdvdInitMode renames
#define SCECdvdInitModes  SCECdvdInitMode
#define CDVD_INIT_INIT    SCECdINIT
#define CDVD_INIT_NOCHECK SCECdINoD
#define CDVD_INIT_EXIT    SCECdEXIT
 
// SCECdvdInterruptCode renames
#define SCECdvdInterruptCodes SCECdvdInterruptCode
#define CDVD_READY_READY      SCECdComplete
#define CDVD_READY_NOTREADY   SCECdNotReady
 
// sceCdCLOCK renames
#define CdvdClock_t sceCdCLOCK
#define cd_clock_t  sceCdCLOCK
// Structure member names differ:
// status -> stat
// week -> pad
 
// SCECdvdStreamMode renames
#define SCECdvdStreamModes   SCECdvdStreamMode
#define CDVD_STREAM_NONBLOCK STMNBLK
#define CDVD_STREAM_BLOCK    STMBLK
 
// SCECdvdTrayReqMode renames
#define SCECdvdTrayReqModes SCECdvdTrayReqMode
#define CDVD_TRAY_OPEN      SCECdTrayOpen
#define CDVD_TRAY_CLOSE     SCECdTrayClose
#define CDVD_TRAY_CHECK     SCECdTrayCheck
 
// sceCdCBFunc rename
#define CdCBFunc sceCdCBFunc
 
// SCECdvdCallbackReason rename
#define SCECdvdCallbackReasons SCECdvdCallbackReason
 
 
// function renames
#define CdInit         sceCdInit
#define cdInit         sceCdInit
#define CdStandby      sceCdStandby
#define cdStandby      sceCdStandby
#define CdRead         sceCdRead
#define cdRead         sceCdRead
#define CdSeek         sceCdSeek
#define cdSeek         sceCdSeek
#define CdGetError     sceCdGetError
#define cdGetError     sceCdGetError
#define CdGetToc       sceCdGetToc
#define cdGetToc       sceCdGetToc
#define CdSearchFile   sceCdSearchFile
#define cdSearchFile   sceCdSearchFile
#define CdSync         sceCdSync
#define cdSync         sceCdSync
#define CdGetDiskType  sceCdGetDiskType
#define cdGetDiscType  sceCdGetDiskType
#define CdDiskReady    sceCdDiskReady
#define cdDiskReady    sceCdDiskReady
#define CdTrayReq      sceCdTrayReq
#define cdTrayReq      sceCdTrayReq
#define CdStop         sceCdStop
#define cdStop         sceCdStop
#define CdPosToInt     sceCdPosToInt
#define cdPosToInt     sceCdPosToInt
#define CdIntToPos     sceCdIntToPos
#define cdIntToPos     sceCdIntToPos
#define CdReadClock    sceCdReadClock
#define cdReadClock    sceCdReadClock
#define CdStatus       sceCdStatus
#define cdStatus       sceCdStatus
#define CdCallback     sceCdCallback
#define cdSetCallback  sceCdCallback
#define CdPause        sceCdPause
#define cdPause        sceCdPause
#define CdBreak        sceCdBreak
#define cdBreak        sceCdBreak
#define CdReadCdda     sceCdReadCdda
#define cdCddaRead     sceCdReadCdda
#define CdGetReadPos   sceCdGetReadPos
#define cdGetReadPos   sceCdGetReadPos
#define CdMmode        sceCdMmode
#define cdSetMediaMode sceCdMmode
 
#define cdDvdRead              sceCdReadDVDV
#define cdApplyNCmd            sceCdApplyNCmd
#define cdReadIOPMem           sceCdReadIOPMem
#define cdNCmdDiskReady        sceCdNCmdDiskReady
#define cdReadChain            sceCdReadChain
#define cdWriteClock           sceCdWriteClock
#define cdApplySCmd            sceCdApplySCmd
#define cdCancelPowerOff       sceCdCancelPOffRdy
#define cdBlueLedCtrl          sceCdBlueLEDCtl
#define sceCdBlueLedCtrl       sceCdBlueLEDCtl
#define cdPowerOff             sceCdPowerOff
#define cdChangeThreadPriority sceCdChangeThreadPriority
#define cdStStart              sceCdStStart
#define cdStRead               sceCdStRead
#define cdStStop               sceCdStStop
#define cdStSeek               sceCdStSeek
#define cdStInit               sceCdStInit
#define cdStStat               sceCdStStat
#define cdStPause              sceCdStPause
#define cdStResume             sceCdStResume
#define CdRC                   sceCdRC
 
// Internal definitions no longer exposed:
// cdStream
// cdCddaStream
// cdInitCallbackThread
 
#ifdef __cplusplus
}
#endif
 
#endif /* __LIBCDVD_COMMON_H__ */