Headerdatei der WGRHAL-Bibliothek. Mehr ...

#include "wgrtypes.h"

Makrodefinitionen
#define	MALLOC

#define	PWM_NOTES

#define	SSD1351

#define	SYSTEM_CLOCK 10000000
	Definiert die Systemtaktfrequenz in Hertz.

#define	HWREG32(addr) (((volatile uint32_t )(addr)))
	Makro zur Adressierung von speicherabgebildeten Registern.

#define	nop() __asm__ volatile("nop")
	Nop-Operation.

#define	DEBUG_ADDR 0x00000100
	Basisadresse für das Debug-Register.

#define	UART_BASE_ADDR 0x00000200
	Basisadresse für den UART.

#define	UART_CTRL_OFFSET 0x00
	Offset für das UART-Steuerregister.

#define	UART_BAUD_OFFSET 0x04
	Offset für das UART-Baudratenregister.

#define	UART_STATUS_OFFSET 0x08
	Offset für das UART-Statusregister.

#define	UART_TX_OFFSET 0x0C
	Offset für das UART-Sende-Register.

#define	UART_RX_OFFSET 0x10
	Offset für das UART-Empfangsregister.

#define	TIME_BASE_ADDR 0x00000300
	Basisadresse für Zeitfunktionen.

#define	TIME_MS_L_OFFSET 0x00
	Offset für die niederwertigen 32-Bit des Millisekundenzählers.

#define	TIME_MS_H_OFFSET 0x04
	Offset für die höheren 32-Bit des Millisekundenzählers.

#define	TIME_MIK_L_OFFSET 0x08
	Offset für die niederwertigen 32-Bit des Mikrosekundenzählers.

#define	TIME_MIK_H_OFFSET 0x0C
	Offset für die höheren 32-Bit des Mikrosekundenzählers.

#define	SYS_CLK_OFFSET 0x10
	Offset für den Systemtakt.

#define	PWM_BASE_ADDR 0x00000400
	Basisadresse für PWM-Funktionen.

#define	PWM_PERIOD_OFFSET 0x00
	Offset für das PWM-Periode-Register.

#define	PWM_DUTY_OFFSET 0x04
	Offset für das PWM-Duty-Cycle-Register.

#define	PWM_COUNTER_OFFSET 0x08
	Offset für das PWM-Zählerregister.

#define	PWM_CTRL_OFFSET 0x0C
	Offset für das PWM-Steuerregister.

#define	GPIO_BASE_ADDR 0x00000800
	Basisadresse für GPIO-Funktionen.

#define	GPIO_DIR_OFFSET 0x0000
	Offset für das GPIO-Richtungsregister.

#define	GPIO_IN_OFFSET 0x0004
	Offset für das GPIO-Eingangsregister.

#define	GPIO_OUT_OFFSET 0x0008
	Offset für das GPIO-Ausgangsregister.

#define	GPIO_OUT_STEP 0x04
	Schrittweite zwischen den Ausgangsregistern der einzelnen Pins.

#define	GPIO_PIN_COUNT 8
	Anzahl der verfügbaren GPIO-Pins.

#define	DEFAULT_TIMEOUT 10
	Standard-Zeitüberschreitung in Millisekunden.

Funktionen
void *	memcpy (void dest, const void src, uint32_t n)
	Kopiert n Bytes von src nach dest.

void *	memset (void *dest, int32_t c, uint32_t n)
	Setzt n Bytes im Zielpuffer auf den Wert c.

void *	memmove (void dest, const void src, uint32_t n)
	Kopiert n Bytes von src nach dest, wobei sich überlappende Speicherbereiche korrekt behandelt werden.

uint32_t	strlen (const char *s)
	Bestimmt die Länge eines Strings.

int32_t	strcmp (const char s1, const char s2)
	Vergleicht zwei Strings.

int32_t	strncmp (const char s1, const char s2, uint32_t n)
	Vergleicht maximal n Zeichen zweier Strings.

char *	strcpy (char dest, const char src)
	Kopiert einen String von src nach dest.

void	int_to_str (int32_t num, int base, char *str)
	Konvertiert eine Ganzzahl in einen String.

int32_t	parse_integer (const char *str)
	Parst einen String in eine Ganzzahl.

int32_t	parse_int_multi (const char str, const char *next)
	Parst eine Ganzzahl aus einem String und gibt den Zeiger auf das nächste Zeichen zurück.

void	debug_write (uint32_t value)
	Schreibt einen Wert in das Debug-Register.

void	uart_enable (void)
	Aktiviert die UART-Schnittstelle.

void	uart_disable (void)
	Deaktiviert die UART-Schnittstelle.

void	uart_set_baud (baud_sel_t baud)
	Setzt die Baudrate der UART-Schnittstelle.

