rspq_internal.h File Reference

RSP Command queue. More...

Go to the source code of this file.

Data Structures
struct	rspq_block_t
	A rspq block: pre-recorded array of commands. More...
struct	rspq_rdp_mode_t
	RDP render mode definition. More...
struct	rspq_overlay_t
	A RSPQ overlay ucode. This is similar to rsp_ucode_t, but is used internally to managed it as a RSPQ overlay. More...
struct	rspq_overlay_tables_t
	The overlay table in DMEM. More...
struct	rsp_queue_t
	RSP Queue data in DMEM. More...

Macros
#define	rspq_int_write(cmd_id, ...)   rspq_write(0, cmd_id, ##__VA_ARGS__)
	Write an internal command to the RSP queue.
#define	RSPQ_DATA_ADDRESS   32
	Address of the RSPQ data header in DMEM (see rsp_queue_t)

Enumerations
enum	{   RSPQ_CMD_INVALID = 0x00 , RSPQ_CMD_NOOP = 0x01 , RSPQ_CMD_JUMP = 0x02 , RSPQ_CMD_CALL = 0x03 ,   RSPQ_CMD_RET = 0x04 , RSPQ_CMD_DMA = 0x05 , RSPQ_CMD_WRITE_STATUS = 0x06 , RSPQ_CMD_SWAP_BUFFERS = 0x07 ,   RSPQ_CMD_TEST_WRITE_STATUS = 0x08 , RSPQ_CMD_RDP_WAIT_IDLE = 0x09 , RSPQ_CMD_RDP_SET_BUFFER = 0x0A , RSPQ_CMD_RDP_APPEND_BUFFER = 0x0B }

Functions
rsp_queue_t *	__rspq_get_state (void)
	Return a pointer to a copy of the current RSPQ state.
void	rspq_block_run_rsp (int nesting_level)
	Notify that a RSP command is going to run a block.

Variables
volatile int	__rspq_syncpoints_done
	ID of the last syncpoint reached by RSP.

Detailed Description

RSP Command queue.

---

Data Structure Documentation

rspq_block_t

struct rspq_block_t

A rspq block: pre-recorded array of commands.

A block (rspq_block_t) is a prerecorded sequence of RSP commands that can be played back. Blocks can be created via rspq_block_begin / rspq_block_end, and then executed by rspq_block_run. It is also possible to do nested calls (a block can call another block), up to 8 levels deep.

Data Fields
uint32_t	nesting_level	Nesting level of the block.
rdpq_block_t *	rdp_block	Option RDP static buffer (with RDP commands)
uint32_t	cmds[]	Block contents (commands)

rspq_rdp_mode_t

struct rspq_rdp_mode_t

RDP render mode definition.

This is the definition of the current RDP render mode

Data Fields
uint64_t	combiner
uint64_t	combiner_mipmapmask
uint32_t	blend_step0
uint32_t	blend_step1
uint64_t	other_modes

rspq_overlay_t

struct rspq_overlay_t

A RSPQ overlay ucode. This is similar to rsp_ucode_t, but is used internally to managed it as a RSPQ overlay.

Data Fields
uint32_t	code	Address of the overlay code in RDRAM.
uint32_t	data	Address of the overlay data in RDRAM.
uint32_t	state	Address of the overlay state in RDRAM (within data)
uint16_t	code_size	Size of the code in bytes - 1.
uint16_t	data_size	Size of the data in bytes - 1.

rspq_overlay_tables_t

struct rspq_overlay_tables_t

The overlay table in DMEM.

This structure is defined in DMEM by rsp_queue.S, and contains the descriptors for the overlays, used by the queue engine to load each overlay when needed.

Data Fields
uint8_t	overlay_table[RSPQ_OVERLAY_TABLE_SIZE]	Table mapping overlay ID to overlay index (used for the descriptors)
rspq_overlay_t	overlay_descriptors[RSPQ_MAX_OVERLAY_COUNT]	Descriptor for each overlay, indexed by the previous table.

rsp_queue_t

struct rsp_queue_t

RSP Queue data in DMEM.

This structure is defined by rsp_queue.S, and represents the top portion of DMEM.

Data Fields
rspq_overlay_tables_t	tables	Overlay table.
uint32_t	rspq_pointer_stack[RSPQ_MAX_BLOCK_NESTING_LEVEL]	Pointer stack used by RSPQ_CMD_CALL and RSPQ_CMD_RET.
uint32_t	rspq_dram_lowpri_addr	Address of the lowpri queue (special slot in the pointer stack)
uint32_t	rspq_dram_highpri_addr	Address of the highpri queue (special slot in the pointer stack)
uint32_t	rspq_dram_addr	Current RDRAM address being processed.
uint32_t	rspq_rdp_sentinel	Current RDP RDRAM end pointer (when rdp_current reaches this, the buffer is full)
rspq_rdp_mode_t	rdp_mode	RDP current render mode definition.
uint64_t	rdp_scissor_rect	Current RDP scissor rectangle.
uint32_t	rspq_rdp_buffers[2]	RDRAM Address of dynamic RDP buffers.
uint32_t	rspq_rdp_current	Current RDP RDRAM write pointer (normally DP_END)
uint32_t	rdp_fill_color	Current RDP fill color.
uint8_t	rdp_target_bitdepth	Current RDP target buffer bitdepth.
uint8_t	rdp_syncfull_ongoing	True if a SYNC_FULL is currently ongoing.
uint8_t	rdpq_debug	Debug mode flag.
uint8_t	__padding0
int16_t	current_ovl	Current overlay index.

