/**************************************************************************
 * 
 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
 * All Rights Reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 **************************************************************************/

/**
 * Types and tokens which are common to the SPU and PPU code.
 */


#ifndef CELL_COMMON_H
#define CELL_COMMON_H

#include "pipe/p_compiler.h"
#include "pipe/p_util.h"
#include "pipe/p_format.h"


/** The standard assert macro doesn't seem to work reliably */
#define ASSERT(x) \
   if (!(x)) { \
      ubyte *p = NULL; \
      fprintf(stderr, "%s:%d: %s(): assertion %s failed.\n", \
              __FILE__, __LINE__, __FUNCTION__, #x);             \
      *p = 0; \
      exit(1); \
   }


/** for sanity checking */
#define ASSERT_ALIGN16(ptr) \
   assert((((unsigned long) (ptr)) & 0xf) == 0);


/** round up value to next multiple of 4 */
#define ROUNDUP4(k)  (((k) + 0x3) & ~0x3)

/** round up value to next multiple of 16 */
#define ROUNDUP16(k)  (((k) + 0xf) & ~0xf)


#define CELL_MAX_SPUS 6

#define TILE_SIZE 32


/**
 * The low byte of a mailbox word contains the command opcode.
 * Remaining higher bytes are command specific.
 */
#define CELL_CMD_OPCODE_MASK 0xff

#define CELL_CMD_EXIT                 1
#define CELL_CMD_CLEAR_SURFACE        2
#define CELL_CMD_FINISH               3
#define CELL_CMD_RENDER               4
#define CELL_CMD_BATCH                5
#define CELL_CMD_RELEASE_VERTS        6
#define CELL_CMD_STATE_FRAMEBUFFER   10
#define CELL_CMD_STATE_DEPTH_STENCIL 11
#define CELL_CMD_STATE_SAMPLER       12
#define CELL_CMD_STATE_TEXTURE       13
#define CELL_CMD_STATE_VERTEX_INFO   14
#define CELL_CMD_STATE_VIEWPORT      15
#define CELL_CMD_STATE_VS_ARRAY_INFO 16
#define CELL_CMD_VS_EXECUTE          17


#define CELL_NUM_BUFFERS 4
#define CELL_BUFFER_SIZE (4*1024)  /**< 16KB would be the max */

#define CELL_BUFFER_STATUS_FREE 10
#define CELL_BUFFER_STATUS_USED 20



/**
 * Tell SPUs about the framebuffer size, location
 */
struct cell_command_framebuffer
{
   uint opcode;
   int width, height;
   void *color_start, *depth_start;
   enum pipe_format color_format, depth_format;
} ALIGN16_ATTRIB;


/**
 * Clear framebuffer to the given value/color.
 */
struct cell_command_clear_surface
{
   uint opcode;
   uint surface; /**< Temporary: 0=color, 1=Z */
   uint value;
} ALIGN16_ATTRIB;


/**
 * Array info used by the vertex shader's vertex puller.
 */
struct cell_array_info
{
    void *base;               /**< Base address of the 0th element. */
    uint attr;                /**< Attribute that this state if for. */
    uint pitch;               /**< Byte pitch from one entry to the next. */
    enum pipe_format format;  /**< Pipe format of each entry. */
} ALIGN16_ATTRIB;


struct cell_shader_info
{
   unsigned num_outputs;

   void *declarations;
   unsigned num_declarations;
   void *instructions;
   unsigned num_instructions;
   void *uniforms;
} ALIGN16_ATTRIB;


#define SPU_VERTS_PER_BATCH 64
struct cell_command_vs
{
   uint opcode;       /**< CELL_CMD_VS_EXECUTE */
   struct cell_shader_info   shader;
   unsigned num_elts;
   unsigned elts[SPU_VERTS_PER_BATCH];
   uint64_t vOut[SPU_VERTS_PER_BATCH];
} ALIGN16_ATTRIB;


struct cell_command_render
{
   uint opcode;       /**< CELL_CMD_RENDER */
   uint prim_type;    /**< PIPE_PRIM_x */
   uint num_verts;
   uint vertex_size;  /**< bytes per vertex */
   uint dummy;        /* XXX this dummy field works around a compiler bug */
   uint num_indexes;
   uint vertex_buf;  /**< which cell->buffer[] contains the vertex data */
   float xmin, dummy2, ymin, xmax, ymax;  /* XXX another dummy field */
   uint dummy3;
   uint min_index;
   boolean inline_verts;
} ALIGN16_ATTRIB;


struct cell_command_release_verts
{
   int opcode;         /**< CELL_CMD_RELEASE_VERTS */
   uint vertex_buf;    /**< in [0, CELL_NUM_BUFFERS-1] */
};


struct cell_command_texture
{
   void *start;         /**< Address in main memory */
   uint width, height;
};


/** XXX unions don't seem to work */
struct cell_command
{
   struct cell_command_framebuffer fb;
   struct cell_command_clear_surface clear;
   struct cell_command_render render;
   struct cell_command_vs vs;
} ALIGN16_ATTRIB;


/** This is the object passed to spe_create_thread() */
struct cell_init_info
{
   unsigned id;
   unsigned num_spus;
   struct cell_command *cmd;

   /** Buffers for command batches, vertex/index data */
   ubyte *buffers[CELL_NUM_BUFFERS];
   uint *buffer_status;  /**< points at cell_context->buffer_status */
} ALIGN16_ATTRIB;


#endif /* CELL_COMMON_H */