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