mmhal.h

/*
 * Copyright 2021-2023 Morse Micro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <time.h>
#include "mmhal_flash.h"
#include "mmhal_wlan.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
void mmhal_early_init(void);
 
void mmhal_init(void);
 
enum mmhal_isr_state
{
    MMHAL_NOT_IN_ISR,               
    MMHAL_IN_ISR,                   
    MMHAL_ISR_STATE_UNKNOWN,        
};
 
enum mmhal_led_id
{
    LED_RED,
    LED_GREEN,
    LED_BLUE,
    LED_WHITE
};
 
enum mmhal_sleep_state
{
    MMHAL_SLEEP_DISABLED,   
    MMHAL_SLEEP_SHALLOW,    
    MMHAL_SLEEP_DEEP,       
};
 
#define LED_OFF   0
 
#define LED_ON    255
 
enum mmhal_isr_state mmhal_get_isr_state(void);
 
void mmhal_log_write(const uint8_t *data, size_t len);
 
void mmhal_log_flush(void);
 
uint32_t mmhal_random_u32(uint32_t min, uint32_t max);
 
void mmhal_reset(void);
 
void mmhal_set_led(uint8_t led, uint8_t level);
 
void mmhal_set_error_led(bool state);
 
enum mmhal_button_id
{
    BUTTON_ID_USER0
};
 
enum mmhal_button_state
{
    BUTTON_RELEASED,
    BUTTON_PRESSED
};
 
typedef void (*mmhal_button_state_cb_t)(enum mmhal_button_id button_id,
                                        enum mmhal_button_state button_state);
 
bool mmhal_set_button_callback(enum mmhal_button_id button_id,
                               mmhal_button_state_cb_t button_state_cb);
 
mmhal_button_state_cb_t mmhal_get_button_callback(enum mmhal_button_id button_id);
 
enum mmhal_button_state mmhal_get_button(enum mmhal_button_id button_id);
 
 
bool mmhal_get_hardware_version(char * version_buffer, size_t version_buffer_length);
 
#define MMHAL_DEBUG_PIN(_pin_num)   (1ul << (_pin_num))
 
#define MMHAL_ALL_DEBUG_PINS        (UINT32_MAX)
 
void mmhal_set_debug_pins(uint32_t mask, uint32_t values);
 
time_t mmhal_get_time(void);
 
void mmhal_set_time(time_t epoch);
 
enum mmhal_sleep_state mmhal_sleep_prepare(uint32_t expected_idle_time_ms);
 
uint32_t mmhal_sleep(enum mmhal_sleep_state sleep_state, uint32_t expected_idle_time_ms);
 
void mmhal_sleep_abort(enum mmhal_sleep_state sleep_state);
 
void mmhal_sleep_cleanup(void);
 
enum mmhal_veto_id
{
    MMHAL_VETO_ID_APP_MIN = 0,
    MMHAL_VETO_ID_APP_MAX = 7,
    MMHAL_VETO_ID_HAL_MIN = 8,
    MMHAL_VETO_ID_HAL_MAX = 15,
    MMHAL_VETO_ID_MORSELIB_MIN = 16,
    MMHAL_VETO_ID_MORSELIB_MAX = 19,
    MMHAL_VETO_ID_DATALINK     = 20,
    MMHAL_VETO_ID_MMCONFIG     = 21,
    MMHAL_VETO_ID_RESERVED_MIN = 22,
    MMHAL_VETO_ID_RESERVED_MAX = 31,
};
 
void mmhal_set_deep_sleep_veto(uint8_t veto_id);
 
void mmhal_clear_deep_sleep_veto(uint8_t veto_id);
 
#ifdef __cplusplus
}
#endif