uint32_t	uart_get_status (void)
	Liest den Status der UART-Schnittstelle.

uint32_t	uart_is_ready (void)
	Prüft, ob die UART bereit ist.

uint32_t	uart_is_busy (void)
	Prüft, ob die UART beschäftigt ist.

uint32_t	uart_rx_full (void)
	Prüft, ob der UART-Empfangspuffer voll ist.

uint32_t	uart_rx_empty (void)
	Prüft, ob der UART-Empfangspuffer leer ist.

uint32_t	uart_tx_full (void)
	Prüft, ob der UART-Sende-Puffer voll ist.

uint32_t	uart_tx_empty (void)
	Prüft, ob der UART-Sende-Puffer leer ist.

int32_t	uart_wait_tx_full (uint32_t timeout_ms)
	Wartet darauf, dass der Sende-Puffer voll wird, bis zu einer Zeitüberschreitung.

int32_t	uart_wait_rx_data (uint32_t timeout_ms)
	Wartet darauf, dass Daten im Empfangspuffer vorhanden sind, bis zu einer Zeitüberschreitung.

int32_t	uart_write_byte (uint8_t data, uint32_t timeout_ms)
	Sendet ein Byte über die UART-Schnittstelle.

int32_t	uart_putchar (char c, uint32_t timeout_ms)
	Sendet ein Zeichen über die UART-Schnittstelle.

void	uart_putchar_default_timeout (char c)
	Sendet ein Zeichen über die UART-Schnittstelle mit voreingestelltem Timeout.

int32_t	uart_write_buffer (const uint8_t *buffer, uint32_t length, uint32_t timeout_ms)
	Sendet einen Puffer von Bytes über die UART-Schnittstelle.

int32_t	uart_read_byte (uint8_t *data, uint32_t timeout_ms)
	Liest ein Byte von der UART-Schnittstelle.

char	uart_getchar (uint32_t timeout_ms)
	Liest ein Zeichen von der UART-Schnittstelle.

int32_t	uart_read_buffer (uint8_t *buf, uint32_t length, uint32_t timeout_ms)
	Liest einen Puffer von Bytes von der UART-Schnittstelle.

void	uart_send_uint32 (uint32_t value, uint32_t timeout_ms)
	Sendet einen 32-Bit-Wert über die UART-Schnittstelle.

void	uart_print_uint (uint32_t num, int32_t base)
	Gibt eine positive Ganzzahl in einem bestimmten Zahlensystem über die UART aus.

void	uart_print_int (int32_t num)
	Gibt eine Ganzzahl über die UART aus.

void	uart_print (const char *s)
	Gibt einen String über die UART aus.

uint32_t	get_sys_clk (void)
	Liest die Systemtaktfrequenz.

void	millis_reset (void)
	Setzt den Millisekunden-Zähler zurück.

uint64_t	millis_long (void)
	Liest einen langen Millisekunden-Zähler.

uint32_t	millis (void)
	Liest den aktuellen Millisekunden-Zähler (32-Bit).

void	micros_reset (void)
	Setzt den Mikrosekunden-Zähler zurück.

uint64_t	micros_long (void)
	Liest einen langen Mikrosekunden-Zähler.

uint32_t	micros (void)
	Liest den aktuellen Mikrosekunden-Zähler (32-Bit).

void	delay (uint32_t ms)
	Verzögert die Ausführung um eine bestimmte Anzahl an Millisekunden.

void	delay_micro (uint32_t microsec)
	Verzögert die Ausführung um eine bestimmte Anzahl an Mikrosekunden.

void	pwm_set_period (uint32_t period)
	Setzt die PWM-Periode.

void	pwm_set_duty (uint32_t duty)
	Setzt das PWM-Duty-Cycle.

uint32_t	pwm_get_period (void)
	Liest die aktuelle PWM-Periode.

uint32_t	pwm_get_duty (void)
	Liest das aktuelle PWM-Duty-Cycle.

uint32_t	pwm_get_counter (void)
	Liest den aktuellen PWM-Zählerstand.

void	pwm_set_control (uint32_t control)
	Setzt den PWM-Kontrollwert.

uint32_t	pwm_get_control (void)
	Liest den aktuellen PWM-Kontrollwert.

void	pwm_set_mode (uint8_t enable_pwm)
	Aktiviert oder deaktiviert den PWM-Modus.

uint32_t	pwm_get_mode (void)
	Liest den aktuellen PWM-Modus.

void	pwm_set_50_percent_mode (uint8_t enable)
	Aktiviert oder deaktiviert den 50%-Modus des PWM.

void	pwm_set_pre_counter (uint16_t pre_counter)
	Setzt den Pre-Counter für PWM.