Enumeration Type Documentation

anonymous enum

anonymous enum

RSPQ internal commands (overlay 0)

Enumerator
RSPQ_CMD_INVALID	RSPQ command: Invalid. Reserved ID for invalid command. This is used as a marker so that RSP knows when it has caught up with CPU and reached an empty portion of the buffer.
RSPQ_CMD_NOOP	RSPQ command: No-op. This commands does nothing. It can be useful for debugging purposes.
RSPQ_CMD_JUMP	RSPQ command: Jump to another buffer. This commands tells the RSP to start fetching commands from a new address. It is mainly used internally to implement the queue as a ring buffer (jumping at the start when we reach the end of the buffer).
RSPQ_CMD_CALL	RSPQ command: Call a block. This command is used by the block functions to implement the execution of a block. It tells RSP to starts fetching commands from the block address, saving the current address in an internal save slot in DMEM, from which it will be recovered by CMD_RET. Using multiple slots allow for nested calls.
RSPQ_CMD_RET	RSPQ command: Return from a block. This command tells the RSP to recover the buffer address from a save slot (from which it was currently saved by a CALL command) and begin fetching commands from there. It is used to finish the execution of a block.
RSPQ_CMD_DMA	RSPQ command: DMA transfer. This commands runs a DMA transfer (either DRAM to DMEM, or DMEM to DRAM). It is used by rspq_overlay_register to register a new overlay table into DMEM while the RSP is already running (to allow for overlays to be registered even after boot), and can be used by the users to perform manual DMA transfers to and from DMEM without risking a conflict with the RSP itself.
RSPQ_CMD_WRITE_STATUS	RSPQ Command: write SP_STATUS register. This command asks the RSP to write to the SP_STATUS register. It is normally used to set/clear signals or to raise RSP interrupts.
RSPQ_CMD_SWAP_BUFFERS	RSPQ Command: Swap lowpri/highpri buffers. This command is used as part of the highpri feature. It allows to switch between lowpri and highpri queue, by saving the current buffer pointer in a special save slot, and restoring the buffer pointer of the other queue from another slot. In addition, it also writes to SP_STATUS, to be able to adjust signals: entering highpri mode requires clearing SIG_HIGHPRI_REQUESTED and setting SIG_HIGHPRI_RUNNING; exiting highpri mode requires clearing SIG_HIGHPRI_RUNNING. The command is called internally by RSP to switch to highpri when the SIG_HIGHPRI_REQUESTED is found set; then it is explicitly enqueued by the CPU when the highpri queue is finished to switch back to lowpri (see rspq_highpri_end).
RSPQ_CMD_TEST_WRITE_STATUS	RSPQ Command: Test and write SP_STATUS register. This commands does a test-and-write sequence on the SP_STATUS register: first, it waits for a certain mask of bits to become zero, looping on it. Then it writes a mask to the register. It is used as part of the syncpoint feature to raise RSP interrupts, while waiting for the previous interrupt to be processed (coalescing interrupts would cause syncpoints to be missed).
RSPQ_CMD_RDP_WAIT_IDLE	RSPQ command: Wait for RDP to be idle. This command will let the RSP spin-wait until the RDP is idle (that is, the DP_STATUS_BUSY bit in COP0_DP_STATUS goes to 0). Notice that the RDP is fully asynchronous, and reading DP_STATUS_BUSY basically makes sense only after a RDP SYNC_FULL command (rdpq_sync_full()), when it really does make sure that all previous commands have finished running.
RSPQ_CMD_RDP_SET_BUFFER	RSPQ Command: send a new buffer to RDP and/or configure it for new commands. This command configures a new buffer in RSP for RDP commands. A buffer is described with three pointers: start, cur, sentinel. Start is the beginning of the buffer. Cur is the current write pointer in the buffer. If start==cur, it means the buffer is currently empty; otherwise, it means it contains some RDP commands that will be sent to RDP right away. Sentinel is the end of the buffer. If cur==sentinel, the buffer is full and no more commands will be written to it.
RSPQ_CMD_RDP_APPEND_BUFFER	RSPQ Command: send more data to RDP (appended to the end of the current buffer) This commands basically just sets DP_END to the specified argument, allowing new commands appended in the current buffer to be sent to RDP.

Function Documentation

__rspq_get_state()

rsp_queue_t * __rspq_get_state

(

void

)

Return a pointer to a copy of the current RSPQ state.

Note

This function forces a full sync by calling rspq_wait to avoid race conditions.