osd
Xilinx SDK Drivers API Documentation
XOsd_Config Struct Reference

OSD core configuration structure. More...

Data Fields

u16 DeviceId
 DeviceId is the unique ID of the core. More...
 
u32 BaseAddress
 BaseAddress is the physical base address of the OSD core registers. More...
 
u16 LayerNum
 The number of Layers. More...
 
u16 SlaveAxisVideoDataWidth
 Slave Axis Video Data Width. More...
 
u16 Layer0Type
 Type of Layer #0. More...
 
u16 Layer1Type
 Type of Layer #1. More...
 
u16 Layer2Type
 Type of Layer #2. More...
 
u16 Layer3Type
 Type of Layer #3. More...
 
u16 Layer4Type
 Type of Layer #4. More...
 
u16 Layer5Type
 Type of Layer #5. More...
 
u16 Layer6Type
 Type of Layer #6. More...
 
u16 Layer7Type
 Type of Layer #7. More...
 
u16 Layer0InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer0InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer0InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer0InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer0ColorLutSize
 Color Look Up Table (LUT) Size. More...
 
u16 Layer0ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer0FontNumChars
 Font: Number of characters. More...
 
u16 Layer0FontWidth
 Font: Width. More...
 
u16 Layer0FontHeight
 Font: Height. More...
 
u16 Layer0FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer0FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer0TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer0TextMaxStringLength
 Text: Maximum length of a String. More...
 
u16 Layer1InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer1InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer1InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer1InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer1ColorLutSize
 Color LUT Size. More...
 
u16 Layer1ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer1FontNumChars
 Font: Number of characters. More...
 
u16 Layer1FontWidth
 Font: Width. More...
 
u16 Layer1FontHeight
 Font: Height. More...
 
u16 Layer1FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer1FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer1TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer1TextMaxStringLength
 Text: Maximum length of a String. More...
 
u16 Layer2InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer2InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer2InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer2InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer2ColorLutSize
 Color LUT Size. More...
 
u16 Layer2ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer2FontNumChars
 Font: Number of characters. More...
 
u16 Layer2FontWidth
 Font: Width. More...
 
u16 Layer2FontHeight
 Font: Height. More...
 
u16 Layer2FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer2FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer2TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer2TextMaxStringLength
 Text: Maximum length of a String. More...
 
u16 Layer3InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer3InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer3InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer3InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer3ColorLutSize
 Color LUT Size. More...
 
u16 Layer3ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer3FontNumChars
 Font: Number of characters. More...
 
u16 Layer3FontWidth
 Font: Width. More...
 
u16 Layer3FontHeight
 Font: Height. More...
 
u16 Layer3FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer3FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer3TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer3TextMaxStringLength
 Text: Maximum length of a String. More...
 
u16 Layer4InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer4InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer4InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer4InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer4ColorLutSize
 Color LUT Size. More...
 
u16 Layer4ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer4FontNumChars
 Font: Number of characters. More...
 
u16 Layer4FontWidth
 Font: Width. More...
 
u16 Layer4FontHeight
 Font: Height. More...
 
u16 Layer4FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer4FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer4TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer4TextMaxStringLength
 Text: Maximum length of a String. More...
 
u16 Layer5InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer5InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer5InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer5InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer5ColorLutSize
 Color LUT Size. More...
 
u16 Layer5ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer5FontNumChars
 Font: Number of characters. More...
 
u16 Layer5FontWidth
 Font: Width. More...
 
u16 Layer5FontHeight
 Font: Height. More...
 
u16 Layer5FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer5FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer5TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer5TextMaxStringLength
 Text: Maximum length of a String. More...
 
u16 Layer6InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer6InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer6InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer6InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer6ColorLutSize
 Color LUT Size. More...
 
u16 Layer6ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer6FontNumChars
 Font: Number of characters. More...
 
u16 Layer6FontWidth
 Font: Width. More...
 
u16 Layer6FontHeight
 Font: Height. More...
 
u16 Layer6FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer6FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer6TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer6TextMaxStringLength
 Text: Maximum length of a String. More...
 
u16 Layer7InstructionMemSize
 Instruction Memory Size. More...
 
u16 Layer7InstructionBoxEnable
 Instruction Box Enable. More...
 
u16 Layer7InstructionLineEnable
 Instruction Line Enable. More...
 
u16 Layer7InstructionTextEnable
 Instruction Text Enable. More...
 
u16 Layer7ColorLutSize
 Color LUT Size. More...
 
u16 Layer7ColorLutMemoryType
 Color LUT Memory Type. More...
 
u16 Layer7FontNumChars
 Font: Number of characters. More...
 
u16 Layer7FontWidth
 Font: Width. More...
 
u16 Layer7FontHeight
 Font: Height. More...
 
