xboxvmp.h File Reference

#include "ntdef.h"
#include "dderror.h"
#include "devioctl.h"
#include "miniport.h"
#include "ioaccess.h"
#include "video.h"

Include dependency graph for xboxvmp.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	XBOXVMP_DEVICE_EXTENSION

Macros
#define	PAGE_SIZE   4096

Typedefs
typedef struct XBOXVMP_DEVICE_EXTENSION *	PXBOXVMP_DEVICE_EXTENSION

Functions
VP_STATUS NTAPI	XboxVmpFindAdapter (IN PVOID HwDeviceExtension, IN PVOID HwContext, IN PWSTR ArgumentString, IN OUT PVIDEO_PORT_CONFIG_INFO ConfigInfo, OUT PUCHAR Again)
BOOLEAN NTAPI	XboxVmpInitialize (PVOID HwDeviceExtension)
BOOLEAN NTAPI	XboxVmpStartIO (PVOID HwDeviceExtension, PVIDEO_REQUEST_PACKET RequestPacket)
BOOLEAN NTAPI	XboxVmpResetHw (PVOID DeviceExtension, ULONG Columns, ULONG Rows)
VP_STATUS NTAPI	XboxVmpGetPowerState (PVOID HwDeviceExtension, ULONG HwId, PVIDEO_POWER_MANAGEMENT VideoPowerControl)
VP_STATUS NTAPI	XboxVmpSetPowerState (PVOID HwDeviceExtension, ULONG HwId, PVIDEO_POWER_MANAGEMENT VideoPowerControl)
BOOLEAN FASTCALL	XboxVmpSetCurrentMode (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PVIDEO_MODE RequestedMode, PSTATUS_BLOCK StatusBlock)
BOOLEAN FASTCALL	XboxVmpResetDevice (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PSTATUS_BLOCK StatusBlock)
BOOLEAN FASTCALL	XboxVmpMapVideoMemory (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PVIDEO_MEMORY RequestedAddress, PVIDEO_MEMORY_INFORMATION MapInformation, PSTATUS_BLOCK StatusBlock)
BOOLEAN FASTCALL	XboxVmpUnmapVideoMemory (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PVIDEO_MEMORY VideoMemory, PSTATUS_BLOCK StatusBlock)
BOOLEAN FASTCALL	XboxVmpQueryNumAvailModes (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PVIDEO_NUM_MODES Modes, PSTATUS_BLOCK StatusBlock)
BOOLEAN FASTCALL	XboxVmpQueryAvailModes (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PVIDEO_MODE_INFORMATION ReturnedModes, PSTATUS_BLOCK StatusBlock)
BOOLEAN FASTCALL	XboxVmpQueryCurrentMode (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PVIDEO_MODE_INFORMATION VideoModeInfo, PSTATUS_BLOCK StatusBlock)
BOOLEAN FASTCALL	XboxVmpSetColorRegisters (PXBOXVMP_DEVICE_EXTENSION DeviceExtension, PVIDEO_CLUT ColorLookUpTable, PSTATUS_BLOCK StatusBlock)

Macro Definition Documentation

PAGE_SIZE

#define PAGE_SIZE   4096

Definition at line 19 of file xboxvmp.h.

Typedef Documentation

PXBOXVMP_DEVICE_EXTENSION

typedef struct XBOXVMP_DEVICE_EXTENSION * PXBOXVMP_DEVICE_EXTENSION

Function Documentation

XboxVmpFindAdapter()

VP_STATUS NTAPI XboxVmpFindAdapter	(	IN PVOID	HwDeviceExtension,
		IN PVOID	HwContext,
		IN PWSTR	ArgumentString,
		IN OUT PVIDEO_PORT_CONFIG_INFO	ConfigInfo,
		OUT PUCHAR	Again
	)

Definition at line 56 of file xboxvmp.c.

