ar.h

Go to the documentation of this file.

#ifndef _DOLPHIN_AR_H_
#define _DOLPHIN_AR_H_
 
#include <dolphin/types.h>
 
struct ARQRequest;
 
typedef void (*ARQCallback)(struct ARQRequest*);
 
struct ARQRequest {
    /* 0x00 */ struct ARQRequest* next;
    /* 0x04 */ uintptr_t owner;
    /* 0x08 */ u32 type;
    /* 0x0C */ u32 priority;
    /* 0x10 */ u32 source;
    /* 0x14 */ u32 dest;
    /* 0x18 */ u32 length;
    /* 0x1C */ ARQCallback callback;
};
 
#define ARQ_DMA_ALIGNMENT 32
 
#define ARAM_DIR_MRAM_TO_ARAM 0x00
#define ARAM_DIR_ARAM_TO_MRAM 0x01
 
#define ARStartDMARead(mmem, aram, len)                                       \
    ARStartDMA(ARAM_DIR_ARAM_TO_MRAM, mmem, aram, len)
#define ARStartDMAWrite(mmem, aram, len)                                      \
    ARStartDMA(ARAM_DIR_MRAM_TO_ARAM, mmem, aram, len)
 
typedef struct ARQRequest ARQRequest;
 
#define ARQ_TYPE_MRAM_TO_ARAM ARAM_DIR_MRAM_TO_ARAM
#define ARQ_TYPE_ARAM_TO_MRAM ARAM_DIR_ARAM_TO_MRAM
 
#define ARQ_PRIORITY_LOW 0
#define ARQ_PRIORITY_HIGH 1
 
// ar.c
ARQCallback ARRegisterDMACallback(ARQCallback callback);
u32 ARGetDMAStatus(void);
void ARStartDMA(u32 type, u32 mainmem_addr, u32 aram_addr, u32 length);
u32 ARAlloc(u32 length);
u32 ARFree(u32* length);
int ARCheckInit(void);
u32 ARInit(u32* stack_index_addr, u32 num_entries);
void ARReset(void);
void ARSetSize(void);
u32 ARGetBaseAddress(void);
u32 ARGetSize(void);
 
// arq.c
void ARQInit(void);
void ARQReset(void);
void ARQPostRequest(struct ARQRequest* request, uintptr_t owner, u32 type,
                    u32 priority, u32 source, u32 dest, u32 length,
                    ARQCallback callback);
void ARQRemoveRequest(struct ARQRequest* request);
void ARQRemoveOwnerRequest(uintptr_t owner);
void ARQFlushQueue(void);
void ARQSetChunkSize(u32 size);
u32 ARQGetChunkSize(void);
 
#endif