uint32_t	pwm_get_pre_counter (void)
	Liest den aktuellen Pre-Counter für PWM.

void	gpio_write_pin (uint8_t pin, uint8_t value)
	Schreibt einen Wert auf einen GPIO-Pin.

uint8_t	gpio_read_all_pins (void)
	Liest alle GPIO-Pins.

uint8_t	gpio_read_pin (uint8_t pin)
	Liest den Zustand eines bestimmten GPIO-Pins.

void	gpio_set_direction (uint8_t pin, uint8_t direction)
	Setzt die Richtung eines GPIO-Pins.

uint8_t	gpio_read_direction (uint8_t pin)
	Liest die Richtung eines GPIO-Pins.

Ausführliche Beschreibung

Headerdatei der WGRHAL-Bibliothek.

Diese Datei enthält Definitionen und Deklarationen für Standard-Memory-Funktionen, String-Funktionen, Debug-Ausgaben, UART, Zeitfunktionen, PWM und GPIO für den WGR-V-Prozessor.

Definiert in Datei wgrhal.h.

Makro-Dokumentation

◆ DEBUG_ADDR

#define DEBUG_ADDR 0x00000100

Basisadresse für das Debug-Register.

Definiert in Zeile 38 der Datei wgrhal.h.

◆ DEFAULT_TIMEOUT

#define DEFAULT_TIMEOUT 10

Standard-Zeitüberschreitung in Millisekunden.

Definiert in Zeile 139 der Datei wgrhal.h.

◆ GPIO_BASE_ADDR

#define GPIO_BASE_ADDR 0x00000800

Basisadresse für GPIO-Funktionen.

Definiert in Zeile 114 der Datei wgrhal.h.

◆ GPIO_DIR_OFFSET

#define GPIO_DIR_OFFSET 0x0000

Offset für das GPIO-Richtungsregister.

Definiert in Zeile 118 der Datei wgrhal.h.

◆ GPIO_IN_OFFSET

#define GPIO_IN_OFFSET 0x0004

Offset für das GPIO-Eingangsregister.

Definiert in Zeile 122 der Datei wgrhal.h.

◆ GPIO_OUT_OFFSET

#define GPIO_OUT_OFFSET 0x0008

Offset für das GPIO-Ausgangsregister.

Definiert in Zeile 126 der Datei wgrhal.h.

◆ GPIO_OUT_STEP

#define GPIO_OUT_STEP 0x04

Schrittweite zwischen den Ausgangsregistern der einzelnen Pins.

Definiert in Zeile 130 der Datei wgrhal.h.

◆ GPIO_PIN_COUNT

#define GPIO_PIN_COUNT 8

Anzahl der verfügbaren GPIO-Pins.

Definiert in Zeile 134 der Datei wgrhal.h.

◆ HWREG32

#define HWREG32 ( addr ) (*((volatile uint32_t *)(addr)))

Makro zur Adressierung von speicherabgebildeten Registern.

Definiert in Zeile 27 der Datei wgrhal.h.

◆ MALLOC

#define MALLOC

Definiert in Zeile 12 der Datei wgrhal.h.

◆ nop

#define nop ( ) __asm__ volatile("nop")

Nop-Operation.

Definiert in Zeile 33 der Datei wgrhal.h.

◆ PWM_BASE_ADDR

#define PWM_BASE_ADDR 0x00000400

Basisadresse für PWM-Funktionen.

Definiert in Zeile 93 der Datei wgrhal.h.

◆ PWM_COUNTER_OFFSET

#define PWM_COUNTER_OFFSET 0x08

Offset für das PWM-Zählerregister.

Definiert in Zeile 105 der Datei wgrhal.h.

◆ PWM_CTRL_OFFSET

#define PWM_CTRL_OFFSET 0x0C

Offset für das PWM-Steuerregister.

Definiert in Zeile 109 der Datei wgrhal.h.

◆ PWM_DUTY_OFFSET

#define PWM_DUTY_OFFSET 0x04

Offset für das PWM-Duty-Cycle-Register.

Definiert in Zeile 101 der Datei wgrhal.h.

◆ PWM_NOTES

#define PWM_NOTES

Definiert in Zeile 13 der Datei wgrhal.h.

◆ PWM_PERIOD_OFFSET

#define PWM_PERIOD_OFFSET 0x00

Offset für das PWM-Periode-Register.

Definiert in Zeile 97 der Datei wgrhal.h.

◆ SSD1351

#define SSD1351

Definiert in Zeile 14 der Datei wgrhal.h.

◆ SYS_CLK_OFFSET

#define SYS_CLK_OFFSET 0x10

Offset für den Systemtakt.

Definiert in Zeile 88 der Datei wgrhal.h.