{
    PXBOXVMP_DEVICE_EXTENSION XboxVmpDeviceExtension;
    VP_STATUS Status;
    /* 3 access ranges: for MMIO, VRAM, and Indirect memory access IO ports */
    VIDEO_ACCESS_RANGE AccessRanges[3];
    USHORT VendorId = 0x10DE; /* NVIDIA Corporation */
    USHORT DeviceId = 0x02A0; /* NV2A XGPU */
    ULONG Slot = 0;
 
    TRACE_(IHVVIDEO, "XboxVmpFindAdapter\n");
 
    XboxVmpDeviceExtension = (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension;
 
    VideoPortZeroMemory(&AccessRanges, sizeof(AccessRanges));
    Status = VideoPortGetAccessRanges(HwDeviceExtension, 0, NULL,
                                      RTL_NUMBER_OF(AccessRanges), AccessRanges,
                                      &VendorId, &DeviceId, &Slot);
    if (Status == NO_ERROR)
    {
        XboxVmpDeviceExtension->PhysControlStart = AccessRanges[0].RangeStart;
        XboxVmpDeviceExtension->ControlLength = AccessRanges[0].RangeLength;
        XboxVmpDeviceExtension->PhysFrameBufferStart = AccessRanges[1].RangeStart;
    }
 
    return Status;
}

Referenced by DriverEntry().

XboxVmpGetPowerState()

VP_STATUS NTAPI XboxVmpGetPowerState	(	PVOID	HwDeviceExtension,
		ULONG	HwId,
		PVIDEO_POWER_MANAGEMENT	VideoPowerControl
	)

Definition at line 310 of file xboxvmp.c.

{
    ERR_(IHVVIDEO, "XboxVmpGetPowerState is not supported\n");
 
    return ERROR_INVALID_FUNCTION;
}

Referenced by DriverEntry().

XboxVmpInitialize()

BOOLEAN NTAPI XboxVmpInitialize

(

PVOID

HwDeviceExtension

)

Definition at line 98 of file xboxvmp.c.

{
    PXBOXVMP_DEVICE_EXTENSION XboxVmpDeviceExtension;
    ULONG inIoSpace = VIDEO_MEMORY_SPACE_MEMORY;
    ULONG Length;
 
    TRACE_(IHVVIDEO, "XboxVmpInitialize\n");
 
    XboxVmpDeviceExtension = (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension;
 
    Length = XboxVmpDeviceExtension->ControlLength;
    XboxVmpDeviceExtension->VirtControlStart = NULL;
 
    if (VideoPortMapMemory(HwDeviceExtension,
                           XboxVmpDeviceExtension->PhysControlStart,
                           &Length,
                           &inIoSpace,
                           &XboxVmpDeviceExtension->VirtControlStart) != NO_ERROR)
    {
        ERR_(IHVVIDEO, "Failed to map control memory\n");
        return FALSE;
    }
 
    INFO_(IHVVIDEO, "Mapped 0x%x bytes of control mem at 0x%x to virt addr 0x%x\n",
        XboxVmpDeviceExtension->ControlLength,
        XboxVmpDeviceExtension->PhysControlStart.u.LowPart,
        XboxVmpDeviceExtension->VirtControlStart);
 
    return TRUE;
}

Referenced by DriverEntry().

XboxVmpMapVideoMemory()

BOOLEAN FASTCALL XboxVmpMapVideoMemory	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PVIDEO_MEMORY	RequestedAddress,
		PVIDEO_MEMORY_INFORMATION	MapInformation,
		PSTATUS_BLOCK	StatusBlock
	)

Definition at line 389 of file xboxvmp.c.

{
    PHYSICAL_ADDRESS FrameBuffer;
    ULONG inIoSpace = VIDEO_MEMORY_SPACE_MEMORY;
 
    StatusBlock->Information = sizeof(VIDEO_MEMORY_INFORMATION);
 
    /* Reuse framebuffer that was set up by firmware */
    FrameBuffer.QuadPart = READ_REGISTER_ULONG((ULONG_PTR)DeviceExtension->VirtControlStart + NV2A_CRTC_FRAMEBUFFER_START);
    /* Framebuffer address offset value is coming from the GPU within
     * memory mapped I/O address space, so we're comparing only low
     * 28 bits of the address within actual RAM address space */
    FrameBuffer.QuadPart &= 0x0FFFFFFF;
    if (FrameBuffer.QuadPart != 0x3C00000 && FrameBuffer.QuadPart != 0x7C00000)
    {
        /* Check framebuffer address (high 4 MB of either 64 or 128 MB RAM) */
        WARN_(IHVVIDEO, "Non-standard framebuffer address 0x%p\n", FrameBuffer.QuadPart);
    }
    /* Verify that framebuffer address is page-aligned */
    ASSERT(FrameBuffer.QuadPart % PAGE_SIZE == 0);
 
    /* Return the address back to GPU memory mapped I/O */
    FrameBuffer.QuadPart += DeviceExtension->PhysFrameBufferStart.QuadPart;
    MapInformation->VideoRamBase = RequestedAddress->RequestedVirtualAddress;
    /* FIXME: obtain fb size from firmware somehow (Cromwell reserves high 4 MB of RAM) */
    MapInformation->VideoRamLength = NV2A_VIDEO_MEMORY_SIZE;
 
    VideoPortMapMemory(
        DeviceExtension,
        FrameBuffer,
        &MapInformation->VideoRamLength,
        &inIoSpace,
        &MapInformation->VideoRamBase);
 
    MapInformation->FrameBufferBase = MapInformation->VideoRamBase;
    MapInformation->FrameBufferLength = MapInformation->VideoRamLength;
 
    /* Tell the nVidia controller about the framebuffer */
    WRITE_REGISTER_ULONG((ULONG_PTR)DeviceExtension->VirtControlStart + NV2A_CRTC_FRAMEBUFFER_START, FrameBuffer.u.LowPart);
 
    INFO_(IHVVIDEO, "Mapped 0x%x bytes of phys mem at 0x%lx to virt addr 0x%p\n",
        MapInformation->VideoRamLength, FrameBuffer.u.LowPart, MapInformation->VideoRamBase);
 
    return TRUE;
}

Referenced by XboxVmpStartIO().

XboxVmpQueryAvailModes()

BOOLEAN FASTCALL XboxVmpQueryAvailModes	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PVIDEO_MODE_INFORMATION	ReturnedModes,
		PSTATUS_BLOCK	StatusBlock
	)

