root/headers/private/graphics/nvidia/DriverInterface.h
/*
        Copyright 1999, Be Incorporated.   All Rights Reserved.
        This file may be used under the terms of the Be Sample Code License.

        Other authors:
        Mark Watson;
        Apsed;
        Rudolf Cornelissen 10/2002-1/2016.
*/

#ifndef DRIVERINTERFACE_H
#define DRIVERINTERFACE_H

#include <Accelerant.h>
#include <video_overlay.h>
#include <Drivers.h>
#include <PCI.h>
#include <OS.h>
#include <edid.h>
#include <AGP.h>

#define DRIVER_PREFIX "nvidia"
#define DEVICE_FORMAT "%04x_%04x_%02x%02x%02x"

/*
        Internal driver state (also for sharing info between driver and accelerant)
*/
#if defined(__cplusplus)
extern "C" {
#endif

typedef struct {
        sem_id  sem;
        int32   ben;
} benaphore;

#define INIT_BEN(x)             x.sem = create_sem(0, "NV "#x" benaphore");  x.ben = 0;
#define AQUIRE_BEN(x)   if((atomic_add(&(x.ben), 1)) >= 1) acquire_sem(x.sem);
#define RELEASE_BEN(x)  if((atomic_add(&(x.ben), -1)) > 1) release_sem(x.sem);
#define DELETE_BEN(x)   delete_sem(x.sem);


#define NV_PRIVATE_DATA_MAGIC   0x0009 /* a private driver rev, of sorts */

/* monitor setup */
#define CRTC1_TMDS      0x01
#define CRTC2_TMDS      0x10
#define CRTC1_VGA       0x02
#define CRTC2_VGA       0x20

/* dualhead extensions to flags */
#define DUALHEAD_OFF (0<<6)
#define DUALHEAD_CLONE (1<<6)
#define DUALHEAD_ON (2<<6)
#define DUALHEAD_SWITCH (3<<6)
#define DUALHEAD_BITS (3<<6)
#define DUALHEAD_CAPABLE (1<<8)
#define TV_BITS (3<<9)
#define TV_MON (0<<9)
#define TV_PAL (1<<9)
#define TV_NTSC (2<<9)
#define TV_CAPABLE (1<<11)
#define TV_VIDEO (1<<12)
#define TV_PRIMARY (1<<13)

/* additional timing flags for GetMode/SetMode for Haiku ScreenPrefs panel */
enum {
        RADEON_MODE_MULTIMON_REQUEST = 1 << 25,
        RADEON_MODE_MULTIMON_REPLY = 1 << 26
};

/* operation codes tunneled via ProposeDisplayMode for Haiku ScreenPrefs panel */
typedef enum {
        ms_swap                         = 'sw',
        ms_use_laptop_panel     = 'up',
        ms_tv_standard          = 'tv'
} multi_mon_settings;


#define SKD_MOVE_CURSOR    0x00000001
#define SKD_PROGRAM_CLUT   0x00000002
#define SKD_SET_START_ADDR 0x00000004
#define SKD_SET_CURSOR     0x00000008
#define SKD_HANDLER_INSTALLED 0x80000000

enum {
        NV_GET_PRIVATE_DATA = B_DEVICE_OP_CODES_END + 1,
        NV_GET_PCI,
        NV_SET_PCI,
        NV_DEVICE_NAME,
        NV_RUN_INTERRUPTS,
        NV_GET_NTH_AGP_INFO,
        NV_ENABLE_AGP,
        NV_ISA_OUT,
        NV_ISA_IN
};

/* card_type in order of date of NV chip design */
enum {
        NV04 = 0,
        NV05,
        NV05M64,
        NV06,
        NV10,
        NV11,
        NV15,
        NV17,
        NV18,
        NV20,
        NV25,
        NV28,
        NV30,
        NV31,
        NV34,
        NV35,
        NV36,
        NV38,
        NV40,
        NV41,
        NV43,
        NV44,
        NV45,
        G70,
        G71,
        G72,
        G73,
        G86,
        G92
};

/* card_arch in order of date of NV chip design */
enum {
        NV04A = 0,
        NV10A,
        NV20A,
        NV30A,
        NV40A,
        NV50A
};

/* card info - information gathered from PINS (and other sources) */
enum
{       // tv_encoder_type in order of capability (more or less)
        NONE = 0,
        CH7003,
        CH7004,
        CH7005,
        CH7006,
        CH7007,
        CH7008,
        SAA7102,
        SAA7103,
        SAA7104,
        SAA7105,
        BT868,
        BT869,
        CX25870,
        CX25871,
        NVIDIA
};

/* handles to pre-defined engine commands */
#define NV_ROP5_SOLID                                   0x00000000 /* 2D */
#define NV_IMAGE_BLACK_RECTANGLE                0x00000001 /* 2D/3D */
#define NV_IMAGE_PATTERN                                0x00000002 /* 2D */
#define NV_SCALED_IMAGE_FROM_MEMORY             0x00000003 /* 2D */
#define NV_TCL_PRIMITIVE_3D                             0x00000004 /* 3D */ //2007
#define NV4_SURFACE                                             0x00000010 /* 2D */
#define NV10_CONTEXT_SURFACES_2D                0x00000010 /* 2D */
#define NV_IMAGE_BLIT                                   0x00000011 /* 2D */
#define NV12_IMAGE_BLIT                                 0x00000011 /* 2D */
/* fixme:
 * never use NV3_GDI_RECTANGLE_TEXT for DMA acceleration:
 * There's a hardware fault in the input->output colorspace conversion here.
 * Besides, in NV40 and up this command nolonger exists. Both 'facts' are confirmed
 * by testing.
 */
//#define NV3_GDI_RECTANGLE_TEXT                        0x00000012 /* 2D */
#define NV4_GDI_RECTANGLE_TEXT                  0x00000012 /* 2D */
#define NV4_CONTEXT_SURFACES_ARGB_ZS    0x00000013 /* 3D */
#define NV10_CONTEXT_SURFACES_ARGB_ZS   0x00000013 /* 3D */
#define NV4_DX5_TEXTURE_TRIANGLE                0x00000014 /* 3D */
#define NV10_DX5_TEXTURE_TRIANGLE               0x00000014 /* 3D */
#define NV4_DX6_MULTI_TEXTURE_TRIANGLE  0x00000015 /* unused (yet?) */
#define NV10_DX6_MULTI_TEXTURE_TRIANGLE 0x00000015 /* unused (yet?) */
#define NV1_RENDER_SOLID_LIN                    0x00000016 /* 2D: unused */

/* max. number of overlay buffers */
#define MAXBUFFERS 3

//-----------------------------------------------------------------------------------
/* safety byte-offset from end of cardRAM for preventing acceleration engine crashes
 * caused by the existance of DMA engine command buffers in cardRAM and/or fifo
 * channel engine command re-assigning on-the-fly */

/* pre-NV40 notes:
 * - we need at least 70kB distance from the end of RAM for fifo-reassigning 'bug'
 *   (confirmed on a TNT1);
 * - keep extra failsafe room to prevent malfunctioning apps from crashing engine. */
#define PRE_NV40_OFFSET         80 * 1024

/* NV40 and higher notes:
 * - we need at least 416kB distance from the DMA command buffer:
 *   If you get too close to the DMA command buffer on NV40 and NV43 at least (both
 *   confirmed), the source DMA instance will mess-up for at least engine command
 *   NV_IMAGE_BLIT and NV12_IMAGE_BLIT; 
 * - we need at least ???kB distance from the end of RAM for fifo-reassigning 'bug'
 *   (fixme: unknown yet because fifo assignment switching isn't used here atm);
 * - keep extra failsafe room to prevent malfunctioning apps from crashing engine. */
#define NV40_PLUS_OFFSET        512 * 1024

/* fifo re-assigning bug definition:
 * if the fifo assignment is changed while at the same time card memory in the
 * dangerous region is being accessed by some application, the engine will crash.
 * This bug applies for both PIO and DMA mode acceleration! */

/* source-DMA instance bug definition:
 * if card memory in the dangerous region is being accessed by some application while
 * a DMA command buffer exists in the same memory (though in a different place),
 * the engine will crash. */
//-----------------------------------------------------------------------------------

/* internal used info on overlay buffers */
typedef struct {
        uint16 slopspace;
        uint32 size;
} int_buf_info;

typedef struct { // apsed, see comments in nvidia.settings
        // for driver
        char   accelerant[B_FILE_NAME_LENGTH];
        char   primary[B_FILE_NAME_LENGTH];
        bool   dumprom;
        // for accelerant
        uint32 logmask;
        uint32 memory;
        uint32 tv_output;
        bool   usebios;
        bool   hardcursor;
        bool   switchhead;
        bool   force_pci;
        bool   unhide_fw;
        bool   pgm_panel;
        bool   dma_acc;
        bool   vga_on_tv;
        bool   force_sync;
        bool   force_ws;
        bool   block_acc;
        uint32 gpu_clk;
        uint32 ram_clk;
        bool   check_edid;
} nv_settings;

/* monitor info gathered via EDID */
typedef struct {
        bool have_native_edid;  /* gathered 'native' EDID either via DDC or via GPU */
        bool digital;                   /* screen connection type: analog (VGA) or digital (DVI) */
        display_timing timing;  /* 'native modeline' fetched for screen */
        float aspect;                   /* screen's aspect ratio */
        bool have_full_edid;    /* EDID read succesfully via DDC  */
        edid1_info full_edid;   /* complete EDID info as fetched via DDC */
} edid_specs;

/* shared info */
typedef struct {
  /* a few ID things */
        uint16  vendor_id;      /* PCI vendor ID, from pci_info */
        uint16  device_id;      /* PCI device ID, from pci_info */
        uint8   revision;       /* PCI device revsion, from pci_info */
        uint8   bus;            /* PCI bus number, from pci_info */
        uint8   device;         /* PCI device number on bus, from pci_info */
        uint8   function;       /* PCI function number in device, from pci_info */

  /* used to return status for INIT_ACCELERANT and CLONE_ACCELERANT */
        bool    accelerant_in_use;

  /* bug workaround for 4.5.0 */
        uint32 use_clone_bugfix;        /*for 4.5.0, cloning of physical memory does not work*/
        uint32 * clone_bugfix_regs;

  /*memory mappings*/
        area_id regs_area;      /* Kernel's area_id for the memory mapped registers.
                                                        It will be cloned into the accelerant's address
                                                        space. */

        area_id fb_area;        /* Frame buffer's area_id.  The addresses are shared with all teams. */
        area_id unaligned_dma_area;     /* Area assigned for DMA. It will be (partially) mapped to an
                                                                        aligned area using MTRR-WC. */
        area_id dma_area;       /* Aligned area assigned for DMA. The addresses are shared with all teams. */

        void    *framebuffer;           /* As viewed from virtual memory */
        void    *framebuffer_pci;       /* As viewed from the PCI bus (for DMA) */
        void    *dma_buffer;            /* As viewed from virtual memory */
        void    *dma_buffer_pci;        /* As viewed from the PCI bus (for DMA) */

  /*screenmode list*/
        area_id mode_area;              /* Contains the list of display modes the driver supports */
        uint32  mode_count;             /* Number of display modes in the list */

  /*flags - used by driver*/
        uint32 flags;

  /*vblank semaphore*/
        sem_id  vblank;                 /* The vertical blank semaphore. Ownership will be
                                                transfered to the team opening the device first */
  /*cursor information*/
        struct {
                uint16  hot_x;          /* Cursor hot spot. The top left corner of the cursor */
                uint16  hot_y;          /* is 0,0 */
                uint16  x;              /* The location of the cursor hot spot on the */
                uint16  y;              /* desktop */
                uint16  width;          /* Width and height of the cursor shape (always 16!) */
                uint16  height;
                bool    is_visible;     /* Is the cursor currently displayed? */
                bool    dh_right;       /* Is cursor on right side of stretched screen? */
        } cursor;

  /*colour lookup table*/
        uint8   color_data[3 * 256];    /* Colour lookup table - as used by DAC */

  /*more display mode stuff*/
        display_mode dm;                /* current display mode configuration: head1 */
        uint32 dpms_flags;              /* current DPMS mode */
        bool acc_mode;                  /* signals (non)accelerated mode */
        bool interlaced_tv_mode;/* signals interlaced CRTC TV output mode */
        bool crtc_switch_mode;  /* signals dualhead switch mode if panels are used */
        bool haiku_prefs_used;  /* signals use of Haiku ScreenPrefs app for special modes */
        bool Haiku_switch_head; /* signals Haiku ScreenPrefs panel want inverted mode later on */

  /*frame buffer config - for BDirectScreen*/
        frame_buffer_config fbc;        /* bytes_per_row and start of frame buffer: head1 */
        accelerant_device_info adi;     /* as returned by hook GET_ACCELERANT_DEVICE_INFO */

  /*acceleration engine*/
        struct {
                uint32          count;          /* last dwgsync slot used */
                uint32          last_idle;      /* last dwgsync slot we *know* the engine was idle after */ 
                benaphore       lock;           /* for serializing access to the acc engine */
                struct {
                        uint32  handle[0x08];   /* FIFO channel's cmd handle for the owning cmd */
                        uint32  ch_ptr[0x20];   /* cmd handle's ptr to it's assigned FIFO ch (if any) */
                } fifo;
                struct {
                        uint32 put;                     /* last 32-bit-word adress given to engine to exec. to */
                        uint32 current;         /* first free 32-bit-word adress in buffer */
                        uint32 free;            /* nr. of useable free 32-bit words remaining in buffer */
                        uint32 max;                     /* command buffer's useable size in 32-bit words */
                } dma;
                bool agp_mode;                  /* card is running in AGP mode */
                struct {
                        uint32 clones;          /* clone 'number' (mask, slot) (one bit per clone) */
                        uint32 reload;          /* reload state and surfaces (one bit per clone) */
                        uint32 newmode;         /* re-allocate all buffers (one bit per clone) */
                        //fixme: memory stuff needs to be expanded (shared texture allocation?)
                        uint32 mem_low;         /* ptr to first free mem adress: cardmem local offset */
                        uint32 mem_high;        /* ptr to last free mem adress: cardmem local offset */
                        bool mode_changing;     /* a mode-change is in progress (set/clear by 2D drv) */
                } threeD;
        } engine;

        struct
        {
                /* specialised registers for card initialisation read from NV BIOS (pins) */

                /* general card information */
                uint32 card_type;           /* see card_type enum above */
                uint32 card_arch;           /* see card_arch enum above */
                bool laptop;                /* mobile chipset or not ('internal' flatpanel!) */
                bool slaved_tmds1;                      /* external TMDS encoder active on CRTC1 */
                bool slaved_tmds2;                      /* external TMDS encoder active on CRTC2 */
                bool master_tmds1;                      /* on die TMDS encoder active on CRTC1 */
                bool master_tmds2;                      /* on die TMDS encoder active on CRTC2 */
                display_timing p1_timing;       /* 'modeline' fetched for panel at CRTC1 */
                display_timing p2_timing;       /* 'modeline' fetched for panel at CRTC2 */
                edid_specs con1_screen;         /* EDID properties of the screen connected to connector 1 */
                edid_specs con2_screen;         /* EDID properties of the screen connected to connector 2 */
                edid_specs crtc1_screen;        /* EDID properties of the screen connected to CRTC1 */
                edid_specs crtc2_screen;        /* EDID properties of the screen connected to CRTC2 */
                bool crtc2_prim;                        /* using CRTC2 as primary CRTC */
                bool i2c_bus0;                          /* we have a wired I2C bus 0 on board */
                bool i2c_bus1;                          /* we have a wired I2C bus 1 on board */
                bool i2c_bus2;                          /* we have a wired I2C bus 2 on board */
                struct
                {
                        uint32 type;                    /* see tvchip_type enum above */
                        uint8 version;                  /* chip silicon version */
                        uint8 bus;                              /* I2C bus on which TVout chip resides */
                        uint8 adress;                   /* I2C adress on which TVout chip resides */
                } tv_encoder;
                uint8 monitors;                         /* output devices connection matrix */
                bool int_assigned;                      /* card has a useable INT assigned to it */
                status_t pins_status;           /* B_OK if read correctly, B_ERROR if faked */

                /* PINS */
                float f_ref;                            /* PLL reference-oscillator frequency (Mhz) */
                bool ext_pll;                           /* the extended PLL contains more dividers */
                uint32 max_system_vco;          /* graphics engine PLL VCO limits (Mhz) */
                uint32 min_system_vco;
                uint32 max_pixel_vco;           /* dac1 PLL VCO limits (Mhz) */
                uint32 min_pixel_vco;
                uint32 max_video_vco;           /* dac2 PLL VCO limits (Mhz) */
                uint32 min_video_vco;
                uint32 std_engine_clock;        /* graphics engine clock speed needed (Mhz) */
                uint32 std_memory_clock;        /* card memory clock speed needed (Mhz) */
                uint32 max_dac1_clock;          /* dac1 limits (Mhz) */
                uint32 max_dac1_clock_8;        /* dac1 limits correlated to RAMspeed limits (Mhz) */
                uint32 max_dac1_clock_16;
                uint32 max_dac1_clock_24;
                uint32 max_dac1_clock_32;
                uint32 max_dac1_clock_32dh;
                uint32 max_dac2_clock;          /* dac2 limits (Mhz) */
                uint32 max_dac2_clock_8;        /* dac2, maven limits correlated to RAMspeed limits (Mhz) */
                uint32 max_dac2_clock_16;
                uint32 max_dac2_clock_24;
                uint32 max_dac2_clock_32;
                uint32 max_dac2_clock_32dh;
                bool secondary_head;            /* presence of functions */
                bool tvout;
                bool primary_dvi;
                bool secondary_dvi;
                uint32 memory_size;                     /* memory (in bytes) */
        } ps;

        /* mirror of the ROM (copied in driver, because may not be mapped permanently) */
        uint8 rom_mirror[65536];

        /* some configuration settings from ~/config/settings/kernel/drivers/nv.settings if exists */
        nv_settings settings;

        struct
        {
                overlay_buffer myBuffer[MAXBUFFERS];/* scaler input buffers */
                int_buf_info myBufInfo[MAXBUFFERS];     /* extra info on scaler input buffers */
                overlay_token myToken;                          /* scaler is free/in use */
                benaphore lock;                                         /* for creating buffers and aquiring overlay unit routines */
                bool crtc;                                                      /* location of overlay unit */
                /* variables needed for virtualscreens (move_overlay()): */
                bool active;                                            /* true is overlay currently in use */
                overlay_window ow;                                      /* current position of overlay output window */
                overlay_buffer ob;                                      /* current inputbuffer in use */
                overlay_view my_ov;                                     /* current corrected view in inputbuffer */
                uint32 h_ifactor;                                       /* current 'unclipped' horizontal inverse scaling factor */
                uint32 v_ifactor;                                       /* current 'unclipped' vertical inverse scaling factor */
        } overlay;

} shared_info;

/* Read or write a value in PCI configuration space */
typedef struct {
        uint32  magic;          /* magic number to make sure the caller groks us */
        uint32  offset;         /* Offset to read/write */
        uint32  size;           /* Number of bytes to transfer */
        uint32  value;          /* The value read or written */
} nv_get_set_pci;

/* Enable or Disable CRTC (1,2) interrupts */
typedef struct {
        uint32  magic;          /* magic number to make sure the caller groks us */
        bool    crtc;           /* adressed CRTC */
        bool    do_it;          /* state to set */
} nv_set_vblank_int;

/* Retrieve the area_id of the kernel/accelerant shared info */
typedef struct {
        uint32  magic;          /* magic number to make sure the caller groks us */
        area_id shared_info_area;       /* area_id containing the shared information */
} nv_get_private_data;

/* Retrieve the device name.  Usefull for when we have a file handle, but want
to know the device name (like when we are cloning the accelerant) */
typedef struct {
        uint32  magic;          /* magic number to make sure the caller groks us */
        char    *name;          /* The name of the device, less the /dev root */
} nv_device_name;

/* Retrieve an AGP device interface if there. Usefull to find the AGP speed scheme
used (pre 3.x or 3.x) */
typedef struct {
        uint32          magic;  /* magic number to make sure the caller groks us */
        bool            agp_bus;/* indicates if we have access to the AGP busmanager */
        uint8           index;  /* device index in list of devices found */
        bool            exist;  /* we got AGP device info */
        agp_info        agpi;   /* AGP interface info of a device */
} nv_nth_agp_info;

/* Execute an AGP command */
typedef struct {
        uint32          magic;  /* magic number to make sure the caller groks us */
        bool            agp_bus;/* indicates if we have access to the AGP busmanager */
        uint32          cmd;    /* actual command to execute */
} nv_cmd_agp;

/* Read or write a value in ISA I/O space */
typedef struct {
        uint32  magic;          /* magic number to make sure the caller groks us */
        uint16  adress;         /* Offset to read/write */
        uint8   size;           /* Number of bytes to transfer */
        uint16  data;           /* The value read or written */
} nv_in_out_isa;

enum {
        
        _WAIT_FOR_VBLANK = (1 << 0)
};

#if defined(__cplusplus)
}
#endif


#endif