/*
 * Mesa 3-D graphics library
 * Version:  5.1
 *
 * Copyright (C) 1999-2003  Brian Paul   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, sublicense,
 * 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 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 NONINFRINGEMENT.  IN NO EVENT SHALL
 * BRIAN PAUL 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.
 */


/* Private fragment program types and constants only used by files
 * related to fragment programs.
 *
 * XXX TO-DO: Rename this file "fragprog.h" since it's not NV-specific.
 */


#ifndef NVFRAGPROG_H
#define NVFRAGPROG_H

#include "config.h"


/* Fragment input registers / attributes */
#define FRAG_ATTRIB_WPOS  0
#define FRAG_ATTRIB_COL0  1
#define FRAG_ATTRIB_COL1  2
#define FRAG_ATTRIB_FOGC  3
#define FRAG_ATTRIB_TEX0  4
#define FRAG_ATTRIB_TEX1  5
#define FRAG_ATTRIB_TEX2  6
#define FRAG_ATTRIB_TEX3  7
#define FRAG_ATTRIB_TEX4  8
#define FRAG_ATTRIB_TEX5  9
#define FRAG_ATTRIB_TEX6  10
#define FRAG_ATTRIB_TEX7  11

/* Bitmasks for the above */
#define FRAG_BIT_WPOS  (1 << FRAG_ATTRIB_WPOS)
#define FRAG_BIT_COL0  (1 << FRAG_ATTRIB_COL0)
#define FRAG_BIT_COL1  (1 << FRAG_ATTRIB_COL1)
#define FRAG_BIT_FOGC  (1 << FRAG_ATTRIB_FOGC)
#define FRAG_BIT_TEX0  (1 << FRAG_ATTRIB_TEX0)
#define FRAG_BIT_TEX1  (1 << FRAG_ATTRIB_TEX1)
#define FRAG_BIT_TEX2  (1 << FRAG_ATTRIB_TEX2)
#define FRAG_BIT_TEX3  (1 << FRAG_ATTRIB_TEX3)
#define FRAG_BIT_TEX4  (1 << FRAG_ATTRIB_TEX4)
#define FRAG_BIT_TEX5  (1 << FRAG_ATTRIB_TEX5)
#define FRAG_BIT_TEX6  (1 << FRAG_ATTRIB_TEX6)
#define FRAG_BIT_TEX7  (1 << FRAG_ATTRIB_TEX7)

/* output registers */
#define FRAG_OUTPUT_COLR  0
#define FRAG_OUTPUT_COLH  1
#define FRAG_OUTPUT_DEPR  2


/* condition codes */
#define COND_GT  1  /* greater than zero */
#define COND_EQ  2  /* equal to zero */
#define COND_LT  3  /* less than zero */
#define COND_UN  4  /* unordered (NaN) */
#define COND_GE  5  /* greater then or equal to zero */
#define COND_LE  6  /* less then or equal to zero */
#define COND_NE  7  /* not equal to zero */
#define COND_TR  8  /* always true */
#define COND_FL  9  /* always false */


/* instruction precision */
#define FLOAT32  0x1
#define FLOAT16  0x2
#define FIXED12  0x4


/* Fragment program instruction opcodes */
enum fp_opcode {
   FP_OPCODE_ABS = 1000,     /* ARB_f_p only */
   FP_OPCODE_ADD,
   FP_OPCODE_CMP,            /* ARB_f_p only */
   FP_OPCODE_COS,
   FP_OPCODE_DDX,            /* NV_f_p only */
   FP_OPCODE_DDY,            /* NV_f_p only */
   FP_OPCODE_DP3,
   FP_OPCODE_DP4,
   FP_OPCODE_DPH,            /* ARB_f_p only */
   FP_OPCODE_DST,
   FP_OPCODE_EX2,
   FP_OPCODE_FLR,
   FP_OPCODE_FRC,
   FP_OPCODE_KIL,
   FP_OPCODE_LG2,
   FP_OPCODE_LIT,
   FP_OPCODE_LRP,
   FP_OPCODE_MAD,
   FP_OPCODE_MAX,
   FP_OPCODE_MIN,
   FP_OPCODE_MOV,
   FP_OPCODE_MUL,
   FP_OPCODE_PK2H,           /* NV_f_p only */
   FP_OPCODE_PK2US,          /* NV_f_p only */
   FP_OPCODE_PK4B,           /* NV_f_p only */
   FP_OPCODE_PK4UB,          /* NV_f_p only */
   FP_OPCODE_POW,
   FP_OPCODE_RCP,
   FP_OPCODE_RFL,            /* NV_f_p only */
   FP_OPCODE_RSQ,
   FP_OPCODE_SCS,            /* ARB_f_p only */
   FP_OPCODE_SEQ,            /* NV_f_p only */
   FP_OPCODE_SFL,            /* NV_f_p only */
   FP_OPCODE_SGE,            /* NV_f_p only */
   FP_OPCODE_SGT,            /* NV_f_p only */
   FP_OPCODE_SIN,
   FP_OPCODE_SLE,            /* NV_f_p only */
   FP_OPCODE_SLT,
   FP_OPCODE_SNE,            /* NV_f_p only */
   FP_OPCODE_STR,            /* NV_f_p only */
   FP_OPCODE_SUB,
   FP_OPCODE_SWZ,            /* ARB_f_p only */
   FP_OPCODE_TEX,
   FP_OPCODE_TXB,            /* ARB_f_p only */
   FP_OPCODE_TXD,            /* NV_f_p only */
   FP_OPCODE_TXP,
   FP_OPCODE_UP2H,           /* NV_f_p only */
   FP_OPCODE_UP2US,          /* NV_f_p only */
   FP_OPCODE_UP4B,           /* NV_f_p only */
   FP_OPCODE_UP4UB,          /* NV_f_p only */
   FP_OPCODE_X2D,            /* XPD in ARB_f_p */
   FP_OPCODE_END /* private opcode */
};


/* Instruction source register */
struct fp_src_register
{
   enum register_file File;
   GLint Index;
   GLuint Swizzle[4];
   GLboolean NegateBase; /* negate before absolute value? */
   GLboolean Abs;        /* take absolute value? */
   GLboolean NegateAbs;  /* negate after absolute value? */
};


/* Instruction destination register */
struct fp_dst_register
{
   enum register_file File;
   GLint Index;
   GLboolean WriteMask[4];
   GLuint CondMask;
   GLuint CondSwizzle[4];
};


/* Fragment program instruction */
struct fp_instruction
{
   enum fp_opcode Opcode;
   struct fp_src_register SrcReg[3];
   struct fp_dst_register DstReg;
   GLboolean Saturate;
   GLboolean UpdateCondRegister;
   GLubyte Precision;    /* FLOAT32, FLOAT16 or FIXED12 */
   GLubyte TexSrcUnit;   /* texture unit for TEX, TXD, TXP instructions */
   GLubyte TexSrcBit;    /* TEXTURE_1D,2D,3D,CUBE,RECT_BIT source target */
#if FEATURE_MESA_program_debug
   GLint StringPos;
#endif
};


#endif
