vbe3.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014  Jan Doležal (dolezj21@fel.cvut.cz)
 *                     CTU in Prague.
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */

#ifndef _VBE_H
#define _VBE_H

#ifndef ASM /* ASM */

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include <rtems/score/basedefs.h>

/*  VESA BIOS EXTENSION (VBE) Core functions Standard
    Version: 3.0 Date: September 16, 1998               */

#define VBE_functionSupported        0x4F

#define VBE_callSuccessful           0x00

#define VBE_callFailed               0x01

#define VBE_notSupportedInCurHWConf  0x02

#define VBE_callInvalid              0x03

/* VBE Mode Numbers */
#define VBE_modeNumberMask         0x01FF
#define VBE_modeNumberShift          0x00

#define VBE_VESAmodeMask           0x0100
#define VBE_VESAmodeShift            0x08
/* D9-D10 =  Reserved by VESA for future expansion (= 0) */
#define VBE_refreshRateCtrlMask    0x0800
#define VBE_refreshRateCtrlShift     0x0B
/* D12-13 = Reserved for VBE/AF (must be 0) */
#define VBE_linearFlatFrameBufMask 0x4000
#define VBE_linearFlatFrameBufShift  0x0E

#define VBE_preserveDispMemMask    0x8000
#define VBE_preserveDispMemShift     0x0F

/* Graphics modes */
#define VBE_R640x400C256      0x100

#define VBE_R640x480C256      0x101

#define VBE_R800x600C16       0x102

#define VBE_b7R800x600C16     0x6A

#define VBE_R800x600C256      0x103

#define VBE_R1024x768C16      0x104

#define VBE_R1024x768C256     0x105

#define VBE_R1280x1024C16     0x106

#define VBE_R1280x1024C256    0x107

#define VBE_R320x200C32K      0x10D

#define VBE_R320x200C64K      0x10E

#define VBE_R320x200C17M      0x10F

#define VBE_R640x480C32K      0x110

#define VBE_R640x480C64K      0x111

#define VBE_R640x480C17M      0x112

#define VBE_R800x600C32K      0x113

#define VBE_R800x600C64K      0x114

#define VBE_R800x600C17M      0x115

#define VBE_R1024x768C32K     0x116

#define VBE_R1024x768C64K     0x117

#define VBE_R1024x768C17M     0x118

#define VBE_R1280x1024C32K    0x119

#define VBE_R1280x1024C64K    0x11A

#define VBE_R1280x1024C17M    0x11B
#define VBE_SpecialMode       0x81FF

/* Text modes */
#define VBE_C80R60            0x108 
#define VBE_C132R25           0x109 
#define VBE_C132R43           0x10A 
#define VBE_C132R50           0x10B 
#define VBE_C132R60           0x10C 
/* VBE function numbers - passed in AX register */

#define VBE_RetVBEConInf       0x4F00

#define VBE_RetVBEModInf       0x4F01

#define VBE_SetVBEMod          0x4F02

#define VBE_RetCurVBEMod       0x4F03

#define VBE_SavResSta          0x4F04

#define VBE_DisWinCon          0x4F05

#define VBE_SetGetLogScaLinLen 0x4F06

#define VBE_SetGetDisSta       0x4F07

#define VBE_SetGetDACPalFor    0x4F08

#define VBE_SetGetPalDat       0x4F09

#define VBE_RetVBEProModInt    0x4F0A

#define VBE_GetSetpixclo       0x4F0B

#define VBE_PowManExt          0x4F10

#define VBE_FlaPanIntExt       0x4F11

#define VBE_AudIntExt          0x4F13

#define VBE_OEMExt             0x4F14

#define VBE_DisDatCha          0x4F15

/* VBE subfunction numbers - passed in BL register */
#define VBE_RetVBESupSpeInf    0x00  
/* *** Structures *** */

typedef struct {
    uint16_t offset;
    uint16_t selector;
} RTEMS_PACKED VBE_far_pointer;

typedef struct {
    uint8_t   Signature[4];
    uint16_t  EntryPoint;
    uint16_t  PMInitialize;
    uint16_t  BIOSDataSel;
    uint16_t  A0000Sel;
    uint16_t  B0000Sel;
    uint16_t  B8000Sel;
    uint16_t  CodeSegSel;
    uint8_t   InProtectMode;
    uint8_t   Checksum;
} RTEMS_PACKED VBE_protected_mode_info_block;

