1    /* --COPYRIGHT--,BSD
     2     * Copyright (c) $(CPYYEAR), Texas Instruments Incorporated
     3     * All rights reserved.
     4     *
     5     * Redistribution and use in source and binary forms, with or without
     6     * modification, are permitted provided that the following conditions
     7     * are met:
     8     *
     9     * *  Redistributions of source code must retain the above copyright
    10     *    notice, this list of conditions and the following disclaimer.
    11     *
    12     * *  Redistributions in binary form must reproduce the above copyright
    13     *    notice, this list of conditions and the following disclaimer in the
    14     *    documentation and/or other materials provided with the distribution.
    15     *
    16     * *  Neither the name of Texas Instruments Incorporated nor the names of
    17     *    its contributors may be used to endorse or promote products derived
    18     *    from this software without specific prior written permission.
    19     *
    20     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
    22     * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    23     * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    24     * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    25     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    26     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
    27     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    28     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
    29     * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
    30     * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    31     * --/COPYRIGHT--*/
    32    /*!
    33     *   Generate driver starter files
    34     *
    35     *   This command line tool helps driver writers by generating starter
    36     *   files. The driver writer can then fill in driver specific code
    37     *   and rebuild.
    38     *
    39     *   required arguments are the output directory name "-o" and the module 
    40     *   name "-m".
    41     *
    42     *   The name of the module and the package name is derived from the module 
    43     *   name. For e.g for -m drivers.io.Uart the module name is Uart and the
    44     *   package name is drivers.dma. 
    45     *
    46     *   The "-o" option must inlcude package path. For the example above
    47     *   -o "C:\Product\drivers\dma.
    48     */
    49    metaonly module Main inherits xdc.tools.mkpkg.ICmd {
    50        /*!
    51         *  ======== main ========
    52         *  main() function, invoked from the command line.
    53         *
    54         *  Parses command line arguments then calls {@link #mkpkg()}.
    55         */
    56        override Int main(String arguments[]);
    57    
    58        config String usage[] = [
    59            '-m modName -o outputDir',
    60            '[--help]',
    61        ];
    62    
    63    instance:
    64        
    65        /*!
    66         * Name of the generated module. You need to specify package name within
    67         * the modName.
    68         */
    69        @CommandOption("m")
    70        config String modName;
    71    
    72    }