wifi_hal_join.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_wifi.h"

typedef enum : uint32_t {
  k_wifi_hal_uart_baud    = 115200U,  
  k_wifi_hal_sck_hz       = 5000000U, 
  k_wifi_hal_edge_poll_ms = 2U,       
  k_wifi_hal_boot_wait_ms = 200U,     
  k_wifi_hal_heartbeat_ms = 5000U,    
  k_wifi_hal_worker_stack = 8192U,    
  k_wifi_hal_worker_prio  = 8U,       
  k_wifi_hal_arena_bytes  = 4096U,    
} wifi_hal_cfg_t;

typedef enum : uint32_t {
  k_wifi_hal_assoc_polls  = 200U,   
  k_wifi_hal_assoc_gap_ms = 50U,    
  k_wifi_hal_dhcp_wait_ms = 25000U, 
} wifi_hal_wait_t;

typedef enum : uint16_t {
  k_wifi_hal_str_max    = 256U,  
  k_wifi_hal_dec_radix  = 10U,   
  k_wifi_hal_dec_digits = 10U,   
  k_wifi_hal_hex_digits = 8U,    
  k_wifi_hal_hex_bits   = 4U,    
  k_wifi_hal_hex_mask   = 0x0FU, 
  k_wifi_hal_hex_alpha  = 10U,   
  k_wifi_hal_hex_byte   = 2U,    
  k_wifi_hal_ip_octets  = 4U,    
  k_wifi_hal_ip_mask    = 0xFFU, 
} wifi_hal_fmt_t;

typedef enum : uint8_t {
  k_wifi_hal_ip_shift_0 = 24U, 
  k_wifi_hal_ip_shift_1 = 16U, 
  k_wifi_hal_ip_shift_2 = 8U,  
  k_wifi_hal_ip_shift_3 = 0U,  
} wifi_hal_ip_shift_t;

extern const char k_wifi_hal_pass_line[];

extern const char k_wifi_hal_fail_line[];

typedef struct wifi_hal_result {
  bool             init_ok;     
  bool             associated;  
  bool             ip_bound;    
  bool             passed;      
  ra8_err_t        init_err;    
  ra8_err_t        connect_err; 
  ra8_err_t        ip_err;      
  ra8_wifi_mac_t   mac;         
  ra8_wifi_ap_t    ap;          
  ra8_wifi_lease_t lease;       
} wifi_hal_result_t;

typedef struct wifi_hal_run_cfg {
  const ra8_wifi_cfg_t* wifi_cfg;    
  ra8_wifi_t*           wifi;        
  const char*           ssid;        
  const char*           psk;         
  uint32_t              poll_budget; 
} wifi_hal_run_cfg_t;

[[nodiscard]] bool wifi_hal_join_run(const wifi_hal_run_cfg_t* cfg, wifi_hal_result_t* out);

[[nodiscard]] ra8_err_t
wifi_hal_ip_bind(void* ip_ctx, const ra8_wifi_mac_t* mac, ra8_wifi_lease_t* out);

void wifi_hal_puts(const char* text);

void wifi_hal_put_u32(uint32_t value);

void wifi_hal_put_hex(uint32_t value, uint8_t digits);

void wifi_hal_put_ip(uint32_t ip);

void wifi_hal_put_mac(const ra8_wifi_mac_t* mac);

void wifi_hal_print_banner(uint32_t cpuclk_hz, uint32_t pclka_hz);