whiskers/standard_8h_source.html

/* Copyright (c) 2026 Zane A. Maples

   Licensed under the MIT license. See LICENSE in the main repository for more information. */


#ifndef W_HAL_STANDARD_H

#define W_HAL_STANDARD_H


#include <stdint.h>

#include "shared.h"


void hal_init();

void hal_init_watchdog(uint32_t ms_timeout);

void hal_deinit_watchdog();

void hal_watchdog_update();

void hal_sleep_ms(uint32_t ms);

uint32_t hal_get_ms_since_boot();


void hal_core1_entry(void (*entry)(void));


void print_chip_info();


void get_board_serial(char out[13]);

#endif

shared.h
Shared structs, error codes, and functions for all HAL files.

hal_init_watchdog
void hal_init_watchdog(uint32_t ms_timeout)
Initializes the watchdog.

hal_watchdog_update
void hal_watchdog_update()
Updates the watchdog and refreshes it's timer.

print_chip_info
void print_chip_info()
Prints out chip information.

get_board_serial
void get_board_serial(char out[13])
Gets the serial number of the board vll_wsk_01**.

hal_core1_entry
void hal_core1_entry(void(*entry)(void))
Launches an entry function on core1.

hal_deinit_watchdog
void hal_deinit_watchdog()
De-initializes the watchdog.

hal_sleep_ms
void hal_sleep_ms(uint32_t ms)
Suspends the active core for specified amount of milliseconds.

hal_get_ms_since_boot
uint32_t hal_get_ms_since_boot()
Gets amount of time since boot.

hal_init
void hal_init()
Initializes the HAL. Must be called first in any program.