1    /*
     2     * Copyright (c) 2016, 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     */
    32    
    33    import ti.catalog.msp430.peripherals.clock.IClock;
    34    
    35    /*!
    36     *  ======== ITimer ========
    37     *  MSP430 ITimer interface
    38     */
    39    metaonly interface ITimer inherits xdc.platform.IPeripheral {
    40    
    41       /*!
    42        *  ======== regIntVect_t ========
    43        *  Interrupt vector description
    44        *
    45        *  Type to describe a single interrupt vector pin and all its possible
    46        *  configurations.
    47        *
    48        *  @see #regIntVect_t
    49        */
    50        struct regIntVect_t {
    51            String                    registerName;
    52            String                    registerDescription;
    53            String                    isrToggleString;
    54            String                    priorityName;
    55            Bool                      interruptEnable;
    56            Bool                      interruptHandler;
    57            Int                       priority;
    58        }
    59    
    60        /*!
    61        *  ======== ForceSetDefaultRegister_t ========
    62        *  Force Set Default Register
    63        *
    64        *  Type to store if each register needs to be forced initialized
    65        *  even if the register is in default state.
    66        *
    67        *  @see #ForceSetDefaultRegister_t
    68        */
    69        struct ForceSetDefaultRegister_t {
    70            String     register;
    71            Bool       regForceSet;
    72        }
    73    
    74        create(IClock.Instance clock);
    75    
    76    instance:
    77        /*!
    78         *  ======== baseAddr ========
    79         *  Address of the peripheral's control register.
    80         *
    81         *  A peripheral's registers are commonly accessed through a structure
    82         *  that defines the offsets of a particular register from the lowest
    83         *  address mapped to a peripheral. That lowest address is specified by
    84         *  this parameter.
    85         */
    86        config UInt baseAddr;
    87    
    88        /*!
    89         *  ======== intNum ========
    90         *  Interrupt source number
    91         *
    92         */
    93        config UInt intNum;
    94    
    95        /*!
    96         *  ======== numberOfTimers ========
    97         *  Stores the number of available timer capture compare blocks
    98         *
    99         */
   100        config UChar numberOfTimers;
   101    
   102        /*!
   103        *  ======== setTxxCCRx ========
   104        *  Sets TxxCCRx register value based on which CCR register
   105        *
   106        *  @see #setTxxCCRx
   107        */
   108        void setTxxCCRx(UChar ccrNumber , Bits16 value);
   109    
   110       /*!
   111        *  ======== getTxxCCRx ========
   112        *  Returns TxxCCRx register value based on which CCR register
   113        *
   114        *  @see #getTxxCCRx
   115        */
   116        Bits16 getTxxCCRx(UChar ccrNumber);
   117    
   118       /*!
   119        *  ======== isInternal ========
   120        *  Boolean that is true if a Timer is internal, meaning
   121        *  it has no external inputs or outputs
   122        *
   123        */
   124        config Bool isInternal = false;
   125    
   126        /*! @_nodoc */
   127        config IClock.Instance clock;
   128    }