#define VBE_SIGNATURE "VESA"

#define VBE20plus_SIGNATURE "VBE2"

#define VBE_STUB_VideoModeList 0xFFFF
#define VBE_END_OF_VideoModeList 0xFFFF

typedef struct {
    uint8_t   VbeSignature[4];
    uint16_t  VbeVersion;
    uint8_t  *OemStringPtr;
    uint8_t   Capabilities[4];
    uint32_t *VideoModePtr;
    uint16_t  TotalMemory;
    /*  Added for VBE 2.0+ */
    uint16_t  OemSoftwareRev;
    uint8_t  *OemVendorNamePtr;
    uint8_t  *OemProductNamePtr;
    uint8_t  *OemProductRevPtr;
    uint8_t   Reserved[222];
    uint8_t   OemData[256];
} RTEMS_PACKED VBE_vbe_info_block;

typedef struct {
    /*  Mandatory information for all VBE revisions */
    uint16_t  ModeAttributes;
    uint8_t   WinAAttributes;
    uint8_t   WinBAttributes;
    uint16_t  WinGranularity;
    uint16_t  WinSize;
    uint16_t  WinASegment;
    uint16_t  WinBSegment;
    uint32_t *WinFuncPtr;
    uint16_t  BytesPerScanLine;
    /*  Mandatory information for VBE 1.2 and above */
    uint16_t  XResolution;
    uint16_t  YResolution;
    uint8_t   XCharSize;
    uint8_t   YCharSize;
    uint8_t   NumberOfPlanes;
    uint8_t   BitsPerPixel;
    uint8_t   NumberOfBanks;
    uint8_t   MemoryModel;
    uint8_t   BankSize;
    uint8_t   NumberOfImagePages;
    uint8_t   Reserved0;
    /*  Direct Color fields (required for direct/6 and YUV/7 memory models) */
    uint8_t   RedMaskSize;
    uint8_t   RedFieldPosition;
    uint8_t   GreenMaskSize;
    uint8_t   GreenFieldPosition;
    uint8_t   BlueMaskSize;
    uint8_t   BlueFieldPosition;
    uint8_t   RsvdMaskSize;
    uint8_t   RsvdFieldPosition;
    uint8_t   DirectColorModeInfo;
    /*  Mandatory information for VBE 2.0 and above */
    uint32_t *PhysBasePtr;
    uint32_t  Reserved1;
    uint16_t  Reserved2;
    /*  Mandatory information for VBE 3.0 and above */
    uint16_t  LinBytesPerScanLine;
    uint8_t   BnkNumberOfImagePages;
    uint8_t   LinNumberOfImagePages;
        /* linear modes */
    uint8_t   LinRedMaskSize;
    uint8_t   LinRedFieldPosition;
    uint8_t   LinGreenMaskSize;
    uint8_t   LinGreenFieldPosition;
    uint8_t   LinBlueMaskSize;
    uint8_t   LinBlueFieldPosition;
    uint8_t   LinRsvdMaskSize;
    uint8_t   LinRsvdFieldPosition;
    uint32_t  MaxPixelClock;
    uint8_t   Reserved3[189];
} RTEMS_PACKED VBE_mode_info_block;

typedef struct {
    uint16_t  HorizontalTotal;
    uint16_t  HorizontalSyncStart;
    uint16_t  HorizontalSyncEnd;
    uint16_t  VerticalTotal;
    uint16_t  VerticalSyncStart;
    uint16_t  VerticalSyncEnd;
    uint8_t   Flags;
    uint32_t  PixelClock;
    uint16_t  RefreshRate;
    uint8_t   Reserved[40];
} RTEMS_PACKED VBE_CRTC_info_block;

typedef struct {
    uint8_t   Blue;
    uint8_t   Green;
    uint8_t   Red;
    uint8_t   Alignment;
} RTEMS_PACKED VBE_palette_entry;

