Core OS Component Reference

This reference covers the components that can be added to the core OS.

Some components are the same on all supported BSPs while others differ from one BSP to another. Some components are only available for particular BSPs. This reference shows information for each BSP variant of the component.

Some components have parameters that can be set as part of the build process. The parameters of each component are listed.

Reference fields

The following fields are used in the reference entries for core OS components:

Include macro

The include macro name is the name used to include a component in a build.

Variants

This is a list of the variants for this component. To see the details for your BSP variant, follow the links to the listing for that variant.

Variant fields

The following fields are used in the reference entries for BSP variants of the core OS components:

Name

The common name of the component.

Synopsis

A synopsis description of the component.

Configlettes

A list of the configlettes provided with this component.

Configuration parameters

A list of the configuration parameters available for this component. For details of each parameter, follow the link to the description of the parameter.

Initialization routines

The name of the routine that is called when the component is initialized.

Modules

A list of the binary object files that make up the component. Where the binary object exposes and API, the name of the module will be linked to the documentation for that API.

Required components

A list of the components that must be included if this component is included. Follow the links for information on the required components. If the component is not linked, that means that the component resides in an individual BSP. These componets are not included in this reference.

Parameter fields

The following fields are used in the reference entries for BSP parameters:

Name

The common name of the parameter.

Synopsis

A synopsis description of the parameter.

Default

The default value of the parameter.

Type

The data type of the parameter.




Generated on 2007-10-15 17:17:22.