Definition at line 490 of file xboxvmp.c.

{
    return XboxVmpQueryCurrentMode(DeviceExtension, VideoMode, StatusBlock);
}

Referenced by XboxVmpStartIO().

XboxVmpQueryCurrentMode()

BOOLEAN FASTCALL XboxVmpQueryCurrentMode	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PVIDEO_MODE_INFORMATION	VideoModeInfo,
		PSTATUS_BLOCK	StatusBlock
	)

Definition at line 537 of file xboxvmp.c.

{
    UCHAR BytesPerPixel;
 
    VideoMode->Length = sizeof(VIDEO_MODE_INFORMATION);
    VideoMode->ModeIndex = 0;
 
    VideoMode->VisScreenWidth = READ_REGISTER_ULONG((ULONG_PTR)DeviceExtension->VirtControlStart + NV2A_RAMDAC_FP_HVALID_END) + 1;
    VideoMode->VisScreenHeight = READ_REGISTER_ULONG((ULONG_PTR)DeviceExtension->VirtControlStart + NV2A_RAMDAC_FP_VVALID_END) + 1;
 
    if (VideoMode->VisScreenWidth <= 1 || VideoMode->VisScreenHeight <= 1)
    {
        ERR_(IHVVIDEO, "Cannot obtain current screen resolution!\n");
        return FALSE;
    }
 
    BytesPerPixel = NvGetBytesPerPixel(DeviceExtension, VideoMode->VisScreenWidth);
    ASSERT(BytesPerPixel >= 1 && BytesPerPixel <= 4);
 
    VideoMode->ScreenStride = VideoMode->VisScreenWidth * BytesPerPixel;
    VideoMode->NumberOfPlanes = 1;
    VideoMode->BitsPerPlane = BytesPerPixel * 8;
    VideoMode->Frequency = 1;
    VideoMode->XMillimeter = 0; /* FIXME */
    VideoMode->YMillimeter = 0; /* FIXME */
    if (BytesPerPixel >= 3)
    {
        VideoMode->NumberRedBits = 8;
        VideoMode->NumberGreenBits = 8;
        VideoMode->NumberBlueBits = 8;
        VideoMode->RedMask = 0xFF0000;
        VideoMode->GreenMask = 0x00FF00;
        VideoMode->BlueMask = 0x0000FF;
    }
    else
    {
        /* FIXME: not implemented */
        WARN_(IHVVIDEO, "BytesPerPixel %d - not implemented\n", BytesPerPixel);
    }
    VideoMode->VideoMemoryBitmapWidth = VideoMode->VisScreenWidth;
    VideoMode->VideoMemoryBitmapHeight = VideoMode->VisScreenHeight;
    VideoMode->AttributeFlags = VIDEO_MODE_GRAPHICS | VIDEO_MODE_COLOR |
        VIDEO_MODE_NO_OFF_SCREEN;
    VideoMode->DriverSpecificAttributeFlags = 0;
 
    StatusBlock->Information = sizeof(VIDEO_MODE_INFORMATION);
 
    /* Verify that screen fits framebuffer size */
    if (VideoMode->VisScreenWidth * VideoMode->VisScreenHeight * (VideoMode->BitsPerPlane / 8) > NV2A_VIDEO_MEMORY_SIZE)
    {
        ERR_(IHVVIDEO, "Current screen resolution exceeds video memory bounds!\n");
        return FALSE;
    }
 
    return TRUE;
}

