aboutsummaryrefslogtreecommitdiff
path: root/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-clock.h
blob: 47345bd5a1e60bfff0cd6684d970f596b762bafb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
#ifndef __CB_BDK_CLOCK_H__
#define __CB_BDK_CLOCK_H__
/***********************license start***********************************
* Copyright (c) 2003-2017  Cavium Inc. (support@cavium.com). All rights
* reserved.
*
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
*   * Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
*
*   * Redistributions in binary form must reproduce the above
*     copyright notice, this list of conditions and the following
*     disclaimer in the documentation and/or other materials provided
*     with the distribution.
*
*   * Neither the name of Cavium Inc. nor the names of
*     its contributors may be used to endorse or promote products
*     derived from this software without specific prior written
*     permission.
*
* This Software, including technical data, may be subject to U.S. export
* control laws, including the U.S. Export Administration Act and its
* associated regulations, and may be subject to export or import
* regulations in other countries.
*
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT
* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT,
* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK
* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
***********************license end**************************************/

/* FIXME(dhendrix): added */
#include <libbdk-arch/bdk-asm.h>
#include <libbdk-arch/bdk-numa.h>
/* FIXME(prudolph): added */

#include <soc/clock.h>

/**
 * @file
 *
 * Interface to Core, IO and DDR Clock.
 *
 * <hr>$Revision: 45089 $<hr>
 *
 * @addtogroup hal
 * @{
 */

#define BDK_GTI_RATE 1000000ull

/**
 * Enumeration of different Clocks.
 */
typedef enum{
    BDK_CLOCK_TIME,     /**< Clock for telling time with fast access. Uses GTI in core */
    BDK_CLOCK_MAIN_REF, /**< Main reference clock */
    BDK_CLOCK_RCLK,     /**< Clock used by cores, coherent bus and L2 cache. */
    BDK_CLOCK_SCLK,     /**< Clock used by IO blocks. */
} bdk_clock_t;

static inline uint64_t clock_get_rate_slow(bdk_clock_t clock)
{
	const uint64_t REF_CLOCK = 50000000;

	switch (clock) {
		case BDK_CLOCK_TIME:
			return BDK_GTI_RATE;    /* Programed as part of setup */
		case BDK_CLOCK_MAIN_REF:
			return REF_CLOCK;
		case BDK_CLOCK_RCLK:
			return thunderx_get_core_clock();
		case BDK_CLOCK_SCLK:
			return thunderx_get_io_clock();
	}
	return 0;
}

/**
 * Called in __bdk_init to setup the global timer
 */
extern void bdk_clock_setup(bdk_node_t node);	/* FIXME(dhendrix): added arg */

extern uint64_t __bdk_clock_get_count_slow(bdk_clock_t clock);
extern uint64_t __bdk_clock_get_rate_slow(bdk_node_t node, bdk_clock_t clock);

/**
 * Get cycle count based on the clock type.
 *
 * @param clock - Enumeration of the clock type.
 * @return      - Get the number of cycles executed so far.
 */
static inline uint64_t bdk_clock_get_count(bdk_clock_t clock) __attribute__ ((always_inline));
static inline uint64_t bdk_clock_get_count(bdk_clock_t clock)
{
    if (clock == BDK_CLOCK_TIME)
    {
        uint64_t clk;
        BDK_MRS(CNTPCT_EL0, clk);
        return clk;
    }
    else
        return __bdk_clock_get_count_slow(clock);
}

/**
 * Get clock rate based on the clock type.
 *
 * @param node    Node to use in a Numa setup. Can be an exact ID or a special value.
 * @param clock - Enumeration of the clock type.
 * @return      - return the clock rate.
 */
static inline uint64_t bdk_clock_get_rate(bdk_node_t node, bdk_clock_t clock) __attribute__ ((always_inline, pure));
static inline uint64_t bdk_clock_get_rate(bdk_node_t node, bdk_clock_t clock)
{
    if (clock == BDK_CLOCK_TIME)
        return BDK_GTI_RATE; /* Programed as part of setup */
    else
        return clock_get_rate_slow(clock);
}

/** @} */
#endif	/* !__CB_BDK_CLOCK_H__ */