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

Subversion Repositories neorv32

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

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


// #################################################################################################
// # << NEORV32: neorv32_mtime.c - Machine System Timer (MTIME) HW Driver >>                       #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2021, Stephan Nolting. All rights reserved.                                     #
// #                                                                                               #
// # Redistribution and use in source and binary forms, with or without modification, are          #
// # permitted provided that the following conditions are met:                                     #
// #                                                                                               #
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
// #    conditions and the following disclaimer.                                                   #
// #                                                                                               #
// # 2. 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.                                                            #
// #                                                                                               #
// # 3. Neither the name of the copyright holder 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 IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #
// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
// #################################################################################################
 
 
/**********************************************************************//**
 * @file neorv32_mtime.c
 * @author Stephan Nolting
 * @brief Machine System Timer (MTIME) HW driver source file.
 *
 * @note These functions should only be used if the MTIME unit was synthesized (IO_MTIME_EN = true).
 **************************************************************************/
 
#include "neorv32.h"
#include "neorv32_mtime.h"
 
 
/**********************************************************************//**
 * Check if MTIME unit was synthesized.
 *
 * @return 0 if MTIME was not synthesized, 1 if MTIME is available.
 **************************************************************************/
int neorv32_mtime_available(void) {
 
  if (NEORV32_SYSINFO.SOC & (1 << SYSINFO_SOC_IO_MTIME)) {
    return 1;
  }
  else {
    return 0;
  }
}
 
 
/**********************************************************************//**
 * Set current system time.
 *
 * @note The MTIME timer increments with the primary processor clock.
 *
 * @param[in] time New system time (uint64_t)
 **************************************************************************/
void neorv32_mtime_set_time(uint64_t time) {
 
  union {
    uint64_t uint64;
    uint32_t uint32[sizeof(uint64_t)/2];
  } cycles;
 
  cycles.uint64 = time;
 
  NEORV32_MTIME.TIME_LO = 0;
  NEORV32_MTIME.TIME_HI = cycles.uint32[1];
  NEORV32_MTIME.TIME_LO = cycles.uint32[0];
 
}
 
 
/**********************************************************************//**
 * Get current system time.
 *
 * @note The MTIME timer increments with the primary processor clock.
 *
 * @return Current system time (uint64_t)
 **************************************************************************/
uint64_t neorv32_mtime_get_time(void) {
 
  union {
    uint64_t uint64;
    uint32_t uint32[sizeof(uint64_t)/2];
  } cycles;
 
  uint32_t tmp1, tmp2, tmp3;
  while(1) {
    tmp1 = NEORV32_MTIME.TIME_HI;
    tmp2 = NEORV32_MTIME.TIME_LO;
    tmp3 = NEORV32_MTIME.TIME_HI;
    if (tmp1 == tmp3) {
      break;
    }
  }
 
  cycles.uint32[0] = tmp2;
  cycles.uint32[1] = tmp3;
 
  return cycles.uint64;
}
 
 
/**********************************************************************//**
 * Set compare time register (MTIMECMP) for generating interrupts.
 *
 * @note The interrupt is triggered when MTIME >= MTIMECMP.
 * @note Global interrupts and the timer interrupt source have to be enabled .
 *
 * @param[in] timecmp System time for interrupt (uint64_t)
 **************************************************************************/
void neorv32_mtime_set_timecmp(uint64_t timecmp) {
 
  union {
    uint64_t uint64;
    uint32_t uint32[sizeof(uint64_t)/2];
  } cycles;
 
  cycles.uint64 = timecmp;
 
  NEORV32_MTIME.TIMECMP_LO = -1; // prevent MTIMECMP from temporarily becoming smaller than the lesser of the old and new values
  NEORV32_MTIME.TIMECMP_HI = cycles.uint32[1];
  NEORV32_MTIME.TIMECMP_LO = cycles.uint32[0];
}
 
 
/**********************************************************************//**
 * Get compare time register (MTIMECMP).
 *
 * @return Current MTIMECMP value.
 **************************************************************************/