Referenced by XboxVmpQueryAvailModes(), and XboxVmpStartIO().

XboxVmpQueryNumAvailModes()

BOOLEAN FASTCALL XboxVmpQueryNumAvailModes	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PVIDEO_NUM_MODES	Modes,
		PSTATUS_BLOCK	StatusBlock
	)

Definition at line 471 of file xboxvmp.c.

{
    Modes->NumModes = 1;
    Modes->ModeInformationLength = sizeof(VIDEO_MODE_INFORMATION);
    StatusBlock->Information = sizeof(VIDEO_NUM_MODES);
    return TRUE;
}

Referenced by XboxVmpStartIO().

XboxVmpResetDevice()

BOOLEAN FASTCALL XboxVmpResetDevice	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PSTATUS_BLOCK	StatusBlock
	)

Definition at line 371 of file xboxvmp.c.

{
    /* There is nothing to be done here */
 
    return TRUE;
}

Referenced by XboxVmpResetHw(), and XboxVmpStartIO().

XboxVmpResetHw()

BOOLEAN NTAPI XboxVmpResetHw	(	PVOID	DeviceExtension,
		ULONG	Columns,
		ULONG	Rows
	)

Definition at line 287 of file xboxvmp.c.

{
    TRACE_(IHVVIDEO, "XboxVmpResetHw\n");
 
    if (!XboxVmpResetDevice((PXBOXVMP_DEVICE_EXTENSION)DeviceExtension, NULL))
    {
        return FALSE;
    }
 
    return TRUE;
}

Referenced by DriverEntry().

XboxVmpSetColorRegisters()

BOOLEAN FASTCALL XboxVmpSetColorRegisters	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PVIDEO_CLUT	ColorLookUpTable,
		PSTATUS_BLOCK	StatusBlock
	)

XboxVmpSetCurrentMode()

BOOLEAN FASTCALL XboxVmpSetCurrentMode	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PVIDEO_MODE	RequestedMode,
		PSTATUS_BLOCK	StatusBlock
	)

Definition at line 346 of file xboxvmp.c.

{
    if (RequestedMode->RequestedMode != 0)
    {
        return FALSE;
    }
 
    /* Nothing to do, really. We only support a single mode and we're already
     * in that mode
     */
    return TRUE;
}

Referenced by XboxVmpStartIO().

XboxVmpSetPowerState()

VP_STATUS NTAPI XboxVmpSetPowerState	(	PVOID	HwDeviceExtension,
		ULONG	HwId,
		PVIDEO_POWER_MANAGEMENT	VideoPowerControl
	)

Definition at line 328 of file xboxvmp.c.

{
    ERR_(IHVVIDEO, "XboxVmpSetPowerState not supported\n");
 
    return ERROR_INVALID_FUNCTION;
}

Referenced by DriverEntry().

XboxVmpStartIO()

BOOLEAN NTAPI XboxVmpStartIO	(	PVOID	HwDeviceExtension,
		PVIDEO_REQUEST_PACKET	RequestPacket
	)

Definition at line 138 of file xboxvmp.c.