u16 Layer7FontBitsPerPixel
 Font: Number of bits per pixel. More...
 
u16 Layer7FontAsciiOffset
 Font: ASCII offset of 1st character. More...
 
u16 Layer7TextNumStrings
 Text: Number of Strings. More...
 
u16 Layer7TextMaxStringLength
 Text: Maximum length of a String. More...
 

Detailed Description

OSD core configuration structure.

Each OSD core should have a configuration structure associated.

Field Documentation

◆ BaseAddress

◆ DeviceId

u16 XOsd_Config::DeviceId

DeviceId is the unique ID of the core.

◆ Layer0ColorLutMemoryType

u16 XOsd_Config::Layer0ColorLutMemoryType

Color LUT Memory Type.

◆ Layer0ColorLutSize

u16 XOsd_Config::Layer0ColorLutSize

Color Look Up Table (LUT) Size.

◆ Layer0FontAsciiOffset

u16 XOsd_Config::Layer0FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer0FontBitsPerPixel

u16 XOsd_Config::Layer0FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer0FontHeight

u16 XOsd_Config::Layer0FontHeight

Font: Height.

◆ Layer0FontNumChars

u16 XOsd_Config::Layer0FontNumChars

Font: Number of characters.

◆ Layer0FontWidth

u16 XOsd_Config::Layer0FontWidth

Font: Width.

◆ Layer0InstructionBoxEnable

u16 XOsd_Config::Layer0InstructionBoxEnable

Instruction Box Enable.

◆ Layer0InstructionLineEnable

u16 XOsd_Config::Layer0InstructionLineEnable

Instruction Line Enable.

◆ Layer0InstructionMemSize

u16 XOsd_Config::Layer0InstructionMemSize

Instruction Memory Size.

◆ Layer0InstructionTextEnable

u16 XOsd_Config::Layer0InstructionTextEnable

Instruction Text Enable.

◆ Layer0TextMaxStringLength

u16 XOsd_Config::Layer0TextMaxStringLength

Text: Maximum length of a String.

Layer 1

◆ Layer0TextNumStrings

u16 XOsd_Config::Layer0TextNumStrings

Text: Number of Strings.

◆ Layer0Type

u16 XOsd_Config::Layer0Type

Type of Layer #0.

◆ Layer1ColorLutMemoryType

u16 XOsd_Config::Layer1ColorLutMemoryType

Color LUT Memory Type.

◆ Layer1ColorLutSize

u16 XOsd_Config::Layer1ColorLutSize

Color LUT Size.

◆ Layer1FontAsciiOffset

u16 XOsd_Config::Layer1FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer1FontBitsPerPixel

u16 XOsd_Config::Layer1FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer1FontHeight

u16 XOsd_Config::Layer1FontHeight

Font: Height.

◆ Layer1FontNumChars

u16 XOsd_Config::Layer1FontNumChars

Font: Number of characters.

◆ Layer1FontWidth

u16 XOsd_Config::Layer1FontWidth

Font: Width.

◆ Layer1InstructionBoxEnable

u16 XOsd_Config::Layer1InstructionBoxEnable

Instruction Box Enable.

◆ Layer1InstructionLineEnable

u16 XOsd_Config::Layer1InstructionLineEnable

Instruction Line Enable.

◆ Layer1InstructionMemSize

u16 XOsd_Config::Layer1InstructionMemSize

Instruction Memory Size.

◆ Layer1InstructionTextEnable

u16 XOsd_Config::Layer1InstructionTextEnable

Instruction Text Enable.

◆ Layer1TextMaxStringLength

u16 XOsd_Config::Layer1TextMaxStringLength

Text: Maximum length of a String.

Layer 2

◆ Layer1TextNumStrings

u16 XOsd_Config::Layer1TextNumStrings

Text: Number of Strings.

◆ Layer1Type

u16 XOsd_Config::Layer1Type

Type of Layer #1.

◆ Layer2ColorLutMemoryType

u16 XOsd_Config::Layer2ColorLutMemoryType

Color LUT Memory Type.

◆ Layer2ColorLutSize

u16 XOsd_Config::Layer2ColorLutSize

Color LUT Size.

◆ Layer2FontAsciiOffset

u16 XOsd_Config::Layer2FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer2FontBitsPerPixel

u16 XOsd_Config::Layer2FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer2FontHeight

u16 XOsd_Config::Layer2FontHeight

Font: Height.

◆ Layer2FontNumChars

u16 XOsd_Config::Layer2FontNumChars

Font: Number of characters.

◆ Layer2FontWidth

u16 XOsd_Config::Layer2FontWidth

Font: Width.

◆ Layer2InstructionBoxEnable

u16 XOsd_Config::Layer2InstructionBoxEnable