◆ SYSTEM_CLOCK

#define SYSTEM_CLOCK 10000000

Definiert die Systemtaktfrequenz in Hertz.

Definiert in Zeile 21 der Datei wgrhal.h.

◆ TIME_BASE_ADDR

#define TIME_BASE_ADDR 0x00000300

Basisadresse für Zeitfunktionen.

Definiert in Zeile 68 der Datei wgrhal.h.

◆ TIME_MIK_H_OFFSET

#define TIME_MIK_H_OFFSET 0x0C

Offset für die höheren 32-Bit des Mikrosekundenzählers.

Definiert in Zeile 84 der Datei wgrhal.h.

◆ TIME_MIK_L_OFFSET

#define TIME_MIK_L_OFFSET 0x08

Offset für die niederwertigen 32-Bit des Mikrosekundenzählers.

Definiert in Zeile 80 der Datei wgrhal.h.

◆ TIME_MS_H_OFFSET

#define TIME_MS_H_OFFSET 0x04

Offset für die höheren 32-Bit des Millisekundenzählers.

Definiert in Zeile 76 der Datei wgrhal.h.

◆ TIME_MS_L_OFFSET

#define TIME_MS_L_OFFSET 0x00

Offset für die niederwertigen 32-Bit des Millisekundenzählers.

Definiert in Zeile 72 der Datei wgrhal.h.

◆ UART_BASE_ADDR

#define UART_BASE_ADDR 0x00000200

Basisadresse für den UART.

Definiert in Zeile 43 der Datei wgrhal.h.

◆ UART_BAUD_OFFSET

#define UART_BAUD_OFFSET 0x04

Offset für das UART-Baudratenregister.

Definiert in Zeile 51 der Datei wgrhal.h.

◆ UART_CTRL_OFFSET

#define UART_CTRL_OFFSET 0x00

Offset für das UART-Steuerregister.

Definiert in Zeile 47 der Datei wgrhal.h.

◆ UART_RX_OFFSET

#define UART_RX_OFFSET 0x10

Offset für das UART-Empfangsregister.

Definiert in Zeile 63 der Datei wgrhal.h.

◆ UART_STATUS_OFFSET

#define UART_STATUS_OFFSET 0x08

Offset für das UART-Statusregister.

Definiert in Zeile 55 der Datei wgrhal.h.

◆ UART_TX_OFFSET

#define UART_TX_OFFSET 0x0C

Offset für das UART-Sende-Register.

Definiert in Zeile 59 der Datei wgrhal.h.

Dokumentation der Funktionen

◆ debug_write()

void debug_write ( uint32_t value )

Schreibt einen Wert in das Debug-Register.

Parameter

value Zu schreibender Wert.

Definiert in Zeile 246 der Datei wgrhal.c.

◆ delay()

void delay ( uint32_t ms )

Verzögert die Ausführung um eine bestimmte Anzahl an Millisekunden.

Parameter

ms	Anzahl der Millisekunden.

Definiert in Zeile 545 der Datei wgrhal.c.

◆ delay_micro()

void delay_micro ( uint32_t microsec )

Verzögert die Ausführung um eine bestimmte Anzahl an Mikrosekunden.

Parameter

microsec Anzahl der Mikrosekunden.

Definiert in Zeile 554 der Datei wgrhal.c.

◆ get_sys_clk()

uint32_t get_sys_clk ( void )

Liest die Systemtaktfrequenz.

Rückgabe: Systemtakt in Hertz.

Definiert in Zeile 492 der Datei wgrhal.c.

◆ gpio_read_all_pins()

uint8_t gpio_read_all_pins ( void )

Liest alle GPIO-Pins.

Rückgabe: 8-Bit Wert aller Pins.

Definiert in Zeile 651 der Datei wgrhal.c.

◆ gpio_read_direction()

uint8_t gpio_read_direction ( uint8_t pin )

Liest die Richtung eines GPIO-Pins.

Parameter

pin	Pin-Nummer.

Rückgabe: Richtung des Pins (1 für Ausgang, 0 für Eingang).

Definiert in Zeile 681 der Datei wgrhal.c.

◆ gpio_read_pin()

uint8_t gpio_read_pin ( uint8_t pin )

Liest den Zustand eines bestimmten GPIO-Pins.

Parameter

pin	Pin-Nummer.

Rückgabe: Zustand des Pins (0 oder 1).

Definiert in Zeile 656 der Datei wgrhal.c.

◆ gpio_set_direction()

void gpio_set_direction	(	uint8_t	pin,
		uint8_t	direction
	)

Setzt die Richtung eines GPIO-Pins.

Parameter

pin	Pin-Nummer.
direction	Richtung (1 für Ausgang, 0 für Eingang).

