Add Device Drivers to the Catalog (Compact 2013)

3/26/2014

You can add a device driver to the catalog by using Platform Builder as a part of the larger process of creating a device driver for use with Windows Embedded Compact 2013

You should add your device driver to the catalog after you create and build a driver that correctly interacts with both your hardware and the Compact 2013 OS.

You can also distribute custom catalog items, along with their corresponding source driver modules, to third-party developers. Then, the third-party developer can view your device drivers in the catalog and can use the Catalog Items View to include them in their custom OS designs.

To add a device driver to the catalog

1. Create a new catalog file that will represent your driver in the Platform Builder catalog.Make sure that you save the new file in a Catalog folder in a directory for a feature. The following list shows the locations where you can save your catalog file:

   • %_WINCEROOT%\PUBLIC\<ANY_DIRECTORY>\CATALOG\*.pbcxml
   • %_WINCEROOT%\PUBLIC\<ANY_DIRECTORY>\CATALOG\<ANY_DIRECTORY>\*.pbcxml
   • %_WINCEROOT%\PLATFORM\<ANY_DIRECTORY>\CATALOG\*.pbcxml
   • %_WINCEROOT%\PLATFORM\<ANY_DIRECTORY>\CATALOG\<ANY_DIRECTORY>\*.pbcxml
   • %_WINCEROOT%\PLATFORM\COMMON\SRC\SOC\<ANY_DIRECTORY>\CATALOG\*.pbcxml
   • %_WINCEROOT%\PLATFORM\COMMON\SRC\SOC\<ANY_DIRECTORY>\CATALOG\<ANY_DIRECTORY>\*.pbcxml

2. Customize the catalog file by setting property values by using the Catalog Editor. This provides Platform Builder with information that is required to display your device driver in the catalog.

3. To validate the catalog file, click Validate in the Catalog Editor to validate the changes against the XSD schema.

4. Edit the build-configuration files to bring in the Sysgen variable for your module.

   To import the .pbcxml file into the catalog:

   1. On the View menu, click Other Windows, and then click Catalog Item View.
   2. In Catalog Item View, click Refresh catalog tree.

   Note

   Catalog Items View is available only if an existing OS design is open in Platform Builder.

5. In Catalog Items View, expand the Third Party node to verify that your driver has been added to the catalog.

To create a catalog item that represents a device driver

1. In Catalog Editor, click the Add arrow, and then click Catalog Item.

2. Browse to the new catalog item and select it.The Properties window displays the property settings for the selected catalog item in the .pbcxml file.

3. Click in the box next to Supported CPUs, select which CPUs will support your device driver, and then click OK. In this example, select x86.

4. Click in the box next to Type, and then select the catalog item group to which you want to add the device driver. In this example, select General.

5. In the box next to Title, type a name for the catalog item that you want to add to the catalog. For example, type My Device Driver.

6. In the box next to Unique Id, type a unique ID for the catalog item that follows the expected format. If the device driver can be used with various board support packages (BSPs), you can use the format Item:VENDOR:SYSGEN. If the device driver is BSP-specific, you can use the format Item:VENDOR:MODULE:BSPDIR. For example, you can type MyDriver:MyCompany:sysgen_my_driver.

7. Click in the box next to Modules. Type the full name of each file that represents a module that implements the functionality of this driver (for example, type MyDriver.dll, and then click OK.

8. In the box next to Sysgen variable, type a Sysgen variable for your selectable catalog item. For example, type SYSGEN_MY_DRIVER.

9. Add any additional property values that you want for the catalog item.

10. If you want to add a link to driver source code, add a source-code link to the catalog item. This source-code link is for display purposes only.

11. On the File menu, click Save <MyCatalogFile>.pbcxml.

See Also

Concepts

Catalog Item Management