sq.h

Go to the documentation of this file.

/* KallistiOS ##version##

   kernel/arch/dreamcast/include/dc/sq.h
   (C)2000-2001 Andrew Kieschnick

*/

/** \file   dc/sq.h
    \brief  Functions to access the SH4 Store Queues.

    The store queues are a way to do efficient burst transfers from the CPU to
    external memory. They can be used in a variety of ways, such as to transfer
    a texture to PVR memory. The transfers are in units of 32-bytes, and the
    destinations must be 32-byte aligned.

    \author Andrew Kieschnick
*/

#ifndef __DC_SQ_H
#define __DC_SQ_H

#include <sys/cdefs.h>
__BEGIN_DECLS

#include <arch/types.h>

/** \brief  Store Queue 0 access register */
#define QACR0 (*(volatile unsigned int *)(void *)0xff000038)

/** \brief  Store Queue 1 access register */
#define QACR1 (*(volatile unsigned int *)(void *)0xff00003c)

/** \brief  Clear a block of memory.

    This function is similar to calling memset() with a value to set of 0, but
    uses the store queues to do its work.

    \param  dest            The address to begin clearing at (32-byte aligned).
    \param  n               The number of bytes to clear (multiple of 32).
*/
void sq_clr(void *dest, int n);

/** \brief  Copy a block of memory.

    This function is similar to memcpy4(), but uses the store queues to do its
    work.

    \param  dest            The address to copy to (32-byte aligned).
    \param  src             The address to copy from (32-bit (4-byte) aligned).
    \param  n               The number of bytes to copy (multiple of 32).
    \return                 The original value of dest.
*/
void * sq_cpy(void *dest, void *src, int n);

/** \brief  Set a block of memory to an 8-bit value.

    This function is similar to calling memset(), but uses the store queues to
    do its work.

    \param  s               The address to begin setting at (32-byte aligned).
    \param  c               The value to set (in the low 8-bits).
    \param  n               The number of bytes to set (multiple of 32).
    \return                 The original value of dest.
*/
void * sq_set(void *s, uint32 c, int n);

/** \brief  Set a block of memory to a 16-bit value.

    This function is similar to calling memset2(), but uses the store queues to
    do its work.

    \param  s               The address to begin setting at (32-byte aligned).
    \param  c               The value to set (in the low 16-bits).
    \param  n               The number of bytes to set (multiple of 32).
    \return                 The original value of dest.
*/
void * sq_set16(void *s, uint32 c, int n);

/** \brief  Set a block of memory to a 32-bit value.

    This function is similar to calling memset4(), but uses the store queues to
    do its work.

    \param  s               The address to begin setting at (32-byte aligned).
    \param  c               The value to set (all 32-bits).
    \param  n               The number of bytes to set (multiple of 32).
    \return                 The original value of dest.
*/
void * sq_set32(void *s, uint32 c, int n);

__END_DECLS

#endif