Definiert in Zeile 665 der Datei wgrhal.c.

◆ gpio_write_pin()

void gpio_write_pin	(	uint8_t	pin,
		uint8_t	value
	)

Schreibt einen Wert auf einen GPIO-Pin.

Parameter

pin	Pin-Nummer.
value	Zu schreibender Wert.

Definiert in Zeile 643 der Datei wgrhal.c.

◆ int_to_str()

void int_to_str	(	int32_t	num,
		int	base,
		char *	str
	)

Konvertiert eine Ganzzahl in einen String.

Parameter

num	Zu konvertierende Zahl.
base	Zahlensystembasis (zwischen 2 und 16).
str	Zielpuffer, in dem der resultierende String gespeichert wird.

Definiert in Zeile 122 der Datei wgrhal.c.

◆ memcpy()

void * memcpy	(	void *	dest,
		const void *	src,
		uint32_t	n
	)

Kopiert n Bytes von src nach dest.

Parameter

dest	Zielpuffer, in den die Bytes kopiert werden.
src	Quellpuffer, von dem die Bytes gelesen werden.
n	Anzahl der zu kopierenden Bytes.

Rückgabe: Zeiger auf den Zielpuffer.

Definiert in Zeile 26 der Datei wgrhal.c.

◆ memmove()

void * memmove	(	void *	dest,
		const void *	src,
		uint32_t	n
	)

Kopiert n Bytes von src nach dest, wobei sich überlappende Speicherbereiche korrekt behandelt werden.

Parameter

dest	Zielpuffer.
src	Quellpuffer.
n	Anzahl der zu kopierenden Bytes.

Rückgabe: Zeiger auf den Zielpuffer.

Definiert in Zeile 47 der Datei wgrhal.c.

◆ memset()

void * memset	(	void *	dest,
		int32_t	c,
		uint32_t	n
	)

Setzt n Bytes im Zielpuffer auf den Wert c.

Parameter

dest	Zielpuffer, in dem der Wert gesetzt wird.
c	Zu setzender Wert.
n	Anzahl der Bytes, die gesetzt werden.

Rückgabe: Zeiger auf den Zielpuffer.

Definiert in Zeile 37 der Datei wgrhal.c.

◆ micros()

uint32_t micros ( void )

Liest den aktuellen Mikrosekunden-Zähler (32-Bit).

Rückgabe: Mikrosekunden-Zähler.

Definiert in Zeile 540 der Datei wgrhal.c.

◆ micros_long()

uint64_t micros_long ( void )

Liest einen langen Mikrosekunden-Zähler.

Rückgabe: 64-Bit Mikrosekunden-Zähler.

Definiert in Zeile 526 der Datei wgrhal.c.

◆ micros_reset()

void micros_reset ( void )

Setzt den Mikrosekunden-Zähler zurück.

Definiert in Zeile 521 der Datei wgrhal.c.

◆ millis()

uint32_t millis ( void )

Liest den aktuellen Millisekunden-Zähler (32-Bit).

Rückgabe: Millisekunden-Zähler.

Definiert in Zeile 516 der Datei wgrhal.c.

◆ millis_long()

uint64_t millis_long ( void )

Liest einen langen Millisekunden-Zähler.

Rückgabe: 64-Bit Millisekunden-Zähler.

Definiert in Zeile 502 der Datei wgrhal.c.

◆ millis_reset()

void millis_reset ( void )

Setzt den Millisekunden-Zähler zurück.

Definiert in Zeile 497 der Datei wgrhal.c.

◆ parse_int_multi()

int32_t parse_int_multi	(	const char *	str,
		const char **	next
	)

Parst eine Ganzzahl aus einem String und gibt den Zeiger auf das nächste Zeichen zurück.

Parameter

str	Zu parsender String.
next	Zeiger auf den Reststring nach der Ganzzahl.

Rückgabe: Die geparste Ganzzahl oder -1 bei Fehler.

Definiert in Zeile 205 der Datei wgrhal.c.

◆ parse_integer()

int32_t parse_integer ( const char * str )

Parst einen String in eine Ganzzahl.

Parameter

str	Zu parsender String.

Rückgabe: Die geparste Ganzzahl oder -1 bei Fehler.

Definiert in Zeile 165 der Datei wgrhal.c.

◆ pwm_get_control()

uint32_t pwm_get_control ( void )

Liest den aktuellen PWM-Kontrollwert.

Rückgabe: Aktueller Kontrollwert.

Definiert in Zeile 599 der Datei wgrhal.c.

◆ pwm_get_counter()

uint32_t pwm_get_counter ( void )

Liest den aktuellen PWM-Zählerstand.

Rückgabe: Aktueller Zählerstand.

Definiert in Zeile 589 der Datei wgrhal.c.