{
    BOOLEAN Result;
 
    RequestPacket->StatusBlock->Status = ERROR_INVALID_PARAMETER;
 
    switch (RequestPacket->IoControlCode)
    {
        case IOCTL_VIDEO_SET_CURRENT_MODE:
        {
            TRACE_(IHVVIDEO, "XboxVmpStartIO IOCTL_VIDEO_SET_CURRENT_MODE\n");
 
            if (RequestPacket->InputBufferLength < sizeof(VIDEO_MODE))
            {
                RequestPacket->StatusBlock->Status = ERROR_INSUFFICIENT_BUFFER;
                return TRUE;
            }
 
            Result = XboxVmpSetCurrentMode(
                (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension,
                (PVIDEO_MODE)RequestPacket->InputBuffer,
                RequestPacket->StatusBlock);
            break;
        }
 
        case IOCTL_VIDEO_RESET_DEVICE:
        {
            TRACE_(IHVVIDEO, "XboxVmpStartIO IOCTL_VIDEO_RESET_DEVICE\n");
 
            Result = XboxVmpResetDevice(
                (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension,
                RequestPacket->StatusBlock);
            break;
        }
 
        case IOCTL_VIDEO_MAP_VIDEO_MEMORY:
        {
            TRACE_(IHVVIDEO, "XboxVmpStartIO IOCTL_VIDEO_MAP_VIDEO_MEMORY\n");
 
            if (RequestPacket->OutputBufferLength < sizeof(VIDEO_MEMORY_INFORMATION) ||
                RequestPacket->InputBufferLength < sizeof(VIDEO_MEMORY))
            {
                RequestPacket->StatusBlock->Status = ERROR_INSUFFICIENT_BUFFER;
                return TRUE;
            }
 
            Result = XboxVmpMapVideoMemory(
                (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension,
                (PVIDEO_MEMORY)RequestPacket->InputBuffer,
                (PVIDEO_MEMORY_INFORMATION)RequestPacket->OutputBuffer,
                RequestPacket->StatusBlock);
            break;
        }
 
        case IOCTL_VIDEO_UNMAP_VIDEO_MEMORY:
        {
            TRACE_(IHVVIDEO, "XboxVmpStartIO IOCTL_VIDEO_UNMAP_VIDEO_MEMORY\n");
 
            if (RequestPacket->InputBufferLength < sizeof(VIDEO_MEMORY))
            {
                RequestPacket->StatusBlock->Status = ERROR_INSUFFICIENT_BUFFER;
                return TRUE;
            }
 
            Result = XboxVmpUnmapVideoMemory(
                (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension,
                (PVIDEO_MEMORY)RequestPacket->InputBuffer,
                RequestPacket->StatusBlock);
            break;
        }
 
        case IOCTL_VIDEO_QUERY_NUM_AVAIL_MODES:
        {
            TRACE_(IHVVIDEO, "XboxVmpStartIO IOCTL_VIDEO_QUERY_NUM_AVAIL_MODES\n");
 
            if (RequestPacket->OutputBufferLength < sizeof(VIDEO_NUM_MODES))
            {
                RequestPacket->StatusBlock->Status = ERROR_INSUFFICIENT_BUFFER;
                return TRUE;
            }
 
            Result = XboxVmpQueryNumAvailModes(
                (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension,
                (PVIDEO_NUM_MODES)RequestPacket->OutputBuffer,
                RequestPacket->StatusBlock);
            break;
        }
 
        case IOCTL_VIDEO_QUERY_AVAIL_MODES:
        {
            TRACE_(IHVVIDEO, "XboxVmpStartIO IOCTL_VIDEO_QUERY_AVAIL_MODES\n");
 
            if (RequestPacket->OutputBufferLength < sizeof(VIDEO_MODE_INFORMATION))
            {
                RequestPacket->StatusBlock->Status = ERROR_INSUFFICIENT_BUFFER;
                return TRUE;
            }
 
            Result = XboxVmpQueryAvailModes(
                (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension,
                (PVIDEO_MODE_INFORMATION)RequestPacket->OutputBuffer,
                RequestPacket->StatusBlock);
            break;
        }
 
        case IOCTL_VIDEO_QUERY_CURRENT_MODE:
        {
            TRACE_(IHVVIDEO, "XboxVmpStartIO IOCTL_VIDEO_QUERY_CURRENT_MODE\n");
 
            if (RequestPacket->OutputBufferLength < sizeof(VIDEO_MODE_INFORMATION))
            {
                RequestPacket->StatusBlock->Status = ERROR_INSUFFICIENT_BUFFER;
                return TRUE;
            }
 
            Result = XboxVmpQueryCurrentMode(
                (PXBOXVMP_DEVICE_EXTENSION)HwDeviceExtension,
                (PVIDEO_MODE_INFORMATION)RequestPacket->OutputBuffer,
                RequestPacket->StatusBlock);
            break;
        }
 
        default:
        {
            WARN_(IHVVIDEO, "XboxVmpStartIO 0x%x not implemented\n", RequestPacket->IoControlCode);
 
            RequestPacket->StatusBlock->Status = ERROR_INVALID_FUNCTION;
            return FALSE;
        }
    }
 
    if (Result)
    {
        RequestPacket->StatusBlock->Status = NO_ERROR;
    }
 
    return TRUE;
}

Referenced by DriverEntry().

XboxVmpUnmapVideoMemory()

BOOLEAN FASTCALL XboxVmpUnmapVideoMemory	(	PXBOXVMP_DEVICE_EXTENSION	DeviceExtension,
		PVIDEO_MEMORY	VideoMemory,
		PSTATUS_BLOCK	StatusBlock
	)

Definition at line 448 of file xboxvmp.c.

{
    VideoPortUnmapMemory(
        DeviceExtension,
        VideoMemory->RequestedVirtualAddress,
        NULL);
 
    return TRUE;
}

Referenced by XboxVmpStartIO().