uint64_t neorv32_mtime_get_timecmp(void) {
 
  union {
    uint64_t uint64;
    uint32_t uint32[sizeof(uint64_t)/2];
  } cycles;
 
  cycles.uint32[0] = NEORV32_MTIME.TIMECMP_LO;
  cycles.uint32[1] = NEORV32_MTIME.TIMECMP_HI;
 
  return cycles.uint64;
}

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	44	zero_gravi	`// # Copyright (c) 2021, Stephan Nolting. All rights reserved. #`
7	2	zero_gravi	`// # #`
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	44	zero_gravi	`* @note These functions should only be used if the MTIME unit was synthesized (IO_MTIME_EN = true).`
42	2	zero_gravi	`**************************************************************************/`
43
44			`#include "neorv32.h"`
45	51	zero_gravi	`#include "neorv32_mtime.h"`
46	2	zero_gravi
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	64	zero_gravi	`if (NEORV32_SYSINFO.SOC & (1 << SYSINFO_SOC_IO_MTIME)) {`
56	2	zero_gravi	`return 1;`
57			`}`
58			`else {`
59			`return 0;`
60			`}`
61			`}`
62
63
64			`/********************************************************************//`
65	11	zero_gravi	`* Set current system time.`
66	2	zero_gravi	`*`
67			`* @note The MTIME timer increments with the primary processor clock.`
68			`*`
69	11	zero_gravi	`* @param[in] time New system time (uint64_t)`
70			`**************************************************************************/`
71			`void neorv32_mtime_set_time(uint64_t time) {`
72
73	12	zero_gravi	`union {`
74			`uint64_t uint64;`
75			`uint32_t uint32[sizeof(uint64_t)/2];`
76			`} cycles;`
77
78			`cycles.uint64 = time;`
79
80	64	zero_gravi	`NEORV32_MTIME.TIME_LO = 0;`
81			`NEORV32_MTIME.TIME_HI = cycles.uint32[1];`
82			`NEORV32_MTIME.TIME_LO = cycles.uint32[0];`
83	12	zero_gravi
84	11	zero_gravi	`}`
85
86
87			`/********************************************************************//`
88			`* Get current system time.`
89			`*`
90			`* @note The MTIME timer increments with the primary processor clock.`
91			`*`
92	2	zero_gravi	`* @return Current system time (uint64_t)`
93			`**************************************************************************/`
94			`uint64_t neorv32_mtime_get_time(void) {`
95
96	12	zero_gravi	`union {`
97			`uint64_t uint64;`
98			`uint32_t uint32[sizeof(uint64_t)/2];`
99			`} cycles;`
100
101			`uint32_t tmp1, tmp2, tmp3;`
102			`while(1) {`
103	64	zero_gravi	`tmp1 = NEORV32_MTIME.TIME_HI;`
104			`tmp2 = NEORV32_MTIME.TIME_LO;`
105			`tmp3 = NEORV32_MTIME.TIME_HI;`
106	12	zero_gravi	`if (tmp1 == tmp3) {`
107			`break;`
108			`}`
109			`}`
110
111			`cycles.uint32[0] = tmp2;`
112			`cycles.uint32[1] = tmp3;`
113
114			`return cycles.uint64;`
115	2	zero_gravi	`}`
116
117
118			`/********************************************************************//`
119			`* Set compare time register (MTIMECMP) for generating interrupts.`
120			`*`
121			`* @note The interrupt is triggered when MTIME >= MTIMECMP.`
122	59	zero_gravi	`* @note Global interrupts and the timer interrupt source have to be enabled .`
123	2	zero_gravi	`*`
124			`* @param[in] timecmp System time for interrupt (uint64_t)`
125			`**************************************************************************/`
126			`void neorv32_mtime_set_timecmp(uint64_t timecmp) {`
127
128	59	zero_gravi	`union {`
129			`uint64_t uint64;`
130			`uint32_t uint32[sizeof(uint64_t)/2];`
131			`} cycles;`
132
133			`cycles.uint64 = timecmp;`
134
135	64	zero_gravi	`NEORV32_MTIME.TIMECMP_LO = -1; // prevent MTIMECMP from temporarily becoming smaller than the lesser of the old and new values`
136			`NEORV32_MTIME.TIMECMP_HI = cycles.uint32[1];`
137			`NEORV32_MTIME.TIMECMP_LO = cycles.uint32[0];`
138	2	zero_gravi	`}`
139
140
141			`/********************************************************************//`
142			`* Get compare time register (MTIMECMP).`
143			`*`
144			`* @return Current MTIMECMP value.`
145			`**************************************************************************/`
146			`uint64_t neorv32_mtime_get_timecmp(void) {`
147
148	64	zero_gravi	`union {`
149			`uint64_t uint64;`
150			`uint32_t uint32[sizeof(uint64_t)/2];`
151			`} cycles;`
152
153			`cycles.uint32[0] = NEORV32_MTIME.TIMECMP_LO;`
154			`cycles.uint32[1] = NEORV32_MTIME.TIMECMP_HI;`
155
156			`return cycles.uint64;`
157	2	zero_gravi	`}`

Browse

Tools

Subversion Repositories neorv32

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