◆ pwm_get_duty()

uint32_t pwm_get_duty ( void )

Liest das aktuelle PWM-Duty-Cycle.

Rückgabe: Aktueller Duty-Cycle.

Definiert in Zeile 584 der Datei wgrhal.c.

◆ pwm_get_mode()

uint32_t pwm_get_mode ( void )

Liest den aktuellen PWM-Modus.

Rückgabe: 1 wenn aktiviert, sonst 0.

◆ pwm_get_period()

uint32_t pwm_get_period ( void )

Liest die aktuelle PWM-Periode.

Rückgabe: Aktuelle Periode.

Definiert in Zeile 579 der Datei wgrhal.c.

◆ pwm_get_pre_counter()

uint32_t pwm_get_pre_counter ( void )

Liest den aktuellen Pre-Counter für PWM.

Rückgabe: Aktueller Pre-Counter-Wert.

Definiert in Zeile 631 der Datei wgrhal.c.

◆ pwm_set_50_percent_mode()

void pwm_set_50_percent_mode ( uint8_t enable )

Aktiviert oder deaktiviert den 50%-Modus des PWM.

Parameter

enable 1 zum Aktivieren, 0 zum Deaktivieren.

Definiert in Zeile 614 der Datei wgrhal.c.

◆ pwm_set_control()

void pwm_set_control ( uint32_t control )

Setzt den PWM-Kontrollwert.

Parameter

control Neuer Kontrollwert.

Definiert in Zeile 594 der Datei wgrhal.c.

◆ pwm_set_duty()

void pwm_set_duty ( uint32_t duty )

Setzt das PWM-Duty-Cycle.

Parameter

duty	Neuer Duty-Cycle.

Definiert in Zeile 574 der Datei wgrhal.c.

◆ pwm_set_mode()

void pwm_set_mode ( uint8_t enable_pwm )

Aktiviert oder deaktiviert den PWM-Modus.

Parameter

enable_pwm 1 zum Aktivieren, 0 zum Deaktivieren.

Definiert in Zeile 604 der Datei wgrhal.c.

◆ pwm_set_period()

void pwm_set_period ( uint32_t period )

Setzt die PWM-Periode.

Parameter

period Neue Periode.

Definiert in Zeile 569 der Datei wgrhal.c.

◆ pwm_set_pre_counter()

void pwm_set_pre_counter ( uint16_t pre_counter )

Setzt den Pre-Counter für PWM.

Parameter

pre_counter Neuer Pre-Counter-Wert.

Definiert in Zeile 624 der Datei wgrhal.c.

◆ strcmp()

int32_t strcmp	(	const char *	s1,
		const char *	s2
	)

Vergleicht zwei Strings.

Parameter

s1	Erster String.
s2	Zweiter String.

Rückgabe: Differenz der ersten unterschiedlichen Zeichen, oder 0, wenn die Strings gleich sind.

Definiert in Zeile 86 der Datei wgrhal.c.

◆ strcpy()

char * strcpy	(	char *	dest,
		const char *	src
	)

Kopiert einen String von src nach dest.

Parameter

dest	Zielpuffer, in den der String kopiert wird.
src	Quellstring.

Rückgabe: Zeiger auf den Zielpuffer.

Definiert in Zeile 114 der Datei wgrhal.c.

◆ strlen()

uint32_t strlen ( const char * s )

Bestimmt die Länge eines Strings.

Parameter

s	Zeiger auf den Null-terminierten String.

Rückgabe: Länge des Strings ohne das Nullzeichen.

Definiert in Zeile 76 der Datei wgrhal.c.

◆ strncmp()

int32_t strncmp	(	const char *	s1,
		const char *	s2,
		uint32_t	n
	)

Vergleicht maximal n Zeichen zweier Strings.

Parameter

s1	Erster String.
s2	Zweiter String.
n	Maximale Anzahl zu vergleichender Zeichen.

Rückgabe: 0, wenn die ersten n Zeichen gleich sind, sonst Differenz der ersten unterschiedlichen Zeichen.

Definiert in Zeile 96 der Datei wgrhal.c.

◆ uart_disable()

void uart_disable ( void )

Deaktiviert die UART-Schnittstelle.

Definiert in Zeile 263 der Datei wgrhal.c.

◆ uart_enable()

void uart_enable ( void )

Aktiviert die UART-Schnittstelle.

Definiert in Zeile 257 der Datei wgrhal.c.

◆ uart_get_status()

uint32_t uart_get_status ( void )

Liest den Status der UART-Schnittstelle.

Rückgabe: Statuswert der UART.

Definiert in Zeile 278 der Datei wgrhal.c.

◆ uart_getchar()

char uart_getchar ( uint32_t timeout_ms )

