OpenCores
URL https://opencores.org/ocsvn/neorv32/neorv32/trunk

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [sw/] [lib/] [source/] [neorv32_mtime.c] - Blame information for rev 2

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 zero_gravi
// #################################################################################################
2
// # << NEORV32: neorv32_mtime.c - Machine System Timer (MTIME) HW Driver >>                       #
3
// # ********************************************************************************************* #
4
// # BSD 3-Clause License                                                                          #
5
// #                                                                                               #
6
// # Copyright (c) 2020, Stephan Nolting. All rights reserved.                                     #
7
// #                                                                                               #
8
// # Redistribution and use in source and binary forms, with or without modification, are          #
9
// # permitted provided that the following conditions are met:                                     #
10
// #                                                                                               #
11
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
12
// #    conditions and the following disclaimer.                                                   #
13
// #                                                                                               #
14
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of     #
15
// #    conditions and the following disclaimer in the documentation and/or other materials        #
16
// #    provided with the distribution.                                                            #
17
// #                                                                                               #
18
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
19
// #    endorse or promote products derived from this software without specific prior written      #
20
// #    permission.                                                                                #
21
// #                                                                                               #
22
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
23
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
24
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
25
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
26
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
27
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #
28
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #
29
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #
30
// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #
31
// # ********************************************************************************************* #
32
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
33
// #################################################################################################
34
 
35
 
36
/**********************************************************************//**
37
 * @file neorv32_mtime.c
38
 * @author Stephan Nolting
39
 * @brief Machine System Timer (MTIME) HW driver source file.
40
 *
41
 * @note These functions should only be used if the MTIME unit was synthesized (IO_MTIME_USE = true).
42
 **************************************************************************/
43
 
44
#include "neorv32.h"
45
#include "neorv32_wdt.h"
46
 
47
 
48
/**********************************************************************//**
49
 * Check if MTIME unit was synthesized.
50
 *
51
 * @return 0 if MTIME was not synthesized, 1 if MTIME is available.
52
 **************************************************************************/
53
int neorv32_mtime_available(void) {
54
 
55
  if (neorv32_cpu_csr_read(CSR_MFEATURES) & (1 << CPU_MFEATURES_IO_MTIME)) {
56
    return 1;
57
  }
58
  else {
59
    return 0;
60
  }
61
}
62
 
63
 
64
/**********************************************************************//**
65
 * Set new system time.
66
 *
67
 * @note The MTIME timer increments with the primary processor clock.
68
 *
69
 * @param[in] time New system time (uint64_t)
70
 **************************************************************************/
71
void neorv32_mtime_set_time(uint64_t time) {
72
 
73
  MTIME = time;
74
}
75
 
76
 
77
/**********************************************************************//**
78
 * Get current system time since reset.
79
 *
80
 * @note The MTIME timer increments with the primary processor clock.
81
 *
82
 * @return Current system time (uint64_t)
83
 **************************************************************************/
84
uint64_t neorv32_mtime_get_time(void) {
85
 
86
  union {
87
    uint64_t uint64;
88
    uint32_t uint32[sizeof(uint64_t)/2];
89
  } sys_mtime;
90
  uint32_t tmp;
91
 
92
  // make sure there is no overflow in mtime_lo during read
93
  while (1) {
94
    sys_mtime.uint32[1] = MTIME_HI;
95
    sys_mtime.uint32[0] = MTIME_LO;
96
    tmp = MTIME_HI;
97
    if (sys_mtime.uint32[1] == tmp) {
98
      break;
99
    }
100
  }
101
 
102
  return sys_mtime.uint64;
103
}
104
 
105
 
106
/**********************************************************************//**
107
 * Set compare time register (MTIMECMP) for generating interrupts.
108
 *
109
 * @note The interrupt is triggered when MTIME >= MTIMECMP.
110
 * @note The interrupt is acknwoledged by writing to the MTIMECMP.HI register.
111
 * @note The timer interrupt is enabled via neorv32_cpu_mti_enable(void) and disabled via neorv32_cpu_mti_disable(void).
112
 * @note Global interrupts have to be enabled via neorv32_cpu_eint(void).
113
 *
114
 * @param[in] timecmp System time for interrupt (uint64_t)
115
 **************************************************************************/
116
void neorv32_mtime_set_timecmp(uint64_t timecmp) {
117
 
118
  MTIMECMP_LO = 0xFFFFFFFF; // prevent mtimecmp from temporarily becoming smaller than the lesser of the old and new values
119
  MTIMECMP = timecmp;
120
}
121
 
122
 
123
/**********************************************************************//**
124
 * Get compare time register (MTIMECMP).
125
 *
126
 * @return Current MTIMECMP value.
127
 **************************************************************************/
128
uint64_t neorv32_mtime_get_timecmp(void) {
129
 
130
  return MTIMECMP;
131
}

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.