metaonly module ti.sdo.io.driverTemplate.Main

Generate driver starter files

This command line tool helps driver writers by generating starter files. The driver writer can then fill in driver specific code and rebuild. [ more ... ]
XDCscript usage meta-domain sourced in ti/sdo/io/driverTemplate/Main.xdc
var Main = xdc.useModule('ti.sdo.io.driverTemplate.Main');
module-wide config parameters
    Main.usage//  = String[] [
        '-m modName -o outputDir',
        '[--help]'
    ];
module-wide functions
    Main.main// main() function, invoked from the command line(String[] arguments) returns Int
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.arguments// Positional parameters = Any[] undefined;
        params.input//  = String undefined;
        params.inputPath//  = String undefined;
        params.output// Output file or directory = String undefined;
 
DETAILS
This command line tool helps driver writers by generating starter files. The driver writer can then fill in driver specific code and rebuild.
required arguments are the output directory name "-o" and the module name "-m".
The name of the module and the package name is derived from the module name. For e.g for -m drivers.io.Uart the module name is Uart and the package name is drivers.dma.
The "-o" option must inlcude package path. For the example above -o "C:\Product\drivers\dma.
 
config Main.usage  // module-wide
XDCscript usage meta-domain
Main.usage = String[] [
    '-m modName -o outputDir',
    '[--help]'
];
 
 
Main.main()  // module-wide

main() function, invoked from the command line

XDCscript usage meta-domain
Main.main(String[] arguments) returns Int
 
DETAILS
Parses command line arguments then calls mkpkg().
Instance Config Parameters

XDCscript usage meta-domain
var params = new Main.Params;
// Instance config-params object
    params.arguments = Any[] undefined;
    // Positional parameters
    params.input = String undefined;
    // 
    params.inputPath = String undefined;
    // 
    params.modName = String undefined;
    // Name of the generated module. You need to specify package name within the modName
    params.output = String undefined;
    // Output file or directory
    params.preserveModTime = Bool false;
    // Only modify the timestamps of output files whose contents changed
 
config Main.arguments  // instance

Positional parameters

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.arguments = Any[] undefined;
 
 
config Main.input  // instance
XDCscript usage meta-domain
var params = new Main.Params;
  ...
const params.input = String computed value;
 
 
config Main.inputPath  // instance
XDCscript usage meta-domain
var params = new Main.Params;
  ...
const params.inputPath = String computed value;
 
 
config Main.modName  // instance

Name of the generated module. You need to specify package name within the modName

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.modName = String undefined;
 
 
config Main.output  // instance

Output file or directory

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.output = String undefined;
 
 
config Main.preserveModTime  // instance

Only modify the timestamps of output files whose contents changed

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.preserveModTime = Bool false;
 
DETAILS
This flag changes the behavior of mkpkg in the case when some of the output files already exists, in particular from a previous invocation of mkpkg. If true, any output file that already exists will only be touched if its contents must change. If the new content is identical, then the timestamp on the file remains unmodified.
This is an optimization that can improve the behavior of mkpkg when used with programs like "make" that are sensitive to file timestamps.
generated on Sat, 11 Feb 2012 00:37:42 GMT