Liest ein Zeichen von der UART-Schnittstelle.

Parameter

timeout_ms Zeitlimit in Millisekunden.

Rückgabe: Gelesenes Zeichen oder -1 bei Fehler.

Definiert in Zeile 399 der Datei wgrhal.c.

◆ uart_is_busy()

uint32_t uart_is_busy ( void )

Prüft, ob die UART beschäftigt ist.

Rückgabe: 1, wenn beschäftigt, sonst 0.

Definiert in Zeile 288 der Datei wgrhal.c.

◆ uart_is_ready()

uint32_t uart_is_ready ( void )

Prüft, ob die UART bereit ist.

Rückgabe: 1, wenn bereit, sonst 0.

Definiert in Zeile 283 der Datei wgrhal.c.

◆ uart_print()

void uart_print ( const char * s )

Gibt einen String über die UART aus.

Parameter

s	Zu druckender String.

Definiert in Zeile 478 der Datei wgrhal.c.

◆ uart_print_int()

void uart_print_int ( int32_t num )

Gibt eine Ganzzahl über die UART aus.

Parameter

num	Zu druckende Zahl.

Definiert in Zeile 467 der Datei wgrhal.c.

◆ uart_print_uint()

void uart_print_uint	(	uint32_t	num,
		int32_t	base
	)

Gibt eine positive Ganzzahl in einem bestimmten Zahlensystem über die UART aus.

Parameter

num	Zu druckende Zahl.
base	Zahlensystembasis.

Definiert in Zeile 438 der Datei wgrhal.c.

◆ uart_putchar()

int32_t uart_putchar	(	char	c,
		uint32_t	timeout_ms
	)

Sendet ein Zeichen über die UART-Schnittstelle.

Parameter

c	Zu sendendes Zeichen.
timeout_ms	Zeitlimit in Millisekunden.

Rückgabe: 0 bei Erfolg, -1 bei Fehler.

Definiert in Zeile 359 der Datei wgrhal.c.

◆ uart_putchar_default_timeout()

void uart_putchar_default_timeout ( char c )

Sendet ein Zeichen über die UART-Schnittstelle mit voreingestelltem Timeout.

Parameter

c	Zu sendendes Zeichen.

Definiert in Zeile 364 der Datei wgrhal.c.

◆ uart_read_buffer()

int32_t uart_read_buffer	(	uint8_t *	buf,
		uint32_t	length,
		uint32_t	timeout_ms
	)

Liest einen Puffer von Bytes von der UART-Schnittstelle.

Parameter

buf	Zielpuffer für die gelesenen Bytes.
length	Anzahl der zu lesenden Bytes.
timeout_ms	Zeitlimit in Millisekunden.

Rückgabe: 0 bei Erfolg, -1 bei Fehler.

Definiert in Zeile 410 der Datei wgrhal.c.

◆ uart_read_byte()

int32_t uart_read_byte	(	uint8_t *	data,
		uint32_t	timeout_ms
	)

Liest ein Byte von der UART-Schnittstelle.

Parameter

data	Zeiger, in den das gelesene Byte gespeichert wird.
timeout_ms	Zeitlimit in Millisekunden.

Rückgabe: 0 bei Erfolg, -1 bei Fehler.

Definiert in Zeile 388 der Datei wgrhal.c.

◆ uart_rx_empty()

uint32_t uart_rx_empty ( void )

Prüft, ob der UART-Empfangspuffer leer ist.

Rückgabe: 1, wenn leer, sonst 0.

Definiert in Zeile 298 der Datei wgrhal.c.

◆ uart_rx_full()

uint32_t uart_rx_full ( void )

Prüft, ob der UART-Empfangspuffer voll ist.

Rückgabe: 1, wenn voll, sonst 0.

Definiert in Zeile 293 der Datei wgrhal.c.

◆ uart_send_uint32()

void uart_send_uint32	(	uint32_t	value,
		uint32_t	timeout_ms
	)

Sendet einen 32-Bit-Wert über die UART-Schnittstelle.

Parameter

value	Zu sendender Wert.
timeout_ms	Zeitlimit in Millisekunden.

Definiert in Zeile 427 der Datei wgrhal.c.

◆ uart_set_baud()

void uart_set_baud ( baud_sel_t baud )

Setzt die Baudrate der UART-Schnittstelle.

Parameter

baud	Auswahl der Baudrate (baud_sel_t).

Definiert in Zeile 269 der Datei wgrhal.c.

◆ uart_tx_empty()

uint32_t uart_tx_empty ( void )

Prüft, ob der UART-Sende-Puffer leer ist.

Rückgabe: 1, wenn leer, sonst 0.

Definiert in Zeile 308 der Datei wgrhal.c.

