1    /*
     2     * Copyright (c) 2014-2015, 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     *  ======== ISeconds.xdc ========
    34     */
    35    
    36    /*!
    37     *  ======== ISeconds ========
    38     *  Seconds interface.
    39     */
    40    
    41    @DirectCall
    42    interface ISeconds
    43    {
    44        /*!
    45         *  ======== get ========
    46         *  Returns number of seconds since 1970 (the Unix epoch).
    47         *
    48         *  The user must call Seconds_set() before making any calls to Seconds_get(),
    49         *  otherwise the value returned by Seconds_get() will be meaningless.
    50         */
    51        UInt32 get();
    52    
    53        /*!
    54         *  ======== Time ========
    55         *  Structure to hold a time value in seconds plus nanoseconds.
    56         */
    57        struct Time {
    58            UInt32 secs;    /*! Seconds */
    59            UInt32 nsecs;   /*! Nanoseconds */
    60        };
    61    
    62        /*!
    63         *  ======== getTime ========
    64         *  Fills in a Seconds_Time structure with seconds and nanoseconds
    65         *  elapsed since 1970 (the Unix epoch).
    66         *
    67         *  Seconds_set() must have been called before making any calls to
    68         *  Seconds_getTime(), otherwise the value returned by Seconds_getTime()
    69         *  will be meaningless.
    70         */
    71        UInt32 getTime(ISeconds.Time *ts);
    72    
    73        /*!
    74         *  ======== set ========
    75         *  Update the real time clock with number of seconds since 1970.
    76         *
    77         *  Note: This function is non-reentrant.
    78         */
    79        Void set(UInt32 seconds);
    80    
    81        /*!
    82         *  ======== setTime ========
    83         *  Update the real time clock with the number of seconds and nanoseconds
    84         *  that have elapsed since 1970 (the Unix epoch).  The Seconds_Time
    85         *  structure passed to setTime() contains the seconds and nanoseconds
    86         *  to set the real time clock to.  This API can be called instead
    87         *  of Seconds_set(), if finer granularity of the time is required.
    88         */
    89        UInt32 setTime(ISeconds.Time *ts);
    90    }