/*++ Copyright (c) 1992 Microsoft Corporation Copyright (c) 1993 Western Digital Corporation Copyright (c) 1994-1995 IBM Corporation Module Name: wd90c24a.h Abstract: This module contains the definitions for the WD90C24A/A2 miniport driver. Environment: Kernel mode Revision History: --*/ // // Assume PPC is Linear Framebuffer (1MB aperture) // #ifdef PPC #define ENABLE_LINEAR_FRAME_BUFFER 1 #define NO_INT10_MODE_SET 1 #endif #ifndef NO_INT10_MODE_SET #define INT10_MODE_SET 1 #endif // // Do full save and restore. // // #define EXTENDED_REGISTER_SAVE_RESTORE 1 // // Capabilities flags // // These are private flags passed to the display driver. They're // put in the 'DriverSpecificAttributeFlags' field of the // 'VIDEO_MODE_INFORMATION' structure (found in 'ntddvdeo.h') passed // to the display driver via an 'VIDEO_QUERY_AVAIL_MODES' or // 'VIDEO_QUERY_CURRENT_MODE' IOCTL. // // NOTE: These definitions must match those in the display driver's // 'driver.h'! typedef enum { CAPS_NEED_SW_POINTER = 0x00000100, // Needs the pointer simulation // for the virtual screen } CAPS; // // Define type of WD boards // typedef enum _BOARD_TYPE { WDPVGA1A = 1, WD90C00, WD90C10, // WD90C10 or WD90C11 WD90C20, // WD90C20 or WD90C22 WD90C30, SPEEDSTAR30, WD90C26, WD90C26A, WD90C24, WD90C24A, // WD90C24A or WD90C24A2 WD90C31, SPEEDSTAR31, WD90C33, OTHER } BOARD_TYPE; typedef enum _LCD_TYPE{ NoLCD = 1, // CRT IBM_F8515 = 2, // CRT + IBM F8515 10.4" TFT LCD IBM_F8532 = 4, // CRT + IBM F8532 10.4" TFT SVGA LCD TOSHIBA_DSTNC = 8 // CRT + Toshiba 10.4" Dual Scan STN Color LCD } LCD_TYPE; #define LCD_ENABLE 1 #define LCD_DISABLE 0 #define CRT_ENABLE 2 #define CRT_DISABLE 0 // // Base address of VGA memory range. Also used as base address of VGA // memory when loading a font, which is done with the VGA mapped at A0000. // #define MEM_VGA 0xA0000 #define MEM_VGA_SIZE 0x20000 #ifdef ENABLE_LINEAR_FRAME_BUFFER // // Base address of Linear-Framebuffer in a 1MB aperture video memory range. // #define MEM_FRAME 0x100000 // WD linear address start address #define MEM_FRAME_SIZE 0x100000 // 1MB for 1024x768x256 maximum #endif // // Port definitions for filling the ACCSES_RANGES structure in the miniport // information, defines the range of I/O ports the VGA spans. // There is a break in the IO ports - a few ports are used for the parallel // port. Those cannot be defined in the ACCESS_RANGE, but are still mapped // so all VGA ports are in one address range. // #define VGA_BASE_IO_PORT 0x000003B0 #define VGA_START_BREAK_PORT 0x000003BB #define VGA_END_BREAK_PORT 0x000003C0 #define VGA_MAX_IO_PORT 0x000003DF #define WD_EXT_PORT_START 0x000023C0 #define WD_EXT_PORT_END 0x000023C7 // // VGA port-related definitions. // // // VGA register definitions // // ports in monochrome mode #define CRTC_ADDRESS_PORT_MONO 0x0004 // CRT Controller Address and #define CRTC_DATA_PORT_MONO 0x0005 // Data registers in mono mode #define FEAT_CTRL_WRITE_PORT_MONO 0x000A // Feature Control write port // in mono mode #define INPUT_STATUS_1_MONO 0x000A // Input Status 1 register read // port in mono mode #define ATT_INITIALIZE_PORT_MONO INPUT_STATUS_1_MONO // Register to read to reset // Attribute Controller index/data #define ATT_ADDRESS_PORT 0x0010 // Attribute Controller Address and #define ATT_DATA_WRITE_PORT 0x0010 // Data registers share one port // for writes, but only Address is // readable at 0x3C0 #define ATT_DATA_READ_PORT 0x0011 // Attribute Controller Data reg is // readable here #define MISC_OUTPUT_REG_WRITE_PORT 0x0012 // Miscellaneous Output reg write // port #define INPUT_STATUS_0_PORT 0x0012 // Input Status 0 register read // port #define VIDEO_SUBSYSTEM_ENABLE_PORT 0x0013 // Bit 0 enables/disables the // entire VGA subsystem #define SEQ_ADDRESS_PORT 0x0014 // Sequence Controller Address and #define SEQ_DATA_PORT 0x0015 // Data registers #define DAC_PIXEL_MASK_PORT 0x0016 // DAC pixel mask reg #define DAC_ADDRESS_READ_PORT 0x0017 // DAC register read index reg, // write-only #define DAC_STATE_PORT 0x0017 // DAC state (read/write), // read-only #define DAC_ADDRESS_WRITE_PORT 0x0018 // DAC register write index reg #define DAC_DATA_REG_PORT 0x0019 // DAC data transfer reg #define FEAT_CTRL_READ_PORT 0x001A // Feature Control read port #define MISC_OUTPUT_REG_READ_PORT 0x001C // Miscellaneous Output reg read // port #define GRAPH_ADDRESS_PORT 0x001E // Graphics Controller Address #define GRAPH_DATA_PORT 0x001F // and Data registers #define CRTC_ADDRESS_PORT_COLOR 0x0024 // CRT Controller Address and #define CRTC_DATA_PORT_COLOR 0x0025 // Data registers in color mode #define FEAT_CTRL_WRITE_PORT_COLOR 0x002A // Feature Control write port #define INPUT_STATUS_1_COLOR 0x002A // Input Status 1 register read // port in color mode #define ATT_INITIALIZE_PORT_COLOR INPUT_STATUS_1_COLOR // Register to read to reset // Attribute Controller index/data // toggle in color mode // // Offsets in HardwareStateHeader->PortValue[] of save areas for non-indexed // VGA registers. // #define CRTC_ADDRESS_MONO_OFFSET 0x04 #define FEAT_CTRL_WRITE_MONO_OFFSET 0x0A #define ATT_ADDRESS_OFFSET 0x10 #define MISC_OUTPUT_REG_WRITE_OFFSET 0x12 #define VIDEO_SUBSYSTEM_ENABLE_OFFSET 0x13 #define SEQ_ADDRESS_OFFSET 0x14 #define DAC_PIXEL_MASK_OFFSET 0x16 #define DAC_STATE_OFFSET 0x17 #define DAC_ADDRESS_WRITE_OFFSET 0x18 #define GRAPH_ADDRESS_OFFSET 0x1E #define CRTC_ADDRESS_COLOR_OFFSET 0x24 #define FEAT_CTRL_WRITE_COLOR_OFFSET 0x2A // // VGA indexed register indexes. // #define IND_CURSOR_START 0x0A // index in CRTC of the Cursor Start #define IND_CURSOR_END 0x0B // and End registers #define IND_CURSOR_HIGH_LOC 0x0E // index in CRTC of the Cursor Location #define IND_CURSOR_LOW_LOC 0x0F // High and Low Registers #define IND_VSYNC_END 0x11 // index in CRTC of the Vertical Sync // End register, which has the bit // that protects/unprotects CRTC // index registers 0-7 #define IND_SET_RESET_ENABLE 0x01 // index of Set/Reset Enable reg in GC #define IND_DATA_ROTATE 0x03 // index of Data Rotate reg in GC #define IND_READ_MAP 0x04 // index of Read Map reg in Graph Ctlr #define IND_GRAPH_MODE 0x05 // index of Mode reg in Graph Ctlr #define IND_GRAPH_MISC 0x06 // index of Misc reg in Graph Ctlr #define IND_BIT_MASK 0x08 // index of Bit Mask reg in Graph Ctlr #define IND_SYNC_RESET 0x00 // index of Sync Reset reg in Seq #define IND_MAP_MASK 0x02 // index of Map Mask in Sequencer #define IND_MEMORY_MODE 0x04 // index of Memory Mode reg in Seq #define IND_CRTC_PROTECT 0x11 // index of reg containing regs 0-7 in // CRTC #define START_SYNC_RESET_VALUE 0x01 // value for Sync Reset reg to start // synchronous reset #define END_SYNC_RESET_VALUE 0x03 // value for Sync Reset reg to end // synchronous reset // // Values for Attribute Controller Index register to turn video off // and on, by setting bit 5 to 0 (off) or 1 (on). // #define VIDEO_DISABLE 0 #define VIDEO_ENABLE 0x20 // // Value written to the Read Map register when identifying the existence of // a VGA in VgaInitialize. This value must be different from the final test // value written to the Bit Mask in that routine. // #define READ_MAP_TEST_SETTING 0x03 // // Masks to keep only the significant bits of the Graphics Controller and // Sequencer Address registers. Masking is necessary because some VGAs, such // as S3-based ones, don't return unused bits set to 0, and some SVGAs use // these bits if extensions are enabled. // #define GRAPH_ADDR_MASK 0x0F #define SEQ_ADDR_MASK 0x07 // // Mask used to toggle Chain4 bit in the Sequencer's Memory Mode register. // #define CHAIN4_MASK 0x08 // // Default text mode setting for various registers, used to restore their // states if VGA detection fails after they've been modified. // #define MEMORY_MODE_TEXT_DEFAULT 0x02 #define BIT_MASK_DEFAULT 0xFF #define READ_MAP_DEFAULT 0x00 // // Palette-related info. // // // Highest valid DAC color register index. // #define VIDEO_MAX_COLOR_REGISTER 0xFF // // Highest valid palette register index // #define VIDEO_MAX_PALETTE_REGISTER 0x0F // // Indices for type of memory mapping; used in ModesVGA[], must match // MemoryMap[]. // typedef enum _VIDEO_MEMORY_MAP { MemMap_Mono, MemMap_CGA, MemMap_VGA, #ifdef ENABLE_LINEAR_FRAME_BUFFER MemMap_FRAME // new memory map for frame buffer #endif } VIDEO_MEMORY_MAP, *PVIDEO_MEMORY_MAP; // // Memory map table definition // typedef struct { ULONG MaxSize; // Maximum addressable size of memory. ULONG Start; // Start address of mode. } MEMORYMAPS; // // For a mode, the type of banking supported. Controls the information // returned in VIDEO_BANK_SELECT. PlanarHCBanking includes NormalBanking. // typedef enum _BANK_TYPE { NoBanking = 0, NormalBanking, PlanarHCBanking } BANK_TYPE, *PBANK_TYPE; // // Structure used to describe each video mode in ModesVGA[]. // #define NUM_DISPLAY_MODE 2 // 0:CRT Only or Simultaneously // 1:Simultaneously typedef struct { USHORT fbType; // color or monochrome, text or graphics, via // VIDEO_MODE_COLOR and VIDEO_MODE_GRAPHICS USHORT numPlanes; // # of video memory planes USHORT bitsPerPlane; // # of bits of color in each plane SHORT col; // # of text columns across screen with default font SHORT row; // # of text rows down screen with default font USHORT hres; // # of pixels across screen USHORT vres; // # of scan lines down screen USHORT wbytes; // # of bytes from start of one scan line to start of next ULONG sbytes; // total size of addressable display memory in bytes ULONG Frequency; // Vertical Frequency ULONG Interlaced; // Determines if the mode is interlaced or not BANK_TYPE banktype; // NoBanking, NormalBanking, PlanarHCBanking VIDEO_MEMORY_MAP MemMap; // index from VIDEO_MEMORY_MAP of memory // mapping used by this mode LCD_TYPE LCDtype; // LCD types to be supported by this mode BOOLEAN ValidMode; //Determines which modes are valid. #ifdef INT10_MODE_SET UCHAR FrequencyMask; // value used to mask the mode frequency UCHAR FrequencySetting; // value used to set the mode frequency ULONG Int10ModeNumber; // Mode number via Int 10 #endif PUSHORT CmdStrings[NUM_DISPLAY_MODE]; // pointer to array of register-setting commands ULONG DisplayDevices[NUM_DISPLAY_MODE]; } VIDEOMODE, *PVIDEOMODE; // // Mode into which to put the VGA before starting a VDM, so it's a plain // vanilla VGA. (This is the mode's index in ModesVGA[], currently standard // 80x25 text mode.) // #define DEFAULT_MODE 0 // // Info for the validator functions. // // // Number of each type of indexed register in a standard VGA, used by // validator and state save/restore functions. // // Note: VDMs currently only support basic VGAs only. // #define VGA_NUM_SEQUENCER_PORTS 5 #define VGA_NUM_CRTC_PORTS 25 #define VGA_NUM_GRAPH_CONT_PORTS 9 #define VGA_NUM_ATTRIB_CONT_PORTS 21 #define VGA_NUM_DAC_ENTRIES 256 #ifdef EXTENDED_REGISTER_SAVE_RESTORE // // Indices to start save/restore in extension registers: // For both chip types #define WD_GRAPH_EXT_START 0x09 #define WD_GRAPH_EXT_END 0x0E #define WD_SEQUENCER_EXT_START 0x07 #define WD_SEQUENCER_EXT_END 0x09 #define WD_SEQUENCER_1_EXT_START 0x10 #define WD_SEQUENCER_1_EXT_END 0x14 #define WD_CRTC_EXT_START 0x2A #define WD_CRTC_EXT_END 0x30 #define WD_CRTC_1_EXT_START 0x3E #define WD_CRTC_1_EXT_END 0x3E // // Number of extended regs for both chip types. // #define WD_NUM_GRAPH_EXT_PORTS (WD_GRAPH_EXT_END - WD_GRAPH_EXT_START + 1) #define WD_NUM_SEQUENCER_EXT_PORTS (WD_SEQUENCER_EXT_END - WD_SEQUENCER_EXT_START + 1) + \ (WD_SEQUENCER_1_EXT_END - WD_SEQUENCER_1_EXT_START + 1) #define WD_NUM_CRTC_EXT_PORTS (WD_CRTC_EXT_END - WD_CRTC_EXT_START + 1) + \ (WD_CRTC_1_EXT_END - WD_CRTC_1_EXT_START + 1) // // set values for save/restore area based on largest value for a chipset. // #define EXT_NUM_GRAPH_CONT_PORTS WD_NUM_GRAPH_EXT_PORTS #define EXT_NUM_SEQUENCER_PORTS WD_NUM_SEQUENCER_EXT_PORTS #define EXT_NUM_CRTC_PORTS WD_NUM_CRTC_EXT_PORTS #define EXT_NUM_ATTRIB_CONT_PORTS 0 #define EXT_NUM_DAC_ENTRIES 0 #else #define EXT_NUM_GRAPH_CONT_PORTS 0 #define EXT_NUM_SEQUENCER_PORTS 0 #define EXT_NUM_CRTC_PORTS 0 #define EXT_NUM_ATTRIB_CONT_PORTS 0 #define EXT_NUM_DAC_ENTRIES 0 #endif #ifdef i386 // // Info used by the Validator functions and save/restore code. // Structure used to trap register accesses that must be done atomically. // #define VGA_MAX_VALIDATOR_DATA 100 #define VGA_VALIDATOR_UCHAR_ACCESS 1 #define VGA_VALIDATOR_USHORT_ACCESS 2 #define VGA_VALIDATOR_ULONG_ACCESS 3 typedef struct _VGA_VALIDATOR_DATA { ULONG Port; UCHAR AccessType; ULONG Data; } VGA_VALIDATOR_DATA, *PVGA_VALIDATOR_DATA; // // Info for the save and restore state functions. // // // Number of bytes to save in each plane. // #define VGA_PLANE_SIZE 0x10000 // // These constants determine the offsets within the // VIDEO_HARDWARE_STATE_HEADER structure that are used to save and // restore the VGA's state. // #define VGA_HARDWARE_STATE_SIZE sizeof(VIDEO_HARDWARE_STATE_HEADER) #define VGA_BASIC_SEQUENCER_OFFSET (VGA_HARDWARE_STATE_SIZE + 0) #define VGA_BASIC_CRTC_OFFSET (VGA_BASIC_SEQUENCER_OFFSET + \ VGA_NUM_SEQUENCER_PORTS) #define VGA_BASIC_GRAPH_CONT_OFFSET (VGA_BASIC_CRTC_OFFSET + \ VGA_NUM_CRTC_PORTS) #define VGA_BASIC_ATTRIB_CONT_OFFSET (VGA_BASIC_GRAPH_CONT_OFFSET + \ VGA_NUM_GRAPH_CONT_PORTS) #define VGA_BASIC_DAC_OFFSET (VGA_BASIC_ATTRIB_CONT_OFFSET + \ VGA_NUM_ATTRIB_CONT_PORTS) #define VGA_BASIC_LATCHES_OFFSET (VGA_BASIC_DAC_OFFSET + \ (3 * VGA_NUM_DAC_ENTRIES)) #define VGA_EXT_SEQUENCER_OFFSET (VGA_BASIC_LATCHES_OFFSET + 4) #define VGA_EXT_CRTC_OFFSET (VGA_EXT_SEQUENCER_OFFSET + \ EXT_NUM_SEQUENCER_PORTS) #define VGA_EXT_GRAPH_CONT_OFFSET (VGA_EXT_CRTC_OFFSET + \ EXT_NUM_CRTC_PORTS) #define VGA_EXT_ATTRIB_CONT_OFFSET (VGA_EXT_GRAPH_CONT_OFFSET + \ EXT_NUM_GRAPH_CONT_PORTS) #define VGA_EXT_DAC_OFFSET (VGA_EXT_ATTRIB_CONT_OFFSET + \ EXT_NUM_ATTRIB_CONT_PORTS) #define VGA_VALIDATOR_OFFSET (VGA_EXT_DAC_OFFSET + 4 * EXT_NUM_DAC_ENTRIES) #define VGA_VALIDATOR_AREA_SIZE sizeof (ULONG) + (VGA_MAX_VALIDATOR_DATA * \ sizeof (VGA_VALIDATOR_DATA)) + \ sizeof (ULONG) + \ sizeof (ULONG) + \ sizeof (PVIDEO_ACCESS_RANGE) #define VGA_MISC_DATA_AREA_OFFSET VGA_VALIDATOR_OFFSET + VGA_VALIDATOR_AREA_SIZE #define VGA_MISC_DATA_AREA_SIZE 0 #define VGA_PLANE_0_OFFSET VGA_MISC_DATA_AREA_OFFSET + VGA_MISC_DATA_AREA_SIZE #define VGA_PLANE_1_OFFSET VGA_PLANE_0_OFFSET + VGA_PLANE_SIZE #define VGA_PLANE_2_OFFSET VGA_PLANE_1_OFFSET + VGA_PLANE_SIZE #define VGA_PLANE_3_OFFSET VGA_PLANE_2_OFFSET + VGA_PLANE_SIZE // // Space needed to store all state data. // #define VGA_TOTAL_STATE_SIZE VGA_PLANE_3_OFFSET + VGA_PLANE_SIZE #endif // // Device extension for the driver object. This data is only used // locally, so this structure can be added to as needed. // typedef struct _HW_DEVICE_EXTENSION { PUCHAR IOAddress; // base I/O address of VGA ports PUCHAR ExtendedIOAddress; // base I/O Address of Extended ports PVOID VideoMemoryAddress; // base virtual memory address of VGA memory ULONG AdapterMemorySize; // size, in bytes, of the memory on the // board. ULONG ModeIndex; // index of current mode in ModesVGA[] ULONG NumAvailableModes; // number of valid modes on this device PVIDEOMODE CurrentMode; // pointer to VIDEOMODE structure for // current mode #ifdef i386 USHORT FontPelColumns; // Width of the font in pels USHORT FontPelRows; // height of the font in pels VIDEO_CURSOR_POSITION CursorPosition; // current cursor position UCHAR CursorEnable; // whether cursor is enabled or not UCHAR CursorTopScanLine; // Cursor Start register setting (top scan) UCHAR CursorBottomScanLine; // Cursor End register setting (bottom scan) #endif UCHAR BoardID; // Used to identify different boards // supported. // Flat Panel Information UCHAR PanelType; // Type ULONG PanelXResolution; // Horizontal Resolution ULONG PanelYResolution; // Vertical Resolution BOOLEAN ExtendedRegisters; // Determines if extended registers have // been claimed. PHYSICAL_ADDRESS PhysicalVideoMemoryBase; // physical memory address and ULONG PhysicalVideoMemoryLength; // length of display memory PHYSICAL_ADDRESS PhysicalFrameBase; // physical memory address and ULONG PhysicalFrameLength; // length of display memory for // the current mode. #ifdef i386 // // These 4 fields must be at the end of the device extension and must be // kept in this order since this data will be copied to and from the save // state buffer that is passed to and from the VDM. // ULONG TrappedValidatorCount; // number of entries in the Trapped // validator data Array. VGA_VALIDATOR_DATA TrappedValidatorData[VGA_MAX_VALIDATOR_DATA]; // Data trapped by the validator routines // but not yet played back into the VGA // register. ULONG SequencerAddressValue; // Determines if the Sequencer Address Port // is currently selecting the SyncReset data // register. ULONG CurrentNumVdmAccessRanges; // Number of access ranges in // the access range array pointed // to by the next field PVIDEO_ACCESS_RANGE CurrentVdmAccessRange; // Access range currently // associated to the VDM #endif ULONG CRTPresent; // External CRT Present(1) or not(0) ULONG LCDEnable; // 0: LCD Disable 1: LCD Enable ULONG VirtualScreenEnable; // 0: Panning disable 1: Panning enable ULONG VirtualScreenPosX; // Horizontal position of virtual screen window ULONG VirtualScreenPosY; // Vertial position of virtual screen window USHORT VirtualScreenOption; // User preference // 0 = OFF // 1 = ON // 2 = AUTO } HW_DEVICE_EXTENSION, *PHW_DEVICE_EXTENSION; // // Function prototypes. // #ifdef i386 // // Entry points for the VGA validator. Used in VgaEmulatorAccessEntries[]. // VP_STATUS VgaValidatorUcharEntry ( ULONG Context, ULONG Port, UCHAR AccessMode, PUCHAR Data ); VP_STATUS VgaValidatorUshortEntry ( ULONG Context, ULONG Port, UCHAR AccessMode, PUSHORT Data ); VP_STATUS VgaValidatorUlongEntry ( ULONG Context, ULONG Port, UCHAR AccessMode, PULONG Data ); BOOLEAN VgaPlaybackValidatorData ( PVOID Context ); // // Bank switch code start and end labels, define in HARDWARE.ASM // extern UCHAR BankSwitchStart; extern UCHAR BankSwitchEnd; // // Vga init scripts for font loading // extern USHORT EnableA000Data[]; extern USHORT DisableA000Color[]; #endif extern MEMORYMAPS MemoryMaps[]; extern VIDEOMODE ModesVGA[]; extern ULONG NumVideoModes; #ifndef ENABLE_LINEAR_FRAME_BUFFER #define NUM_WD_ACCESS_RANGES 4 #else #define NUM_WD_ACCESS_RANGES 5 #endif #define NUM_VGA_ACCESS_RANGES 3 extern VIDEO_ACCESS_RANGE VgaAccessRange[]; #ifdef i386 #define VGA_NUM_EMULATOR_ACCESS_ENTRIES 6 extern EMULATOR_ACCESS_ENTRY VgaEmulatorAccessEntries[]; #define NUM_MINIMAL_VGA_VALIDATOR_ACCESS_RANGE 4 extern VIDEO_ACCESS_RANGE MinimalVgaValidatorAccessRange[]; #define NUM_FULL_VGA_VALIDATOR_ACCESS_RANGE 2 extern VIDEO_ACCESS_RANGE FullVgaValidatorAccessRange[]; #endif