◆ uart_tx_full()

uint32_t uart_tx_full ( void )

Prüft, ob der UART-Sende-Puffer voll ist.

Rückgabe: 1, wenn voll, sonst 0.

Definiert in Zeile 303 der Datei wgrhal.c.

◆ uart_wait_rx_data()

int32_t uart_wait_rx_data ( uint32_t timeout_ms )

Wartet darauf, dass Daten im Empfangspuffer vorhanden sind, bis zu einer Zeitüberschreitung.

Parameter

timeout_ms Zeitlimit in Millisekunden.

Rückgabe: 0 bei Erfolg, -1 bei Zeitüberschreitung.

Definiert in Zeile 328 der Datei wgrhal.c.

◆ uart_wait_tx_full()

int32_t uart_wait_tx_full ( uint32_t timeout_ms )

Wartet darauf, dass der Sende-Puffer voll wird, bis zu einer Zeitüberschreitung.

Parameter

timeout_ms Zeitlimit in Millisekunden.

Rückgabe: 0 bei Erfolg, -1 bei Zeitüberschreitung.

Definiert in Zeile 313 der Datei wgrhal.c.

◆ uart_write_buffer()

int32_t uart_write_buffer	(	const uint8_t *	buffer,
		uint32_t	length,
		uint32_t	timeout_ms
	)

Sendet einen Puffer von Bytes über die UART-Schnittstelle.

Parameter

buffer	Zeiger auf den zu sendenden Datenpuffer.
length	Anzahl der zu sendenden Bytes.
timeout_ms	Zeitlimit in Millisekunden.

Rückgabe: 0 bei Erfolg, -1 bei Fehler.

Definiert in Zeile 369 der Datei wgrhal.c.

◆ uart_write_byte()

int32_t uart_write_byte	(	uint8_t	data,
		uint32_t	timeout_ms
	)

Sendet ein Byte über die UART-Schnittstelle.

Parameter

data	Zu sendendes Byte.
timeout_ms	Zeitlimit in Millisekunden.

Rückgabe: 0 bei Erfolg, -1 bei Fehler.

Definiert in Zeile 343 der Datei wgrhal.c.

Makrodefinitionen

Funktionen

Ausführliche Beschreibung

Makro-Dokumentation

◆ DEBUG_ADDR

◆ DEFAULT_TIMEOUT

◆ GPIO_BASE_ADDR

◆ GPIO_DIR_OFFSET

◆ GPIO_IN_OFFSET

◆ GPIO_OUT_OFFSET

◆ GPIO_OUT_STEP

◆ GPIO_PIN_COUNT

◆ HWREG32

◆ MALLOC

◆ nop

◆ PWM_BASE_ADDR

◆ PWM_COUNTER_OFFSET

◆ PWM_CTRL_OFFSET

◆ PWM_DUTY_OFFSET

◆ PWM_NOTES

◆ PWM_PERIOD_OFFSET

◆ SSD1351

◆ SYS_CLK_OFFSET

◆ SYSTEM_CLOCK

◆ TIME_BASE_ADDR

◆ TIME_MIK_H_OFFSET

◆ TIME_MIK_L_OFFSET

◆ TIME_MS_H_OFFSET

◆ TIME_MS_L_OFFSET

◆ UART_BASE_ADDR

◆ UART_BAUD_OFFSET

◆ UART_CTRL_OFFSET

◆ UART_RX_OFFSET

◆ UART_STATUS_OFFSET

◆ UART_TX_OFFSET

Dokumentation der Funktionen

◆ debug_write()

◆ delay()

◆ delay_micro()

◆ get_sys_clk()

◆ gpio_read_all_pins()

◆ gpio_read_direction()

◆ gpio_read_pin()

◆ gpio_set_direction()

◆ gpio_write_pin()

◆ int_to_str()

◆ memcpy()

◆ memmove()

◆ memset()

◆ micros()

◆ micros_long()

◆ micros_reset()

◆ millis()

◆ millis_long()

◆ millis_reset()

◆ parse_int_multi()

◆ parse_integer()

◆ pwm_get_control()

◆ pwm_get_counter()

◆ pwm_get_duty()

◆ pwm_get_mode()

◆ pwm_get_period()

◆ pwm_get_pre_counter()

◆ pwm_set_50_percent_mode()

◆ pwm_set_control()

◆ pwm_set_duty()

◆ pwm_set_mode()

◆ pwm_set_period()

◆ pwm_set_pre_counter()

◆ strcmp()

◆ strcpy()

◆ strlen()

◆ strncmp()

◆ uart_disable()

◆ uart_enable()

◆ uart_get_status()

◆ uart_getchar()

◆ uart_is_busy()

◆ uart_is_ready()

◆ uart_print()