1 /* 2 * Copyright (c) 2013, 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 * ======== TimestampProvider.xdc ======== 34 * 35 * 36 */ 37 38 package ti.sysbios.family.arm.m3; 39 40 /*! 41 * ======== TimestampProvider ======== 42 * Cortex M3 TimestampProvider 43 * 44 * Cortex M3 TimestampProvider delegate for use 45 * with {@link xdc.runtime.Timestamp}. 46 * 47 * The SysTick timer is used as the timestamp source. 48 * 49 * Implements {@link ti.sysbios.interfaces.ITimestampProvider} 50 * 51 * @p(html) 52 * <h3> Calling Context </h3> 53 * <table border="1" cellpadding="3"> 54 * <colgroup span="1"></colgroup> <colgroup span="5" align="center"></colgroup> 55 * 56 * <tr><th> Function </th><th> Hwi </th><th> Swi </th><th> Task </th><th> Main** </th><th> Startup*** </th></tr> 57 * <!-- --> 58 * <tr><td> {@link #get32} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr> 59 * <tr><td> {@link #get64} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr> 60 * <tr><td> {@link #getFreq} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr> 61 * 62 * </table> 63 * @p 64 */ 65 66 @ModuleStartup 67 68 module TimestampProvider inherits ti.sysbios.interfaces.ITimestamp 69 { 70 /* 71 * By default, TimestampProvider assumes the SysTick timer is 72 * configured elsewhere (ie by the Clock module). 73 * Set this parameter to true if TimestampProvider is the only user 74 * of the SysTick timer. 75 */ 76 config Bool configTimer = false; 77 78 /*!@_nodoc 79 * Internal use. Function that starts timer before main 80 */ 81 Void startTimer(); 82 83 /*!@_nodoc 84 * Internal use. Timer rollover interrupt handler. 85 */ 86 Void rolloverFunc(UArg unused); 87 88 internal: /* not for client use */ 89 90 struct Module_State { 91 Timer.Handle timer; /* timer instance used */ 92 } 93 }