Instruction Box Enable.

◆ Layer2InstructionLineEnable

u16 XOsd_Config::Layer2InstructionLineEnable

Instruction Line Enable.

◆ Layer2InstructionMemSize

u16 XOsd_Config::Layer2InstructionMemSize

Instruction Memory Size.

◆ Layer2InstructionTextEnable

u16 XOsd_Config::Layer2InstructionTextEnable

Instruction Text Enable.

◆ Layer2TextMaxStringLength

u16 XOsd_Config::Layer2TextMaxStringLength

Text: Maximum length of a String.

Layer 3

◆ Layer2TextNumStrings

u16 XOsd_Config::Layer2TextNumStrings

Text: Number of Strings.

◆ Layer2Type

u16 XOsd_Config::Layer2Type

Type of Layer #2.

◆ Layer3ColorLutMemoryType

u16 XOsd_Config::Layer3ColorLutMemoryType

Color LUT Memory Type.

◆ Layer3ColorLutSize

u16 XOsd_Config::Layer3ColorLutSize

Color LUT Size.

◆ Layer3FontAsciiOffset

u16 XOsd_Config::Layer3FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer3FontBitsPerPixel

u16 XOsd_Config::Layer3FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer3FontHeight

u16 XOsd_Config::Layer3FontHeight

Font: Height.

◆ Layer3FontNumChars

u16 XOsd_Config::Layer3FontNumChars

Font: Number of characters.

◆ Layer3FontWidth

u16 XOsd_Config::Layer3FontWidth

Font: Width.

◆ Layer3InstructionBoxEnable

u16 XOsd_Config::Layer3InstructionBoxEnable

Instruction Box Enable.

◆ Layer3InstructionLineEnable

u16 XOsd_Config::Layer3InstructionLineEnable

Instruction Line Enable.

◆ Layer3InstructionMemSize

u16 XOsd_Config::Layer3InstructionMemSize

Instruction Memory Size.

◆ Layer3InstructionTextEnable

u16 XOsd_Config::Layer3InstructionTextEnable

Instruction Text Enable.

◆ Layer3TextMaxStringLength

u16 XOsd_Config::Layer3TextMaxStringLength

Text: Maximum length of a String.

Layer 4

◆ Layer3TextNumStrings

u16 XOsd_Config::Layer3TextNumStrings

Text: Number of Strings.

◆ Layer3Type

u16 XOsd_Config::Layer3Type

Type of Layer #3.

◆ Layer4ColorLutMemoryType

u16 XOsd_Config::Layer4ColorLutMemoryType

Color LUT Memory Type.

◆ Layer4ColorLutSize

u16 XOsd_Config::Layer4ColorLutSize

Color LUT Size.

◆ Layer4FontAsciiOffset

u16 XOsd_Config::Layer4FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer4FontBitsPerPixel

u16 XOsd_Config::Layer4FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer4FontHeight

u16 XOsd_Config::Layer4FontHeight

Font: Height.

◆ Layer4FontNumChars

u16 XOsd_Config::Layer4FontNumChars

Font: Number of characters.

◆ Layer4FontWidth

u16 XOsd_Config::Layer4FontWidth

Font: Width.

◆ Layer4InstructionBoxEnable

u16 XOsd_Config::Layer4InstructionBoxEnable

Instruction Box Enable.

◆ Layer4InstructionLineEnable

u16 XOsd_Config::Layer4InstructionLineEnable

Instruction Line Enable.

◆ Layer4InstructionMemSize

u16 XOsd_Config::Layer4InstructionMemSize

Instruction Memory Size.

◆ Layer4InstructionTextEnable

u16 XOsd_Config::Layer4InstructionTextEnable

Instruction Text Enable.

◆ Layer4TextMaxStringLength

u16 XOsd_Config::Layer4TextMaxStringLength

Text: Maximum length of a String.

Layer 5

◆ Layer4TextNumStrings

u16 XOsd_Config::Layer4TextNumStrings

Text: Number of Strings.

◆ Layer4Type

u16 XOsd_Config::Layer4Type

Type of Layer #4.

◆ Layer5ColorLutMemoryType

u16 XOsd_Config::Layer5ColorLutMemoryType

Color LUT Memory Type.

◆ Layer5ColorLutSize

u16 XOsd_Config::Layer5ColorLutSize

Color LUT Size.

◆ Layer5FontAsciiOffset

u16 XOsd_Config::Layer5FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer5FontBitsPerPixel

u16 XOsd_Config::Layer5FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer5FontHeight

u16 XOsd_Config::Layer5FontHeight

Font: Height.

◆ Layer5FontNumChars

u16 XOsd_Config::Layer5FontNumChars

Font: Number of characters.

◆ Layer5FontWidth