typedef struct {
    uint8_t   SupVbeSignature[7];
    uint16_t  SupVbeVersion;
    uint8_t   SupVbeSubFunc[8];
    uint16_t  OemSoftwareRev;
    uint8_t  *OemVendorNamePtr;
    uint8_t  *OemProductNamePtr;
    uint8_t  *OemProductRevPtr;
    uint8_t  *OemStringPtr;
    uint8_t   Reserved[221];
} RTEMS_PACKED VBE_supplemental_vbe_info_block;

/* VBE_vbe_info_block Capabilities */
#define VBE_DACswitchableMask     0x0001

#define VBE_notVGAcompatibleMask  0x0002

#define VBE_specialRAMDACopMask   0x0004

#define VBE_hwStereoscopicMask    0x0008

#define VBE_supportEVCconnMask    0x0010
/*  D5-31 = Reserved */

/* VBE_mode_info_block ModeAttributes */
#define VBE_modSupInHWMask        0x0001
/*  D1 =  1 (Reserved) */
#define VBE_TTYOutSupByBIOSMask   0x0004

#define VBE_ColorModeMask         0x0008

#define VBE_GraphicsModeMask      0x0010

#define VBE_VGACompModeMask       0x0020

#define VBE_VGACompWinMemModeMask 0x0040

#define VBE_LinFraBufModeAvaiMask 0x0080

#define VBE_DblScnModeAvaiMask    0x0100

#define VBE_InterlModeAvaiMask    0x0200

#define VBE_HWTripBufSupMask      0x0400

#define VBE_HWSterDispSupMask     0x0800

#define VBE_DualDispStAdrSupMask  0x1000
/*  D13-D15 =  Reserved */

/* VBE_mode_info_block WinXAttributes */
#define VBE_RelocWinSupMask       0x01

#define VBE_WinReadableMask       0x02

#define VBE_WinWritableMask       0x04
/*  D3-D7 =  Reserved */

/* VBE_mode_info_block MemoryModel */
#define VBE_TextMode              0x00
#define VBE_CGAGraphics           0x01
#define VBE_HerculesGraphics      0x02
#define VBE_Planar                0x03
#define VBE_PackedPixel           0x04
#define VBE_NonChain4Color256     0x05
#define VBE_DirectColor           0x06
#define VBE_YUV                   0x07
    /* 0x08-0x0F Reserved, to be defined by VESA */
    /* 0x10-0xFF To be defined by OEM */

/* VBE_mode_info_block DirectColorModeInfo */
#define VBE_ColRampProgMask       0x01

#define VBE_RsvdBitsUsableMask    0x02

/* VBE_CRTC_info_block Flags */
#define VBE_GrModeDblScanMask     0x01

#define VBE_GrModeInterlMask      0x02

#define VBE_HorSncPolNegMask      0x04

#define VBE_VerSncPolNegMask      0x08


/*  VESA BIOS Extensions/Display Data Channel Standard
    Version: 1.1 November 18, 1999                      */

/* VBE/DDC subfunction numbers - passed in BL register */
#define VBEDDC_Capabilities    0x0

#define VBEDDC_ReadEDID        0x1

/* DDC Capabilities */
/* DDC level supported - returned in BL register */
#define VBEDDC_1SupportedMask  0x1

#define VBEDDC_2SupportedMask  0x2

#define VBEDDC_scrBlnkDatTrMs  0x4


/*  VESA BIOS Extensions/Serial Control Interface Standard
    Version: 1.0 Revision: 2 Date: July 2, 1997         */

/* VBE/SCI subfunction numbers - passed in BL register */
#define VBESCI_ReportCapabil   0x10

#define VBESCI_BegSCLSDACtrl   0x11

#define VBESCI_EndSCLSDACtrl   0x12

#define VBESCI_WrtSCLClkLine   0x13

#define VBESCI_WrtSDADatLine   0x14

#define VBESCI_RdySCLClkLine   0x15

#define VBESCI_RdySDADatLine   0x16

/* SCI Capabilities */
/* I2C level supported - returned in BL register */
#define VBESCI_capSCLwrtMask   0x1

#define VBESCI_capSDAwrtMask   0x2

#define VBESCI_capSCLrdyMask   0x4

#define VBESCI_capSDArdyMask   0x8


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* ASM */

#endif /* _VBE_H */