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