u16 XOsd_Config::Layer5FontWidth

Font: Width.

◆ Layer5InstructionBoxEnable

u16 XOsd_Config::Layer5InstructionBoxEnable

Instruction Box Enable.

◆ Layer5InstructionLineEnable

u16 XOsd_Config::Layer5InstructionLineEnable

Instruction Line Enable.

◆ Layer5InstructionMemSize

u16 XOsd_Config::Layer5InstructionMemSize

Instruction Memory Size.

◆ Layer5InstructionTextEnable

u16 XOsd_Config::Layer5InstructionTextEnable

Instruction Text Enable.

◆ Layer5TextMaxStringLength

u16 XOsd_Config::Layer5TextMaxStringLength

Text: Maximum length of a String.

Layer 6

◆ Layer5TextNumStrings

u16 XOsd_Config::Layer5TextNumStrings

Text: Number of Strings.

◆ Layer5Type

u16 XOsd_Config::Layer5Type

Type of Layer #5.

◆ Layer6ColorLutMemoryType

u16 XOsd_Config::Layer6ColorLutMemoryType

Color LUT Memory Type.

◆ Layer6ColorLutSize

u16 XOsd_Config::Layer6ColorLutSize

Color LUT Size.

◆ Layer6FontAsciiOffset

u16 XOsd_Config::Layer6FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer6FontBitsPerPixel

u16 XOsd_Config::Layer6FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer6FontHeight

u16 XOsd_Config::Layer6FontHeight

Font: Height.

◆ Layer6FontNumChars

u16 XOsd_Config::Layer6FontNumChars

Font: Number of characters.

◆ Layer6FontWidth

u16 XOsd_Config::Layer6FontWidth

Font: Width.

◆ Layer6InstructionBoxEnable

u16 XOsd_Config::Layer6InstructionBoxEnable

Instruction Box Enable.

◆ Layer6InstructionLineEnable

u16 XOsd_Config::Layer6InstructionLineEnable

Instruction Line Enable.

◆ Layer6InstructionMemSize

u16 XOsd_Config::Layer6InstructionMemSize

Instruction Memory Size.

◆ Layer6InstructionTextEnable

u16 XOsd_Config::Layer6InstructionTextEnable

Instruction Text Enable.

◆ Layer6TextMaxStringLength

u16 XOsd_Config::Layer6TextMaxStringLength

Text: Maximum length of a String.

Layer 7

◆ Layer6TextNumStrings

u16 XOsd_Config::Layer6TextNumStrings

Text: Number of Strings.

◆ Layer6Type

u16 XOsd_Config::Layer6Type

Type of Layer #6.

◆ Layer7ColorLutMemoryType

u16 XOsd_Config::Layer7ColorLutMemoryType

Color LUT Memory Type.

◆ Layer7ColorLutSize

u16 XOsd_Config::Layer7ColorLutSize

Color LUT Size.

◆ Layer7FontAsciiOffset

u16 XOsd_Config::Layer7FontAsciiOffset

Font: ASCII offset of 1st character.

◆ Layer7FontBitsPerPixel

u16 XOsd_Config::Layer7FontBitsPerPixel

Font: Number of bits per pixel.

◆ Layer7FontHeight

u16 XOsd_Config::Layer7FontHeight

Font: Height.

◆ Layer7FontNumChars

u16 XOsd_Config::Layer7FontNumChars

Font: Number of characters.

◆ Layer7FontWidth

u16 XOsd_Config::Layer7FontWidth

Font: Width.

◆ Layer7InstructionBoxEnable

u16 XOsd_Config::Layer7InstructionBoxEnable

Instruction Box Enable.

◆ Layer7InstructionLineEnable

u16 XOsd_Config::Layer7InstructionLineEnable

Instruction Line Enable.

◆ Layer7InstructionMemSize

u16 XOsd_Config::Layer7InstructionMemSize

Instruction Memory Size.

◆ Layer7InstructionTextEnable

u16 XOsd_Config::Layer7InstructionTextEnable

Instruction Text Enable.

◆ Layer7TextMaxStringLength

u16 XOsd_Config::Layer7TextMaxStringLength

Text: Maximum length of a String.

◆ Layer7TextNumStrings

u16 XOsd_Config::Layer7TextNumStrings

Text: Number of Strings.

◆ Layer7Type

u16 XOsd_Config::Layer7Type

Type of Layer #7.

Layer 0

◆ LayerNum

u16 XOsd_Config::LayerNum

The number of Layers.

Referenced by XOsd_CfgInitialize().

◆ SlaveAxisVideoDataWidth

u16 XOsd_Config::SlaveAxisVideoDataWidth

Slave Axis Video Data Width.

Referenced by XOsd_LoadColorLUTBank().