1 2 3 4 5 6 7 8 9 10 11 12
13 14 15
16
17 package xdc.runtime;
18
19 /*!
20 * ======== Timestamp ========
21 * Timestamp services
22 *
23 * This module provides `{@link xdc.runtime.ITimestampClient}` APIs for the xdc
24 * Runtime Support Library. Calls to these APIs are forwarded to a platform
25 * specific `{@link xdc.runtime.ITimestampProvider}` implementation.
26 *
27 * A user can attach their own ITimestampProvider module
28 * using the following config file command:
29 * @p(code)
30 *
31 * xdc.runtime.Timestamp.SupportProxy = xdc.useModule("usersTimestampProvider");
32 * @p
33 * If no such `{@link #SupportProxy SupportProxy}` initialization is done,
34 * the `{@link xdc.runtime.TimestampNull}` ITimestampProvider implementation,
35 * which provides null stubs for the APIs, will be attached by default.
36 *
37 * If the user is developing code using CCS, the
38 * `{@link xdc.runtime.TimestampStd}` ITimestampProvider implementation, which
39 * uses the ANSI C clock() function, may provide a satisfactory timestamp
40 * source (remember to enable the profile clock in CCS).
41 *
42 * To use the TimestampStd implementation, add the following to
43 * your config script:
44 * @p(code)
45 *
46 * xdc.runtime.Timestamp.SupportProxy = xdc.useModule("xdc.runtime.TimestampStd");
47 * @p
48 */
49 module Timestamp inherits ITimestampClient {
50
51 /*!
52 * ======== SupportProxy ========
53 * User supplied time stamp provider module.
54 *
55 * The SupportProxy module provides application/platform specific
56 * implementations of the `{@link xdc.runtime.ITimestampProvider}` APIs.
57 *
58 * If not explicitly supplied by the user, this proxy defaults to
59 * `{@link xdc.runtime.TimestampNull}`,
60 * which provides null stubs for all of the ITimestampProvider APIs.
61 */
62
63 proxy SupportProxy inherits ITimestampProvider;
64 }
65 66 67
68