module ti.catalog.arm.cortexm3.concertoInit.Boot

module ti.catalog.arm.cortexm3.concertoInit.Boot

Concerto M3 Boot Support

C synopsis
Individual elements
XDCscript usage
Individual elements

The Boot module supports boot initialization for the Concerto M3 core. A special boot init function is created based on the configuration settings for this module. This function is hooked into the xdc.runtime.Reset.fxns[] array and called very early at boot time (prior to cinit processing). [ more ... ]

C synopsis target-domain sourced in ti/catalog/arm/cortexm3/concertoInit/Boot.xdc

#include <ti/catalog/arm/cortexm3/concertoInit/Boot.h>

Functions common to all target modules
	Boot_Module_getMask// Returns the diagnostics mask for this module, Boot_Module_hasMask// Test whether this module has a diagnostics mask, Boot_Module_heap// The heap from which this module allocates memory, Boot_Module_id// Get this module's unique id, Boot_Module_setMask// Set the diagnostics mask for this module, Boot_Module_startupDone// Test if this module has completed startup
Constants
extern const Bool	Boot_configureClocks// Clock configuration flag, default is false;

DETAILS

The Boot module supports boot initialization for the Concerto M3 core. A special boot init function is created based on the configuration settings for this module. This function is hooked into the xdc.runtime.Reset.fxns[] array and called very early at boot time (prior to cinit processing).

The code to support the boot module is placed in a separate section named ".text:.bootCodeSection" to allow placement of this section in the linker .cmd file if necessary. This section is a subsection of the ".text" section so this code will be placed into the .text section unless explicitly placed, either through Program.sectMap or through a linker command file.

config Boot_configureClocks // module-wide

Clock configuration flag, default is false

C synopsis target-domain

extern const Bool Boot_configureClocks;

DETAILS

Set to true to configure the PLL and system and M3 subsystem clock dividers.

Module-Wide Built-Ins

C synopsis target-domain

Types_ModuleId Boot_Module_id();

// Get this module's unique id

Bool Boot_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle Boot_Module_heap();

// The heap from which this module allocates memory

Bool Boot_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 Boot_Module_getMask();

// Returns the diagnostics mask for this module

Void Boot_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

XDCscript usage meta-domain sourced in ti/catalog/arm/cortexm3/concertoInit/Boot.xdc

var Boot = xdc.useModule('ti.catalog.arm.cortexm3.concertoInit.Boot');

module-wide constants & types

values of type Boot.FractMult// System PLL Fractional Multiplier (SPLLFMULT) value

const Boot.Fract_0// Fractional multiplier is 0;

const Boot.Fract_25// Fractional multiplier is 0.25;

const Boot.Fract_50// Fractional multiplier is 0.5;

const Boot.Fract_75// Fractional multiplier is 0.75;

values of type Boot.M3Div// M3 Subsystem Clock Divider (M3SSDIVSEL) value

const Boot.M3Div_1// Divide by 1;

const Boot.M3Div_2// Divide by 2;

const Boot.M3Div_4// Divide by 4;

values of type Boot.SysDiv// System Clock Divider (SYSDIVSEL) value

const Boot.Div_1// Divide by 1;

const Boot.Div_2// Divide by 2;

const Boot.Div_4// Divide by 4;

const Boot.Div_8// Divide by 8;

var obj = new Boot.ModuleView// ;

obj.configureClocks = Bool ...

obj.OSCCLK = UInt ...

obj.SPLLIMULT = UInt ...

obj.SPLLFMULT = String ...

obj.SYSDIVSEL = String ...

obj.M3SSDIVSEL = String ...

obj.bootC28 = Bool ...

module-wide config parameters

Boot.configureClocks// Clock configuration flag, default is false = Bool false;

Boot.M3SSDIVSEL// M3 Subsystem Clock Divider (M3SSDIVSEL) value = Boot.M3Div Boot.M3Div_4;

Boot.OSCCLK// OSCCLK input frequency to PLL, in MHz. Default is 20 MHz = UInt 20;

Boot.SPLLFMULT// System PLL Fractional Multiplier (SPLLFMULT) value = Boot.FractMult Boot.Fract_0;

Boot.SPLLIMULT// System PLL Integer Multiplier (SPLLIMULT) value = UInt 1;

Boot.SYSDIVSEL// System Clock Divider (SYSDIVSEL) value = Boot.SysDiv Boot.Div_8;

Boot.bootC28// Initiate booting of the C28 processor. Default is false = Bool false;

Boot.bootFromFlash// Boot from FLASH flag. Default is true = Bool true;

Boot.common$// Common module configuration parameters = Types.Common$ undefined;

