BSP Catalog Data (Windows Embedded CE 6.0)

1/5/2010

Catalog files (.pbcxml files) containing data about a BSP should be placed in a subdirectory named 'Catalog' below the root of the BSP's source code.

For example, Catalog information about the CEPC BSP is located in %_WINCEROOT%\Platform\Cepc\Catalog\Cepc.pbcxml. BSPs are described by 'Bsp' elements. Drivers or features of the BSP are described by 'Item' elements.

For information about driver Catalog data, see Driver Catalog Data.

'Bsp' elements typically contain the following information.

Name	Description
Id attribute	Required. Specifies an identifier that uniquely identifies the BSP within the Catalog. Identifiers can be any unique string, but the recommended format is: Bsp:<vendor name>:<BSP name>:<cpu> For example, the Id attribute of the Microsoft-supplied CEPC BSP is Bsp:MS:cepc:x86.
Title	Required. Specifies a friendly name for the BSP, which is displayed in the Catalog. The title should contain the name of the BSP and the supported CPU. The default value is set to the value of the Id attribute. This value should be edited by the BSP developer.
Description	Optional. Specifies a description for the BSP.
Size	Optional. Specifies an estimate, in bytes, of the amount of space that the BSP typically adds to a run-time image (.bin) file. This is used to estimate the size of an OS design before it is built.
SizeIsScaled	Optional. When set to TRUE, the size of the BSP changes depending on the CPU for which it is built. By default, SizeIsScaled is set to TRUE. For example, when the BSP is a CEPC, the value specified in the Size element is assumed to have been measured on an x86 CPU. When SizeIsScaled is set to TRUE, this value is multiplied by an approximate scaling factor, based on the typical change in sizes between x86 source code and code compiled for the CPU in the current platform configuration.
PlatformDirectory	Required. Specifies the BSP directory, typically under %_WINCEROOT%\Platform, where the BSP source code is located. Platform Builder uses this information to determine where to build the BSP.
CpuId	Required. Specifies the Catalog ID of the Catalog record describing the CPU that is supported by this BSP. Note: Each Catalog BSP can support only one CPU. However, multiple Catalog BSPs which support different CPUs can be created in the same PlatformDirectory. For example, the MIPSII, MIPSII_FP, MIPSIV, and MIPSIV_FP CPUs are supported by the code in the Platform\sg2_vr5500 directory. So the sg2_vr5500 Catalog file specifies 4 different Catalog BSPs, each of which supports one of these CPUs.
BspItemId	Zero or More. Specifies the Catalog ID of the Catalog record describing a Catalog item that you can include in the specified BSP. These Catalog items must be of type BspSpecific. Catalog items referenced using this type appear under the specified BSP in the Catalog.

Sample BSP Catalog File

The following example code shows a sample BSP catalog file.

<?xml version="1.0" encoding="utf-8"?>

<CatalogFile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" RequiredVersion="6.00" xsi:schemaLocation="urn:Microsoft.PlatformBuilder/Catalog PbcXml600.xsd" xmlns="urn:Microsoft.PlatformBuilder/Catalog">
  <FileInformation Id="FileInformation:MyBSPDir:x86">
    <Title>MyBSP: X86</Title>
    <Description>The MyBSP board support package.</Description>
    <Vendor>Microsoft</Vendor>
    <OSVersion>6.00</OSVersion>
    <FileVersion>6.00</FileVersion>
  </FileInformation>
  <Bsp Id="Bsp:MS:MyBSPDir:X86">
    <Title>MyBSP: X86</Title>
    <PlatformDirectory>MyBSPDir</PlatformDirectory>
    <CpuId>Cpu:X86</CpuId>
  </Bsp>
</CatalogFile>

See Also

Concepts

Device Driver and BSP Updater

Other Resources

Catalog Editor