File syn_port_system.h

FileList > port > syn_port_system.h

Go to the source code of this file

System-level port interface — functions the user must implement. More...

• #include "../common/syn_compiler.h"
• #include "../common/syn_defs.h"

Public Functions

Type	Name
void	syn_port_delay_ms (uint32_t ms) Blocking delay for the specified number of milliseconds.
void	syn_port_enter_critical (void) Enter a critical section (disable interrupts).
void	syn_port_exit_critical (void) Exit a critical section (re-enable interrupts).
uint32_t	syn_port_get_tick_ms (void) Return the current system tick in milliseconds.
uint32_t	syn_port_get_tick_us (void) Return the current system tick in microseconds.
void	syn_port_nvic_enable_irq (uint8_t irq_num) Enable a specific interrupt line in the hardware interrupt controller.
void	syn_port_nvic_set_priority (uint8_t irq_num, uint8_t preempt_prio, uint8_t sub_prio) Configure interrupt preemption and subpriority in hardware controller.
SYN_NORETURN void	syn_port_system_reset (void) Perform a system reset.

Detailed Description

Provides critical-section management, a millisecond tick source, delay, interrupt priority management, and system reset.

Public Functions Documentation

function syn_port_delay_ms

Blocking delay for the specified number of milliseconds.

void syn_port_delay_ms (
    uint32_t ms
) 

Parameters:

• ms Delay duration in milliseconds.

---

function syn_port_enter_critical

Enter a critical section (disable interrupts).

void syn_port_enter_critical (
    void
) 

---

function syn_port_exit_critical

Exit a critical section (re-enable interrupts).

void syn_port_exit_critical (
    void
) 

---

function syn_port_get_tick_ms

Return the current system tick in milliseconds.

uint32_t syn_port_get_tick_ms (
    void
) 

Returns:

Current system tick count in milliseconds.

---

function syn_port_get_tick_us

Return the current system tick in microseconds.

uint32_t syn_port_get_tick_us (
    void
) 

Returns:

Current system tick count in microseconds.

---

function syn_port_nvic_enable_irq

Enable a specific interrupt line in the hardware interrupt controller.

void syn_port_nvic_enable_irq (
    uint8_t irq_num
) 

Parameters:

• irq_num Interrupt vector number to enable.

---

function syn_port_nvic_set_priority

Configure interrupt preemption and subpriority in hardware controller.

void syn_port_nvic_set_priority (
    uint8_t irq_num,
    uint8_t preempt_prio,
    uint8_t sub_prio
) 

Parameters:

• irq_num Interrupt vector number.
• preempt_prio Preemption priority (0 = highest).
• sub_prio Subpriority level (0 = highest).

---

function syn_port_system_reset

Perform a system reset.

SYN_NORETURN void syn_port_system_reset (
    void
) 

---

---

The documentation for this class was generated from the following file src/syntropic/port/syn_port_system.h