Boot.limpAbortFunction// Function to be called when Limp mode is detected = Fxn undefined;

Boot.rovViewInfo// = ViewInfo.Instance ViewInfo.create;

metaonly enum Boot.FractMult

System PLL Fractional Multiplier (SPLLFMULT) value

XDCscript usage meta-domain

values of type Boot.FractMult

const Boot.Fract_0;

// Fractional multiplier is 0

const Boot.Fract_25;

// Fractional multiplier is 0.25

const Boot.Fract_50;

// Fractional multiplier is 0.5

const Boot.Fract_75;

// Fractional multiplier is 0.75

metaonly enum Boot.M3Div

M3 Subsystem Clock Divider (M3SSDIVSEL) value

XDCscript usage meta-domain

values of type Boot.M3Div

const Boot.M3Div_1;

// Divide by 1

const Boot.M3Div_2;

// Divide by 2

const Boot.M3Div_4;

// Divide by 4

metaonly enum Boot.SysDiv

System Clock Divider (SYSDIVSEL) value

XDCscript usage meta-domain

values of type Boot.SysDiv

const Boot.Div_1;

// Divide by 1

const Boot.Div_2;

// Divide by 2

const Boot.Div_4;

// Divide by 4

const Boot.Div_8;

// Divide by 8

metaonly struct Boot.ModuleView

XDCscript usage meta-domain

var obj = new Boot.ModuleView;

obj.configureClocks = Bool ...

obj.OSCCLK = UInt ...

obj.SPLLIMULT = UInt ...

obj.SPLLFMULT = String ...

obj.SYSDIVSEL = String ...

obj.M3SSDIVSEL = String ...

obj.bootC28 = Bool ...

config Boot.configureClocks // module-wide

Clock configuration flag, default is false

XDCscript usage meta-domain

Boot.configureClocks = Bool false;

DETAILS

Set to true to configure the PLL and system and M3 subsystem clock dividers.

C SYNOPSIS

Boot_configureClocks

metaonly config Boot.M3SSDIVSEL // module-wide

M3 Subsystem Clock Divider (M3SSDIVSEL) value

XDCscript usage meta-domain

Boot.M3SSDIVSEL = Boot.M3Div Boot.M3Div_4;

metaonly config Boot.OSCCLK // module-wide

OSCCLK input frequency to PLL, in MHz. Default is 20 MHz

XDCscript usage meta-domain

Boot.OSCCLK = UInt 20;

DETAILS

This is the frequency of the oscillator clock (OSCCLK) input to the PLL.

metaonly config Boot.SPLLFMULT // module-wide

System PLL Fractional Multiplier (SPLLFMULT) value

XDCscript usage meta-domain

Boot.SPLLFMULT = Boot.FractMult Boot.Fract_0;

metaonly config Boot.SPLLIMULT // module-wide

System PLL Integer Multiplier (SPLLIMULT) value

XDCscript usage meta-domain

Boot.SPLLIMULT = UInt 1;

metaonly config Boot.SYSDIVSEL // module-wide

System Clock Divider (SYSDIVSEL) value

XDCscript usage meta-domain

Boot.SYSDIVSEL = Boot.SysDiv Boot.Div_8;

metaonly config Boot.bootC28 // module-wide

Initiate booting of the C28 processor. Default is false

XDCscript usage meta-domain

Boot.bootC28 = Bool false;

DETAILS

Set to true to enable the M3 to initiate boot of the C28.

If enabled, this will occur after the optional clock configuration step, enabled by configureClocks.

metaonly config Boot.bootFromFlash // module-wide

Boot from FLASH flag. Default is true

XDCscript usage meta-domain

Boot.bootFromFlash = Bool true;

DETAILS

Set to true to enable booting the M3 from FLASH.

metaonly config Boot.common$ // module-wide

Common module configuration parameters

XDCscript usage meta-domain

Boot.common$ = Types.Common$ undefined;

DETAILS

All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.

metaonly config Boot.limpAbortFunction // module-wide

Function to be called when Limp mode is detected

XDCscript usage meta-domain

Boot.limpAbortFunction = Fxn undefined;

DETAILS

This function is called when the Boot module is about to configure the PLL, but finds the device operating in Limp mode (i.e., the mode when a missing OSCCLK input has been detected).

If this function is not specified by the application, a default function will be used, which spins in an infinite loop.

metaonly config Boot.rovViewInfo // module-wide

XDCscript usage meta-domain

Boot.rovViewInfo = ViewInfo.Instance ViewInfo.create;

generated on Fri, 10 Feb 2012 21:40:03 GMT