neorv32_aux.h File Reference

General auxiliary functions header file. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	date_t

Functions
AUX prototypes
void	neorv32_aux_delay_ms (uint32_t clock_hz, uint32_t time_ms)
uint64_t	neorv32_aux_date2unixtime (date_t *date)
void	neorv32_aux_unixtime2date (uint64_t unixtime, date_t *date)
uint64_t	neorv32_aux_hexstr2uint64 (char *buffer, unsigned int length)
uint32_t	neorv32_aux_xorshift32 (void)
void	neorv32_aux_itoa (char *buffer, uint32_t num, uint32_t base)
void	neorv32_aux_print_hw_config (void)
void	neorv32_aux_print_hw_version (uint32_t impid)
void	neorv32_aux_print_about (void)
void	neorv32_aux_print_logo (void)
void	neorv32_aux_print_license (void)

Detailed Description

General auxiliary functions header file.

Function Documentation

neorv32_aux_date2unixtime()

uint64_t neorv32_aux_date2unixtime

(

date_t *

date

)

Convert date to Unix time stamp.

Copyright

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved. SPDX-License-Identifier: GPL-2.0-or-later https://github.com/Oryx-Embedded/Common/blob/master/date_time.c

Parameters

[in]

date

Pointer to date and time struct (date_t).

Returns

Unix time since 00:00:00 UTC, January 1, 1970 in seconds.

neorv32_aux_delay_ms()

void neorv32_aux_delay_ms	(	uint32_t	clock_hz,
		uint32_t	time_ms )

Simple delay function using busy-wait.

Warning

Timing is imprecise! Use CLINT.MTIME or CSR.[M]CYCLE[H] for precise timing.

Parameters

[in]	clock_hz	CPU clock speed in Hz.
[in]	time_ms	Time in ms to wait (unsigned 32-bit).

neorv32_aux_hexstr2uint64()

uint64_t neorv32_aux_hexstr2uint64	(	char *	buffer,
		unsigned int	length )

Helper function to convert up to 16 hex chars string into uint64_t

Parameters

[in,out]	buffer	Pointer to array of chars to convert into number.
[in]	length	Length of the conversion string.

Returns

Converted number (uint64_t).

neorv32_aux_itoa()

void neorv32_aux_itoa	(	char *	buffer,
		uint32_t	num,
		uint32_t	base )

Simplified version of "itoa": convert number to string.

Parameters

[in,out]	buffer	Pointer to array for the result string [33 chars].
[in]	num	Number to convert.
[in]	base	Base of number representation (2..16).

neorv32_aux_print_about()

void neorv32_aux_print_about

(

void

)

Print project info via UART0.

neorv32_aux_print_hw_config()

void neorv32_aux_print_hw_config

(

void

)

Print hardware configuration information via UART0.

Warning

This function overrides several CSRs!

neorv32_aux_print_hw_version()

void neorv32_aux_print_hw_version

(

uint32_t

impid

)

Print processor version in human-readable format via UART0.

Parameters

[in]

impid

BCD-coded implementation ID (aka the version), typically from the mimpid CSR.

neorv32_aux_print_license()

void neorv32_aux_print_license

(

void

)

Print project license via UART0.

neorv32_aux_print_logo()

void neorv32_aux_print_logo

(

void

)

Print project logo via UART0.

neorv32_aux_unixtime2date()

void neorv32_aux_unixtime2date	(	uint64_t	unixtime,
		date_t *	date )

Convert Unix time stamp to date.

Copyright

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved. SPDX-License-Identifier: GPL-2.0-or-later https://github.com/Oryx-Embedded/Common/blob/master/date_time.c

Parameters

[in]	unixtime	Unix time since 00:00:00 UTC, January 1, 1970 in seconds.
[in,out]	date	Pointer to date and time struct (date_t).

neorv32_aux_xorshift32()

uint32_t neorv32_aux_xorshift32

(

void

)

XORSHIFT pseudo random number generator.

Returns

Random number (uint32_t).